feat(cli): show message when no components or stacks found in list command (#1754)

* feat(cli): show message when no stacks found

Display a user-friendly message in color when the list stacks command
returns no results, improving user feedback and clarity.

* feat(cli): show message when no components found

Display a user-friendly message when the list components command returns
no results. This improves UX by providing clear feedback instead of
showing an empty output.

* fix: consistent formatting

* refactor(ui): use ui.Error for empty list messages

Replaced usage of u.PrintMessageInColor for empty component and stack
lists with the new ui.Error function. This improves consistency in error
messaging and centralizes UI logic. Imports were updated accordingly.

* test: add tests for empty and missing components/stacks

Add tests to cover scenarios where no components are found in stacks and
where no stacks match a given component. This improves coverage for
edge cases in FilterAndListComponents and FilterAndListStacks.

* test(list): add tests for empty list results

Add tests to verify that the list commands handle empty results correctly.
These tests ensure that the "No components found" and "No stacks found"
messages are triggered when the filter functions return empty slices.

* fix(ui): use Info instead of Error for empty list messages

Changed the message level from Error to Info when no components or stacks
are found in the list commands. This avoids treating empty results as
errors and provides a clearer user experience.

Author: RoseSecurity

cmd/list_components.go

@@ -10,6 +10,7 @@ import (
 	"github.com/cloudposse/atmos/pkg/config"
 	l "github.com/cloudposse/atmos/pkg/list"
 	"github.com/cloudposse/atmos/pkg/schema"
+	"github.com/cloudposse/atmos/pkg/ui"
 	"github.com/cloudposse/atmos/pkg/ui/theme"
 	u "github.com/cloudposse/atmos/pkg/utils"
 )
@@ -29,6 +30,11 @@ var listComponentsCmd = &cobra.Command{
 			return err
 		}
 
+		if len(output) == 0 {
+			ui.Info("No components found")
+			return nil
+		}
+
 		u.PrintMessageInColor(strings.Join(output, "\n")+"\n", theme.Colors.Success)
 		return nil
 	},

cmd/list_stacks.go

@@ -10,6 +10,7 @@ import (
 	"github.com/cloudposse/atmos/pkg/config"
 	l "github.com/cloudposse/atmos/pkg/list"
 	"github.com/cloudposse/atmos/pkg/schema"
+	"github.com/cloudposse/atmos/pkg/ui"
 	"github.com/cloudposse/atmos/pkg/ui/theme"
 	u "github.com/cloudposse/atmos/pkg/utils"
 )
@@ -30,6 +31,11 @@ var listStacksCmd = &cobra.Command{
 			return err
 		}
 
+		if len(output) == 0 {
+			ui.Info("No stacks found")
+			return nil
+		}
+
 		u.PrintMessageInColor(strings.Join(output, "\n")+"\n", theme.Colors.Success)
 		return nil
 	},

cmd/list_test.go

@@ -6,6 +6,7 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/stretchr/testify/assert"
 
+	l "github.com/cloudposse/atmos/pkg/list"
 	"github.com/cloudposse/atmos/pkg/list/errors"
 )
 
@@ -202,3 +203,42 @@ func TestListCmds_Error(t *testing.T) {
 	err = listWorkflowsCmd.RunE(listWorkflowsCmd, []string{"--invalid-flag"})
 	assert.Error(t, err, "list workflows command should return an error when called with invalid flags")
 }
+
+// TestListCmds_NoResults verifies that the list commands can handle empty results.
+// This tests the condition that triggers "No components found" and "No stacks found" messages.
+// Note: This test verifies the underlying filter functions return empty slices, which is the
+// condition that causes the RunE functions to display the "No X found" UI error messages.
+func TestListCmds_NoResults(t *testing.T) {
+	// Test that FilterAndListComponents can return empty results
+	t.Run("list components returns empty when no components exist", func(t *testing.T) {
+		emptyStacksMap := map[string]any{
+			"test-stack": map[string]any{
+				"components": map[string]any{
+					"terraform": map[string]any{},
+					"helmfile":  map[string]any{},
+				},
+			},
+		}
+
+		output, err := l.FilterAndListComponents("", emptyStacksMap)
+		assert.NoError(t, err)
+		assert.Empty(t, output, "Expected empty output when no components exist")
+	})
+
+	// Test that FilterAndListStacks can return empty results
+	t.Run("list stacks returns empty when no matching stacks exist", func(t *testing.T) {
+		stacksMap := map[string]any{
+			"test-stack": map[string]any{
+				"components": map[string]any{
+					"terraform": map[string]any{
+						"existing-component": map[string]any{},
+					},
+				},
+			},
+		}
+
+		output, err := l.FilterAndListStacks(stacksMap, "nonexistent-component")
+		assert.NoError(t, err)
+		assert.Nil(t, output, "Expected nil output when no matching stacks exist")
+	})
+}

pkg/list/list_components_test.go

@@ -259,6 +259,23 @@ func TestFilterAndListComponents(t *testing.T) {
 		assert.ElementsMatch(t, []string{"vpc", "eks", "rds", "s3", "test", "elasticache"}, components)
 	})
 
+	// Test no components found
+	t.Run("no components", func(t *testing.T) {
+		emptyStacks := map[string]any{
+			"stack1": map[string]any{
+				"components": map[string]any{
+					"terraform": map[string]any{},
+					"helmfile":  map[string]any{},
+					"packer":    map[string]any{},
+				},
+			},
+		}
+
+		components, err := FilterAndListComponents("", emptyStacks)
+		require.NoError(t, err)
+		assert.Empty(t, components)
+	})
+
 	// Test error cases
 	t.Run("non-existent stack", func(t *testing.T) {
 		_, err := FilterAndListComponents("non-existent-stack", stacksMap)

pkg/list/list_stacks_test.go

@@ -48,3 +48,19 @@ func TestListStacksWithComponent(t *testing.T) {
 	assert.Contains(t, dependentsYaml, "tenant1-uw1-test-1")
 	assert.Contains(t, dependentsYaml, "tenant1-uw2-test-1")
 }
+
+func TestFilterAndListStacks_NoMatchingComponent(t *testing.T) {
+	stacksMap := map[string]any{
+		"stack1": map[string]any{
+			"components": map[string]any{
+				"terraform": map[string]any{
+					"existing": map[string]any{},
+				},
+			},
+		},
+	}
+
+	output, err := FilterAndListStacks(stacksMap, "missing")
+	assert.NoError(t, err)
+	assert.Nil(t, output)
+}