Config Core library

Makefile

@@ -61,7 +61,7 @@ testacc: get
 
 testacc-cover: get
 	@echo "Running tests with coverage"
-	go test $(TEST) -v $(TESTARGS) -timeout 20m -coverprofile=coverage.out.tmp
+	go test $(TEST) -v -coverpkg=./... $(TESTARGS) -timeout 20m -coverprofile=coverage.out.tmp
 	cat coverage.out.tmp | grep -v "mock_" > coverage.out
 
 # Run acceptance tests with coverage report

cmd/cmd_utils.go

@@ -512,7 +512,7 @@ func checkAtmosConfig(opts ...AtmosValidateOption) {
 		atmosConfigExists, err := u.IsDirectory(atmosConfig.StacksBaseAbsolutePath)
 		if !atmosConfigExists || err != nil {
 			printMessageForMissingAtmosConfig(atmosConfig)
-			os.Exit(1)
+			u.OsExit(1)
 		}
 	}
 }

cmd/helmfile.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	e "github.com/cloudposse/atmos/internal/exec"
+	"github.com/cloudposse/atmos/pkg/config"
 	u "github.com/cloudposse/atmos/pkg/utils"
 	"github.com/spf13/cobra"
 )
@@ -20,10 +21,41 @@ func init() {
 	// https://github.com/spf13/cobra/issues/739
 	helmfileCmd.DisableFlagParsing = true
 	helmfileCmd.PersistentFlags().Bool("", false, doubleDashHint)
+	config.DefaultConfigHandler.AddConfig(helmfileCmd, &config.ConfigOptions{
+		FlagName:     "helmfile-command",
+		EnvVar:       "ATMOS_COMPONENTS_HELMFILE_COMMAND",
+		Description:  "Specifies the executable to be called by `atmos` when running Helmfile commands.",
+		Key:          "components.helmfile.command",
+		DefaultValue: "helmfile",
+	})
+	config.DefaultConfigHandler.AddConfig(helmfileCmd, &config.ConfigOptions{
+		FlagName:     "helmfile-dir",
+		EnvVar:       "ATMOS_COMPONENTS_HELMFILE_BASE_PATH",
+		Description:  "Specifies the directory where Helmfile commands are executed. (Deprecated: use `--helmfile-base-path` instead)",
+		Key:          "components.helmfile.base_path",
+		DefaultValue: "",
+	})
+	config.DefaultConfigHandler.AddConfig(helmfileCmd, &config.ConfigOptions{
+		FlagName:     "helmfile-base-path",
+		EnvVar:       "ATMOS_COMPONENTS_HELMFILE_BASE_PATH",
+		Description:  "Specifies the directory where Helmfile commands are executed.",
+		Key:          "components.helmfile.base_path",
+		DefaultValue: "",
+	})
+
 	AddStackCompletion(helmfileCmd)
+	helmfileCommandConfig()
 	RootCmd.AddCommand(helmfileCmd)
 }
 
+func helmfileCommandConfig() {
+	config.DefaultConfigHandler.SetDefault("components.helmfile.use_eks", true)
+	config.DefaultConfigHandler.BindEnv("components.helmfile.use_eks", "ATMOS_COMPONENTS_HELMFILE_USE_EKS")
+	config.DefaultConfigHandler.BindEnv("components.helmfile.kubeconfig_path", "ATMOS_COMPONENTS_HELMFILE_KUBECONFIG_PATH")
+	config.DefaultConfigHandler.BindEnv("components.helmfile.helm_aws_profile_pattern", "ATMOS_COMPONENTS_HELMFILE_HELM_AWS_PROFILE_PATTERN")
+	config.DefaultConfigHandler.BindEnv("components.helmfile.cluster_name_pattern", "ATMOS_COMPONENTS_HELMFILE_CLUSTER_NAME_PATTERN")
+}
+
 func helmfileRun(cmd *cobra.Command, commandName string, args []string) {
 	handleHelpRequest(cmd, args)
 	diffArgs := []string{commandName}

cmd/root.go

@@ -16,6 +16,7 @@ import (
 	e "github.com/cloudposse/atmos/internal/exec"
 	"github.com/cloudposse/atmos/internal/tui/templates"
 	tuiUtils "github.com/cloudposse/atmos/internal/tui/utils"
+	"github.com/cloudposse/atmos/pkg/config"
 	cfg "github.com/cloudposse/atmos/pkg/config"
 	"github.com/cloudposse/atmos/pkg/logger"
 	"github.com/cloudposse/atmos/pkg/schema"
@@ -189,11 +190,61 @@ func init() {
 	RootCmd.PersistentFlags().String("redirect-stderr", "", "File descriptor to redirect `stderr` to. "+
 		"Errors can be redirected to any file or any standard file descriptor (including `/dev/null`)")
 
-	RootCmd.PersistentFlags().String("logs-level", "Info", "Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages")
-	RootCmd.PersistentFlags().String("logs-file", "/dev/stderr", "The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null'")
-	RootCmd.PersistentFlags().String("base-path", "", "Base path for Atmos project")
-	RootCmd.PersistentFlags().StringSlice("config", []string{}, "Paths to configuration files (comma-separated or repeated flag)")
-	RootCmd.PersistentFlags().StringSlice("config-path", []string{}, "Paths to configuration directories (comma-separated or repeated flag)")
+	config.DefaultConfigHandler.AddConfig(RootCmd, &cfg.ConfigOptions{
+		FlagName:     "logs-level",
+		EnvVar:       "ATMOS_LOGS_LEVEL",
+		Description:  "Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages",
+		Key:          "logs.level",
+		DefaultValue: "Info",
+	})
+	config.DefaultConfigHandler.AddConfig(RootCmd, &cfg.ConfigOptions{
+		FlagName:     "logs-file",
+		EnvVar:       "ATMOS_LOGS_FILE",
+		DefaultValue: "/dev/stderr",
+		Description:  "The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`",
+		Key:          "logs.file",
+	})
+	config.DefaultConfigHandler.AddConfig(RootCmd, &cfg.ConfigOptions{
+		FlagName:     "base-path",
+		EnvVar:       "ATMOS_BASE_PATH",
+		Key:          "base_path",
+		Description:  "Base path for components, stacks and workflows configurations.",
+		DefaultValue: "",
+	})
+	config.DefaultConfigHandler.AddConfig(RootCmd, &cfg.ConfigOptions{
+		FlagName:     "stacks-dir",
+		EnvVar:       "ATMOS_STACKS_BASE_PATH",
+		Key:          "stacks.base_path",
+		Description:  "Base path for stacks configurations. (Deprecated: use `--stacks-base-path` instead)",
+		DefaultValue: "",
+	})
+	config.DefaultConfigHandler.AddConfig(RootCmd, &cfg.ConfigOptions{
+		FlagName:     "stacks-base-path",
+		EnvVar:       "ATMOS_STACKS_BASE_PATH",
+		Key:          "stacks.base_path",
+		Description:  "Base path for stacks configurations.",
+		DefaultValue: "",
+	})
+	config.DefaultConfigHandler.AddConfig(RootCmd, &cfg.ConfigOptions{
+		FlagName:     "settings-list-merge-strategy",
+		EnvVar:       "ATMOS_SETTINGS_LIST_MERGE_STRATEGY",
+		Key:          "settings.list_merge_strategy",
+		Description:  "Specifies the merge strategy for lists in settings files. Supported values are `append`, `merge` and `replace`.",
+		DefaultValue: "replace",
+	})
+	config.DefaultConfigHandler.AddConfig(RootCmd, &cfg.ConfigOptions{
+		FlagName:     "config",
+		Key:          "config",
+		Description:  "Paths to configuration files (comma-separated or repeated flag)",
+		DefaultValue: []string{},
+	})
+	config.DefaultConfigHandler.AddConfig(RootCmd, &cfg.ConfigOptions{
+		FlagName:     "config-path",
+		Key:          "config_path",
+		Description:  "Paths to configuration directories (comma-separated or repeated flag)",
+		DefaultValue: []string{},
+	})
+
 	// Set custom usage template
 	err := templates.SetCustomUsageFunc(RootCmd)
 	if err != nil {

cmd/terraform.go

@@ -8,10 +8,12 @@ import (
 	"github.com/spf13/cobra"
 
 	e "github.com/cloudposse/atmos/internal/exec"
+	"github.com/cloudposse/atmos/pkg/config"
 	cfg "github.com/cloudposse/atmos/pkg/config"
 	terrerrors "github.com/cloudposse/atmos/pkg/errors"
 	h "github.com/cloudposse/atmos/pkg/hooks"
 	u "github.com/cloudposse/atmos/pkg/utils"
+	"github.com/cloudposse/atmos/pkg/version"
 )
 
 // terraformCmd represents the base command for all terraform sub-commands
@@ -27,11 +29,101 @@ func init() {
 	// https://github.com/spf13/cobra/issues/739
 	terraformCmd.DisableFlagParsing = true
 	terraformCmd.PersistentFlags().Bool("", false, doubleDashHint)
+	addTerraformCommandConfig()
 	AddStackCompletion(terraformCmd)
 	attachTerraformCommands(terraformCmd)
 	RootCmd.AddCommand(terraformCmd)
 }
 
+func addTerraformCommandConfig() {
+	addTerraformCommandSettings()
+	addTerraformInitSettings()
+	addTerraformExecutionSettings()
+}
+
+func addTerraformCommandSettings() {
+	config.DefaultConfigHandler.AddConfig(terraformCmd, &cfg.ConfigOptions{
+		FlagName:     "terraform-command",
+		EnvVar:       "ATMOS_COMPONENTS_TERRAFORM_COMMAND",
+		Description:  "Specifies the executable to be called by `atmos` when running Terraform commands.",
+		Key:          "components.terraform.command",
+		DefaultValue: "terraform",
+	})
+	config.DefaultConfigHandler.AddConfig(terraformCmd, &cfg.ConfigOptions{
+		FlagName:     "terraform-dir",
+		EnvVar:       "ATMOS_COMPONENTS_TERRAFORM_BASE_PATH",
+		Description:  "Specifies the directory where Terraform commands are executed. (Deprecated: use `--terraform-base-path` instead)",
+		Key:          "components.terraform.base_path",
+		DefaultValue: "",
+	})
+	config.DefaultConfigHandler.AddConfig(terraformCmd, &cfg.ConfigOptions{
+		FlagName:     "terraform-base-path",
+		EnvVar:       "ATMOS_COMPONENTS_TERRAFORM_BASE_PATH",
+		Description:  "Specifies the directory where Terraform commands are executed.",
+		Key:          "components.terraform.base_path",
+		DefaultValue: "",
+	})
+	config.DefaultConfigHandler.BindEnv("components.terraform.apply_auto_approve", "ATMOS_COMPONENTS_TERRAFORM_APPLY_AUTO_APPROVE")
+}
+
+func addTerraformInitSettings() {
+	config.DefaultConfigHandler.AddConfig(terraformCmd, &cfg.ConfigOptions{
+		Key:          "components.terraform.init_run_config",
+		EnvVar:       "ATMOS_COMPONENTS_TERRAFORM_INIT_RUN_RECONFIGURE",
+		FlagName:     "init-run-reconfigure",
+		Description:  "Run `terraform init` with reconfigure before running `terraform apply`",
+		DefaultValue: false,
+	})
+	config.DefaultConfigHandler.AddConfig(terraformCmd, &cfg.ConfigOptions{
+		Key:          "components.terraform.auto_generate_backend_file",
+		EnvVar:       "ATMOS_COMPONENTS_TERRAFORM_AUTO_GENERATE_BACKEND_FILE",
+		FlagName:     "auto-generate-backend-file",
+		Description:  "Automatically generate a backend file for Terraform commands",
+		DefaultValue: false,
+	})
+	config.DefaultConfigHandler.AddConfig(terraformCmd, &cfg.ConfigOptions{
+		Key:          "components.terraform.init.pass_vars",
+		FlagName:     "init-pass-vars",
+		EnvVar:       "ATMOS_COMPONENTS_TERRAFORM_INIT_PASS_VARS",
+		Description:  "Pass the generated varfile to `terraform init` using the `--var-file` flag. [OpenTofu supports passing a varfile to `init`](https://opentofu.org/docs/cli/commands/init/#general-options) to dynamically configure backends",
+		DefaultValue: false,
+	})
+}
+
+func addTerraformExecutionSettings() {
+	config.DefaultConfigHandler.AddConfig(terraformCmd, &cfg.ConfigOptions{
+		Key:          "components.terraform.append_user_agent",
+		FlagName:     "append-user-agent",
+		EnvVar:       "ATMOS_COMPONENTS_TERRAFORM_APPEND_USER_AGENT",
+		DefaultValue: fmt.Sprintf("Atmos/%s (Cloud Posse; +https://atmos.tools)", version.Version),
+		Description:  fmt.Sprintf("Sets the TF_APPEND_USER_AGENT environment variable to customize the User-Agent string in Terraform provider requests. Example: `Atmos/%s (Cloud Posse; +https://atmos.tools)`. This flag works with almost all commands.", version.Version),
+	})
+	config.DefaultConfigHandler.AddConfig(terraformCmd, &cfg.ConfigOptions{
+		Key:          "components.terraform.skip_init",
+		FlagName:     "skip-init",
+		Description:  "Skip running `terraform init` before executing terraform commands",
+		DefaultValue: false,
+	})
+	config.DefaultConfigHandler.AddConfig(terraformCmd, &cfg.ConfigOptions{
+		Key:          "components.terraform.process_templates",
+		FlagName:     "process-templates",
+		Description:  "Enable/disable Go template processing in Atmos stack manifests when executing terraform commands",
+		DefaultValue: true,
+	})
+	config.DefaultConfigHandler.AddConfig(terraformCmd, &cfg.ConfigOptions{
+		Key:          "components.terraform.process_functions",
+		FlagName:     "process-functions",
+		Description:  "Enable/disable YAML functions processing in Atmos stack manifests when executing terraform commands",
+		DefaultValue: true,
+	})
+	config.DefaultConfigHandler.AddConfig(terraformCmd, &cfg.ConfigOptions{
+		Key:          "components.terraform.skip",
+		FlagName:     "skip",
+		Description:  "Skip executing specific YAML functions in the Atmos stack manifests when executing terraform commands",
+		DefaultValue: []string{},
+	})
+}
+
 func runHooks(event h.HookEvent, cmd *cobra.Command, args []string) error {
 	info := getConfigAndStacksInfo("terraform", cmd, append([]string{cmd.Name()}, args...))
 

cmd/terraform_commands.go

@@ -1,12 +1,12 @@
 package cmd
 
 import (
-	"fmt"
 	"log"
 	"os"
 
+	"github.com/cloudposse/atmos/pkg/config"
+	cfg "github.com/cloudposse/atmos/pkg/config"
 	h "github.com/cloudposse/atmos/pkg/hooks"
-	"github.com/cloudposse/atmos/pkg/version"
 	"github.com/spf13/cobra"
 )
 
@@ -268,12 +268,6 @@ Arguments:
 
 // attachTerraformCommands attaches static Terraform commands to a provided parent command
 func attachTerraformCommands(parentCmd *cobra.Command) {
-	parentCmd.PersistentFlags().String("append-user-agent", "", fmt.Sprintf("Sets the TF_APPEND_USER_AGENT environment variable to customize the User-Agent string in Terraform provider requests. Example: `Atmos/%s (Cloud Posse; +https://atmos.tools)`. This flag works with almost all commands.", version.Version))
-	parentCmd.PersistentFlags().Bool("skip-init", false, "Skip running `terraform init` before executing terraform commands")
-	parentCmd.PersistentFlags().Bool("process-templates", true, "Enable/disable Go template processing in Atmos stack manifests when executing terraform commands")
-	parentCmd.PersistentFlags().Bool("process-functions", true, "Enable/disable YAML functions processing in Atmos stack manifests when executing terraform commands")
-	parentCmd.PersistentFlags().StringSlice("skip", nil, "Skip executing specific YAML functions in the Atmos stack manifests when executing terraform commands")
-
 	commands := getTerraformCommands()
 
 	for _, cmd := range commands {
@@ -303,7 +297,13 @@ func attachTerraformCommands(parentCmd *cobra.Command) {
 
 var commandMaps = map[string]func(cmd *cobra.Command){
 	"deploy": func(cmd *cobra.Command) {
-		cmd.PersistentFlags().Bool("deploy-run-init", false, "If set atmos will run `terraform init` before executing the command")
+		config.DefaultConfigHandler.AddConfig(cmd, &cfg.ConfigOptions{
+			Key:          "components.terraform.deploy_run_init",
+			EnvVar:       "ATMOS_COMPONENTS_TERRAFORM_DEPLOY_RUN_INIT",
+			FlagName:     "deploy-run-init",
+			Description:  "Run `terraform init` before running `terraform apply`",
+			DefaultValue: false,
+		})
 		cmd.PersistentFlags().Bool("from-plan", false, "If set atmos will use the previously generated plan file")
 		cmd.PersistentFlags().String("planfile", "", "Set the plan file to use")
 	},

cmd/validate_component.go

@@ -6,6 +6,7 @@ import (
 	"github.com/spf13/cobra"
 
 	e "github.com/cloudposse/atmos/internal/exec"
+	"github.com/cloudposse/atmos/pkg/config"
 	"github.com/cloudposse/atmos/pkg/ui/theme"
 	u "github.com/cloudposse/atmos/pkg/utils"
 )
@@ -45,6 +46,23 @@ func init() {
 	if err != nil {
 		u.LogErrorAndExit(err)
 	}
-
+	validateComponentCommandConfig()
 	validateCmd.AddCommand(validateComponentCmd)
 }
+
+func validateComponentCommandConfig() {
+	config.DefaultConfigHandler.AddConfig(validateComponentCmd, &config.ConfigOptions{
+		FlagName:     "schemas-jsonschema-dir",
+		EnvVar:       "ATMOS_SCHEMAS_JSONSCHEMA_BASE_PATH",
+		Description:  "Base path for JSON Schema files.",
+		Key:          "schemas.jsonschema.base_path",
+		DefaultValue: "",
+	})
+	config.DefaultConfigHandler.AddConfig(validateComponentCmd, &config.ConfigOptions{
+		FlagName:     "schemas-opa-dir",
+		EnvVar:       "ATMOS_SCHEMAS_OPA_BASE_PATH",
+		Description:  "Base path for OPA policy files.",
+		Key:          "schemas.opa.base_path",
+		DefaultValue: "",
+	})
+}

cmd/validate_editorconfig.go

@@ -9,6 +9,7 @@ import (
 	u "github.com/cloudposse/atmos/pkg/utils"
 	"github.com/cloudposse/atmos/pkg/version"
 
+	cfg "github.com/cloudposse/atmos/pkg/config"
 	"github.com/editorconfig-checker/editorconfig-checker/v3/pkg/config"
 	er "github.com/editorconfig-checker/editorconfig-checker/v3/pkg/error"
 	"github.com/editorconfig-checker/editorconfig-checker/v3/pkg/files"
@@ -206,4 +207,5 @@ func init() {
 	addPersistentFlags(editorConfigCmd)
 	// Add command
 	validateCmd.AddCommand(editorConfigCmd)
+	cfg.DefaultConfigHandler.SetDefault("validate.editorconfig.color", true)
 }

cmd/validate_stacks.go

@@ -4,6 +4,7 @@ import (
 	"github.com/spf13/cobra"
 
 	e "github.com/cloudposse/atmos/internal/exec"
+	"github.com/cloudposse/atmos/pkg/config"
 	"github.com/cloudposse/atmos/pkg/ui/theme"
 	u "github.com/cloudposse/atmos/pkg/utils"
 )
@@ -32,7 +33,12 @@ var ValidateStacksCmd = &cobra.Command{
 func init() {
 	ValidateStacksCmd.DisableFlagParsing = false
 
-	ValidateStacksCmd.PersistentFlags().String("schemas-atmos-manifest", "", "Specifies the path to a JSON schema file used to validate the structure and content of the Atmos manifest file")
-
+	config.DefaultConfigHandler.AddConfig(ValidateStacksCmd, &config.ConfigOptions{
+		FlagName:     "schemas-atmos-manifest",
+		EnvVar:       "ATMOS_SCHEMAS_ATMOS_MANIFEST",
+		Description:  "Specifies the path to a JSON schema file used to validate the structure and content of the Atmos manifest file",
+		Key:          "schemas.atmos.manifest",
+		DefaultValue: "",
+	})
 	validateCmd.AddCommand(ValidateStacksCmd)
 }

cmd/vendor.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"github.com/cloudposse/atmos/pkg/config"
 	"github.com/spf13/cobra"
 )
 
@@ -14,5 +15,12 @@ var vendorCmd = &cobra.Command{
 }
 
 func init() {
+	config.DefaultConfigHandler.AddConfig(vendorCmd, &config.ConfigOptions{
+		FlagName:     "vendor-base-path",
+		EnvVar:       "ATMOS_VENDOR_BASE_PATH",
+		Description:  "Base path for vendored dependencies.",
+		Key:          "vendor.base_path",
+		DefaultValue: "",
+	})
 	RootCmd.AddCommand(vendorCmd)
 }