Update atmos terraform commands that require processing of Go templates and Atmos YAML functions

[aknysh]

what

• Update atmos terraform commands that require processing of Go templates and Atmos YAML functions

why

• The following atmos terraform commands require processing of Go templates and Atmos YAML functions in Atmos manifests:

plan
apply
deploy
destroy
generate
output
shell
write
force-unlock
import
refresh
show
taint
untaint
validate
state list
state mv
state pull
state push
state replace-provider
state rm
state show

related

• https://github.com/cloudposse/atmos/releases/edit/v1.160.0

Summary by CodeRabbit

• Chores
  • Updated the Atmos CLI dependency to version 1.162.1 across configuration and workflow setups, providing users with access to the most recent improvements and fixes.

[mergify]

Important

Cloud Posse Engineering Team Review Required

This pull request modifies files that require Cloud Posse's review. Please be patient, and a core maintainer will review your changes.

To expedite this process, reach out to us on Slack in the #pr-reviews channel.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates the Atmos tool version from 1.162.0 to 1.162.1 across multiple components. The Dockerfile and GitHub Actions workflow configuration in the documentation now use the updated version. Additionally, the function needProcessTemplatesAndYamlFunctions in internal/exec/terraform_utils.go has been modified to include a broader set of commands for processing Go templates and Atmos YAML functions.

Changes

File(s)	Change Summary
examples/quick-start-advanced/Dockerfile website/docs/integrations/atlantis.mdx	Updated ATMOS_VERSION from 1.162.0 to 1.162.1 in the Docker build argument and GitHub Actions workflow configuration.
internal/exec/terraform_utils.go	Extended the needProcessTemplatesAndYamlFunctions function by adding new commands ("shell", "write", "force-unlock", "import", "refresh", "show", "taint", "untaint", "validate", "state list", "state mv", "state pull", "state push", "state replace-provider", "state rm", "state show").

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant TerraformUtils
    Caller->>TerraformUtils: call needProcessTemplatesAndYamlFunctions(command)
    Note right of TerraformUtils: Check if command requires template processing
    alt Command in extended list
        TerraformUtils-->>Caller: Process Go templates and Atmos YAML functions
    else Other commands
        TerraformUtils-->>Caller: Default processing
    end

Loading

Possibly related PRs

• Fix: condition to display help interactive menu #724: Modifies the ATMOS_VERSION in a different Dockerfile, establishing consistency in Atmos version updates.
• Mergify #862: Updates the ATMOS_VERSION in the GitHub Actions workflow configuration, aligning with the version changes in this PR.
• Merge atmos specific and terraform help documentation #857: Addresses version updates in the Dockerfile, providing a direct comparison with the modifications introduced here.

Suggested labels

minor

Suggested reviewers

• osterman
• mcalhoun

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 161c074 and 760741e.

📒 Files selected for processing (3)

• examples/quick-start-advanced/Dockerfile (1 hunks)
• internal/exec/terraform_utils.go (1 hunks)
• website/docs/integrations/atlantis.mdx (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• website/docs/integrations/atlantis.mdx

🧰 Additional context used

🧠 Learnings (1)

examples/quick-start-advanced/Dockerfile (2)

Learnt from: aknysh
PR: cloudposse/atmos#775
File: examples/quick-start-advanced/Dockerfile:9-9
Timestamp: 2024-11-12T05:52:05.088Z
Learning: It is acceptable to set `ARG ATMOS_VERSION` to a future version like `1.105.0` in `examples/quick-start-advanced/Dockerfile` if that will be the next release.

Learnt from: osterman
PR: cloudposse/atmos#801
File: examples/quick-start-advanced/Dockerfile:9-9
Timestamp: 2024-11-23T00:13:22.004Z
Learning: When updating the `ATMOS_VERSION` in Dockerfiles, the team prefers to pin to the next future version when the PR merges, even if the version is not yet released.

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Build (windows-latest, windows)
• GitHub Check: Summary

🔇 Additional comments (2)

internal/exec/terraform_utils.go (1)

126-141:

❓ Verification inconclusive

LGTM! Comprehensive expansion of template processing commands.

The addition of these commands aligns perfectly with the PR objectives. The expanded list now includes all relevant Terraform operations that might require Go template and Atmos YAML function processing.

Let's verify we haven't missed any important Terraform commands:

---

🏁 Script executed:

#!/bin/bash
# Description: Check if we've covered all relevant Terraform commands

# Get list of all terraform commands that might need template processing
terraform -help | grep -E "^\s+\w+\s+.*" | awk '{print $1}' | sort > /tmp/tf_commands.txt

# Compare with our list
echo "plan
apply
deploy
destroy
generate
output
shell
write
force-unlock
import
refresh
show
taint
untaint
validate
state list
state mv
state pull
state push
state replace-provider
state rm
state show" | sort > /tmp/our_commands.txt

# Show any commands we might have missed
echo "Potentially missing commands:"
comm -13 /tmp/our_commands.txt /tmp/tf_commands.txt

Length of output: 598

---

Heads up: Manual verification of Terraform commands is needed.

While the expanded commands list in internal/exec/terraform_utils.go appears aligned with the PR's intent, the automated shell script couldn’t complete as expected because the environment lacks the Terraform tool (resulting in a "terraform: command not found" error) and the comm utility was also unavailable. This means our automated check for missing commands is inconclusive.

• Missing tools: Terraform and comm are not available in the environment which prevented a complete comparison.
• Next steps: Please manually run the verification or ensure that the required tools are installed in your test environment to confirm that no additional Terraform commands are needed for template processing.

examples/quick-start-advanced/Dockerfile (1)

9-9: LGTM! Version update follows team conventions.

The update to ATMOS_VERSION=1.162.1 aligns with the team's practice of pinning to the next future version when the PR merges.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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.

[github-actions]

These changes were released in v1.162.1.

[osterman]

@aknysh I think we missed terraform clean

• atmos terraform clean does not expand templates #1043