fix: Avoid losing diagnostics raised when we parse config in (c *InitCommand) Run, instead pass config and diags into downstream code.

Author: SarahFrench

internal/command/init.go

@@ -62,20 +62,21 @@ func (c *InitCommand) Run(args []string) int {
 		view.Diagnostics(diags)
 		return 1
 	}
-	rootMod, _ := c.loadSingleModuleWithTests(path, initArgs.TestsDirectory)
-	// We purposefully ignore any diagnostics returned here. They will be encountered downstream,
-	// when the 'run' logic below is executed. If we return early due to error diagnostics here we
-	// will break the order that errors are expected to be raised in.
+	rootMod, rootModDiags := c.loadSingleModuleWithTests(path, initArgs.TestsDirectory)
+	// We purposefully don't exit early if there are error diagnostics returned here; there are errors related to the Terraform version
+	// that have precedence and are detected downstream.
+	// We pass the configuration and diagnostic values from here into downstream code, replacing where the files are parsed there.
+	// This prevents the diagnostics being lost, as re-parsing the same config results in lost diagnostics.
 
 	// The else condition below invokes the original logic of the init command.
 	// An experimental version of the init code will be used if:
 	// 	> The user uses an experimental version of TF (alpha or built from source).
 	//  > The terraform block in the configuration lists the `pluggable_state_stores` experiment.
 	if c.Meta.AllowExperimentalFeatures && rootMod.ActiveExperiments.Has(experiments.PluggableStateStores) {
 		// TODO(SarahFrench/radeksimko): Remove forked init logic once feature is no longer experimental
-		return c.runPssInit(initArgs, view)
+		return c.runPssInit(initArgs, view, rootMod, rootModDiags)
 	} else {
-		return c.run(initArgs, view)
+		return c.run(initArgs, view, rootMod, rootModDiags)
 	}
 }
 
@@ -1488,10 +1489,11 @@ Options:
   -test-directory=path    Set the Terraform test directory, defaults to "tests".
 
   -create-default-workspace [EXPERIMENTAL]
-                          This flag must be used alongside the -enable-pluggable-state-storage-
-                          experiment flag with experiments enabled. This flag's value defaults
-                          to true, which allows the default workspace to be created if it does
-                          not exist. Use -create-default-workspace=false to disable this behavior.
+                          This flag must be used alongside naming the pluggable_state_stores
+                          experiment in your configuration and using an experimental build of
+                          Terraform. This flag's value defaults to true, which allows the default
+                          workspace to be created if it does not exist.
+                          Use -create-default-workspace=false to disable this behavior.
 
 `
 	return strings.TrimSpace(helpText)

internal/command/init_run.go

@@ -23,7 +23,7 @@ import (
 	"go.opentelemetry.io/otel/trace"
 )
 
-func (c *InitCommand) run(initArgs *arguments.Init, view views.Init) int {
+func (c *InitCommand) run(initArgs *arguments.Init, view views.Init, rootModEarly *configs.Module, earlyConfDiags tfdiags.Diagnostics) int {
 	var diags tfdiags.Diagnostics
 
 	c.forceInitCopy = initArgs.ForceInitCopy
@@ -130,8 +130,14 @@ func (c *InitCommand) run(initArgs *arguments.Init, view views.Init) int {
 		return 0
 	}
 
-	// Load just the root module to begin backend and module initialization
-	rootModEarly, earlyConfDiags := c.loadSingleModuleWithTests(path, initArgs.TestsDirectory)
+	// If the passed root module is nil, attempt to parse it.
+	// At this point we load just the root module to begin backend and module initialization
+	//
+	// TODO(SarahFrench/radeksimko): Once PSS's experiment is over, remove use of arguments and
+	// restore parsing of config to always happen here in this code instead of calling code.
+	if rootModEarly == nil {
+		rootModEarly, earlyConfDiags = c.loadSingleModuleWithTests(path, initArgs.TestsDirectory)
+	}
 
 	// There may be parsing errors in config loading but these will be shown later _after_
 	// checking for core version requirement errors. Not meeting the version requirement should

internal/command/init_run_experiment.go

@@ -31,7 +31,7 @@ import (
 // `runPssInit` is an altered version of the logic in `run` that contains changes
 // related to the PSS project. This is used by the (InitCommand.Run method only if Terraform has
 // experimental features enabled.
-func (c *InitCommand) runPssInit(initArgs *arguments.Init, view views.Init) int {
+func (c *InitCommand) runPssInit(initArgs *arguments.Init, view views.Init, rootModEarly *configs.Module, earlyConfDiags tfdiags.Diagnostics) int {
 	var diags tfdiags.Diagnostics
 
 	c.forceInitCopy = initArgs.ForceInitCopy
@@ -138,8 +138,14 @@ func (c *InitCommand) runPssInit(initArgs *arguments.Init, view views.Init) int
 		return 0
 	}
 
-	// Load just the root module to begin backend and module initialization
-	rootModEarly, earlyConfDiags := c.loadSingleModuleWithTests(path, initArgs.TestsDirectory)
+	// If the passed root module is nil, attempt to parse it.
+	// At this point we load just the root module to begin backend and module initialization
+	//
+	// TODO(SarahFrench/radeksimko): Once PSS's experiment is over, remove use of arguments and
+	// restore parsing of config to always happen here in this code instead of calling code.
+	if rootModEarly == nil {
+		rootModEarly, earlyConfDiags = c.loadSingleModuleWithTests(path, initArgs.TestsDirectory)
+	}
 
 	// There may be parsing errors in config loading but these will be shown later _after_
 	// checking for core version requirement errors. Not meeting the version requirement should