workspace

type Terraform interface {
	// SetEnv allows you to override environment variables, this should not be used for any well known
	// Terraform environment variables that are already covered in options. Pass nil to copy the values
	// from os.Environ. Attempting to set environment variables that should be managed manually will
	// result in ErrManualEnvVar being returned.
	SetEnv(env map[string]string) error
	// SetLogger specifies a logger for tfexec to use.
	// SetStdout specifies a writer to stream stdout to for every command.
	//
	// This should be used for information or logging purposes only, not control
	// flow. Any parsing necessary should be added as functionality to this package.
	SetStdout(w io.Writer)
	// SetStderr specifies a writer to stream stderr to for every command.
	//
	// This should be used for information or logging purposes only, not control
	// flow. Any parsing necessary should be added as functionality to this package.
	SetStderr(w io.Writer)
	// SetLog sets the TF_LOG environment variable for Terraform CLI execution.
	// This must be combined with a call to SetLogPath to take effect.
	//
	// This is only compatible with Terraform CLI 0.15.0 or later as setting the
	// log level was unreliable in earlier versions. It will default to TRACE when
	// SetLogPath is called on versions 0.14.11 and earlier, or if SetLogCore and
	// SetLogProvider have not been called before SetLogPath on versions 0.15.0 and
	// later.
	SetLog(log string) error
	// SetLogCore sets the TF_LOG_CORE environment variable for Terraform CLI
	// execution. This must be combined with a call to SetLogPath to take effect.
	//
	// This is only compatible with Terraform CLI 0.15.0 or later.
	SetLogCore(logCore string) error
	// SetLogPath sets the TF_LOG_PATH environment variable for Terraform CLI
	// execution.
	SetLogPath(path string) error
	// SetLogProvider sets the TF_LOG_PROVIDER environment variable for Terraform
	// CLI execution. This must be combined with a call to SetLogPath to take
	// effect.
	//
	// This is only compatible with Terraform CLI 0.15.0 or later.
	SetLogProvider(logProvider string) error
	// SetAppendUserAgent sets the TF_APPEND_USER_AGENT environment variable for
	// Terraform CLI execution.
	SetAppendUserAgent(ua string) error
	// SetDisablePluginTLS sets the TF_DISABLE_PLUGIN_TLS environment variable for
	// Terraform CLI execution.
	SetDisablePluginTLS(disabled bool) error
	// SetSkipProviderVerify sets the TF_SKIP_PROVIDER_VERIFY environment variable
	// for Terraform CLI execution. This is no longer used in 0.13.0 and greater.
	SetSkipProviderVerify(skip bool) error
	// WorkingDir returns the working directory for Terraform.
	WorkingDir() string
	// ExecPath returns the path to the Terraform executable.
	ExecPath() string
	Init(ctx context.Context, opts ...tfexec.InitOption) error
	// Apply represents the terraform apply subcommand.
	Apply(ctx context.Context, opts ...tfexec.ApplyOption) error
	// ApplyJSON represents the terraform apply subcommand with the `-json` flag.
	// Using the `-json` flag will result in
	// [machine-readable](https://developer.hashicorp.com/terraform/internals/machine-readable-ui)
	// JSON being written to the supplied `io.Writer`. ApplyJSON is likely to be
	// removed in a future major version in favour of Apply returning JSON by default.
	ApplyJSON(ctx context.Context, w io.Writer, opts ...tfexec.ApplyOption) error
	// Destroy represents the terraform destroy subcommand.
	Destroy(ctx context.Context, opts ...tfexec.DestroyOption) error
	// DestroyJSON represents the terraform destroy subcommand with the `-json` flag.
	// Using the `-json` flag will result in
	// [machine-readable](https://developer.hashicorp.com/terraform/internals/machine-readable-ui)
	// JSON being written to the supplied `io.Writer`. DestroyJSON is likely to be
	// removed in a future major version in favour of Destroy returning JSON by default.
	DestroyJSON(ctx context.Context, w io.Writer, opts ...tfexec.DestroyOption) error
	// FormatString formats a passed string.
	FormatString(ctx context.Context, content string) (string, error)
	// Format performs formatting on the unformatted io.Reader (as stdin to the CLI) and returns
	// the formatted result on the formatted io.Writer.
	Format(ctx context.Context, unformatted io.Reader, formatted io.Writer) error
	// FormatWrite attempts to format and modify all config files in the working or selected (via DirOption) directory.
	FormatWrite(ctx context.Context, opts ...tfexec.FormatOption) error
	// FormatCheck returns true if the config files in the working or selected (via DirOption) directory are already formatted.
	FormatCheck(ctx context.Context, opts ...tfexec.FormatOption) (bool, []string, error)
	ForceUnlock(ctx context.Context, lockID string, opts ...tfexec.ForceUnlockOption) error
	Graph(ctx context.Context, opts ...tfexec.GraphOption) (string, error)
	// Output represents the terraform output subcommand.
	Output(ctx context.Context, opts ...tfexec.OutputOption) (map[string]tfexec.OutputMeta, error)
	Validate(ctx context.Context) (*tfjson.ValidateOutput, error)
	// Plan executes `terraform plan` with the specified options and waits for it
	// to complete.
	//
	// The returned boolean is false when the plan diff is empty (no changes) and
	// true when the plan diff is non-empty (changes present).
	//
	// The returned error is nil if `terraform plan` has been executed and exits
	// with either 0 or 2.
	Plan(ctx context.Context, opts ...tfexec.PlanOption) (bool, error)
	// PlanJSON executes `terraform plan` with the specified options as well as the
	// `-json` flag and waits for it to complete.
	//
	// Using the `-json` flag will result in
	// [machine-readable](https://developer.hashicorp.com/terraform/internals/machine-readable-ui)
	// JSON being written to the supplied `io.Writer`.
	//
	// The returned boolean is false when the plan diff is empty (no changes) and
	// true when the plan diff is non-empty (changes present).
	//
	// The returned error is nil if `terraform plan` has been executed and exits
	// with either 0 or 2.
	//
	// PlanJSON is likely to be removed in a future major version in favour of
	// Plan returning JSON by default.
	PlanJSON(ctx context.Context, w io.Writer, opts ...tfexec.PlanOption) (bool, error)
	// ProvidersLock represents the `terraform providers lock` command
	ProvidersLock(ctx context.Context, opts ...tfexec.ProvidersLockOption) error
	Get(ctx context.Context, opts ...tfexec.GetCmdOption) error
	// ProvidersSchema represents the terraform providers schema -json subcommand.
	ProvidersSchema(ctx context.Context) (*tfjson.ProviderSchemas, error)
	// Refresh represents the terraform refresh subcommand.
	Refresh(ctx context.Context, opts ...tfexec.RefreshCmdOption) error
	// RefreshJSON represents the terraform refresh subcommand with the `-json` flag.
	// Using the `-json` flag will result in
	// [machine-readable](https://developer.hashicorp.com/terraform/internals/machine-readable-ui)
	// JSON being written to the supplied `io.Writer`. RefreshJSON is likely to be
	// removed in a future major version in favour of Refresh returning JSON by default.
	RefreshJSON(ctx context.Context, w io.Writer, opts ...tfexec.RefreshCmdOption) error
	// Show reads the default state path and outputs the state.
	// To read a state or plan file, ShowState or ShowPlan must be used instead.
	Show(ctx context.Context, opts ...tfexec.ShowOption) (*tfjson.State, error)
	// ShowStateFile reads a given state file and outputs the state.
	ShowStateFile(ctx context.Context, statePath string, opts ...tfexec.ShowOption) (*tfjson.State, error)
	// ShowPlanFile reads a given plan file and outputs the plan.
	ShowPlanFile(ctx context.Context, planPath string, opts ...tfexec.ShowOption) (*tfjson.Plan, error)
	// ShowPlanFileRaw reads a given plan file and outputs the plan in a
	// human-friendly, opaque format.
	ShowPlanFileRaw(ctx context.Context, planPath string, opts ...tfexec.ShowOption) (string, error)
	// StateMv represents the terraform state mv subcommand.
	StateMv(ctx context.Context, source, destination string, opts ...tfexec.StateMvCmdOption) error
}

type Workspace interface {
	// LoadArchive loads the archives into the workspace
	LoadArchive(ctx context.Context) error
	// LoadBackend loads the backend from the provided plugin
	LoadBackend(ctx context.Context) error
	// LoadBinary installs the binary using the provided binary
	LoadBinary(ctx context.Context, log hclog.Logger) error
	// LoadHooks initializes any hooks that need to be executed
	LoadHooks(ctx context.Context) error
	// InitRoot: initializes workspace should be called before any other load functions
	InitRoot(ctx context.Context) error
	//LoadVariables is used to load the variables into the environment
	LoadVariables(ctx context.Context) error
	// Root returns the root directory
	Root() string

	Cleanup(ctx context.Context) error

	// the following commands are used to run terraform operations against a workspace
	Apply(context.Context, hclog.Logger) ([]byte, error)
	ApplyPlan(context.Context, hclog.Logger) ([]byte, error)
	Destroy(context.Context, hclog.Logger) ([]byte, error)
	ApplyDestroyPlan(context.Context, hclog.Logger) ([]byte, error)
	Init(context.Context, hclog.Logger) error
	Refresh(context.Context, hclog.Logger) ([]byte, error)
	Plan(context.Context, hclog.Logger) ([]byte, error)
	Output(context.Context, hclog.Logger) (map[string]tfexec.OutputMeta, error)
	Show(context.Context, hclog.Logger) (*tfjson.State, error)
	ShowPlan(context.Context, hclog.Logger) (*tfjson.Plan, error)
	// StateMv renames a resource address in state without touching infra.
	StateMv(ctx context.Context, log hclog.Logger, source, destination string) error
	Validate(context.Context, hclog.Logger) (*tfjson.ValidateOutput, error)
	// Writes plan to plan.json
	WriteTFPlan(context.Context, hclog.Logger) ([]byte, error)
	CompressTFPlan(context.Context, hclog.Logger) ([]byte, error)
	PlanDestroy(context.Context, hclog.Logger) ([]byte, error)
	GetTfplan(ctx context.Context, log hclog.Logger) ([]byte, error)
	GetTfplanCompressed(ctx context.Context, log hclog.Logger) ([]byte, error)
	GetTfplanJsonCompressed(ctx context.Context, log hclog.Logger) ([]byte, error)
}