2014-07-13 04:47:31 +02:00
|
|
|
package command
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"os"
|
|
|
|
"strings"
|
|
|
|
|
backend/local: Replace CLI with view instance
This commit extracts the remaining UI logic from the local backend,
and removes access to the direct CLI output. This is replaced with an
instance of a `views.Operation` interface, which codifies the current
requirements for the local backend to interact with the user.
The exception to this at present is interactivity: approving a plan
still depends on the `UIIn` field for the backend. This is out of scope
for this commit and can be revisited separately, at which time the
`UIOut` field can also be removed.
Changes in support of this:
- Some instances of direct error output have been replaced with
diagnostics, most notably in the emergency state backup handler. This
requires reformatting the error messages to allow the diagnostic
renderer to line-wrap them;
- The "in-automation" logic has moved out of the backend and into the
view implementation;
- The plan, apply, refresh, and import commands instantiate a view and
set it on the `backend.Operation` struct, as these are the only code
paths which call the `local.Operation()` method that requires it;
- The show command requires the plan rendering code which is now in the
views package, so there is a stub implementation of a `views.Show`
interface there.
Other refactoring work in support of migrating these commands to the
common views code structure will come in follow-up PRs, at which point
we will be able to remove the UI instances from the unit tests for those
commands.
2021-02-17 19:01:30 +01:00
|
|
|
"github.com/hashicorp/terraform/command/arguments"
|
2017-01-19 05:50:45 +01:00
|
|
|
"github.com/hashicorp/terraform/command/format"
|
2018-12-19 20:08:25 +01:00
|
|
|
"github.com/hashicorp/terraform/command/jsonplan"
|
2019-01-29 00:53:53 +01:00
|
|
|
"github.com/hashicorp/terraform/command/jsonstate"
|
backend/local: Replace CLI with view instance
This commit extracts the remaining UI logic from the local backend,
and removes access to the direct CLI output. This is replaced with an
instance of a `views.Operation` interface, which codifies the current
requirements for the local backend to interact with the user.
The exception to this at present is interactivity: approving a plan
still depends on the `UIIn` field for the backend. This is out of scope
for this commit and can be revisited separately, at which time the
`UIOut` field can also be removed.
Changes in support of this:
- Some instances of direct error output have been replaced with
diagnostics, most notably in the emergency state backup handler. This
requires reformatting the error messages to allow the diagnostic
renderer to line-wrap them;
- The "in-automation" logic has moved out of the backend and into the
view implementation;
- The plan, apply, refresh, and import commands instantiate a view and
set it on the `backend.Operation` struct, as these are the only code
paths which call the `local.Operation()` method that requires it;
- The show command requires the plan rendering code which is now in the
views package, so there is a stub implementation of a `views.Show`
interface there.
Other refactoring work in support of migrating these commands to the
common views code structure will come in follow-up PRs, at which point
we will be able to remove the UI instances from the unit tests for those
commands.
2021-02-17 19:01:30 +01:00
|
|
|
"github.com/hashicorp/terraform/command/views"
|
2021-05-17 17:42:17 +02:00
|
|
|
"github.com/hashicorp/terraform/internal/backend"
|
2021-05-17 19:11:06 +02:00
|
|
|
"github.com/hashicorp/terraform/internal/tfdiags"
|
terraform: Ugly huge change to weave in new State and Plan types
Due to how often the state and plan types are referenced throughout
Terraform, there isn't a great way to switch them out gradually. As a
consequence, this huge commit gets us from the old world to a _compilable_
new world, but still has a large number of known test failures due to
key functionality being stubbed out.
The stubs here are for anything that interacts with providers, since we
now need to do the follow-up work to similarly replace the old
terraform.ResourceProvider interface with its replacement in the new
"providers" package. That work, along with work to fix the remaining
failing tests, will follow in subsequent commits.
The aim here was to replace all references to terraform.State and its
downstream types with states.State, terraform.Plan with plans.Plan,
state.State with statemgr.State, and switch to the new implementations of
the state and plan file formats. However, due to the number of times those
types are used, this also ended up affecting numerous other parts of core
such as terraform.Hook, the backend.Backend interface, and most of the CLI
commands.
Just as with 5861dbf3fc49b19587a31816eb06f511ab861bb4 before, I apologize
in advance to the person who inevitably just found this huge commit while
spelunking through the commit history.
2018-08-14 23:24:45 +02:00
|
|
|
"github.com/hashicorp/terraform/plans"
|
2019-01-25 00:28:53 +01:00
|
|
|
"github.com/hashicorp/terraform/plans/planfile"
|
|
|
|
"github.com/hashicorp/terraform/states/statefile"
|
|
|
|
"github.com/hashicorp/terraform/states/statemgr"
|
2014-07-13 04:47:31 +02:00
|
|
|
)
|
|
|
|
|
|
|
|
// ShowCommand is a Command implementation that reads and outputs the
|
|
|
|
// contents of a Terraform plan or state file.
|
|
|
|
type ShowCommand struct {
|
2014-07-13 05:21:46 +02:00
|
|
|
Meta
|
2014-07-13 04:47:31 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
func (c *ShowCommand) Run(args []string) int {
|
2020-04-01 21:01:08 +02:00
|
|
|
args = c.Meta.process(args)
|
2018-11-21 15:35:27 +01:00
|
|
|
cmdFlags := c.Meta.defaultFlagSet("show")
|
2018-12-19 20:08:25 +01:00
|
|
|
var jsonOutput bool
|
2019-01-29 00:53:53 +01:00
|
|
|
cmdFlags.BoolVar(&jsonOutput, "json", false, "produce JSON output")
|
2014-07-13 04:47:31 +02:00
|
|
|
cmdFlags.Usage = func() { c.Ui.Error(c.Help()) }
|
|
|
|
if err := cmdFlags.Parse(args); err != nil {
|
2019-08-16 14:31:21 +02:00
|
|
|
c.Ui.Error(fmt.Sprintf("Error parsing command-line flags: %s\n", err.Error()))
|
2014-07-13 04:47:31 +02:00
|
|
|
return 1
|
|
|
|
}
|
|
|
|
|
|
|
|
args = cmdFlags.Args()
|
2018-12-19 20:08:25 +01:00
|
|
|
if len(args) > 2 {
|
2014-07-13 04:47:31 +02:00
|
|
|
c.Ui.Error(
|
2018-12-19 20:08:25 +01:00
|
|
|
"The show command expects at most two arguments.\n The path to a " +
|
|
|
|
"Terraform state or plan file, and optionally -json for json output.\n")
|
2014-07-13 04:47:31 +02:00
|
|
|
cmdFlags.Usage()
|
|
|
|
return 1
|
|
|
|
}
|
2014-10-11 21:56:55 +02:00
|
|
|
|
2019-03-05 17:32:11 +01:00
|
|
|
// Check for user-supplied plugin path
|
2020-04-01 21:01:08 +02:00
|
|
|
var err error
|
2019-03-05 17:32:11 +01:00
|
|
|
if c.pluginPath, err = c.loadPluginPath(); err != nil {
|
|
|
|
c.Ui.Error(fmt.Sprintf("Error loading plugin path: %s", err))
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
|
2018-09-25 00:00:07 +02:00
|
|
|
var diags tfdiags.Diagnostics
|
|
|
|
|
|
|
|
// Load the backend
|
|
|
|
b, backendDiags := c.Backend(nil)
|
|
|
|
diags = diags.Append(backendDiags)
|
|
|
|
if backendDiags.HasErrors() {
|
|
|
|
c.showDiagnostics(diags)
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
|
|
|
|
// We require a local backend
|
|
|
|
local, ok := b.(backend.Local)
|
|
|
|
if !ok {
|
|
|
|
c.showDiagnostics(diags) // in case of any warnings in here
|
|
|
|
c.Ui.Error(ErrUnsupportedLocalOp)
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
|
backend: Validate remote backend Terraform version
When using the enhanced remote backend, a subset of all Terraform
operations are supported. Of these, only plan and apply can be executed
on the remote infrastructure (e.g. Terraform Cloud). Other operations
run locally and use the remote backend for state storage.
This causes problems when the local version of Terraform does not match
the configured version from the remote workspace. If the two versions
are incompatible, an `import` or `state mv` operation can cause the
remote workspace to be unusable until a manual fix is applied.
To prevent this from happening accidentally, this commit introduces a
check that the local Terraform version and the configured remote
workspace Terraform version are compatible. This check is skipped for
commands which do not write state, and can also be disabled by the use
of a new command-line flag, `-ignore-remote-version`.
Terraform version compatibility is defined as:
- For all releases before 0.14.0, local must exactly equal remote, as
two different versions cannot share state;
- 0.14.0 to 1.0.x are compatible, as we will not change the state
version number until at least Terraform 1.1.0;
- Versions after 1.1.0 must have the same major and minor versions, as
we will not change the state version number in a patch release.
If the two versions are incompatible, a diagnostic is displayed,
advising that the error can be suppressed with `-ignore-remote-version`.
When this flag is used, the diagnostic is still displayed, but as a
warning instead of an error.
Commands which will not write state can assert this fact by calling the
helper `meta.ignoreRemoteBackendVersionConflict`, which will disable the
checks. Those which can write state should instead call the helper
`meta.remoteBackendVersionCheck`, which will return diagnostics for
display.
In addition to these explicit paths for managing the version check, we
have an implicit check in the remote backend's state manager
initialization method. Both of the above helpers will disable this
check. This fallback is in place to ensure that future code paths which
access state cannot accidentally skip the remote version check.
2020-11-13 22:43:56 +01:00
|
|
|
// This is a read-only command
|
|
|
|
c.ignoreRemoteBackendVersionConflict(b)
|
|
|
|
|
2018-10-09 23:57:03 +02:00
|
|
|
// the show command expects the config dir to always be the cwd
|
|
|
|
cwd, err := os.Getwd()
|
|
|
|
if err != nil {
|
|
|
|
c.Ui.Error(fmt.Sprintf("Error getting cwd: %s", err))
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
|
2018-12-19 20:08:25 +01:00
|
|
|
// Determine if a planfile was passed to the command
|
|
|
|
var planFile *planfile.Reader
|
|
|
|
if len(args) > 0 {
|
|
|
|
// We will handle error checking later on - this is just required to
|
|
|
|
// load the local context if the given path is successfully read as
|
|
|
|
// a planfile.
|
|
|
|
planFile, _ = c.PlanFile(args[0])
|
|
|
|
}
|
|
|
|
|
2018-09-25 00:00:07 +02:00
|
|
|
// Build the operation
|
|
|
|
opReq := c.Operation(b)
|
2018-10-09 23:57:03 +02:00
|
|
|
opReq.ConfigDir = cwd
|
2018-12-19 20:08:25 +01:00
|
|
|
opReq.PlanFile = planFile
|
2018-09-25 00:00:07 +02:00
|
|
|
opReq.ConfigLoader, err = c.initConfigLoader()
|
2019-10-09 23:29:40 +02:00
|
|
|
opReq.AllowUnsetVariables = true
|
2018-09-25 00:00:07 +02:00
|
|
|
if err != nil {
|
|
|
|
diags = diags.Append(err)
|
|
|
|
c.showDiagnostics(diags)
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
|
|
|
|
// Get the context
|
|
|
|
ctx, _, ctxDiags := local.Context(opReq)
|
|
|
|
diags = diags.Append(ctxDiags)
|
|
|
|
if ctxDiags.HasErrors() {
|
|
|
|
c.showDiagnostics(diags)
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
|
2018-11-21 15:35:27 +01:00
|
|
|
// Get the schemas from the context
|
2018-09-25 00:00:07 +02:00
|
|
|
schemas := ctx.Schemas()
|
|
|
|
|
2015-02-22 01:04:32 +01:00
|
|
|
var planErr, stateErr error
|
terraform: Ugly huge change to weave in new State and Plan types
Due to how often the state and plan types are referenced throughout
Terraform, there isn't a great way to switch them out gradually. As a
consequence, this huge commit gets us from the old world to a _compilable_
new world, but still has a large number of known test failures due to
key functionality being stubbed out.
The stubs here are for anything that interacts with providers, since we
now need to do the follow-up work to similarly replace the old
terraform.ResourceProvider interface with its replacement in the new
"providers" package. That work, along with work to fix the remaining
failing tests, will follow in subsequent commits.
The aim here was to replace all references to terraform.State and its
downstream types with states.State, terraform.Plan with plans.Plan,
state.State with statemgr.State, and switch to the new implementations of
the state and plan file formats. However, due to the number of times those
types are used, this also ended up affecting numerous other parts of core
such as terraform.Hook, the backend.Backend interface, and most of the CLI
commands.
Just as with 5861dbf3fc49b19587a31816eb06f511ab861bb4 before, I apologize
in advance to the person who inevitably just found this huge commit while
spelunking through the commit history.
2018-08-14 23:24:45 +02:00
|
|
|
var plan *plans.Plan
|
2019-01-25 00:28:53 +01:00
|
|
|
var stateFile *statefile.File
|
2018-12-19 20:08:25 +01:00
|
|
|
|
|
|
|
// if a path was provided, try to read it as a path to a planfile
|
|
|
|
// if that fails, try to read the cli argument as a path to a statefile
|
2014-10-11 21:56:55 +02:00
|
|
|
if len(args) > 0 {
|
2018-12-19 20:08:25 +01:00
|
|
|
path := args[0]
|
2019-06-05 13:29:02 +02:00
|
|
|
plan, stateFile, planErr = getPlanFromPath(path)
|
2018-12-19 20:08:25 +01:00
|
|
|
if planErr != nil {
|
2019-01-25 00:28:53 +01:00
|
|
|
stateFile, stateErr = getStateFromPath(path)
|
2018-12-19 20:08:25 +01:00
|
|
|
if stateErr != nil {
|
|
|
|
c.Ui.Error(fmt.Sprintf(
|
|
|
|
"Terraform couldn't read the given file as a state or plan file.\n"+
|
|
|
|
"The errors while attempting to read the file as each format are\n"+
|
|
|
|
"shown below.\n\n"+
|
|
|
|
"State read error: %s\n\nPlan read error: %s",
|
|
|
|
stateErr,
|
|
|
|
planErr))
|
|
|
|
return 1
|
2014-12-06 00:38:41 +01:00
|
|
|
}
|
2014-07-13 04:47:31 +02:00
|
|
|
}
|
2019-06-05 13:29:02 +02:00
|
|
|
} else {
|
2020-06-16 18:23:15 +02:00
|
|
|
env, err := c.Workspace()
|
|
|
|
if err != nil {
|
|
|
|
c.Ui.Error(fmt.Sprintf("Error selecting workspace: %s", err))
|
|
|
|
return 1
|
|
|
|
}
|
2019-01-25 00:28:53 +01:00
|
|
|
stateFile, stateErr = getStateFromEnv(b, env)
|
2019-09-13 16:51:32 +02:00
|
|
|
if stateErr != nil {
|
|
|
|
c.Ui.Error(stateErr.Error())
|
2017-01-19 05:50:45 +01:00
|
|
|
return 1
|
|
|
|
}
|
2014-07-13 04:47:31 +02:00
|
|
|
}
|
2014-12-06 00:38:41 +01:00
|
|
|
|
2014-07-13 04:47:31 +02:00
|
|
|
if plan != nil {
|
2020-10-07 17:00:06 +02:00
|
|
|
if jsonOutput {
|
2018-12-19 20:08:25 +01:00
|
|
|
config := ctx.Config()
|
2019-06-05 13:29:02 +02:00
|
|
|
jsonPlan, err := jsonplan.Marshal(config, plan, stateFile, schemas)
|
2019-03-01 22:59:57 +01:00
|
|
|
|
2018-12-19 20:08:25 +01:00
|
|
|
if err != nil {
|
|
|
|
c.Ui.Error(fmt.Sprintf("Failed to marshal plan to json: %s", err))
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
c.Ui.Output(string(jsonPlan))
|
|
|
|
return 0
|
|
|
|
}
|
2019-11-06 02:20:26 +01:00
|
|
|
|
backend/local: Replace CLI with view instance
This commit extracts the remaining UI logic from the local backend,
and removes access to the direct CLI output. This is replaced with an
instance of a `views.Operation` interface, which codifies the current
requirements for the local backend to interact with the user.
The exception to this at present is interactivity: approving a plan
still depends on the `UIIn` field for the backend. This is out of scope
for this commit and can be revisited separately, at which time the
`UIOut` field can also be removed.
Changes in support of this:
- Some instances of direct error output have been replaced with
diagnostics, most notably in the emergency state backup handler. This
requires reformatting the error messages to allow the diagnostic
renderer to line-wrap them;
- The "in-automation" logic has moved out of the backend and into the
view implementation;
- The plan, apply, refresh, and import commands instantiate a view and
set it on the `backend.Operation` struct, as these are the only code
paths which call the `local.Operation()` method that requires it;
- The show command requires the plan rendering code which is now in the
views package, so there is a stub implementation of a `views.Show`
interface there.
Other refactoring work in support of migrating these commands to the
common views code structure will come in follow-up PRs, at which point
we will be able to remove the UI instances from the unit tests for those
commands.
2021-02-17 19:01:30 +01:00
|
|
|
view := views.NewShow(arguments.ViewHuman, c.View)
|
2021-05-06 00:24:58 +02:00
|
|
|
view.Plan(plan, schemas)
|
2014-07-13 04:47:31 +02:00
|
|
|
return 0
|
|
|
|
}
|
|
|
|
|
2020-10-07 17:00:06 +02:00
|
|
|
if jsonOutput {
|
2019-03-14 22:52:07 +01:00
|
|
|
// At this point, it is possible that there is neither state nor a plan.
|
|
|
|
// That's ok, we'll just return an empty object.
|
2019-01-29 00:53:53 +01:00
|
|
|
jsonState, err := jsonstate.Marshal(stateFile, schemas)
|
|
|
|
if err != nil {
|
|
|
|
c.Ui.Error(fmt.Sprintf("Failed to marshal state to json: %s", err))
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
c.Ui.Output(string(jsonState))
|
|
|
|
} else {
|
2019-03-14 22:52:07 +01:00
|
|
|
if stateFile == nil {
|
|
|
|
c.Ui.Output("No state.")
|
|
|
|
return 0
|
|
|
|
}
|
2019-01-29 00:53:53 +01:00
|
|
|
c.Ui.Output(format.State(&format.StateOpts{
|
|
|
|
State: stateFile.State,
|
|
|
|
Color: c.Colorize(),
|
|
|
|
Schemas: schemas,
|
|
|
|
}))
|
|
|
|
}
|
|
|
|
|
2014-07-13 04:47:31 +02:00
|
|
|
return 0
|
|
|
|
}
|
|
|
|
|
|
|
|
func (c *ShowCommand) Help() string {
|
|
|
|
helpText := `
|
2021-02-22 15:25:56 +01:00
|
|
|
Usage: terraform [global options] show [options] [path]
|
2014-07-13 04:47:31 +02:00
|
|
|
|
|
|
|
Reads and outputs a Terraform state or plan file in a human-readable
|
2014-10-11 21:57:47 +02:00
|
|
|
form. If no path is specified, the current state will be shown.
|
2014-07-13 04:47:31 +02:00
|
|
|
|
2014-07-13 05:21:46 +02:00
|
|
|
Options:
|
|
|
|
|
2014-09-26 04:25:10 +02:00
|
|
|
-no-color If specified, output won't contain any color.
|
2019-02-21 20:52:08 +01:00
|
|
|
-json If specified, output the Terraform plan or state in
|
|
|
|
a machine-readable form.
|
2014-07-13 05:21:46 +02:00
|
|
|
|
2014-07-13 04:47:31 +02:00
|
|
|
`
|
|
|
|
return strings.TrimSpace(helpText)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (c *ShowCommand) Synopsis() string {
|
2020-10-24 01:55:32 +02:00
|
|
|
return "Show the current state or a saved plan"
|
2014-07-13 04:47:31 +02:00
|
|
|
}
|
2018-12-19 20:08:25 +01:00
|
|
|
|
2019-06-05 13:29:02 +02:00
|
|
|
// getPlanFromPath returns a plan and statefile if the user-supplied path points
|
|
|
|
// to a planfile. If both plan and error are nil, the path is likely a
|
|
|
|
// directory. An error could suggest that the given path points to a statefile.
|
|
|
|
func getPlanFromPath(path string) (*plans.Plan, *statefile.File, error) {
|
2018-12-19 20:08:25 +01:00
|
|
|
pr, err := planfile.Open(path)
|
|
|
|
if err != nil {
|
2019-06-05 13:29:02 +02:00
|
|
|
return nil, nil, err
|
2018-12-19 20:08:25 +01:00
|
|
|
}
|
|
|
|
plan, err := pr.ReadPlan()
|
|
|
|
if err != nil {
|
2019-06-05 13:29:02 +02:00
|
|
|
return nil, nil, err
|
2018-12-19 20:08:25 +01:00
|
|
|
}
|
2019-06-05 13:29:02 +02:00
|
|
|
|
|
|
|
stateFile, err := pr.ReadStateFile()
|
2019-09-13 16:51:32 +02:00
|
|
|
return plan, stateFile, err
|
2018-12-19 20:08:25 +01:00
|
|
|
}
|
|
|
|
|
2019-01-25 00:28:53 +01:00
|
|
|
// getStateFromPath returns a statefile if the user-supplied path points to a statefile.
|
|
|
|
func getStateFromPath(path string) (*statefile.File, error) {
|
2018-12-19 20:08:25 +01:00
|
|
|
f, err := os.Open(path)
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("Error loading statefile: %s", err)
|
|
|
|
}
|
|
|
|
defer f.Close()
|
|
|
|
|
|
|
|
var stateFile *statefile.File
|
|
|
|
stateFile, err = statefile.Read(f)
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("Error reading %s as a statefile: %s", path, err)
|
|
|
|
}
|
2019-01-25 00:28:53 +01:00
|
|
|
return stateFile, nil
|
2018-12-19 20:08:25 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// getStateFromEnv returns the State for the current workspace, if available.
|
2019-01-25 00:28:53 +01:00
|
|
|
func getStateFromEnv(b backend.Backend, env string) (*statefile.File, error) {
|
2018-12-19 20:08:25 +01:00
|
|
|
// Get the state
|
|
|
|
stateStore, err := b.StateMgr(env)
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("Failed to load state manager: %s", err)
|
|
|
|
}
|
|
|
|
|
2019-03-25 21:28:35 +01:00
|
|
|
if err := stateStore.RefreshState(); err != nil {
|
|
|
|
return nil, fmt.Errorf("Failed to load state: %s", err)
|
|
|
|
}
|
|
|
|
|
2019-01-25 00:28:53 +01:00
|
|
|
sf := statemgr.Export(stateStore)
|
|
|
|
|
|
|
|
return sf, nil
|
2018-12-19 20:08:25 +01:00
|
|
|
}
|