Fix invalid command should not show terraform help

[samtholiya]

issue: https://linear.app/cloudposse/issue/DEV-2894/atmos-terraform-asdfasdf-should-show-error-message-instead-of-help

what

• We will now show error message if the command is invalid like:
  

• After Merge atmos specific and terraform help documentation #857 we would be getting rid of the help content that is seen above the error.
  This would then look like:
  

why

• Currently if customer executes invalid command we get the following help screen:
  
  This was not consistent with
  

references

• https://linear.app/cloudposse/issue/DEV-2894/atmos-terraform-asdfasdf-should-show-error-message-instead-of-help

Summary by CodeRabbit

• New Features

  • Enhanced error handling for the terraformCmd command, providing clearer feedback for command usage.

• Bug Fixes

  • Improved consistency in command execution return values to ensure proper error reporting.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request modifies the terraformCmd in cmd/terraform.go to improve error handling and command execution. The primary change involves transitioning from Run to RunE, which enables more robust error reporting. When an unknown subcommand is provided, the function now prints a specific error message and returns an error, enhancing user feedback during Terraform command interactions.

Changes

File	Change Summary
cmd/terraform.go	- Updated method signature from Run to RunE - Added explicit error handling for unknown subcommands - Standardized return statements to consistently return nil or an error

Assessment against linked issues

Objective	Addressed	Explanation
Show error for invalid Terraform subcommands [DEV-2894]	✅

Possibly related PRs

• Fix: condition to display help interactive menu #724: Command structure error handling improvements
• Do not process stack configs when executing command atmos vendor pull and the --stack flag is not specified #740: Error handling updates in vendor pull command
• improve custom command error message for missing arguments #752: Enhanced error messages for missing arguments
• handle invalid command error #766: Improved error handling for invalid commands
• add support for terraform version #846: Terraform version command support
• Fix terraform plan file should not be deleted #855: Modifications to Terraform execution cleanup logic

Suggested labels

patch

Suggested reviewers

• hans-d
• aknysh
• johncblandii

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary or @auto-summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

cmd/terraform.go (1)

41-41: Correct the spelling of “Unknkown”.

It should be spelled “Unknown” in both the error message and printed string.

- fmt.Printf(`Error: Unknkown command %q for %q`+"\n", args[0], cmd.CommandPath())
+ fmt.Printf(`Error: Unknown command %q for %q`+"\n", args[0], cmd.CommandPath())

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6a27442 and 50d09a6.

📒 Files selected for processing (1)

• cmd/terraform.go (4 hunks)

🔇 Additional comments (2)

cmd/terraform.go (2)

21-21: Good change to RunE.

Switching from Run to RunE allows for better error handling. This aligns with the PR’s objective to provide a clearer error message and more robust reporting.

---

56-56: Consistent return ensures proper run lifecycle.

Using return nil here complies with the RunE signature, signaling successful execution and preventing help output for invalid commands.

[osterman]

Won't this depend on:

• Merge atmos specific and terraform help documentation #857

[samtholiya]

Won't this depend on:

• Merge atmos specific and terraform help documentation #857

I realized it later why bother having multiple pr for the same issue. Closing this. (#857) will include this. But ofcourse the #857 is already having multiple fixes by now.