Enhance Atmos CLI: Add Support for Custom Base Path and Config Paths

cmd/root.go

@@ -190,8 +190,10 @@ func init() {
 		"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("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)")
 	// Set custom usage template
 	err := templates.SetCustomUsageFunc(RootCmd)
 	if err != nil {

cmd/validate_editorconfig.go

@@ -50,6 +50,12 @@
 	replaceAtmosConfigInConfig(cmd, atmosConfig)
 
 	configPaths := []string{}
+	if cmd.Flags().Changed("config") {
+		config := cmd.Flags().Lookup("config")
+		if config != nil {
+			configFilePaths = strings.Split(config.Value.String(), ",")
+		}
+	}
 	if len(configFilePaths) == 0 {
 		configPaths = append(configPaths, defaultConfigFileNames...)
 	} else {
@@ -179,7 +185,6 @@
 
 // addPersistentFlags adds flags to the root command
 func addPersistentFlags(cmd *cobra.Command) {
-	cmd.PersistentFlags().StringSliceVar(&configFilePaths, "config", defaultConfigFileNames, "Paths to the configuration files")
 	cmd.PersistentFlags().StringVar(&tmpExclude, "exclude", "", "Regex to exclude files from checking")
 	cmd.PersistentFlags().BoolVar(&initEditorConfig, "init", false, "Create an initial configuration")
 

internal/exec/utils.go

@@ -209,6 +209,18 @@
 		return configAndStacksInfo, err
 	}
 
+	configAndStacksInfo.BasePath, err = cmd.Flags().GetString("base-path")
+	if err != nil {
+		return configAndStacksInfo, err
+	}
+	configAndStacksInfo.AtmosConfigFilesFromArg, err = cmd.Flags().GetStringSlice("config")
+	if err != nil {
+		return configAndStacksInfo, err
+	}
+	configAndStacksInfo.AtmosConfigDirsFromArg, err = cmd.Flags().GetStringSlice("config-path")
+	if err != nil {
+		return configAndStacksInfo, err
+	}
 	finalAdditionalArgsAndFlags := argsAndFlagsInfo.AdditionalArgsAndFlags
 	if len(additionalArgsAndFlags) > 0 {
 		finalAdditionalArgsAndFlags = append(finalAdditionalArgsAndFlags, additionalArgsAndFlags...)
@@ -220,7 +232,6 @@
 	configAndStacksInfo.ComponentType = componentType
 	configAndStacksInfo.ComponentFromArg = argsAndFlagsInfo.ComponentFromArg
 	configAndStacksInfo.GlobalOptions = argsAndFlagsInfo.GlobalOptions
-	configAndStacksInfo.BasePath = argsAndFlagsInfo.BasePath
 	configAndStacksInfo.TerraformCommand = argsAndFlagsInfo.TerraformCommand
 	configAndStacksInfo.TerraformDir = argsAndFlagsInfo.TerraformDir
 	configAndStacksInfo.HelmfileCommand = argsAndFlagsInfo.HelmfileCommand

internal/exec/vendor_utils_test.go

@@ -48,7 +48,9 @@ func TestExecuteVendorPullCommand(t *testing.T) {
 	cmd.PersistentFlags().Bool("dry-run", false, "Simulate pulling the latest version of the specified component from the remote repository without making any changes.")
 	cmd.PersistentFlags().String("tags", "", "Only vendor the components that have the specified tags")
 	cmd.PersistentFlags().Bool("everything", false, "Vendor all components")
-
+	cmd.PersistentFlags().String("base-path", "", "Base path for Atmos project")
+	cmd.PersistentFlags().StringSlice("config", []string{}, "Paths to configuration file")
+	cmd.PersistentFlags().StringSlice("config-path", []string{}, "Path to configuration directory")
 	// Execute the command
 	err = cmd.RunE(cmd, []string{})
 	assert.NoError(t, err, "'atmos vendor pull' command should execute without error")
@@ -103,6 +105,9 @@ func TestExecuteVendorPull(t *testing.T) {
 	}
 	// set vendor pull command
 	cmd := cobra.Command{}
+	cmd.PersistentFlags().String("base-path", "", "Base path for Atmos project")
+	cmd.PersistentFlags().StringSlice("config", []string{}, "Paths to configuration file")
+	cmd.PersistentFlags().StringSlice("config-path", []string{}, "Path to configuration directory")
 	flags := cmd.Flags()
 	flags.String("component", "", "")
 	flags.String("stack", "", "")

internal/exec/workflow_test.go

@@ -55,7 +55,9 @@ atmos describe component c1 -s test
 	cmd.PersistentFlags().Bool("dry-run", false, "Simulate the workflow without making any changes")
 	cmd.PersistentFlags().String("from-step", "", "Resume the workflow from the specified step")
 	cmd.PersistentFlags().String("stack", "", "Execute the workflow for the specified stack")
-
+	cmd.PersistentFlags().String("base-path", "", "Base path for Atmos project")
+	cmd.PersistentFlags().StringSlice("config", []string{}, "Paths to configuration file")
+	cmd.PersistentFlags().StringSlice("config-path", []string{}, "Path to configuration directory")
 	// Execute the command
 	cmd.SetArgs([]string{"--file", "workflows", "show-all-describe-component-commands"})
 	err = cmd.Execute()

pkg/config/atmos.yaml

@@ -0,0 +1,8 @@
+logs:
+  # Can also be set using 'ATMOS_LOGS_FILE' ENV var, or '--logs-file' command-line argument
+  # File or standard file descriptor to write logs to
+  # Logs can be written to any file or any standard file descriptor, including `/dev/stdout`, `/dev/stderr` and `/dev/null`
+  file: "/dev/stderr"
+  # Supported log levels: Trace, Debug, Info, Warning, Off
+  # Can also be set using 'ATMOS_LOGS_LEVEL' ENV var, or '--logs-level' command-line argument
+  level: Info

pkg/config/config_test.go

@@ -244,7 +244,7 @@ func TestMergeConfig_ConfigFileNotFound(t *testing.T) {
 	tempDir := t.TempDir() // Empty directory, no config file
 
 	v := viper.New()
-	err := mergeConfig(v, tempDir, true)
+	err := mergeConfig(v, tempDir, CliConfigFileName, true)
 
 	assert.Error(t, err)
 	assert.Contains(t, err.Error(), "Config File \"atmos\" Not Found")
@@ -262,7 +262,7 @@ logs:
 	createConfigFile(t, tempDir, "atmos.yaml", content)
 	v := viper.New()
 	v.SetConfigType("yaml")
-	err := mergeConfig(v, tempDir, false)
+	err := mergeConfig(v, tempDir, CliConfigFileName, false)
 	assert.NoError(t, err)
 	assert.Equal(t, "./", v.GetString("base_path"))
 	content2 := `
@@ -272,10 +272,20 @@ vendor:
 `
 	tempDir2 := t.TempDir()
 	createConfigFile(t, tempDir2, "atmos.yml", content2)
-	err = mergeConfig(v, tempDir2, false)
+	err = mergeConfig(v, tempDir2, CliConfigFileName, false)
 	assert.NoError(t, err)
 	assert.Equal(t, "./test", v.GetString("base_path"))
 	assert.Equal(t, "./test2-vendor.yaml", v.GetString("vendor.base_path"))
 	assert.Equal(t, "Debug", v.GetString("logs.level"))
 	assert.Equal(t, filepath.Join(tempDir2, "atmos.yml"), v.ConfigFileUsed())
 }
+
+func TestMergeDefaultConfig(t *testing.T) {
+	v := viper.New()
+
+	err := mergeDefaultConfig(v)
+	assert.Error(t, err, "cannot decode configuration: unable to determine config type")
+	v.SetConfigType("yaml")
+	err = mergeDefaultConfig(v)
+	assert.NoError(t, err, "should not return error if config type is yaml")
+}

pkg/config/const.go

@@ -1,7 +1,9 @@
 package config
 
 const (
-	CliConfigFileName       = "atmos"
+	CliConfigFileName    = "atmos"
+	DotCliConfigFileName = ".atmos"
+
 	SystemDirConfigFilePath = "/usr/local/etc/atmos"
 	WindowsAppDataEnvVar    = "LOCALAPPDATA"
 

pkg/config/load.go

@@ -2,6 +2,7 @@
 
 import (
 	"bytes"
+	_ "embed"
 	"errors"
 	"fmt"
 	"os"
@@ -16,10 +17,14 @@
 	"gopkg.in/yaml.v3"
 )
 
+//go:embed atmos.yaml
+var embeddedConfigData []byte
+
 const MaximumImportLvL = 10
 
 var ErrAtmosDIrConfigNotFound = errors.New("atmos config directory not found")
 
+// * Embedded atmos.yaml (`atmos/pkg/config/atmos.yaml`)
 // * System dir (`/usr/local/etc/atmos` on Linux, `%LOCALAPPDATA%/atmos` on Windows).
 // * Home directory (~/.atmos).
 // * Current working directory.
@@ -31,8 +36,20 @@
 	v.SetConfigType("yaml")
 	v.SetTypeByDefaultValue(true)
 	setDefaultConfiguration(v)
+	// Load embed atmos.yaml
+	if err := loadEmbeddedConfig(v); err != nil {
+		return atmosConfig, err
+	}
+	if len(configAndStacksInfo.AtmosConfigFilesFromArg) > 0 || len(configAndStacksInfo.AtmosConfigDirsFromArg) > 0 {
+		err := loadConfigFromCLIArgs(v, configAndStacksInfo, &atmosConfig)
+		if err != nil {
+			return atmosConfig, err
+		}
+		return atmosConfig, nil
+	}
+
 	// Load configuration from different sources.
-	if err := loadConfigSources(v, configAndStacksInfo.AtmosCliConfigPath); err != nil {
+	if err := loadConfigSources(v, configAndStacksInfo); err != nil {
 		return atmosConfig, err
 	}
 	// If no config file is used, fall back to the default CLI config.
@@ -103,7 +120,7 @@
 
 // loadConfigSources delegates reading configs from each source,
 // returning early if any step in the chain fails.
-func loadConfigSources(v *viper.Viper, cliConfigPath string) error {
+func loadConfigSources(v *viper.Viper, configAndStacksInfo *schema.ConfigAndStacksInfo) error {
 	if err := readSystemConfig(v); err != nil {
 		return err
 	}
@@ -120,7 +137,7 @@
 		return err
 	}
 
-	return readAtmosConfigCli(v, cliConfigPath)
+	return readAtmosConfigCli(v, configAndStacksInfo.AtmosCliConfigPath)
 }
 
 // readSystemConfig load config from system dir .
@@ -136,7 +153,7 @@
 	}
 
 	if len(configFilePath) > 0 {
-		err := mergeConfig(v, configFilePath, false)
+		err := mergeConfig(v, configFilePath, CliConfigFileName, false)
 		switch err.(type) {
 		case viper.ConfigFileNotFoundError:
 			return nil
@@ -154,7 +171,7 @@
 		return err
 	}
 	configFilePath := filepath.Join(home, ".atmos")
-	err = mergeConfig(v, configFilePath, true)
+	err = mergeConfig(v, configFilePath, CliConfigFileName, true)
 	if err != nil {
 		switch err.(type) {
 		case viper.ConfigFileNotFoundError:
@@ -173,7 +190,7 @@
 	if err != nil {
 		return err
 	}
-	err = mergeConfig(v, wd, true)
+	err = mergeConfig(v, wd, CliConfigFileName, true)
 	if err != nil {
 		switch err.(type) {
 		case viper.ConfigFileNotFoundError:
@@ -190,7 +207,7 @@
 	if atmosPath == "" {
 		return nil
 	}
-	err := mergeConfig(v, atmosPath, true)
+	err := mergeConfig(v, atmosPath, CliConfigFileName, true)
 	if err != nil {
 		switch err.(type) {
 		case viper.ConfigFileNotFoundError:
@@ -209,7 +226,7 @@
 	if len(atmosCliConfigPath) == 0 {
 		return nil
 	}
-	err := mergeConfig(v, atmosCliConfigPath, true)
+	err := mergeConfig(v, atmosCliConfigPath, CliConfigFileName, true)
 	switch err.(type) {
 	case viper.ConfigFileNotFoundError:
 		log.Debug("config not found", "file", atmosCliConfigPath)
@@ -221,11 +238,11 @@
 }
 
 // mergeConfig merge config from a specified path directory and process imports. Return error if config file does not exist.
-func mergeConfig(v *viper.Viper, path string, processImports bool) error {
+func mergeConfig(v *viper.Viper, path string, fileName string, processImports bool) error {
 	// Create a temporary Viper instance to isolate this configuration load
 	tempViper := viper.New()
 	tempViper.AddConfigPath(path)
-	tempViper.SetConfigName(CliConfigFileName)
+	tempViper.SetConfigName(fileName)
 	tempViper.SetConfigType("yaml")
 	// Read configuration into temporary instance
 	if err := tempViper.ReadInConfig(); err != nil {
@@ -413,3 +430,16 @@
 
 	return nil
 }
+
+// loadEmbeddedConfig loads the embedded atmos.yaml configuration.
+func loadEmbeddedConfig(v *viper.Viper) error {
+	// Create a reader from the embedded YAML data
+	reader := bytes.NewReader(embeddedConfigData)
+
+	// Merge the embedded configuration into Viper
+	if err := v.MergeConfig(reader); err != nil {
+		return fmt.Errorf("failed to merge embedded config: %w", err)
+	}
+
+	return nil
+}