feat(config): enable permissive config file parsing (#472)

Author: reubeno

internal/app/azldev/app.go

@@ -40,16 +40,17 @@ type PostInitCallbackFunc func(app *App, env *Env) error
 // An instance of the azldev CLI application. This is typically used as a singleton.
 type App struct {
 	// Global options for the CLI.
-	explicitProjectDir   string
-	verbose              bool
-	quiet                bool
-	acceptAllPrompts     bool
-	dryRun               bool
-	networkRetries       int
-	reportFormat         ReportFormat
-	disableDefaultConfig bool
-	configFiles          []string
-	colorMode            ColorMode
+	explicitProjectDir      string
+	verbose                 bool
+	quiet                   bool
+	acceptAllPrompts        bool
+	dryRun                  bool
+	networkRetries          int
+	reportFormat            ReportFormat
+	disableDefaultConfig    bool
+	permissiveConfigParsing bool
+	configFiles             []string
+	colorMode               ColorMode
 
 	// Root command for the CLI.
 	cmd cobra.Command
@@ -127,6 +128,7 @@ func NewApp(fsFactory opctx.FileSystemFactory, osEnvFactory opctx.OSEnvFactory)
 			env.SetAcceptAllPrompts(app.acceptAllPrompts)
 			env.SetColorMode(app.colorMode)
 			env.SetNetworkRetries(app.networkRetries)
+			env.SetPermissiveConfigParsing(app.permissiveConfigParsing)
 
 			return nil
 		},
@@ -165,6 +167,8 @@ func NewApp(fsFactory opctx.FileSystemFactory, osEnvFactory opctx.OSEnvFactory)
 		"output format {csv, json, markdown, table}")
 	app.cmd.PersistentFlags().Var(&app.colorMode, "color",
 		"output colorization mode {always, auto, never}")
+	app.cmd.PersistentFlags().BoolVar(&app.permissiveConfigParsing, "permissive-config",
+		false, "do not fail on unknown fields in TOML config files")
 
 	return app
 }
@@ -443,6 +447,8 @@ func (a *App) handParseConfigFlags(args []string) {
 			}
 		case "--no-default-config":
 			a.disableDefaultConfig = true
+		case "--permissive-config":
+			a.permissiveConfigParsing = true
 		case "--config-file":
 			index++
 			if index < len(args) {
@@ -498,6 +504,7 @@ func (a *App) findAndLoadConfig(dryRunnable opctx.DryRunnable, tempDirPath strin
 		a.disableDefaultConfig,
 		tempDirPath,
 		extraConfigFiles,
+		a.permissiveConfigParsing,
 	)
 	if err != nil {
 		return projectDir, config, fmt.Errorf("failed to load project configuration:\n%w", err)

internal/app/azldev/app_test.go

@@ -143,3 +143,53 @@ func TestApp_QuietLongOption(t *testing.T) {
 	app.Execute([]string{"--quiet"})
 	assert.True(t, callbackCalled)
 }
+
+func TestApp_PermissiveConfigOption(t *testing.T) {
+	app := createTestApp(t)
+
+	ran := false
+	cmd := &cobra.Command{
+		Use: "test-cmd",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			env, err := azldev.GetEnvFromCommand(cmd)
+			require.NoError(t, err)
+
+			assert.True(t, env.PermissiveConfigParsing())
+
+			ran = true
+
+			return nil
+		},
+	}
+
+	app.AddTopLevelCommand(cmd)
+
+	result := app.Execute([]string{"--permissive-config", "test-cmd"})
+	assert.Zero(t, result)
+	assert.True(t, ran)
+}
+
+func TestApp_PermissiveConfigOption_DefaultFalse(t *testing.T) {
+	app := createTestApp(t)
+
+	ran := false
+	cmd := &cobra.Command{
+		Use: "test-cmd",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			env, err := azldev.GetEnvFromCommand(cmd)
+			require.NoError(t, err)
+
+			assert.False(t, env.PermissiveConfigParsing())
+
+			ran = true
+
+			return nil
+		},
+	}
+
+	app.AddTopLevelCommand(cmd)
+
+	result := app.Execute([]string{"test-cmd"})
+	assert.Zero(t, result)
+	assert.True(t, ran)
+}

internal/app/azldev/env.go

@@ -58,14 +58,15 @@ type Env struct {
 	classicToolkitDir string
 
 	// Tool behavior/preferences.
-	defaultReportFormat ReportFormat
-	colorMode           ColorMode
-	reportFile          io.Writer
-	verbose             bool
-	quiet               bool
-	promptsAllowed      bool
-	acceptAllPrompts    bool
-	networkRetries      int
+	defaultReportFormat     ReportFormat
+	colorMode               ColorMode
+	reportFile              io.Writer
+	verbose                 bool
+	quiet                   bool
+	promptsAllowed          bool
+	acceptAllPrompts        bool
+	networkRetries          int
+	permissiveConfigParsing bool
 
 	// Injected dependencies.
 	cmdFactory    opctx.CmdFactory
@@ -124,12 +125,13 @@ func NewEnv(ctx context.Context, options EnvOptions) *Env {
 		osEnvFactory:  options.Interfaces.OSEnvFactory,
 
 		// Tool behavior/preferences
-		defaultReportFormat: ReportFormatTable,
-		colorMode:           ColorModeAuto,
-		reportFile:          os.Stdout,
-		verbose:             false,
-		quiet:               false,
-		promptsAllowed:      isatty.IsTerminal(os.Stdin.Fd()),
+		defaultReportFormat:     ReportFormatTable,
+		colorMode:               ColorModeAuto,
+		reportFile:              os.Stdout,
+		verbose:                 false,
+		quiet:                   false,
+		promptsAllowed:          isatty.IsTerminal(os.Stdin.Fd()),
+		permissiveConfigParsing: false,
 
 		// Start time.
 		constructionTime: time.Now(),
@@ -187,6 +189,18 @@ func (env *Env) SetNetworkRetries(retries int) {
 	env.networkRetries = retries
 }
 
+// PermissiveConfigParsing returns whether permissive parsing of configuration files
+// is enabled, where unknown fields are ignored instead of causing an error.
+func (env *Env) PermissiveConfigParsing() bool {
+	return env.permissiveConfigParsing
+}
+
+// SetPermissiveConfigParsing enables or disables permissive parsing of
+// configuration files, where unknown fields are ignored instead of causing an error.
+func (env *Env) SetPermissiveConfigParsing(permissive bool) {
+	env.permissiveConfigParsing = permissive
+}
+
 // SetEventListener registers the event listener to be used in this environment.
 func (env *Env) SetEventListener(eventListener opctx.EventListener) {
 	env.eventListener = eventListener

internal/app/azldev/env_test.go

@@ -54,6 +54,7 @@ func TestNewEnv(t *testing.T) {
 	assert.Equal(t, env.ReportFile(), os.Stdout)
 	assert.False(t, env.Quiet())
 	assert.False(t, env.Verbose())
+	assert.False(t, env.PermissiveConfigParsing())
 
 	// Confirm that our parameters were appropriately wrapped.
 	assert.Equal(t, testProjectRoot, env.ProjectDir())
@@ -94,6 +95,21 @@ func TestSetNetworkRetries(t *testing.T) {
 	}
 }
 
+func TestSetPermissiveConfigParsing(t *testing.T) {
+	testEnv := testutils.NewTestEnv(t)
+
+	// Default should be false.
+	assert.False(t, testEnv.Env.PermissiveConfigParsing())
+
+	// Setting to true should stick.
+	testEnv.Env.SetPermissiveConfigParsing(true)
+	assert.True(t, testEnv.Env.PermissiveConfigParsing())
+
+	// Setting back to false should work.
+	testEnv.Env.SetPermissiveConfigParsing(false)
+	assert.False(t, testEnv.Env.PermissiveConfigParsing())
+}
+
 func TestEnvConstructionTime(t *testing.T) {
 	testEnv := testutils.NewTestEnv(t)
 

internal/projectconfig/config.go

@@ -23,6 +23,7 @@ func LoadProjectConfig(
 	disableDefaultConfig bool,
 	tempDirPath string,
 	extraConfigFilePaths []string,
+	permissiveConfigParsing bool,
 ) (projectDir string, config *ProjectConfig, err error) {
 	// Look for project root and azldev.toml file.
 	projectDir, projectFilePath, err := FindProjectRootAndConfigFile(fs, referenceDir)
@@ -59,7 +60,7 @@ func LoadProjectConfig(
 	//
 	// NOTE: We don't wrap the error returned back here (if one is returned) because we already have
 	// a decent one coming from this function.
-	config, err = loadAndResolveProjectConfig(fs, configFilePaths...)
+	config, err = loadAndResolveProjectConfig(fs, permissiveConfigParsing, configFilePaths...)
 	if err != nil {
 		return "", nil, err
 	}

internal/projectconfig/loader.go

@@ -30,7 +30,9 @@ var (
 // Loads and resolves the project configuration files located at the given path. Referenced include files
 // are recursively loaded and appropriately merged. If multiple file paths are provided, they are each
 // fully loaded and merged in specified order, with later files overriding earlier ones.
-func loadAndResolveProjectConfig(fs opctx.FS, configFilePaths ...string) (*ProjectConfig, error) {
+func loadAndResolveProjectConfig(
+	fs opctx.FS, permissiveConfigParsing bool, configFilePaths ...string,
+) (*ProjectConfig, error) {
 	resolvedCfg := &ProjectConfig{
 		ComponentGroups: make(map[string]ComponentGroupConfig),
 		Components:      make(map[string]ComponentConfig),
@@ -40,7 +42,7 @@ func loadAndResolveProjectConfig(fs opctx.FS, configFilePaths ...string) (*Proje
 
 	for _, configFilePath := range configFilePaths {
 		// Load the project config file and all transitive includes.
-		err := loadAndMergeConfigWithIncludes(resolvedCfg, fs, configFilePath)
+		err := loadAndMergeConfigWithIncludes(resolvedCfg, fs, configFilePath, permissiveConfigParsing)
 		if err != nil {
 			return nil, err
 		}
@@ -55,9 +57,12 @@ func loadAndResolveProjectConfig(fs opctx.FS, configFilePaths ...string) (*Proje
 	return resolvedCfg, nil
 }
 
-func loadAndMergeConfigWithIncludes(configToUpdate *ProjectConfig, fs opctx.FS, filePath string) error {
+func loadAndMergeConfigWithIncludes(
+	configToUpdate *ProjectConfig, fs opctx.FS, filePath string,
+	permissiveConfigParsing bool,
+) error {
 	// Load the project config file and all transitive includes.
-	loadedCfgs, err := loadProjectConfigWithIncludes(fs, filePath)
+	loadedCfgs, err := loadProjectConfigWithIncludes(fs, filePath, permissiveConfigParsing)
 	if err != nil {
 		return err
 	}
@@ -154,9 +159,11 @@ func mergeConfigFile(resolvedCfg *ProjectConfig, loadedCfg *ConfigFile) error {
 	return nil
 }
 
-func loadProjectConfigWithIncludes(fs opctx.FS, filePath string) ([]*ConfigFile, error) {
+func loadProjectConfigWithIncludes(
+	fs opctx.FS, filePath string, permissiveConfigParsing bool,
+) ([]*ConfigFile, error) {
 	// Load the immediate config file.
-	cfg, err := loadProjectConfigFile(fs, filePath)
+	cfg, err := loadProjectConfigFile(fs, filePath, permissiveConfigParsing)
 	if err != nil {
 		return nil, err
 	}
@@ -188,7 +195,9 @@ func loadProjectConfigWithIncludes(fs opctx.FS, filePath string) ([]*ConfigFile,
 		for _, includePath := range matches {
 			absIncludePath := makeAbsolute(cfg.dir, includePath)
 
-			includeCfgs, err := loadProjectConfigWithIncludes(fs, absIncludePath)
+			includeCfgs, err := loadProjectConfigWithIncludes(
+				fs, absIncludePath, permissiveConfigParsing,
+			)
 			if err != nil {
 				return nil, err
 			}
@@ -200,7 +209,9 @@ func loadProjectConfigWithIncludes(fs opctx.FS, filePath string) ([]*ConfigFile,
 	return allCfgs, nil
 }
 
-func loadProjectConfigFile(fs opctx.FS, filePath string) (*ConfigFile, error) {
+func loadProjectConfigFile(
+	fs opctx.FS, filePath string, permissiveConfigParsing bool,
+) (*ConfigFile, error) {
 	slog.Debug("Loading project config", "filePath", filePath)
 
 	absFilePath, err := filepath.Abs(filePath)
@@ -214,7 +225,10 @@ func loadProjectConfigFile(fs opctx.FS, filePath string) (*ConfigFile, error) {
 	}
 
 	decoder := toml.NewDecoder(projectFile)
-	decoder.DisallowUnknownFields()
+
+	if !permissiveConfigParsing {
+		decoder.DisallowUnknownFields()
+	}
 
 	cfg := &ConfigFile{}