Reduce Output in Atmos Tests

.github/workflows/test.yml

@@ -176,7 +176,7 @@ jobs:
         timeout-minutes: 10
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: make testacc
+        run: make testacc ATMOS_TEST_VERBOSITY=quiet
 
   docker:
     name: "Docker Lint"
@@ -503,4 +503,4 @@ jobs:
     with:
       publish: false
       format: binary
-    secrets: inherit
+    secrets: inherit

Makefile

@@ -53,8 +53,17 @@ version-windows: build-windows
 deps:
 	go mod download
 
-# Run acceptance tests
-testacc: get
-	go test $(TEST) -v $(TESTARGS) -timeout 2m
+# Test verbosity levels: quiet, normal, verbose
+ATMOS_TEST_VERBOSITY ?= normal
+
+.PHONY: testacc
+testacc: ## Run all tests
+	@if [ "$(ATMOS_TEST_VERBOSITY)" = "quiet" ]; then \
+		go test ./... -timeout 20m; \
+	elif [ "$(ATMOS_TEST_VERBOSITY)" = "verbose" ]; then \
+		go test -v -count=1 ./... -timeout 20m; \
+	else \
+		go test -v ./... -timeout 20m; \
+	fi
 
 .PHONY: lint get build version build-linux build-windows build-macos deps version-linux version-windows version-macos testacc

README.md

@@ -221,4 +221,4 @@ Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
 
 <a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/atmos&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
 
-<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/atmos?pixel&cs=github&cm=readme&an=atmos"/>
+<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/atmos?pixel&cs=github&cm=readme&an=atmos"/>

README.yaml

@@ -135,3 +135,27 @@ introduction: |-
   Find all documentation at: [atmos.tools](https://atmos.tools)
 
 contributors: []
+
+testing:
+  content: |-
+    ## Testing
+
+    ### Test Verbosity Control
+
+    The test suite supports three verbosity levels to control output:
+
+    - `quiet`: Minimal output, only shows failures
+    - `normal`: Standard test output (default)
+    - `verbose`: Detailed test output with additional debugging information
+
+    You can control the verbosity level using the `ATMOS_TEST_VERBOSITY` environment variable:
+
+    ```bash
+    # Run tests with minimal output
+    make test ATMOS_TEST_VERBOSITY=quiet
+
+    # Run acceptance tests with verbose output
+    make testacc ATMOS_TEST_VERBOSITY=verbose
+    ```
+
+    This is particularly useful when running tests in CI environments or when debugging specific test failures.

cmd/root.go

@@ -15,6 +15,7 @@ import (
 	"github.com/cloudposse/atmos/internal/tui/templates"
 	tuiUtils "github.com/cloudposse/atmos/internal/tui/utils"
 	cfg "github.com/cloudposse/atmos/pkg/config"
+	"github.com/cloudposse/atmos/pkg/logger"
 	"github.com/cloudposse/atmos/pkg/schema"
 	u "github.com/cloudposse/atmos/pkg/utils"
 )
@@ -44,6 +45,14 @@ var RootCmd = &cobra.Command{
 			cmd.SilenceErrors = true
 		}
 
+		// Validate logs-level flag if provided
+		if cmd.Flags().Changed("logs-level") {
+			logsLevel, _ := cmd.Flags().GetString("logs-level")
+			if _, err := logger.ParseLogLevel(logsLevel); err != nil {
+				u.LogErrorAndExit(schema.AtmosConfiguration{}, err)
+			}
+		}
+
 		logsLevel, _ := cmd.Flags().GetString("logs-level")
 		logsFile, _ := cmd.Flags().GetString("logs-file")
 
@@ -62,7 +71,12 @@ var RootCmd = &cobra.Command{
 		// Only validate the config, don't store it yet since commands may need to add more info
 		_, err := cfg.InitCliConfig(configAndStacksInfo, false)
 		if err != nil {
-			if !errors.Is(err, cfg.NotFound) {
+			if errors.Is(err, cfg.NotFound) {
+				// For help commands or when help flag is set, we don't want to show the error
+				if !isHelpRequested {
+					u.LogWarning(errorConfig, err.Error())
+				}
+			} else {
 				u.LogErrorAndExit(errorConfig, err)
 			}
 		}

pkg/describe/describe_stacks_test.go

@@ -1,6 +1,7 @@
 package describe
 
 import (
+	"os"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -10,6 +11,11 @@ import (
 	u "github.com/cloudposse/atmos/pkg/utils"
 )
 
+// shouldLogVerbose returns true if test verbosity is set to verbose
+func shouldLogVerbose() bool {
+	return os.Getenv("ATMOS_TEST_VERBOSITY") == "verbose"
+}
+
 func TestDescribeStacks(t *testing.T) {
 	configAndStacksInfo := schema.ConfigAndStacksInfo{}
 
@@ -18,10 +24,13 @@ func TestDescribeStacks(t *testing.T) {
 
 	stacks, err := ExecuteDescribeStacks(atmosConfig, "", nil, nil, nil, false, false)
 	assert.Nil(t, err)
+	assert.NotNil(t, stacks)
 
-	dependentsYaml, err := u.ConvertToYAML(stacks)
-	assert.Nil(t, err)
-	t.Log(dependentsYaml)
+	if shouldLogVerbose() {
+		dependentsYaml, err := u.ConvertToYAML(stacks)
+		assert.Nil(t, err)
+		t.Log(dependentsYaml)
+	}
 }
 
 func TestDescribeStacksWithFilter1(t *testing.T) {
@@ -34,10 +43,13 @@ func TestDescribeStacksWithFilter1(t *testing.T) {
 
 	stacks, err := ExecuteDescribeStacks(atmosConfig, stack, nil, nil, nil, false, false)
 	assert.Nil(t, err)
+	assert.NotNil(t, stacks)
 
-	dependentsYaml, err := u.ConvertToYAML(stacks)
-	assert.Nil(t, err)
-	t.Log(dependentsYaml)
+	if shouldLogVerbose() {
+		dependentsYaml, err := u.ConvertToYAML(stacks)
+		assert.Nil(t, err)
+		t.Log(dependentsYaml)
+	}
 }
 
 func TestDescribeStacksWithFilter2(t *testing.T) {
@@ -51,10 +63,13 @@ func TestDescribeStacksWithFilter2(t *testing.T) {
 
 	stacks, err := ExecuteDescribeStacks(atmosConfig, stack, components, nil, nil, false, false)
 	assert.Nil(t, err)
+	assert.NotNil(t, stacks)
 
-	dependentsYaml, err := u.ConvertToYAML(stacks)
-	assert.Nil(t, err)
-	t.Log(dependentsYaml)
+	if shouldLogVerbose() {
+		dependentsYaml, err := u.ConvertToYAML(stacks)
+		assert.Nil(t, err)
+		t.Log(dependentsYaml)
+	}
 }
 
 func TestDescribeStacksWithFilter3(t *testing.T) {
@@ -68,10 +83,13 @@ func TestDescribeStacksWithFilter3(t *testing.T) {
 
 	stacks, err := ExecuteDescribeStacks(atmosConfig, stack, nil, nil, sections, false, false)
 	assert.Nil(t, err)
+	assert.NotNil(t, stacks)
 
-	dependentsYaml, err := u.ConvertToYAML(stacks)
-	assert.Nil(t, err)
-	t.Log(dependentsYaml)
+	if shouldLogVerbose() {
+		dependentsYaml, err := u.ConvertToYAML(stacks)
+		assert.Nil(t, err)
+		t.Log(dependentsYaml)
+	}
 }
 
 func TestDescribeStacksWithFilter4(t *testing.T) {
@@ -85,10 +103,13 @@ func TestDescribeStacksWithFilter4(t *testing.T) {
 
 	stacks, err := ExecuteDescribeStacks(atmosConfig, "", nil, componentTypes, sections, false, false)
 	assert.Nil(t, err)
+	assert.NotNil(t, stacks)
 
-	dependentsYaml, err := u.ConvertToYAML(stacks)
-	assert.Nil(t, err)
-	t.Log(dependentsYaml)
+	if shouldLogVerbose() {
+		dependentsYaml, err := u.ConvertToYAML(stacks)
+		assert.Nil(t, err)
+		t.Log(dependentsYaml)
+	}
 }
 
 func TestDescribeStacksWithFilter5(t *testing.T) {
@@ -117,9 +138,11 @@ func TestDescribeStacksWithFilter5(t *testing.T) {
 	assert.Equal(t, "ue2", tenant1Ue2DevStackComponentsTerraformComponentVarsEnvironment)
 	assert.Equal(t, "dev", tenant1Ue2DevStackComponentsTerraformComponentVarsStage)
 
-	stacksYaml, err := u.ConvertToYAML(stacks)
-	assert.Nil(t, err)
-	t.Log(stacksYaml)
+	if shouldLogVerbose() {
+		stacksYaml, err := u.ConvertToYAML(stacks)
+		assert.Nil(t, err)
+		t.Log(stacksYaml)
+	}
 }
 
 func TestDescribeStacksWithFilter6(t *testing.T) {
@@ -144,9 +167,11 @@ func TestDescribeStacksWithFilter6(t *testing.T) {
 	tenant1Ue2DevStackComponentsTerraformWorkspace := tenant1Ue2DevStackComponentsTerraformComponent["workspace"].(string)
 	assert.Equal(t, "tenant1-ue2-dev", tenant1Ue2DevStackComponentsTerraformWorkspace)
 
-	stacksYaml, err := u.ConvertToYAML(stacks)
-	assert.Nil(t, err)
-	t.Log(stacksYaml)
+	if shouldLogVerbose() {
+		stacksYaml, err := u.ConvertToYAML(stacks)
+		assert.Nil(t, err)
+		t.Log(stacksYaml)
+	}
 }
 
 func TestDescribeStacksWithFilter7(t *testing.T) {
@@ -171,9 +196,11 @@ func TestDescribeStacksWithFilter7(t *testing.T) {
 	tenant1Ue2DevStackComponentsTerraformWorkspace := tenant1Ue2DevStackComponentsTerraformComponent["workspace"].(string)
 	assert.Equal(t, "test-component-override-3-workspace", tenant1Ue2DevStackComponentsTerraformWorkspace)
 
-	stacksYaml, err := u.ConvertToYAML(stacks)
-	assert.Nil(t, err)
-	t.Log(stacksYaml)
+	if shouldLogVerbose() {
+		stacksYaml, err := u.ConvertToYAML(stacks)
+		assert.Nil(t, err)
+		t.Log(stacksYaml)
+	}
 }
 
 func TestDescribeStacksWithEmptyStacks(t *testing.T) {

pkg/utils/test_utils.go

@@ -0,0 +1,103 @@
+package utils
+
+import (
+	"fmt"
+	"os"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+// TestVerbosity controls the verbosity level of test output
+type TestVerbosity int
+
+const (
+	// TestVerbosityQuiet minimal output, only failures
+	TestVerbosityQuiet TestVerbosity = iota
+	// TestVerbosityNormal standard test output
+	TestVerbosityNormal
+	// TestVerbosityVerbose detailed test output
+	TestVerbosityVerbose
+)
+
+var (
+	// DefaultTestVerbosity is the default verbosity level for tests
+	DefaultTestVerbosity = TestVerbosityNormal
+	// Store descriptions to avoid repetition
+	printedDescriptions = make(map[string]bool)
+)
+
+// GetTestVerbosity returns the current test verbosity level
+func GetTestVerbosity() TestVerbosity {
+	verbStr := os.Getenv("ATMOS_TEST_VERBOSITY")
+	switch verbStr {
+	case "quiet":
+		return TestVerbosityQuiet
+	case "verbose":
+		return TestVerbosityVerbose
+	default:
+		return DefaultTestVerbosity
+	}
+}
+
+// TestLogf logs a message during test execution based on verbosity level
+func TestLogf(t *testing.T, minVerbosity TestVerbosity, format string, args ...interface{}) {
+	if GetTestVerbosity() >= minVerbosity {
+		t.Logf(format, args...)
+	}
+}
+
+// TestLog logs a message during test execution based on verbosity level
+func TestLog(t *testing.T, minVerbosity TestVerbosity, args ...interface{}) {
+	if GetTestVerbosity() >= minVerbosity {
+		t.Log(args...)
+	}
+}
+
+// LogTestDescription logs a test description only once to avoid repetition
+func LogTestDescription(t *testing.T, description string) {
+	if description == "" {
+		return
+	}
+
+	// Create a unique key for the description to avoid repetition within the same test
+	key := fmt.Sprintf("%s-%s", t.Name(), description)
+	if !printedDescriptions[key] {
+		if GetTestVerbosity() == TestVerbosityQuiet {
+			t.Logf("Test Description: %s", description)
+		} else {
+			t.Logf("\nTest Description: %s", description)
+		}
+		printedDescriptions[key] = true
+	}
+}
+
+// LogTestFailure logs detailed failure information based on verbosity
+func LogTestFailure(t *testing.T, description string, expected, actual interface{}, extraInfo ...string) {
+	LogTestDescription(t, description)
+
+	verbosity := GetTestVerbosity()
+	if verbosity == TestVerbosityQuiet {
+		t.Errorf("Expected: %v\nGot: %v", expected, actual)
+	} else {
+		t.Errorf("\nExpected: %v\nGot: %v", expected, actual)
+		if len(extraInfo) > 0 && verbosity >= TestVerbosityNormal {
+			t.Logf("Additional Info:\n%s", strings.Join(extraInfo, "\n"))
+		}
+	}
+}
+
+// AssertTestResult is a wrapper for testify/assert that respects verbosity
+func AssertTestResult(t *testing.T, assertion func() bool, description string, msgAndArgs ...interface{}) bool {
+	result := assertion()
+	if !result {
+		LogTestDescription(t, description)
+		return assert.True(t, result, msgAndArgs...)
+	}
+	if GetTestVerbosity() >= TestVerbosityVerbose {
+		LogTestDescription(t, description)
+		return assert.True(t, result, msgAndArgs...)
+	}
+	return result
+}