Deprecation of Kitchen-Terraform

[brettcurtis]

Fixes #35

Summary by CodeRabbit

• New Features

  • Introduced automated Terraform tests that trigger on specific GitHub events.
  • Added a new test configuration for Terraform commands.

• Documentation

  • Updated GitHub Actions badges and development setup commands in the README.
  • Simplified the list of development tools and adjusted directory paths in documentation.

• Chores

  • Updated pre-commit hooks to a newer version for enhanced YAML checks and file fixers.

[infracost]

💰 Infracost report

Monthly cost will not change

Changed project	Baseline cost	Usage cost*	Total change	New monthly cost
fixtures-default	+$0	+$15	+$15	$15
test-fixtures-default_bucket	+$0	-$15	-$15	$0

*Usage costs were estimated using Infracost Cloud settings, see docs for other options.

Cost details

Key: * usage cost, ~ changed, + added, - removed

──────────────────────────────────
Project: fixtures-default
Module path: fixtures/default

+ module.storage_bucket.google_storage_bucket.this
  +$15

    + Storage (standard)
      +$5, +192 GiB*

    + Object adds, bucket/object list (class A)
      +$5, +100 10k operations*

    + Object gets, retrieve bucket/object metadata (class B)
      +$5, +1,250 10k operations*

    + Network egress
    
        + Data transfer to worldwide excluding Asia, Australia (first 1TB)
          Monthly cost depends on usage
            +$0.12 per GB
    
        + Data transfer to Asia excluding China, but including Hong Kong (first 1TB)
          Monthly cost depends on usage
            +$0.12 per GB
    
        + Data transfer to China excluding Hong Kong (first 1TB)
          Monthly cost depends on usage
            +$0.23 per GB
    
        + Data transfer to Australia (first 1TB)
          Monthly cost depends on usage
            +$0.19 per GB

Monthly cost change for fixtures-default (Module path: fixtures/default)
Amount:  +$15 ($0.00 → $15)

──────────────────────────────────
Project: test-fixtures-default_bucket
Module path: test/fixtures/default_bucket

- module.storage_bucket.google_storage_bucket.this
  -$15

    - Storage (standard)
      -$5, -192 GiB*

    - Object adds, bucket/object list (class A)
      -$5, -100 10k operations*

    - Object gets, retrieve bucket/object metadata (class B)
      -$5, -1,250 10k operations*

    - Network egress
    
        - Data transfer to worldwide excluding Asia, Australia (first 1TB)
          Monthly cost depends on usage
            -$0.12 per GB
    
        - Data transfer to Asia excluding China, but including Hong Kong (first 1TB)
          Monthly cost depends on usage
            -$0.12 per GB
    
        - Data transfer to China excluding Hong Kong (first 1TB)
          Monthly cost depends on usage
            -$0.23 per GB
    
        - Data transfer to Australia (first 1TB)
          Monthly cost depends on usage
            -$0.19 per GB

Monthly cost change for test-fixtures-default_bucket (Module path: test/fixtures/default_bucket)
Amount:  -$15 ($15 → $0.00)

──────────────────────────────────
Key: * usage cost, ~ changed, + added, - removed

*Usage costs were estimated using Infracost Cloud settings, see docs for other options.

1 cloud resource was detected:
∙ 1 was estimated

Governance checks

🟢 53 passed

52 FinOps policies and 1 Tagging policy passed.

_{View report in Infracost Cloud. This comment will be updated when code changes.}

[coderabbitai]

Walkthrough

Walkthrough

The changes introduce a new GitHub workflow for Terraform testing, update pre-commit hooks, modify README documentation, adjust module source paths in Terraform configurations, and add a test configuration file. These updates are likely in response to the deprecation of Kitchen-Terraform, aiming to transition to a native Terraform test framework.

Changes

File Path	Change Summary
.github/workflows/test.yml	New GitHub action workflow for Terraform testing.
.pre-commit-config.yaml	Updated pre-commit hooks from v4.5.0 to v4.6.0.
README.md	Updated GitHub Actions badges, directory paths, development tools list, and local setup commands.
fixtures/default/main.tf	Changed the source path for the storage_bucket module.
fixtures/default/tests/...	New test configuration using the apply action.

Assessment against linked issues

Objective	Addressed	Explanation
Tests re-written using native test framework [#35, #17, #16, #63, #107, #36, #20, #29, #18, #95]	✅

Possibly related issues

• osinfra-io/terraform-google-cloud-nat#17: The changes introduce a new testing framework which could replace Kitchen-Terraform.
• osinfra-io/terraform-google-cloud-dns#16: Similar to above, the introduction of a new test configuration suggests alignment with transitioning away from Kitchen-Terraform.
• Deprecation of Kitchen-Terraform terraform-google-kubernetes-engine#63: The added test configuration in this PR aligns with the objectives to replace Kitchen-Terraform.
• Deprecation of Kitchen-Terraform terraform-google-project#107: The updates in testing approach in this PR could address the deprecation of Kitchen-Terraform mentioned in this issue.
• Deprecation of Kitchen-Terraform terraform-google-cloud-sql#36: The new workflow and testing configurations suggest a move away from Kitchen-Terraform, aligning with this issue's objectives.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 36cdff5 and 5b082ec.

Files selected for processing (1)

• README.md (5 hunks)

Additional comments not posted (6)

README.md (6)

5-5: Updated GitHub Actions badges correctly reflect the new workflows.

---

23-23: Updated directory path in the Usage section helps users locate example configurations more easily.

---

53-61: Added commands for setting up a local development environment are clear and helpful.

---

77-77: Specifying the provider version ensures compatibility and clarity for users.

---

Line range hint 1-1: Consider adding alt text to images to improve accessibility.

---

25-25: Consider adding alt text to images to improve accessibility.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.