Support *.tofu and .*tofu.json file detection

[wazy]

Description

Fixes/implements #4061.

Glob *.tofu and *.tofu.json extensions so an error about no *.tf files doesn't occur.

Release Notes (draft)

Added support for *.tofu and *.tofu.json files to prevent error of no *.tf files detected.

Summary by CodeRabbit

• New Features
  • Extended configuration file detection to include OpenTofu file formats alongside Terraform.
• Bug Fixes
  • Updated error messages to clearly indicate when neither supported file type is present.
• Tests
  • Added new scenarios validating directories with various combinations of Terraform and OpenTofu files.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
terragrunt-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 21, 2025 6:45pm

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates the CLI to support OpenTofu file extensions. The error message now specifies that neither Terraform (.tf) nor OpenTofu (.tofu) files were found. The file scanning function in the run command has been extended to include both *.tofu and *.tofu.json patterns. Additionally, new test cases have been added to verify the functionality for directories containing OpenTofu files alongside Terraform files.

Changes

Files	Change Summary
cli/commands/run/errors.go	Updated error message in NoTerraformFilesFound.Error() to include both Terraform (.tf) and OpenTofu (.tofu) file types.
cli/commands/run/run.go, cli/commands/run/run_test.go	Extended file scanning in CheckFolderContainsTerraformCode to include *.tofu and *.tofu.json. Added corresponding tests to validate directories with OpenTofu files.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant R as CheckFolderContainsTerraformCode
    participant FS as FileSystem
    participant E as NoTerraformFilesFound

    U->>R: Initiate file check in directory
    R->>FS: Search for *.tf & *.tf.json files
    FS-->>R: Return Terraform file list
    R->>FS: Search for *.tofu & *.tofu.json files
    FS-->>R: Return OpenTofu file list
    alt Files Found
        R-->>U: Return success with file list
    else No Files Found
        R->>E: Create NoTerraformFilesFound error
        E-->>R: Return error message ("...Terraform nor OpenTofu files were found")
        R-->>U: Return error
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Support OpenTofu file extensions for some CLI options (#4061)	✅

Suggested reviewers

• levkohimins
• denis256

---

📜 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 03cacad and 4f56877.

📒 Files selected for processing (3)

• cli/commands/run/errors.go (1 hunks)
• cli/commands/run/run.go (1 hunks)
• cli/commands/run/run_test.go (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.go`: Review the Go code for quality and correctness. Make sure that the Go code follows best practices, is performant, and is easy to understand and maintain.

**/*.go: Review the Go code for quality and correctness. Make sure that the Go code follows best practices, is performant, and is easy to understand and maintain.

• cli/commands/run/errors.go
• cli/commands/run/run.go
• cli/commands/run/run_test.go

🔇 Additional comments (6)

cli/commands/run/errors.go (1)

41-42: Clean error message update to include OpenTofu files.

The error message has been updated to include OpenTofu files (*.tofu) when no Terraform configuration files are found in the specified path. This change aligns well with the PR's objective to support OpenTofu file extensions.

cli/commands/run/run.go (2)

543-548: *Good implementation for detecting .tofu files.

This implementation follows the same pattern as the existing code for detecting Terraform files. The error handling is properly implemented, and the discovered files are correctly appended to the list.

---

557-562: *Good implementation for detecting .tofu.json files.

The implementation correctly detects OpenTofu JSON files using the same pattern as existing Terraform JSON file detection. Error handling and file list management are properly implemented.

cli/commands/run/run_test.go (3)

99-108: Good test coverage for plain OpenTofu files.

Added test cases to verify that directories containing only OpenTofu files or a combination of Terraform and OpenTofu files are properly detected. This ensures the implemented functionality works correctly.

---

115-123: Good test coverage for JSON formatted OpenTofu files.

These test cases verify that the implementation correctly handles directories containing JSON formatted OpenTofu files or combinations with Terraform JSON files. Comprehensive test coverage helps ensure reliability.

---

125-125: Updated test description to include OpenTofu.

The test description for the "directory with no files" case has been properly updated to reflect that both Terraform and OpenTofu files are checked, maintaining consistency with the implementation changes.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @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 to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai 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.

[yhakbar]

Thanks for your contribution @wazy !