Skip to content

Add atmos terraform generate planfile command#1214

Merged
aknysh merged 34 commits intomainfrom
terraform-generate-planfile
Apr 24, 2025
Merged

Add atmos terraform generate planfile command#1214
aknysh merged 34 commits intomainfrom
terraform-generate-planfile

Conversation

@aknysh
Copy link
Member

@aknysh aknysh commented Apr 23, 2025 •
edited by osterman
Loading

what

  • Add atmos terraform generate planfile command
  • Add unit tests
  • Update docs

why

Use the atmos terraform generate planfile command to generate a planfile for an Atmos Terraform/OpenTofu component in a stack in JSON or YAML formats.

Usage

Execute the terraform generate planfile command like this:

atmos terraform generate planfile <component> -s <stack> [options]

This command generates a planfile for an Atmos terraform component in a stack.

Examples

atmos terraform generate planfile component1 -s plat-ue2-dev
atmos terraform generate planfile component1 -s plat-ue2-prod --format=json
atmos terraform generate planfile component1 -s plat-ue2-prod --format=yaml
atmos terraform generate planfile <component> -s <stack> --file=planfile.json
atmos terraform generate planfile <component> -s <stack> --format=yaml --file=planfiles/planfile.yaml
atmos terraform generate planfile <component> -s <stack> --file=/Users/me/Documents/atmos/infra/planfile.json

Validate Terraform/OpenTofu planfiles using Checkov

You can generate a planfile for a component in a stack and validate it using Checkov.

atmos terraform generate planfile <component> -s <stack>
checkov --file components/terraform/<component>/<stack>-<component>.planfile.json --framework terraform_plan

Refer to Evaluate Checkov Policies on Terraform Plan for more information.

Summary by CodeRabbit

  • New Features
    • Introduced a new CLI command to generate Terraform planfiles for specified components, supporting JSON and YAML output formats.
  • Documentation
    • Added comprehensive documentation for the new planfile generation command, including usage instructions, examples, and validation guidance.
    • Updated examples and integration docs to reflect the latest CLI version and improved template usage in documentation.
  • Bug Fixes
    • Improved quoting in template functions and documentation examples to ensure correct string rendering in JSON outputs.
  • Tests
    • Added extensive tests for the new planfile generation feature, covering standard operation and error scenarios.
  • Chores
    • Upgraded multiple dependencies and bumped the CLI version to 1.172.0.
    • Enhanced style consistency in code comments.

@aknysh aknysh added the minor New features that do not break anything label Apr 23, 2025
@aknysh aknysh self-assigned this Apr 23, 2025
@aknysh aknysh requested review from a team as code owners April 23, 2025 14:39
@aknysh aknysh requested a review from osterman April 23, 2025 18:29
osterman
osterman reviewed Apr 23, 2025
View reviewed changes
@aknysh @osterman
Update website/docs/cli/commands/terraform/terraform-generate-planfil…
d4e5f53 
…e.mdx

Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>
coderabbitai[bot]
coderabbitai bot previously approved these changes Apr 23, 2025
View reviewed changes
@aknysh aknysh requested a review from osterman April 23, 2025 21:29
coderabbitai[bot]
coderabbitai bot reviewed Apr 23, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
internal/exec/terraform_generate_planfile.go (1)

212-212: Use the defined error format constant for consistency

The error wrapping format string is used directly here, while other locations use the ErrWrappingFormat constant.

-		return fmt.Errorf("%w: %w", ErrConvertingJsonToGoType, err)
+		return fmt.Errorf(ErrWrappingFormat, ErrConvertingJsonToGoType, err)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d4e5f53 and 90c81a9.

📒 Files selected for processing (3)
  • internal/exec/terraform_generate_planfile.go (1 hunks)
  • internal/exec/terraform_generate_planfile_test.go (1 hunks)
  • tests/fixtures/scenarios/terraform-generate-planfile/atmos.yaml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • tests/fixtures/scenarios/terraform-generate-planfile/atmos.yaml
  • internal/exec/terraform_generate_planfile_test.go
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Build (windows-latest, windows)
  • GitHub Check: Summary
🔇 Additional comments (6)
internal/exec/terraform_generate_planfile.go (6)

17-24: Errors are appropriately defined

Good job defining comprehensive error variables to clarify different types of errors that might occur during execution. This improves error handling and makes debugging easier.

26-35: Well-designed options structure

The PlanfileOptions struct provides a clean way to group related parameters, solving the "too many arguments" issue identified in previous reviews. This pattern improves maintainability and readability.

37-93: Command execution function looks solid

The function thoroughly validates inputs, properly extracts flags, and safely passes pointers to the execution function. The early check for empty arguments at line 39 prevents panic conditions.

95-165: Core execution function is well-structured

The function has been nicely refactored into smaller, focused helper functions that follow the single responsibility principle. The temporary directory is properly managed with deferred cleanup.

125-136: Good resource management

Properly creating and cleaning up the temporary directory with a deferred function call. The warning log on cleanup failure is a thoughtful addition.

167-223: Helper functions are well-designed

Breaking the functionality into smaller, focused helper functions improves readability and testability. Each function has a clear purpose and appropriate error handling.

@aknysh aknysh requested a review from osterman April 24, 2025 00:01
@aknysh aknysh merged commit b4203b6 into main Apr 24, 2025
51 checks passed
@aknysh aknysh deleted the terraform-generate-planfile branch April 24, 2025 00:18
@mergify mergify bot removed the needs-cloudposse Needs Cloud Posse assistance label Apr 24, 2025
@cfsb-jrose
Copy link

cfsb-jrose commented Apr 28, 2025

Hello! I am currently testing this new functionality and finding that it's hanging.

Initializing the backend...

Successfully configured the backend "s3"! Terraform will automatically
use this backend unless the backend configuration changes.
Initializing provider plugins...
- Reusing previous version of hashicorp/aws from the dependency lock file
- Using previously-installed hashicorp/aws v5.96.0

Terraform has been successfully initialized!

Not quite sure how to debug or troubleshoot further. Suggestions?

@osterman
Copy link
Member

osterman commented Apr 29, 2025

@cfsb-jrose can you re-run the command with --log-level=Debug? Can you include the complete command as well?

@cfsb-jrose
Copy link

cfsb-jrose commented Apr 29, 2025

@osterman sure! I'll add to #1223

@coderabbitai coderabbitai bot mentioned this pull request Aug 16, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Sep 23, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Oct 4, 2025
Merged
6 tasks
@coderabbitai coderabbitai bot mentioned this pull request Nov 7, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 28, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Dec 16, 2025
Closed
@coderabbitai coderabbitai bot mentioned this pull request Dec 24, 2025
Open
@coderabbitai coderabbitai bot mentioned this pull request Jan 16, 2026
Merged
@coderabbitai coderabbitai bot mentioned this pull request Mar 10, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@osterman osterman osterman approved these changes

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

@aknysh aknysh

Labels

minor New features that do not break anything

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

atmos terraform generate plan should create JSON file

3 participants

@aknysh @cfsb-jrose @osterman