internal/exec/terraform.go (1)

Line range hint 78-98: Overall changes effectively address all reported bugs.

The modifications to stack processing and component validation logic successfully fix all three reported issues with the atmos terraform clean command. The changes are minimal, focused, and maintain the existing behavior for other commands.

Consider adding integration tests to cover these specific scenarios to prevent regression:

1. atmos terraform clean --everything
2. atmos terraform clean -s <stack>
3. atmos terraform clean <component>

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

Learnt from: haitham911
PR: cloudposse/atmos#727
File: internal/exec/terraform_clean.go:407-416
Timestamp: 2024-11-24T19:13:10.287Z
Learning: In `internal/exec/terraform_clean.go`, when `getStackTerraformStateFolder` returns an error in the `handleCleanSubCommand` function, the error is logged, and the process continues without returning the error.

#!/bin/bash
# Description: Search for tests covering these scenarios

# Test: Look for clean command test cases
rg -A 5 "TestExecuteTerraform.*Clean" 

# Test: Search for clean command implementation details
ast-grep --pattern 'func $_(t *testing.T) {
  $$$
  clean
  $$$
}'

#!/bin/bash
# Let's try a broader search for test files and clean command implementation

# Search for test files related to terraform execution
fd "terraform.*test.*" --type f --exec rg -l "clean"

# Look for clean command implementation in terraform.go
rg -B 5 -A 10 "SubCommand == \"clean\"" internal/exec/terraform.go

# Search for any test functions that might test clean functionality
rg -B 2 -A 5 "func Test.*" --type go | rg -B 2 -A 5 -i "clean"

#!/bin/bash
# Let's examine the handleCleanSubCommand function implementation

# Search for handleCleanSubCommand function
ast-grep --pattern 'func handleCleanSubCommand($$$) {
  $$$
}'

# Look for any related error handling or validation logic
rg -B 2 -A 5 "handleCleanSubCommand" --type go

# Check for any clean-related constants or types that might affect the behavior
rg "clean" -i --type go internal/exec/

website/docs/cli/commands/terraform/usage.mdx (1)

Line range hint 62-66: Ensure consistency with the clean command documentation.

The description of the --everything flag's behavior should be consistent with the dedicated clean command documentation and clearly explain the confirmation prompt behavior.

-  Use the `--everything` flag is the default behavior to delete all the local Terraform state files and directories (including `terraform.tfstate.d`) for all components and stacks. 
-  Use the `--force` flag to bypass the safety confirmation prompt and force the deletion (use with caution).
-
-  :::warning
-  The `--everything` flag performs destructive operations that can lead to permanent state loss. Always ensure you have remote state configured in your components before proceeding.
-  :::
+  The command now defaults to the behavior of the `--everything` flag, which means it will:
+  - Delete all local Terraform state files and directories (including `terraform.tfstate.d`)
+  - Apply to all components and stacks
+  - Show a confirmation prompt before proceeding
+
+  Use the `--force` flag to bypass the safety confirmation prompt (use with extreme caution).
+
+  :::danger Data Loss Risk
+  This command performs destructive operations that can lead to permanent state loss:
+  1. Always ensure you have remote state configured in your components
+  2. Verify your state backups are current
+  3. Consider the impact on other team members
+  :::

internal/exec/help.go (1)

Line range hint 82-87: Fix typos and improve clarity in help text.

The help text contains typos and could be clearer about the default behavior.

-			"Use '--everything' flag —everything is the default behavior to delete the Terraform state files and and directories with confirm message.\n\n" +
-			"Use --force to forcefully delete Terraform state files and directories for the component.\n\n" +
-			"- If no component is specified, the command will apply to all components and stacks.\n" +
-			"- If no stack is specified, the command will apply to all stacks for the specified component.\n" +
-			"Use '--skip-lock-file' flag to skip deleting the '.terraform.lock.hcl' file.\n\n" +
-			"If no component or stack is specified, the clean operation will apply globally to all components.\n\n" +
+			"IMPORTANT: By default, this command will attempt to delete all Terraform state files and directories.\n" +
+			"A confirmation prompt will be shown before deletion.\n\n" +
+			"Flags:\n" +
+			"  --force        Bypass the confirmation prompt (use with extreme caution)\n" +
+			"  --skip-lock-file  Skip deleting the '.terraform.lock.hcl' file\n\n" +
+			"Scope:\n" +
+			"  - No component specified: Applies to all components and stacks\n" +
+			"  - No stack specified: Applies to all stacks for the specified component\n\n" +

Issues fixed:

1. Removed duplicate "and" in "state files and and directories"
2. Fixed em dash usage
3. Removed redundant information about global operation
4. Improved formatting for better readability

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

Learnt from: osterman
PR: cloudposse/atmos#727
File: internal/exec/terraform.go:114-118
Timestamp: 2024-11-12T05:52:05.088Z
Learning: When `atmos terraform clean --everything` is used without specifying a component and without the `--force` flag, prompt the user for confirmation before deleting all components. Use the `--force` flag to skip the confirmation prompt.

Learnt from: osterman
PR: cloudposse/atmos#727
File: internal/exec/terraform.go:114-118
Timestamp: 2024-11-12T05:52:05.088Z
Learning: When `atmos terraform clean --everything` is used without specifying a component and without the `--force` flag, prompt the user for confirmation before deleting all components. Use the `--force` flag to skip the confirmation prompt.

Learnt from: osterman
PR: cloudposse/atmos#727
File: internal/exec/terraform.go:114-118
Timestamp: 2024-11-12T05:52:05.088Z
Learning: When `atmos terraform clean --everything` is used without specifying a component and without the `--force` flag, prompt the user for confirmation before deleting all components. Use the `--force` flag to skip the confirmation prompt.

tests/cli_terraform_test.go (2)

13-42: Consider improving test setup maintainability.

The test setup could be enhanced in two ways:

1. Add documentation for the PathManager usage and its purpose
2. Consider making the working directory path configurable through environment variables or test parameters

+// TestCLITerraformClean validates the `atmos terraform clean` command by:
+// 1. Setting up the test environment with the correct PATH
+// 2. Running terraform apply commands to create state
+// 3. Verifying the clean command removes all state files
 func TestCLITerraformClean(t *testing.T) {
     // ... existing code ...
-    workDir := "../examples/quick-start-simple"
+    workDir := os.Getenv("ATMOS_TEST_WORKDIR")
+    if workDir == "" {
+        workDir = "../examples/quick-start-simple"
+    }

---

53-58: Remove unnecessary return after Fatalf.

The return statement after t.Fatalf() is redundant as Fatalf already terminates the test.

 if err != nil {
     t.Log(stdout.String())
     t.Fatalf("Failed to run terraform apply station -s dev: %v", stderr.String())
-    return
 }

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

tests/cli_terraform_test.go (2)

74-89: Add timeout handling and improve logging consistency.

The command execution should have a timeout to prevent hanging tests, and logging should be consistent across all command executions.

 func runTerraformApply(t *testing.T, binaryPath, environment string) {
+    t.Logf("Running terraform apply for environment: %s", environment)
     cmd := exec.Command(binaryPath, "terraform", "apply", "station", "-s", environment)
+    // Add timeout
+    ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
+    defer cancel()
+    cmd = exec.CommandContext(ctx, cmd.Path, cmd.Args[1:]...)
     envVars := os.Environ()
     envVars = append(envVars, "ATMOS_COMPONENTS_TERRAFORM_APPLY_AUTO_APPROVE=true")
     cmd.Env = envVars

     var stdout, stderr bytes.Buffer
     cmd.Stdout = &stdout
     cmd.Stderr = &stderr
     err := cmd.Run()
-    t.Log(stdout.String())
+    t.Logf("Command output:\n%s", stdout.String())
     if err != nil {
+        if ctx.Err() == context.DeadlineExceeded {
+            t.Fatalf("Command timed out after 5 minutes")
+        }
         t.Fatalf("Failed to run terraform apply station -s %s: %v", environment, stderr.String())
     }
 }

---

117-131: Improve error reporting in verification.

The verification function could provide more descriptive error messages and aggregate multiple failures.

 func verifyStateFilesDeleted(t *testing.T, stateFiles []string) {
+    var errors []string
     for _, file := range stateFiles {
         fileAbs, err := filepath.Abs(file)
         if err != nil {
             t.Fatalf("Failed to resolve absolute path for %q: %v", file, err)
         }
         _, err = os.Stat(fileAbs)
         if err == nil {
-            t.Errorf("Expected Terraform state file to be deleted: %q", fileAbs)
+            errors = append(errors, fmt.Sprintf("File still exists: %q", fileAbs))
         } else if !errors.Is(err, os.ErrNotExist) {
-            t.Errorf("Unexpected error checking file %q: %v", fileAbs, err)
+            errors = append(errors, fmt.Sprintf("Error checking %q: %v", fileAbs, err))
         }
     }
+    if len(errors) > 0 {
+        t.Errorf("Verification failed:\n%s", strings.Join(errors, "\n"))
+    }
 }

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro