mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-05-16 16:01:49 -04:00
ce59943d99
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org> Signed-off-by: Christian Mesh <christianmesh1@gmail.com> Co-authored-by: Christian Mesh <christianmesh1@gmail.com>
127 lines
4.3 KiB
Go
127 lines
4.3 KiB
Go
// Copyright (c) The OpenTofu Authors
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
// Copyright (c) 2023 HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package command
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
|
|
"github.com/mitchellh/cli"
|
|
"github.com/opentofu/opentofu/internal/command/arguments"
|
|
"github.com/opentofu/opentofu/internal/command/views"
|
|
"github.com/opentofu/opentofu/internal/tfdiags"
|
|
"github.com/opentofu/opentofu/internal/tracing"
|
|
)
|
|
|
|
// GetCommand is a Command implementation that takes a OpenTofu
|
|
// configuration and downloads all the modules.
|
|
type GetCommand struct {
|
|
Meta
|
|
}
|
|
|
|
func (c *GetCommand) Run(rawArgs []string) int {
|
|
ctx := c.CommandContext()
|
|
ctx, span := tracing.Tracer().Start(ctx, "Get")
|
|
defer span.End()
|
|
|
|
// new view
|
|
common, rawArgs := arguments.ParseView(rawArgs)
|
|
c.View.Configure(common)
|
|
// Because the legacy UI was using println to show diagnostics and the new view is using, by default, print,
|
|
// in order to keep functional parity, we setup the view to add a new line after each diagnostic.
|
|
c.View.DiagsWithNewline()
|
|
|
|
// Parse and validate flags
|
|
args, closer, diags := arguments.ParseGet(rawArgs)
|
|
defer closer()
|
|
|
|
// Instantiate the view, even if there are flag errors, so that we render
|
|
// diagnostics according to the desired view
|
|
view := views.NewGet(args.ViewOptions, c.View)
|
|
|
|
if diags.HasErrors() {
|
|
view.Diagnostics(diags)
|
|
if args.ViewOptions.ViewType == arguments.ViewJSON {
|
|
return 1
|
|
}
|
|
return cli.RunResultHelp
|
|
}
|
|
c.Meta.variableArgs = args.Vars.All()
|
|
|
|
// Initialization can be aborted by interruption signals
|
|
ctx, done := c.InterruptibleContext(ctx)
|
|
defer done()
|
|
|
|
// This gets the current directory as full path.
|
|
path := c.WorkingDir.NormalizePath(c.WorkingDir.RootModuleDir())
|
|
|
|
abort, diags := getModules(ctx, &c.Meta, path, args.TestsDirectory, args.Update, view)
|
|
view.Diagnostics(diags)
|
|
if abort || diags.HasErrors() {
|
|
return 1
|
|
}
|
|
|
|
return 0
|
|
}
|
|
|
|
func (c *GetCommand) Help() string {
|
|
helpText := `
|
|
Usage: tofu [global options] get [options]
|
|
|
|
Downloads and installs modules needed for the configuration in the
|
|
current working directory.
|
|
|
|
This recursively downloads all modules needed, such as modules
|
|
imported by modules imported by the root and so on. If a module is
|
|
already downloaded, it will not be redownloaded or checked for updates
|
|
unless the -update flag is specified.
|
|
|
|
Module installation also happens automatically by default as part of
|
|
the "tofu init" command, so you should rarely need to run this
|
|
command separately.
|
|
|
|
Options:
|
|
|
|
-update Check already-downloaded modules for available updates
|
|
and install the newest versions available.
|
|
|
|
-no-color Disable text coloring in the output.
|
|
|
|
-test-directory=path Set the OpenTofu test directory, defaults to "tests". When set, the
|
|
test command will search for test files in the current directory and
|
|
in the one specified by the flag.
|
|
|
|
-json Produce output in a machine-readable JSON format,
|
|
suitable for use in text editor integrations and other
|
|
automated systems. Always disables color.
|
|
|
|
-json-into=out.json Produce the same output as -json, but sent directly
|
|
to the given file. This allows automation to preserve
|
|
the original human-readable output streams, while
|
|
capturing more detailed logs for machine analysis.
|
|
|
|
-var 'foo=bar' Set a value for one of the input variables in the root
|
|
module of the configuration. Use this option more than
|
|
once to set more than one variable.
|
|
|
|
-var-file=filename Load variable values from the given file, in addition
|
|
to the default files terraform.tfvars and *.auto.tfvars.
|
|
Use this option more than once to include more than one
|
|
variables file.
|
|
|
|
`
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *GetCommand) Synopsis() string {
|
|
return "Install or upgrade remote OpenTofu modules"
|
|
}
|
|
|
|
func getModules(ctx context.Context, m *Meta, path string, testsDir string, upgrade bool, view views.Get) (abort bool, diags tfdiags.Diagnostics) {
|
|
hooks := view.Hooks(true)
|
|
return m.installModules(ctx, path, testsDir, upgrade, true, hooks, view)
|
|
}
|