DO NOT MERGE: Fix Terraform help printing log twice and causing error

cmd/cmd_utils.go

@@ -394,7 +394,7 @@ func printMessageForMissingAtmosConfig(cliConfig schema.CliConfiguration) {
 	c2 := color.New(color.FgGreen)
 
 	fmt.Println()
-	err := tuiUtils.PrintStyledText("ATMOS")
+	err := tuiUtils.PrintAtmosLogo()
 	if err != nil {
 		u.LogErrorAndExit(cliConfig, err)
 	}

cmd/root.go

@@ -26,38 +26,40 @@ var RootCmd = &cobra.Command{
 	Use:   "atmos",
 	Short: "Universal Tool for DevOps and Cloud Automation",
 	Long:  `Atmos is a universal tool for DevOps and cloud automation used for provisioning, managing and orchestrating workflows across various toolchains`,
-	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		// Determine if the command is a help command or if the help flag is set
-		isHelpCommand := cmd.Name() == "help"
-		helpFlag := cmd.Flags().Changed("help")
-
-		isHelpRequested := isHelpCommand || helpFlag
-
-		if isHelpRequested {
-			// Do not silence usage or errors when help is invoked
-			cmd.SilenceUsage = false
-			cmd.SilenceErrors = false
-		} else {
-			cmd.SilenceUsage = true
-			cmd.SilenceErrors = true
-		}
-	},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration
 		checkAtmosConfig()
 
-		// Print a styled Atmos logo to the terminal
-		fmt.Println()
-		err := tuiUtils.PrintStyledText("ATMOS")
+		// Print the Atmos logo
+		err := tuiUtils.PrintAtmosLogo()
 		if err != nil {
 			u.LogErrorAndExit(schema.CliConfiguration{}, err)
+			return
 		}
 
 		err = e.ExecuteAtmosCmd()
 		if err != nil {
 			u.LogErrorAndExit(schema.CliConfiguration{}, err)
 		}
 	},
+	PersistentPreRun: func(cmd *cobra.Command, args []string) {
+		// Determine if the command is a help command or if the help flag is set
+		isHelpCommand := cmd.Name() == "help"
+		helpFlag := cmd.Flags().Changed("help")
+
+		isHelpRequested := isHelpCommand || helpFlag
+
+		if isHelpRequested {
+			// Do not silence usage or errors when help is invoked
+			cmd.Root().SilenceUsage = false
+			cmd.Root().SilenceErrors = false
+		} else {
+			// For non-help commands, we want to control the error output
+			cmd.Root().SilenceUsage = true
+			// Only silence errors for unknown commands
+			cmd.Root().SilenceErrors = cmd.Parent() == nil
+		}
+	},
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.
@@ -80,11 +82,15 @@ func Execute() error {
 	// This custom help function will call the original help function and then display the bordered message.
 	RootCmd.SetHelpFunc(customHelpMessageToUpgradeToAtmosLatestRelease)
 
+	// Set custom error handling to prevent duplicate messages
+	RootCmd.SilenceErrors = true
+	RootCmd.SilenceUsage = true
+
 	// Check if the `help` flag is passed and print a styled Atmos logo to the terminal before printing the help
 	err := RootCmd.ParseFlags(os.Args)
-	if err != nil && errors.Is(err, pflag.ErrHelp) {
-		fmt.Println()
-		err = tuiUtils.PrintStyledText("ATMOS")
+	if err != nil && errors.Is(err, pflag.ErrHelp) ||
+		(len(os.Args) > 1 && (os.Args[len(os.Args)-1] == "help" || os.Args[len(os.Args)-1] == "--help")) {
+		err = tuiUtils.PrintAtmosLogo()
 		if err != nil {
 			u.LogErrorAndExit(schema.CliConfiguration{}, err)
 		}
@@ -140,9 +146,8 @@ func initConfig() {
 	RootCmd.SetUsageFunc(b.UsageFunc)
 
 	RootCmd.SetHelpFunc(func(command *cobra.Command, strings []string) {
-		// Print a styled Atmos logo to the terminal
-		fmt.Println()
-		err := tuiUtils.PrintStyledText("ATMOS")
+		// Print the Atmos logo
+		err := tuiUtils.PrintAtmosLogo()
 		if err != nil {
 			u.LogErrorAndExit(schema.CliConfiguration{}, err)
 		}

cmd/terraform.go

@@ -17,6 +17,15 @@ var terraformCmd = &cobra.Command{
 	Long:               `This command executes Terraform commands`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: true},
 	Run: func(cmd *cobra.Command, args []string) {
+		// Check if help is requested
+		if cmd.Flags().Changed("help") || (len(args) > 0 && args[0] == "help") {
+			err := e.ExecuteTerraformCmd(cmd, args, nil)
+			if err != nil {
+				u.LogErrorAndExit(schema.CliConfiguration{}, err)
+			}
+			return
+		}
+
 		// Check Atmos configuration
 		checkAtmosConfig()
 

cmd/version.go

@@ -19,9 +19,8 @@ var versionCmd = &cobra.Command{
 	Long:    `This command prints the CLI version`,
 	Example: "atmos version",
 	Run: func(cmd *cobra.Command, args []string) {
-		// Print a styled Atmos logo to the terminal
-		fmt.Println()
-		err := tuiUtils.PrintStyledText("ATMOS")
+		// Print the Atmos logo
+		err := tuiUtils.PrintAtmosLogo()
 		if err != nil {
 			u.LogErrorAndExit(schema.CliConfiguration{}, err)
 		}

internal/exec/helmfile.go

@@ -39,8 +39,7 @@ func ExecuteHelmfile(info schema.ConfigAndStacksInfo) error {
 
 	// If the user just types `atmos helmfile`, print Atmos logo and show helmfile help
 	if info.SubCommand == "" {
-		fmt.Println()
-		err = tuiUtils.PrintStyledText("ATMOS")
+		err = tuiUtils.PrintAtmosLogo()
 		if err != nil {
 			return err
 		}

internal/exec/terraform.go

@@ -10,7 +10,6 @@ import (
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 
-	tuiUtils "github.com/cloudposse/atmos/internal/tui/utils"
 	cfg "github.com/cloudposse/atmos/pkg/config"
 	"github.com/cloudposse/atmos/pkg/schema"
 	u "github.com/cloudposse/atmos/pkg/utils"
@@ -36,19 +35,9 @@ func ExecuteTerraformCmd(cmd *cobra.Command, args []string, additionalArgsAndFla
 
 // ExecuteTerraform executes terraform commands
 func ExecuteTerraform(info schema.ConfigAndStacksInfo) error {
-	cliConfig, err := cfg.InitCliConfig(info, true)
-	if err != nil {
-		return err
-	}
-
-	if info.NeedHelp {
-		return nil
-	}
-
-	// If the user just types `atmos terraform`, print Atmos logo and show terraform help
-	if info.SubCommand == "" {
-		fmt.Println()
-		err = tuiUtils.PrintStyledText("ATMOS")
+	// For help commands and empty subcommand, we don't need to process stacks
+	if info.NeedHelp || info.SubCommand == cfg.HelpFlag1 || info.SubCommand == cfg.HelpFlag2 || info.SubCommand == "" {
+		cliConfig, err := cfg.InitCliConfig(info, false)
 		if err != nil {
 			return err
 		}
@@ -57,11 +46,29 @@ func ExecuteTerraform(info schema.ConfigAndStacksInfo) error {
 		if err != nil {
 			return err
 		}
-
 		fmt.Println()
 		return nil
 	}
 
+	// For all other commands, we need to process stacks
+	cliConfig, err := cfg.InitCliConfig(info, true)
+	if err != nil {
+		return err
+	}
+
+	info, err = ProcessStacks(cliConfig, info, true, true)
+	if err != nil {
+		return err
+	}
+
+	if info.ComponentFromArg == "" {
+		return errors.New("component must be specified")
+	}
+
+	if len(info.Stack) < 1 {
+		return errors.New("stack must be specified")
+	}
+
 	shouldProcessStacks := true
 	shouldCheckStack := true
 	// Skip stack processing when cleaning with --everything or --force flags to allow

internal/exec/utils.go

@@ -41,6 +41,7 @@ var (
 		cfg.PlanFileFlag,
 		cfg.HelpFlag1,
 		cfg.HelpFlag2,
+		cfg.HelpFlag3,
 		cfg.WorkflowDirFlag,
 		cfg.JsonSchemaDirFlag,
 		cfg.OpaDirFlag,
@@ -221,10 +222,6 @@ func processCommandLineArgs(
 
 	// Check if `-h` or `--help` flags are specified
 	if argsAndFlagsInfo.NeedHelp {
-		err = processHelp(schema.CliConfiguration{}, componentType, argsAndFlagsInfo.SubCommand)
-		if err != nil {
-			return configAndStacksInfo, err
-		}
 		return configAndStacksInfo, nil
 	}
 
@@ -285,6 +282,16 @@ func ProcessStacks(
 
 	configAndStacksInfo.StackFromArg = configAndStacksInfo.Stack
 
+	// Initialize component section maps
+	configAndStacksInfo.ComponentSection = make(map[string]any)
+	configAndStacksInfo.ComponentVarsSection = make(map[string]any)
+	configAndStacksInfo.ComponentSettingsSection = make(map[string]any)
+	configAndStacksInfo.ComponentOverridesSection = make(map[string]any)
+	configAndStacksInfo.ComponentProvidersSection = make(map[string]any)
+	configAndStacksInfo.ComponentEnvSection = make(map[string]any)
+	configAndStacksInfo.ComponentBackendSection = make(map[string]any)
+	configAndStacksInfo.ComponentMetadataSection = make(map[string]any)
+
 	stacksMap, rawStackConfigs, err := FindStacksMap(cliConfig, false)
 	if err != nil {
 		return configAndStacksInfo, err
@@ -979,8 +986,11 @@ func processArgsAndFlags(componentType string, inputArgsAndFlags []string) (sche
 			info.SkipInit = true
 		}
 
-		if arg == cfg.HelpFlag1 || arg == cfg.HelpFlag2 {
+		if arg == cfg.HelpFlag1 || arg == cfg.HelpFlag2 || arg == cfg.HelpFlag3 {
 			info.NeedHelp = true
+			// For help commands, we don't need a component or stack
+			info.ComponentFromArg = ""
+			return info, nil
 		}
 
 		for _, f := range commonFlags {

internal/tui/utils/utils.go

@@ -2,7 +2,9 @@ package utils
 
 import (
 	"bytes"
+	"fmt"
 	"os"
+	"sync"
 
 	"github.com/alecthomas/chroma/quick"
 	"github.com/arsham/figurine/figurine"
@@ -19,6 +21,9 @@ func HighlightCode(code string, language string, syntaxTheme string) (string, er
 	return buf.String(), nil
 }
 
+// logoOnce ensures the ATMOS logo is printed exactly once
+var logoOnce sync.Once
+
 // PrintStyledText prints a styled text to the terminal
 func PrintStyledText(text string) error {
 	// Check if the terminal supports colors
@@ -27,3 +32,13 @@ func PrintStyledText(text string) error {
 	}
 	return nil
 }
+
+// logoOnce ensures thread-safe single execution of logo display
+func PrintAtmosLogo() error {
+	var err error
+	logoOnce.Do(func() {
+		fmt.Println()
+		err = PrintStyledText("ATMOS")
+	})
+	return err
+}

pkg/config/const.go

@@ -37,6 +37,7 @@ const (
 
 	HelpFlag1 = "-h"
 	HelpFlag2 = "--help"
+	HelpFlag3 = "-help"
 
 	ComponentVendorConfigFileName = "component.yaml"
 	AtmosVendorConfigFileName     = "vendor"