Add -create-default-workspace flag to init command, for overriding behaviour when TF isn't in interactive mode

This required refactoring the signature of the initBackend method; pass in all init args instead of a subset

Author: SarahFrench

internal/command/arguments/init.go

@@ -78,6 +78,10 @@ type Init struct {
 	// TODO(SarahFrench/radeksimko): Remove this once the feature is no longer
 	// experimental
 	EnablePssExperiment bool
+
+	// CreateDefaultWorkspace indicates whether the default workspace should be created by
+	// Terraform when initializing a state store for the first time.
+	CreateDefaultWorkspace bool
 }
 
 // ParseInit processes CLI arguments, returning an Init value and errors.
@@ -111,7 +115,7 @@ func ParseInit(args []string) (*Init, tfdiags.Diagnostics) {
 	cmdFlags.BoolVar(&init.Json, "json", false, "json")
 	cmdFlags.Var(&init.BackendConfig, "backend-config", "")
 	cmdFlags.Var(&init.PluginPath, "plugin-dir", "plugin directory")
-
+	cmdFlags.BoolVar(&init.CreateDefaultWorkspace, "create-default-workspace", true, "when -input=false, use this flag to block creation of the default workspace")
 	// Used for enabling experimental code that's invoked before configuration is parsed.
 	cmdFlags.BoolVar(&init.EnablePssExperiment, "enable-pluggable-state-storage-experiment", false, "Enable the pluggable state storage experiment")
 
@@ -139,6 +143,14 @@ func ParseInit(args []string) (*Init, tfdiags.Diagnostics) {
 		))
 	}
 
+	if init.InputEnabled && !init.CreateDefaultWorkspace {
+		diags = diags.Append(tfdiags.Sourceless(
+			tfdiags.Warning,
+			"Invalid init options",
+			"The flag -create-default-workspace=false is ignored when Terraform is configured to ask users for input. Instead, add -input=false or remove the -create-default-workspace flag",
+		))
+	}
+
 	init.Args = cmdFlags.Args()
 
 	backendFlagSet := FlagIsSet(cmdFlags, "backend")

internal/command/init.go

@@ -51,7 +51,7 @@ func (c *InitCommand) Run(args []string) int {
 	args = c.Meta.process(args)
 	initArgs, initDiags := arguments.ParseInit(args)
 
-	view := views.NewInit(initArgs.ViewType, c.View)
+	view := views.NewInit(viewType, c.View)
 
 	if initDiags.HasErrors() {
 		diags = diags.Append(initDiags)
@@ -159,7 +159,11 @@ func (c *InitCommand) initCloud(ctx context.Context, root *configs.Module, extra
 	return back, true, diags
 }
 
-func (c *InitCommand) initBackend(ctx context.Context, root *configs.Module, extraConfig arguments.FlagNameValueSlice, viewType arguments.ViewType, locks *depsfile.Locks, view views.Init) (be backend.Backend, output bool, diags tfdiags.Diagnostics) {
+func (c *InitCommand) initBackend(ctx context.Context, root *configs.Module, initArgs *arguments.Init, locks *depsfile.Locks, view views.Init) (be backend.Backend, output bool, diags tfdiags.Diagnostics) {
+	// Temporary vars to account for refactoring the method's parameters
+	extraConfig := initArgs.BackendConfig
+	viewType := initArgs.ViewType
+
 	ctx, span := tracer.Start(ctx, "initialize backend")
 	_ = ctx // prevent staticcheck from complaining to avoid a maintenance hazard of having the wrong ctx in scope here
 	defer span.End()
@@ -271,12 +275,13 @@ func (c *InitCommand) initBackend(ctx context.Context, root *configs.Module, ext
 		}
 
 		opts = &BackendOpts{
-			StateStoreConfig: root.StateStore,
-			Locks:            locks,
-			ProviderFactory:  factory,
-			ConfigOverride:   configOverride,
-			Init:             true,
-			ViewType:         viewType,
+			StateStoreConfig:       root.StateStore,
+			Locks:                  locks,
+			ProviderFactory:        factory,
+			CreateDefaultWorkspace: initArgs.CreateDefaultWorkspace,
+			ConfigOverride:         configOverride,
+			Init:                   true,
+			ViewType:               viewType,
 		}
 
 	case root.Backend != nil:

internal/command/init_run.go

@@ -172,7 +172,7 @@ func (c *InitCommand) run(initArgs *arguments.Init, view views.Init) int {
 		back, backendOutput, backDiags = c.initCloud(ctx, rootModEarly, initArgs.BackendConfig, initArgs.ViewType, view)
 	case initArgs.Backend:
 		var locks *depsfile.Locks // Empty locks- this value is unused when a `backend` is used (vs. a `state_store`)
-		back, backendOutput, backDiags = c.initBackend(ctx, rootModEarly, initArgs.BackendConfig, initArgs.ViewType, locks, view)
+		back, backendOutput, backDiags = c.initBackend(ctx, rootModEarly, initArgs, locks, view)
 	default:
 		// load the previously-stored backend config
 		back, backDiags = c.Meta.backendFromState(ctx)

internal/command/init_run_experiment.go

@@ -208,7 +208,7 @@ func (c *InitCommand) runPssInit(initArgs *arguments.Init, view views.Init) int
 		// This handles case when config contains either backend or state_store blocks.
 		// This is valid as either can be implementations of backend.Backend, which is what we
 		// obtain here.
-		back, backendOutput, backDiags = c.initBackend(ctx, rootModEarly, initArgs.BackendConfig, initArgs.ViewType, configLocks, view)
+		back, backendOutput, backDiags = c.initBackend(ctx, rootModEarly, initArgs, configLocks, view)
 	default:
 		// load the previously-stored backend config
 		back, backDiags = c.Meta.backendFromState(ctx)

internal/command/meta_backend.go

@@ -89,6 +89,10 @@ type BackendOpts struct {
 	// ViewType will set console output format for the
 	// initialization operation (JSON or human-readable).
 	ViewType arguments.ViewType
+
+	// CreateDefaultWorkspace signifies whether the operations backend should create
+	// the default workspace or not
+	CreateDefaultWorkspace bool
 }
 
 // BackendWithRemoteTerraformVersion is a shared interface between the 'remote' and 'cloud' backends
@@ -1666,32 +1670,43 @@ func (m *Meta) stateStore_C_s(c *configs.StateStore, cHash int, backendSMgr *cli
 				return nil, diags
 
 			case ws == backend.DefaultStateName:
-				// TODO: do we want to prompt for input here (m.Input()), or create automatically unless -readonly flag present?
-				// input := m.UIInput()
-				// desc := fmt.Sprintf("Terraform will create the %q workspace via %q.\n"+
-				// 	"Only 'yes' will be accepted to approve.", backend.DefaultStateName, c.Type)
-				// v, err := input.Input(context.Background(), &terraform.InputOpts{
-				// 	Id:          "approve",
-				// 	Query:       fmt.Sprintf("Workspace %q does not exit, would you like to create one?", backend.DefaultStateName),
-				// 	Description: desc,
-				// })
-				// if err != nil {
-				// 	diags = diags.Append(fmt.Errorf("Failed to confirm default workspace creation: %w", err))
-				// 	return nil, diags
-				// }
-				// if v != "yes" {
-				// 	diags = diags.Append(errors.New("Failed to create default workspace"))
-				// 	return nil, diags
-				// }
-
-				// TODO: Confirm if defaulting to creation on first use (rather than error) is a good idea
-				// Make the default workspace. All other workspaces are user-created via the workspace commands.
-				m.createDefaultWorkspace(c, b)
+				// Should we create the default state after prompting the user, or not?
+				if m.Input() {
+					// If input is enabled, we prompt the user before creating the default workspace.
+					input := m.UIInput()
+					desc := fmt.Sprintf("Terraform will create the %q workspace via state store %q.\n"+
+						"Only 'yes' will be accepted to approve.", backend.DefaultStateName, c.Type)
+					v, err := input.Input(context.Background(), &terraform.InputOpts{
+						Id:          "approve",
+						Query:       fmt.Sprintf("Workspace the %s workspace does not exit, would you like to create it?", backend.DefaultStateName),
+						Description: desc,
+					})
+					if err != nil {
+						diags = diags.Append(fmt.Errorf("Failed to confirm %s workspace creation: %w", backend.DefaultStateName, err))
+						return nil, diags
+					}
+					if v != "yes" {
+						diags = diags.Append(fmt.Errorf("Cancelled creation of the %s workspace", backend.DefaultStateName))
+						return nil, diags
+					}
+					m.createDefaultWorkspace(c, b)
+				} else {
+					// If input is disabled, we don't prompt before creating the default workspace.
+					// However this can be blocked with other flags present.
+					if opts.CreateDefaultWorkspace {
+						m.createDefaultWorkspace(c, b)
+					} else {
+						diags = diags.Append(&hcl.Diagnostic{
+							Severity: hcl.DiagWarning,
+							Summary:  "The default workspace does not exist",
+							Detail:   "Terraform has been configured to skip creation of the default workspace in the state store. This may cause issues in subsequent Terraform operations",
+						})
+					}
+				}
 			default:
 				diags = diags.Append(err)
 				return nil, diags
 			}
-			// TODO: handle if input is not enabled
 		}
 	}
 	if diags.HasErrors() {