96dccca475
This enables imports in mcl code, and is one of last remaining blockers to using mgmt. Now we can start writing standalone modules, and adding standard library functions as needed. There's still lots to do, but this was a big missing piece. It was much harder to get right than I had expected, but I think it's solid! This unfortunately large commit is the result of some wild hacking I've been doing for the past little while. It's the result of a rebase that broke many "wip" commits that tracked my private progress, into something that's not gratuitously messy for our git logs. Since this was a learning and discovery process for me, I've "erased" the confusing git history that wouldn't have helped. I'm happy to discuss the dead-ends, and a small portion of that code was even left in for possible future use. This patch includes: * A change to the cli interface: You now specify the front-end explicitly, instead of leaving it up to the front-end to decide when to "activate". For example, instead of: mgmt run --lang code.mcl we now do: mgmt run lang --lang code.mcl We might rename the --lang flag in the future to avoid the awkward word repetition. Suggestions welcome, but I'm considering "input". One side-effect of this change, is that flags which are "engine" specific now must be specified with "run" before the front-end name. Eg: mgmt run --tmp-prefix lang --lang code.mcl instead of putting --tmp-prefix at the end. We also changed the GAPI slightly, but I've patched all code that used it. This also makes things consistent with the "deploy" command. * The deploys are more robust and let you deploy after a run This has been vastly improved and let's mgmt really run as a smart engine that can handle different workloads. If you don't want to deploy when you've started with `run` or if one comes in, you can use the --no-watch-deploy option to block new deploys. * The import statement exists and works! We now have a working `import` statement. Read the docs, and try it out. I think it's quite elegant how it fits in with `SetScope`. Have a look. As a result, we now have some built-in functions available in modules. This also adds the metadata.yaml entry-point for all modules. Have a look at the examples or the tests. The bulk of the patch is to support this. * Improved lang input parsing code: I re-wrote the parsing that determined what ran when we passed different things to --lang. Deciding between running an mcl file or raw code is now handled in a more intelligent, and re-usable way. See the inputs.go file if you want to have a look. One casualty is that you can't stream code from stdin *directly* to the front-end, it's encapsulated into a deploy first. You can still use stdin though! I doubt anyone will notice this change. * The scope was extended to include functions and classes: Go forth and import lovely code. All these exist in scopes now, and can be re-used! * Function calls actually use the scope now. Glad I got this sorted out. * There is import cycle detection for modules! Yes, this is another dag. I think that's #4. I guess they're useful. * A ton of tests and new test infra was added! This should make it much easier to add new tests that run mcl code. Have a look at TestAstFunc1 to see how to add more of these. As usual, I'll try to keep these commits smaller in the future!
99 lines
3.8 KiB
Go
99 lines
3.8 KiB
Go
// Mgmt
|
|
// Copyright (C) 2013-2018+ James Shubin and the project contributors
|
|
// Written by James Shubin <james@shubin.ca> and the project contributors
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package interfaces
|
|
|
|
import (
|
|
"github.com/purpleidea/mgmt/engine"
|
|
)
|
|
|
|
// ImportData is the result of parsing a string import when it has not errored.
|
|
type ImportData struct {
|
|
// Name is the original input that produced this struct. It is stored
|
|
// here so that you can parse it once and pass this struct around
|
|
// without having to include a copy of the original data if needed.
|
|
Name string
|
|
|
|
// Alias is the name identifier that should be used for this import.
|
|
Alias string
|
|
|
|
// IsSystem specifies that this is a system import.
|
|
IsSystem bool
|
|
|
|
// IsLocal represents if a module is either local or a remote import.
|
|
IsLocal bool
|
|
|
|
// IsFile represents if we're referring to an individual file or not.
|
|
IsFile bool
|
|
|
|
// Path represents the relative path to the directory that this import
|
|
// points to. Since it specifies a directory, it will end with a
|
|
// trailing slash which makes detection more obvious for other helpers.
|
|
// If this points to a local import, that directory is probably not
|
|
// expected to contain a metadata file, and it will be a simple path
|
|
// addition relative to the current file this import was parsed from. If
|
|
// this is a remote import, then it's likely that the file will be found
|
|
// in a more distinct path, such as a search path that contains the full
|
|
// fqdn of the import.
|
|
// TODO: should system imports put something here?
|
|
Path string
|
|
|
|
// URL is the path that a `git clone` operation should use as the URL.
|
|
// If it is a local import, then this is the empty value.
|
|
URL string
|
|
}
|
|
|
|
// DownloadInfo is the set of input values passed into the Init method of the
|
|
// Downloader interface, so that it can have some useful information to use.
|
|
type DownloadInfo struct {
|
|
// Fs is the filesystem to use for downloading to.
|
|
Fs engine.Fs
|
|
|
|
// Noop specifies if we should actually download or just fake it. The
|
|
// one problem is that if we *don't* download something, then we can't
|
|
// follow it to see if there's anything else to download.
|
|
Noop bool
|
|
|
|
// Sema specifies the max number of simultaneous downloads to run.
|
|
Sema int
|
|
|
|
// Update specifies if we should try and update existing downloaded
|
|
// artifacts.
|
|
Update bool
|
|
|
|
// Debug represents if we're running in debug mode or not.
|
|
Debug bool
|
|
|
|
// Logf is a logger which should be used.
|
|
Logf func(format string, v ...interface{})
|
|
}
|
|
|
|
// Downloader is the interface that must be fulfilled to download modules.
|
|
// TODO: this should probably be in a more central package like the top-level
|
|
// GAPI package, and not contain the lang specific *ImportData struct. Since we
|
|
// aren't working on a downloader for any other frontend at the moment, we'll
|
|
// keep it here, and keep it less generalized for now. If we *really* wanted to
|
|
// generalize it, Get would be implemented as part of the *ImportData struct and
|
|
// there would be an interface it helped fulfill for the Downloader GAPI.
|
|
type Downloader interface {
|
|
// Init initializes the downloader with some core structures we'll need.
|
|
Init(*DownloadInfo) error
|
|
|
|
// Get runs a single download of an import and stores it on disk.
|
|
Get(*ImportData, string) error
|
|
}
|