feat: improve how to use resource_group in modules #76
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @posquit0, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request streamlines the management of AWS resource groups within several core modules. By refactoring how resource group configurations are defined and referenced, it enhances the modularity and maintainability of the codebase. The changes aim to provide a more consistent and intuitive way to interact with resource group settings across the affected modules.
Highlights
- Module Version Update: The internal
resource-groupmodule version has been updated from~> 0.10.0to~> 0.12.0across all affected modules. - Variable Refactoring: Individual
resource_group_enabled,resource_group_name, andresource_group_descriptionvariables have been consolidated into a single, object-basedresource_groupvariable for a more structured configuration. - Reference Updates: All internal references within the modules have been updated to utilize the new
var.resource_group.attributestructure, ensuring consistency with the refactored variable. - New Output Added: A new
resource_groupoutput has been introduced in each updated module to expose details of the managed resource group, such as its ARN and name.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
github-actions
bot
added
💾 nacl
There was a problem hiding this comment.
Code Review
This pull request refactors the resource group configuration across several modules to use a more modern object-based pattern. This is a great improvement for consistency and maintainability. My review includes suggestions to simplify the implementation of the new resource_group output in each module for better readability. I also noticed a minor misplacement of a variable definition in one of the modules.
| value = merge( | ||
| { | ||
| enabled = var.resource_group.enabled && var.module_tags_enabled | ||
| }, | ||
| (var.resource_group.enabled && var.module_tags_enabled | ||
| ? { | ||
| arn = module.resource_group[0].arn | ||
| name = module.resource_group[0].name | ||
| } | ||
| : {} | ||
| ) | ||
| ) |
There was a problem hiding this comment.
The use of merge here makes the code a bit complex to read. You can simplify this by using a ternary operator for the entire value, which is more direct and readable.
value = (var.resource_group.enabled && var.module_tags_enabled) ? {
enabled = true
arn = module.resource_group[0].arn
name = module.resource_group[0].name
} : {
enabled = false
}
| value = merge( | ||
| { | ||
| enabled = var.resource_group.enabled && var.module_tags_enabled | ||
| }, | ||
| (var.resource_group.enabled && var.module_tags_enabled | ||
| ? { | ||
| arn = module.resource_group[0].arn | ||
| name = module.resource_group[0].name | ||
| } | ||
| : {} | ||
| ) | ||
| ) |
There was a problem hiding this comment.
The use of merge here makes the code a bit complex to read. You can simplify this by using a ternary operator for the entire value, which is more direct and readable.
value = (var.resource_group.enabled && var.module_tags_enabled) ? {
enabled = true
arn = module.resource_group[0].arn
name = module.resource_group[0].name
} : {
enabled = false
}
| value = merge( | ||
| { | ||
| enabled = var.resource_group.enabled && var.module_tags_enabled | ||
| }, | ||
| (var.resource_group.enabled && var.module_tags_enabled | ||
| ? { | ||
| arn = module.resource_group[0].arn | ||
| name = module.resource_group[0].name | ||
| } | ||
| : {} | ||
| ) | ||
| ) |
There was a problem hiding this comment.
The use of merge here makes the code a bit complex to read. You can simplify this by using a ternary operator for the entire value, which is more direct and readable.
value = (var.resource_group.enabled && var.module_tags_enabled) ? {
enabled = true
arn = module.resource_group[0].arn
name = module.resource_group[0].name
} : {
enabled = false
}
| value = merge( | ||
| { | ||
| enabled = var.resource_group.enabled && var.module_tags_enabled | ||
| }, | ||
| (var.resource_group.enabled && var.module_tags_enabled | ||
| ? { | ||
| arn = module.resource_group[0].arn | ||
| name = module.resource_group[0].name | ||
| } | ||
| : {} | ||
| ) | ||
| ) |
There was a problem hiding this comment.
The use of merge here makes the code a bit complex to read. You can simplify this by using a ternary operator for the entire value, which is more direct and readable.
value = (var.resource_group.enabled && var.module_tags_enabled) ? {
enabled = true
arn = module.resource_group[0].arn
name = module.resource_group[0].name
} : {
enabled = false
}
| value = merge( | ||
| { | ||
| enabled = var.resource_group.enabled && var.module_tags_enabled | ||
| }, | ||
| (var.resource_group.enabled && var.module_tags_enabled | ||
| ? { | ||
| arn = module.resource_group[0].arn | ||
| name = module.resource_group[0].name | ||
| } | ||
| : {} | ||
| ) | ||
| ) |
There was a problem hiding this comment.
The use of merge here makes the code a bit complex to read. You can simplify this by using a ternary operator for the entire value, which is more direct and readable.
value = (var.resource_group.enabled && var.module_tags_enabled) ? {
enabled = true
arn = module.resource_group[0].arn
name = module.resource_group[0].name
} : {
enabled = false
}
| variable "resource_group" { | ||
| description = <<EOF | ||
| (Optional) A configurations of Resource Group for this module. `resource_group` as defined below. | ||
| (Optional) `enabled` - Whether to create Resource Group to find and group AWS resources which are created by this module. Defaults to `true`. | ||
| (Optional) `name` - The name of Resource Group. A Resource Group name can have a maximum of 127 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with `AWS` or `aws`. If not provided, a name will be generated using the module name and instance name. | ||
| (Optional) `description` - The description of Resource Group. Defaults to `Managed by Terraform.`. | ||
| EOF | ||
| type = object({ | ||
| enabled = optional(bool, true) | ||
| name = optional(string, "") | ||
| description = optional(string, "Managed by Terraform.") | ||
| }) | ||
| default = {} | ||
| nullable = false | ||
| } |
There was a problem hiding this comment.
For better organization and consistency with other modules in this PR, this resource_group variable block should be placed under the # Resource Group section header, around line 325. It's currently placed at the end of the file.
| value = merge( | ||
| { | ||
| enabled = var.resource_group.enabled && var.module_tags_enabled | ||
| }, | ||
| (var.resource_group.enabled && var.module_tags_enabled | ||
| ? { | ||
| arn = module.resource_group[0].arn | ||
| name = module.resource_group[0].name | ||
| } | ||
| : {} | ||
| ) | ||
| ) |
There was a problem hiding this comment.
The use of merge here makes the code a bit complex to read. You can simplify this by using a ternary operator for the entire value, which is more direct and readable.
value = (var.resource_group.enabled && var.module_tags_enabled) ? {
enabled = true
arn = module.resource_group[0].arn
name = module.resource_group[0].name
} : {
enabled = false
}
1 participant
Summary
Update resource group configuration to use object-based pattern.
Changes
Modules Updated
Test Plan