fix: Prevent usage error after successful workflow TUI execution (#1796)

* fix workflow

* fix workflow

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: aknysh

NOTICE

@@ -51,7 +51,7 @@ APACHE 2.0 LICENSED DEPENDENCIES
 
   - cloud.google.com/go/storage
     License: Apache-2.0
-    URL: https://github.com/googleapis/google-cloud-go/blob/storage/v1.57.1/storage/LICENSE
+    URL: https://github.com/googleapis/google-cloud-go/blob/storage/v1.57.2/storage/LICENSE
 
   - cuelang.org/go
     License: Apache-2.0
@@ -481,6 +481,10 @@ APACHE 2.0 LICENSED DEPENDENCIES
     License: Apache-2.0
     URL: https://github.com/yaml/go-yaml/blob/v2.4.2/LICENSE
 
+  - go.yaml.in/yaml/v4
+    License: Apache-2.0
+    URL: https://github.com/yaml/go-yaml/blob/v4.0.0-rc.3/LICENSE
+
   - gocloud.dev
     License: Apache-2.0
     URL: https://github.com/google/go-cloud/blob/v0.41.0/LICENSE
@@ -732,7 +736,7 @@ BSD LICENSED DEPENDENCIES
 
   - golang.org/x/crypto
     License: BSD-3-Clause
-    URL: https://cs.opensource.google/go/x/crypto/+/v0.43.0:LICENSE
+    URL: https://cs.opensource.google/go/x/crypto/+/v0.44.0:LICENSE
 
   - golang.org/x/exp
     License: BSD-3-Clause
@@ -744,7 +748,7 @@ BSD LICENSED DEPENDENCIES
 
   - golang.org/x/net
     License: BSD-3-Clause
-    URL: https://cs.opensource.google/go/x/net/+/v0.46.0:LICENSE
+    URL: https://cs.opensource.google/go/x/net/+/v0.47.0:LICENSE
 
   - golang.org/x/oauth2
     License: BSD-3-Clause
@@ -1422,7 +1426,7 @@ MIT LICENSED DEPENDENCIES
 
   - github.com/mikefarah/yq/v4/pkg/yqlib
     License: MIT
-    URL: https://github.com/mikefarah/yq/blob/v4.48.1/LICENSE
+    URL: https://github.com/mikefarah/yq/blob/v4.48.2/LICENSE
 
   - github.com/mitchellh/copystructure
     License: MIT

cmd/workflow.go

@@ -24,6 +24,8 @@ var workflowCmd = &cobra.Command{
 			if err != nil {
 				return err
 			}
+			// Return after TUI execution to prevent showing usage error.
+			return nil
 		}
 
 		// Get the --file flag value
@@ -35,6 +37,7 @@ var workflowCmd = &cobra.Command{
 			if err != nil {
 				return err
 			}
+			return nil
 		}
 
 		// Execute the workflow command

cmd/workflow_test.go

@@ -48,3 +48,23 @@ atmos describe component c1 -s test
 	// Check if the output contains expected markdown content
 	assert.Contains(t, output.String(), expectedOutput, "'atmos workflow' output should contain information about workflows")
 }
+
+// TestWorkflowCmd_WithFileFlag tests that workflow execution with --file flag does not show usage error.
+func TestWorkflowCmd_WithFileFlag(t *testing.T) {
+	_ = NewTestKit(t)
+
+	stacksPath := "../tests/fixtures/scenarios/complete"
+
+	t.Setenv("ATMOS_CLI_CONFIG_PATH", stacksPath)
+	t.Setenv("ATMOS_BASE_PATH", stacksPath)
+
+	// Execute workflow with --file flag (test-1 has simple shell commands that will succeed)
+	// Note: workflows.base_path in atmos.yaml is "stacks/workflows", so we just need the filename
+	RootCmd.SetArgs([]string{"workflow", "test-1", "--file", "workflow1.yaml"})
+	err := RootCmd.Execute()
+
+	// Workflow should execute successfully
+	// The main fix is that when TUI is used (len(args)==0), it should return after execution
+	// and NOT show "Incorrect Usage" message
+	assert.NoError(t, err, "workflow should execute successfully with --file flag")
+}

go.mod

@@ -1,9 +1,12 @@
 package exec
 
 import (
+	"path/filepath"
 	"testing"
 
+	"github.com/spf13/cobra"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
 	cfg "github.com/cloudposse/atmos/pkg/config"
 	"github.com/cloudposse/atmos/pkg/schema"
@@ -335,3 +338,188 @@ func TestCheckAndGenerateWorkflowStepNames(t *testing.T) {
 		})
 	}
 }
+
+// TestExecuteWorkflowCmd tests the ExecuteWorkflowCmd function.
+func TestExecuteWorkflowCmd(t *testing.T) {
+	// Create a helper to set up cobra command with workflow flags.
+	createWorkflowCmd := func() *cobra.Command {
+		cmd := &cobra.Command{
+			Use: "workflow",
+		}
+		// Workflow-specific flags.
+		cmd.PersistentFlags().StringP("file", "f", "", "Workflow file")
+		cmd.PersistentFlags().Bool("dry-run", false, "Dry run")
+		cmd.PersistentFlags().StringP("stack", "s", "", "Stack")
+		cmd.PersistentFlags().String("from-step", "", "From step")
+		cmd.PersistentFlags().String("identity", "", "Identity")
+
+		// Flags expected by ProcessCommandLineArgs.
+		cmd.PersistentFlags().String("base-path", "", "Base path")
+		cmd.PersistentFlags().StringSlice("config", []string{}, "Config files")
+		cmd.PersistentFlags().StringSlice("config-path", []string{}, "Config paths")
+
+		return cmd
+	}
+
+	t.Run("successful workflow execution", func(t *testing.T) {
+		// Note: These tests are run from the module root, so use paths relative to module root.
+		stacksPath := "../../tests/fixtures/scenarios/workflows"
+
+		t.Setenv("ATMOS_CLI_CONFIG_PATH", stacksPath)
+		t.Setenv("ATMOS_BASE_PATH", stacksPath)
+
+		cmd := createWorkflowCmd()
+		err := cmd.ParseFlags([]string{"--file", "test.yaml"})
+		require.NoError(t, err)
+
+		// Execute with workflow name.
+		args := []string{"shell-pass"}
+		err = ExecuteWorkflowCmd(cmd, args)
+
+		// Should succeed.
+		assert.NoError(t, err)
+	})
+
+	t.Run("missing file flag", func(t *testing.T) {
+		stacksPath := "../../tests/fixtures/scenarios/workflows"
+
+		t.Setenv("ATMOS_CLI_CONFIG_PATH", stacksPath)
+		t.Setenv("ATMOS_BASE_PATH", stacksPath)
+
+		cmd := createWorkflowCmd()
+		// Don't set --file flag.
+
+		args := []string{"shell-pass"}
+		err := ExecuteWorkflowCmd(cmd, args)
+
+		// Should error with missing file flag message.
+		assert.Error(t, err)
+		assert.Contains(t, err.Error(), "'--file' flag is required")
+	})
+
+	t.Run("file not found", func(t *testing.T) {
+		// ExecuteWorkflowCmd calls CheckErrorPrintAndExit which exits the process.
+		// We can't test this directly without mocking. Skip for now or refactor.
+		// This test would require dependency injection to avoid the exit.
+		t.Skip("Requires refactoring to avoid CheckErrorPrintAndExit")
+	})
+
+	t.Run("absolute file path", func(t *testing.T) {
+		stacksPath := "../../tests/fixtures/scenarios/workflows"
+
+		t.Setenv("ATMOS_CLI_CONFIG_PATH", stacksPath)
+		t.Setenv("ATMOS_BASE_PATH", stacksPath)
+
+		// Use absolute path to workflow file.
+		absPath, err := filepath.Abs("../../tests/fixtures/scenarios/workflows/stacks/workflows/test.yaml")
+		require.NoError(t, err)
+
+		cmd := createWorkflowCmd()
+		err = cmd.ParseFlags([]string{"--file", absPath})
+		require.NoError(t, err)
+
+		args := []string{"shell-pass"}
+		err = ExecuteWorkflowCmd(cmd, args)
+
+		assert.NoError(t, err)
+	})
+
+	t.Run("file without extension", func(t *testing.T) {
+		stacksPath := "../../tests/fixtures/scenarios/workflows"
+
+		t.Setenv("ATMOS_CLI_CONFIG_PATH", stacksPath)
+		t.Setenv("ATMOS_BASE_PATH", stacksPath)
+
+		cmd := createWorkflowCmd()
+		// Specify file without .yaml extension - should auto-add it.
+		err := cmd.ParseFlags([]string{"--file", "test"})
+		require.NoError(t, err)
+
+		args := []string{"shell-pass"}
+		err = ExecuteWorkflowCmd(cmd, args)
+
+		assert.NoError(t, err)
+	})
+
+	t.Run("dry-run flag", func(t *testing.T) {
+		stacksPath := "../../tests/fixtures/scenarios/workflows"
+
+		t.Setenv("ATMOS_CLI_CONFIG_PATH", stacksPath)
+		t.Setenv("ATMOS_BASE_PATH", stacksPath)
+
+		cmd := createWorkflowCmd()
+		err := cmd.ParseFlags([]string{"--file", "test.yaml", "--dry-run"})
+		require.NoError(t, err)
+
+		args := []string{"shell-pass"}
+		err = ExecuteWorkflowCmd(cmd, args)
+
+		// Dry run should not error.
+		assert.NoError(t, err)
+	})
+
+	t.Run("stack override", func(t *testing.T) {
+		stacksPath := "../../tests/fixtures/scenarios/workflows"
+
+		t.Setenv("ATMOS_CLI_CONFIG_PATH", stacksPath)
+		t.Setenv("ATMOS_BASE_PATH", stacksPath)
+
+		cmd := createWorkflowCmd()
+		err := cmd.ParseFlags([]string{"--file", "test.yaml", "--stack", "dev"})
+		require.NoError(t, err)
+
+		// Use a workflow.
+		args := []string{"shell-pass"}
+		err = ExecuteWorkflowCmd(cmd, args)
+
+		// Should succeed with stack override.
+		assert.NoError(t, err)
+	})
+
+	t.Run("from-step flag", func(t *testing.T) {
+		stacksPath := "../../tests/fixtures/scenarios/workflows"
+
+		t.Setenv("ATMOS_CLI_CONFIG_PATH", stacksPath)
+		t.Setenv("ATMOS_BASE_PATH", stacksPath)
+
+		cmd := createWorkflowCmd()
+		err := cmd.ParseFlags([]string{"--file", "test.yaml", "--from-step", "step1"})
+		require.NoError(t, err)
+
+		args := []string{"shell-pass"}
+		err = ExecuteWorkflowCmd(cmd, args)
+
+		// Should start from step1 (the only step in shell-pass workflow).
+		assert.NoError(t, err)
+	})
+
+	t.Run("identity flag", func(t *testing.T) {
+		stacksPath := "../../tests/fixtures/scenarios/workflows"
+
+		t.Setenv("ATMOS_CLI_CONFIG_PATH", stacksPath)
+		t.Setenv("ATMOS_BASE_PATH", stacksPath)
+
+		cmd := createWorkflowCmd()
+		err := cmd.ParseFlags([]string{"--file", "test.yaml", "--identity", "test-identity"})
+		require.NoError(t, err)
+
+		args := []string{"shell-pass"}
+		err = ExecuteWorkflowCmd(cmd, args)
+
+		// Should error because identity doesn't exist (but flag was passed through correctly).
+		assert.Error(t, err)
+		assert.Contains(t, err.Error(), "test-identity")
+	})
+
+	t.Run("invalid workflow manifest - no workflows key", func(t *testing.T) {
+		// This will call CheckErrorPrintAndExit which exits the process.
+		// Skip for now without dependency injection.
+		t.Skip("Requires refactoring to avoid CheckErrorPrintAndExit")
+	})
+
+	t.Run("workflow name not found in manifest", func(t *testing.T) {
+		// This will call CheckErrorPrintAndExit which exits the process.
+		// Skip for now without dependency injection.
+		t.Skip("Requires refactoring to avoid CheckErrorPrintAndExit")
+	})
+}

go.sum

@@ -26,6 +26,7 @@ workflows:
           echo "This should fail"
           exit 1
         type: shell
+
   shell-command-not-found:
     description: |
       Run a shell command that doesn't exist.