Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Replace deprecated splat expression with [*] for Terraform 1.5.… #7

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

sushmithakumar
Copy link

@sushmithakumar sushmithakumar commented Dec 20, 2024

Terraform 0.12.0+ Splat Operator Updates

What

Updated Terraform configuration to replace legacy splat syntax

(resource.*.attribute)

with modern bracket-based expressions (resource[*].attribute).
Incorporated for expressions where applicable to improve flexibility and readability.
No functional changes to infrastructure; these updates are syntax improvements.

Why

Aligns with Terraform 0.12.0+ enhancements and first-class expression support.
Improves readability and maintainability of Terraform code.
Prevents potential deprecation warnings by replacing outdated syntax.

References

Terraform v0.12.0 Upgrade Guide

Summary by CodeRabbit

  • Chores
    • Updated the method of constructing service_name_set in the configuration for improved clarity.

@sushmithakumar sushmithakumar requested a review from a team as a code owner December 20, 2024 06:55
Copy link

coderabbitai bot commented Dec 20, 2024

Walkthrough

The pull request introduces a minor modification to the Terraform configuration file src/main.tf, specifically changing the method of accessing service_name within the locals block. The change involves replacing the .* syntax with the [*] syntax for extracting service names from the local.quotas variable, which represents a subtle adjustment in how array or map elements are referenced.

Changes

File Change Summary
src/main.tf Modified service_name_set local variable construction, replacing .* with [*] syntax for extracting service names

Poem

🐰 A Terraform Hop of Syntax Delight

With brackets square and syntax bright,
From dot-star to list we take flight,
A gentle change, so clean and neat,
Our config dance is now complete!

🌟 Code hops on, precise and light! 🌟


🪧 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 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.

CodeRabbit Configuration 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.

@sushmithakumar
Copy link
Author

/terratest

Copy link

mergify bot commented Dec 20, 2024

Important

Title is necessary and should not be empty.

Kindly provide a meaningful title for this Pull Request.

Copy link

mergify bot commented Dec 20, 2024

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟠 Require terratest

Waiting checks: test/terratest.

This rule require terratest status

  • check-success = test/terratest

Copy link

@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 (2)
src/main.tf (2)

3-3: LGTM! Correct usage of the modern splat expression syntax.

The change from .* to [*] aligns with Terraform's recommended syntax for splat expressions introduced in version 0.12+. This is a safe, non-functional change that improves code maintainability.

Consider using a for expression as an alternative, which might be more explicit:

-  service_name_set = toset(compact(values(local.quotas)[*].service_name))
+  service_name_set = toset([for quota in values(local.quotas) : quota.service_name if quota.service_name != null])

This eliminates the need for the compact() function and makes the null checking more explicit.


Line range hint 1-85: Well-structured configuration with good documentation and error handling.

The overall configuration demonstrates several good practices:

  1. Clear documentation of API limitations and workarounds
  2. Proper handling of default values and drift
  3. Well-structured data transformations
  4. Good use of Terraform's map and set operations

Consider adding a README.md or HCL comments documenting the expected format of the var.quotas input variable, as it's a critical part of this configuration.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4d15ad8 and 9e61a92.

📒 Files selected for processing (1)
  • src/main.tf (1 hunks)

@mergify mergify bot added the needs-test Needs testing label Dec 25, 2024
@GabisCampana
Copy link

@goruha

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-test Needs testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants