properly handle stdout, stderr, and null (#1029)

* properly handle stdout, stderr, and null * update snapshots * fix test
cloudposse · Feb 9, 2025 · e24ba78 · e24ba78
1 parent 4267453
commit e24ba78
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 13 deletions.
diff --git a/cmd/root.go b/cmd/root.go
@@ -101,14 +101,25 @@ func setupLogger(atmosConfig *schema.AtmosConfiguration) {
 		log.SetLevel(log.InfoLevel)
 	}
 
-	if atmosConfig.Logs.File != "/dev/stderr" {
+	var output io.Writer
+
+	switch atmosConfig.Logs.File {
+	case "/dev/stderr":
+		output = os.Stderr
+	case "/dev/stdout":
+		output = os.Stdout
+	case "/dev/null":
+		output = io.Discard // More efficient than opening os.DevNull
+	default:
 		logFile, err := os.OpenFile(atmosConfig.Logs.File, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o666)
 		if err != nil {
 			log.Fatal("Failed to open log file:", err)
 		}
 		defer logFile.Close()
-		log.SetOutput(logFile)
+		output = logFile
 	}
+
+	log.SetOutput(output)
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.
@@ -183,7 +194,7 @@ func init() {
 		"Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout")
 
 	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/stdout", "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'")
 
 	// Set custom usage template
 	err := templates.SetCustomUsageFunc(RootCmd)

diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -75,7 +75,7 @@ var (
 			BasePath: "stacks/workflows",
 		},
 		Logs: schema.Logs{
-			File:  "/dev/stdout",
+			File:  "/dev/stderr",
 			Level: "Info",
 		},
 		Schemas: schema.Schemas{

diff --git a/tests/fixtures/scenarios/valid-log-level/atmos.yaml b/tests/fixtures/scenarios/valid-log-level/atmos.yaml
@@ -1,8 +1,8 @@
 logs:
   level: Trace
-  file: /dev/stdout
+  file: /dev/stderr
 
 stacks:
   base_path: stacks
   included_paths:
-    - "**/*" 
+    - "**/*"
diff --git a/tests/snapshots/TestCLICommands_Valid_Log_Level_in_Config_File.stderr.golden b/tests/snapshots/TestCLICommands_Valid_Log_Level_in_Config_File.stderr.golden
diff --git a/tests/snapshots/TestCLICommands_Valid_Log_Level_in_Environment_Variable.stderr.golden b/tests/snapshots/TestCLICommands_Valid_Log_Level_in_Environment_Variable.stderr.golden
diff --git a/tests/snapshots/TestCLICommands_atmos_--help.stdout.golden b/tests/snapshots/TestCLICommands_atmos_--help.stdout.golden
diff --git a/tests/snapshots/TestCLICommands_atmos_validate_editorconfig_--help.stdout.golden b/tests/snapshots/TestCLICommands_atmos_validate_editorconfig_--help.stdout.golden
diff --git a/tests/snapshots/TestCLICommands_atmos_validate_editorconfig_help.stdout.golden b/tests/snapshots/TestCLICommands_atmos_validate_editorconfig_help.stdout.golden
diff --git a/tests/test-cases/log-level-validation.yaml b/tests/test-cases/log-level-validation.yaml
@@ -54,7 +54,8 @@ tests:
       stdout:
         - '^\n👽 Atmos (\d+\.\d+\.\d+|test) on [a-z]+/[a-z0-9_]+\n\n$'
       stderr:
-        - "^$"
+        # This is actually an invalid debug statement, we are not passing the log level in the command line
+        - "DEBU Using command line argument"
       exit_code: 0
 
   - name: "Valid Log Level in Environment Variable"