Improve atmos list stacks

atmos.yaml

@@ -394,4 +394,3 @@ version:
     enabled: true
     timeout: 1000 # ms
     frequency: 1h
-

cmd/list_stacks.go

@@ -19,14 +19,19 @@ var listStacksCmd = &cobra.Command{
 	Short: "List all Atmos stacks or stacks for a specific component",
 	Long:  "This command lists all Atmos stacks, or filters the list to show only the stacks associated with a specified component.",
 	Example: "atmos list stacks\n" +
-		"atmos list stacks -c <component>",
+		"atmos list stacks -c <component>\n" +
+		"atmos list stacks --format json\n" +
+		"atmos list stacks --format csv --delimiter ','\n" +
+		"atmos list stacks --format table",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Args:               cobra.NoArgs,
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration
 		checkAtmosConfig()
 
 		componentFlag, _ := cmd.Flags().GetString("component")
+		formatFlag, _ := cmd.Flags().GetString("format")
+		delimiterFlag, _ := cmd.Flags().GetString("delimiter")
 
 		configAndStacksInfo := schema.ConfigAndStacksInfo{}
 		atmosConfig, err := config.InitCliConfig(configAndStacksInfo, true)
@@ -35,13 +40,13 @@ var listStacksCmd = &cobra.Command{
 			return
 		}
 
-		stacksMap, err := e.ExecuteDescribeStacks(atmosConfig, "", nil, nil, nil, false, false, false, false, nil)
+		stacksMap, err := e.ExecuteDescribeStacks(atmosConfig, "", nil, nil, nil, false, true, true, false, nil)
 		if err != nil {
 			u.PrintMessageInColor(fmt.Sprintf("Error describing stacks: %v", err), theme.Colors.Error)
 			return
 		}
 
-		output, err := l.FilterAndListStacks(stacksMap, componentFlag)
+		output, err := l.FilterAndListStacks(stacksMap, componentFlag, atmosConfig.Stacks.List, formatFlag, delimiterFlag)
 		if err != nil {
 			u.PrintMessageInColor(fmt.Sprintf("Error filtering stacks: %v", err), theme.Colors.Error)
 			return
@@ -52,6 +57,8 @@ var listStacksCmd = &cobra.Command{
 
 func init() {
 	listStacksCmd.DisableFlagParsing = false
-	listStacksCmd.PersistentFlags().StringP("component", "c", "", "atmos list stacks -c <component>")
+	listStacksCmd.PersistentFlags().StringP("component", "c", "", "Filter stacks by component")
+	listStacksCmd.PersistentFlags().StringP("format", "f", "", "Output format (table, json, csv)")
+	listStacksCmd.PersistentFlags().StringP("delimiter", "d", "\t", "Delimiter for table and csv formats")
 	listCmd.AddCommand(listStacksCmd)
 }

examples/quick-start-advanced/atmos.yaml

@@ -66,6 +66,16 @@ stacks:
     - "**/_defaults.yaml"
   # Can also be set using 'ATMOS_STACKS_NAME_PATTERN' ENV var
   name_pattern: "{tenant}-{environment}-{stage}"
+  list:
+    columns:
+      - name: Stack
+        value: '{{ .atmos_stack }}'
+      - name: Tenant
+        value: '{{ index .vars "tenant" }}'
+      - name: Environment
+        value: '{{ index .vars "environment" }}'
+      - name: File
+        value: '{{ .atmos_stack_file }}'
 
 workflows:
   # Can also be set using 'ATMOS_WORKFLOWS_BASE_PATH' ENV var, or '--workflows-dir' command-line argument

internal/exec/describe_stacks.go

@@ -214,6 +214,7 @@ func ExecuteDescribeStacks(
 		if !u.MapKeyExists(finalStacksMap, stackName) {
 			finalStacksMap[stackName] = make(map[string]any)
 			finalStacksMap[stackName].(map[string]any)["components"] = make(map[string]any)
+			finalStacksMap[stackName].(map[string]any)["atmos_stack_file"] = stackFileName
 		}
 
 		if componentsSection, ok := stackSection.(map[string]any)["components"].(map[string]any); ok {
@@ -307,15 +308,22 @@ func ExecuteDescribeStacks(
 							if err != nil {
 								return nil, err
 							}
-						} else {
+						} else if atmosConfig.Stacks.NamePattern != "" {
 							context = cfg.GetContextFromVars(varsSection)
 							configAndStacksInfo.Context = context
 							stackName, err = cfg.GetContextPrefix(stackFileName, context, GetStackNamePattern(atmosConfig), stackFileName)
 							if err != nil {
 								return nil, err
 							}
+						} else {
+							// If no name pattern or template is configured, use the stack file name
+							stackName = stackFileName
 						}
 
+						// Update the component section with the final stack name
+						configAndStacksInfo.ComponentSection["atmos_stack"] = stackName
+						configAndStacksInfo.ComponentSection["stack"] = stackName
+
 						if filterByStack != "" && filterByStack != stackFileName && filterByStack != stackName {
 							continue
 						}
@@ -327,18 +335,15 @@ func ExecuteDescribeStacks(
 						// Only create the stack entry if it doesn't exist
 						if !u.MapKeyExists(finalStacksMap, stackName) {
 							finalStacksMap[stackName] = make(map[string]any)
+							finalStacksMap[stackName].(map[string]any)["components"] = make(map[string]any)
+							finalStacksMap[stackName].(map[string]any)["atmos_stack_file"] = stackFileName
 						}
 
 						configAndStacksInfo.ComponentSection["atmos_component"] = componentName
-						configAndStacksInfo.ComponentSection["atmos_stack"] = stackName
-						configAndStacksInfo.ComponentSection["stack"] = stackName
 						configAndStacksInfo.ComponentSection["atmos_stack_file"] = stackFileName
 						configAndStacksInfo.ComponentSection["atmos_manifest"] = stackFileName
 
 						if len(components) == 0 || u.SliceContainsString(components, componentName) || u.SliceContainsString(derivedComponents, componentName) {
-							if !u.MapKeyExists(finalStacksMap[stackName].(map[string]any), "components") {
-								finalStacksMap[stackName].(map[string]any)["components"] = make(map[string]any)
-							}
 							if !u.MapKeyExists(finalStacksMap[stackName].(map[string]any)["components"].(map[string]any), "terraform") {
 								finalStacksMap[stackName].(map[string]any)["components"].(map[string]any)["terraform"] = make(map[string]any)
 							}
@@ -516,15 +521,22 @@ func ExecuteDescribeStacks(
 							if err != nil {
 								return nil, err
 							}
-						} else {
+						} else if atmosConfig.Stacks.NamePattern != "" {
 							context = cfg.GetContextFromVars(varsSection)
 							configAndStacksInfo.Context = context
 							stackName, err = cfg.GetContextPrefix(stackFileName, context, GetStackNamePattern(atmosConfig), stackFileName)
 							if err != nil {
 								return nil, err
 							}
+						} else {
+							// If no name pattern or template is configured, use the stack file name
+							stackName = stackFileName
 						}
 
+						// Update the component section with the final stack name
+						configAndStacksInfo.ComponentSection["atmos_stack"] = stackName
+						configAndStacksInfo.ComponentSection["stack"] = stackName
+
 						if filterByStack != "" && filterByStack != stackFileName && filterByStack != stackName {
 							continue
 						}
@@ -536,18 +548,15 @@ func ExecuteDescribeStacks(
 						// Only create the stack entry if it doesn't exist
 						if !u.MapKeyExists(finalStacksMap, stackName) {
 							finalStacksMap[stackName] = make(map[string]any)
+							finalStacksMap[stackName].(map[string]any)["components"] = make(map[string]any)
+							finalStacksMap[stackName].(map[string]any)["atmos_stack_file"] = stackFileName
 						}
 
 						configAndStacksInfo.ComponentSection["atmos_component"] = componentName
-						configAndStacksInfo.ComponentSection["atmos_stack"] = stackName
-						configAndStacksInfo.ComponentSection["stack"] = stackName
 						configAndStacksInfo.ComponentSection["atmos_stack_file"] = stackFileName
 						configAndStacksInfo.ComponentSection["atmos_manifest"] = stackFileName
 
 						if len(components) == 0 || u.SliceContainsString(components, componentName) || u.SliceContainsString(derivedComponents, componentName) {
-							if !u.MapKeyExists(finalStacksMap[stackName].(map[string]any), "components") {
-								finalStacksMap[stackName].(map[string]any)["components"] = make(map[string]any)
-							}
 							if !u.MapKeyExists(finalStacksMap[stackName].(map[string]any)["components"].(map[string]any), "helmfile") {
 								finalStacksMap[stackName].(map[string]any)["components"].(map[string]any)["helmfile"] = make(map[string]any)
 							}

pkg/list/list_components_test.go

@@ -45,7 +45,16 @@ func TestListComponentsWithStack(t *testing.T) {
 		nil, false, false, false, false, nil)
 	assert.Nil(t, err)
 
-	output, err := FilterAndListStacks(stacksMap, testStack)
+	// Create test list config
+	listConfig := schema.ListConfig{
+		Format: "",
+		Columns: []schema.ListColumnConfig{
+			{Name: "Stack", Value: "{{ .atmos_stack }}"},
+			{Name: "File", Value: "{{ .atmos_stack_file }}"},
+		},
+	}
+
+	output, err := FilterAndListStacks(stacksMap, testStack, listConfig, "", "\t")
 	assert.Nil(t, err)
 	dependentsYaml, err := u.ConvertToYAML(output)
 	assert.Nil(t, err)