feat: improve how to use resource_group in modules #37
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 significantly refactors the resource group configuration within several Terraform modules. The change transitions from disparate variables to a unified object-based approach, enhancing the clarity and maintainability of the module interfaces. This standardization simplifies how users interact with resource group settings across various AWS services.
Highlights
- Module Version Update: The internal
resource-groupmodule dependency has been updated from version~> 0.10.0to~> 0.12.0across all affected modules. - Object-Based Resource Group Configuration: Individual
resource_group_enabled,resource_group_name, andresource_group_descriptionvariables have been consolidated into a single, structuredresource_groupobject variable. This simplifies configuration by grouping related settings. - Variable Reference Updates: All internal references within the affected modules have been updated to utilize the new
var.resource_group.*syntax, ensuring consistency with the new object-based configuration. - New Resource Group Output: A new
resource_groupoutput has been added to each updated module, providing direct access to the ARN and name of the created resource group, if enabled.
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
💾 eventbridge-event-bus
There was a problem hiding this comment.
Code Review
This pull request refactors the resource group configuration across multiple modules to use a more modern object-based variable pattern, which is a great improvement for usability and consistency. The changes are well-implemented. I've provided a couple of suggestions to further improve the consistency of the module outputs and the readability of the variable descriptions. These suggestions apply to all updated 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.
For better consistency in the module's output API, it's preferable for the resource_group output to always have the same shape, regardless of whether the resource group is enabled or not. This avoids consumers of the module having to check for the existence of the arn and name attributes.
You can achieve this by using a single conditional expression that returns a complete object with null values for arn and name when the resource group is disabled.
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
arn = null
name = null
}
)
| 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 |
There was a problem hiding this comment.
The indentation within the description heredoc is inconsistent. The first line has two spaces of indentation, while the subsequent lines describing the object attributes have four. For better readability of the generated documentation, it's best to have consistent indentation. I suggest removing the leading spaces from the first line and using a two-space indent for the attribute descriptions.
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
| 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.
For better consistency in the module's output API, it's preferable for the resource_group output to always have the same shape, regardless of whether the resource group is enabled or not. This avoids consumers of the module having to check for the existence of the arn and name attributes.
You can achieve this by using a single conditional expression that returns a complete object with null values for arn and name when the resource group is disabled.
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
arn = null
name = null
}
)
| 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 |
There was a problem hiding this comment.
The indentation within the description heredoc is inconsistent. The first line has two spaces of indentation, while the subsequent lines describing the object attributes have four. For better readability of the generated documentation, it's best to have consistent indentation. I suggest removing the leading spaces from the first line and using a two-space indent for the attribute descriptions.
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
| 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.
For better consistency in the module's output API, it's preferable for the resource_group output to always have the same shape, regardless of whether the resource group is enabled or not. This avoids consumers of the module having to check for the existence of the arn and name attributes.
You can achieve this by using a single conditional expression that returns a complete object with null values for arn and name when the resource group is disabled.
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
arn = null
name = null
}
)
| 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 |
There was a problem hiding this comment.
The indentation within the description heredoc is inconsistent. The first line has two spaces of indentation, while the subsequent lines describing the object attributes have four. For better readability of the generated documentation, it's best to have consistent indentation. I suggest removing the leading spaces from the first line and using a two-space indent for the attribute descriptions.
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
| 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.
For better consistency in the module's output API, it's preferable for the resource_group output to always have the same shape, regardless of whether the resource group is enabled or not. This avoids consumers of the module having to check for the existence of the arn and name attributes.
You can achieve this by using a single conditional expression that returns a complete object with null values for arn and name when the resource group is disabled.
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
arn = null
name = null
}
)
| 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 |
There was a problem hiding this comment.
The indentation within the description heredoc is inconsistent. The first line has two spaces of indentation, while the subsequent lines describing the object attributes have four. For better readability of the generated documentation, it's best to have consistent indentation. I suggest removing the leading spaces from the first line and using a two-space indent for the attribute descriptions.
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
| 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.
For better consistency in the module's output API, it's preferable for the resource_group output to always have the same shape, regardless of whether the resource group is enabled or not. This avoids consumers of the module having to check for the existence of the arn and name attributes.
You can achieve this by using a single conditional expression that returns a complete object with null values for arn and name when the resource group is disabled.
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
arn = null
name = null
}
)
| 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 |
There was a problem hiding this comment.
The indentation within the description heredoc is inconsistent. The first line has two spaces of indentation, while the subsequent lines describing the object attributes have four. For better readability of the generated documentation, it's best to have consistent indentation. I suggest removing the leading spaces from the first line and using a two-space indent for the attribute descriptions.
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
Summary
Update resource group configuration to use object-based pattern.
Changes
Modules Updated
Test Plan