feat: support for `.yml` and `.yaml` file extensions for component vendoring by RoseSecurity · Pull Request #725 · cloudposse/atmos

RoseSecurity · 2024-10-15T16:03:33Z

what

Support for .yml and .yaml when vendoring using component.yaml
This change introduces a simple check into

alternative solutions

No modification of the constants, check if component.yaml exists before checking if component.yml exists

	componentConfigFile := path.Join(componentPath, cfg.ComponentVendorConfigFileName)
	if !u.FileExists(componentConfigFile) {
		componentConfigFileYML := path.Join(componentPath, "component.yml")
		if !u.FileExists(componentConfigFileYML) {
			return componentConfig, "", fmt.Errorf("component vendoring config file '%s' or 'component.yml' does not exist in the '%s' folder",
				cfg.ComponentVendorConfigFileName,
				componentPath,
			)
		}
		componentConfigFile = componentConfigFileYML
	}

	componentConfigFileContent, err := os.ReadFile(componentConfigFile)

Modify constant and add helper function

var possibleConfigExtensions = []string{"yaml", "yml"}

func findComponentConfigFile(basePath, fileName string, extensions []string) (string, error) {
    for _, ext := range extensions {
        configFilePath := path.Join(basePath, fmt.Sprintf("%s.%s", fileName, ext))
        if u.FileExists(configFilePath) {
            return configFilePath, nil
        }
    }
    return "", fmt.Errorf("component vendoring config file does not exist in the '%s' folder", basePath)
}

componentConfigFile, err := findComponentConfigFile(componentPath, "component", possibleConfigExtensions)
if err != nil {
    return componentConfig, "", err
}

why

The tool is strict about needing component.yaml, file ending for yaml files is a matter of preference and both should be accepted.

testing

make build

# component.yml
❯ ./build/atmos vendor pull -c aurora-postgres-resources
Pulling sources for the component 'aurora-postgres-resources' from 'github.com/cloudposse/terraform-aws-components.git//modules/aurora-postgres-resources?ref=1.511.0' into 
'/Users/infra/components/terraform/aurora-postgres-resources'

# component.yaml
❯ ./build/atmos vendor pull -c aurora-postgres-resources
Pulling sources for the component 'aurora-postgres-resources' from 'github.com/cloudposse/terraform-aws-components.git//modules/aurora-postgres-resources?ref=1.511.0' into 
'/Users/infra/components/terraform/aurora-postgres-resources'

# Missing both
❯ ./build/atmos vendor pull -c aurora-postgres-resources
component vendoring config file does not exist in the '/Users/infra/components/terraform/aurora-postgres-resources' folder

references

Closes the following issue

Summary by CodeRabbit

New Features
- Enhanced file existence checks for component configuration, now supporting both .yaml and .yml file formats.
Refactor
- Streamlined variable declarations for improved readability without changing logic.

osterman · 2024-10-15T17:28:08Z

@coderabbitai full review

coderabbitai · 2024-10-15T17:28:13Z

✅ Actions performed

Full review triggered.

coderabbitai · 2024-10-15T17:28:16Z

📝 Walkthrough

Walkthrough

The changes in this pull request involve the introduction of a new function, findComponentConfigFile, in the internal/exec/vendor_component_utils.go file. This function enhances the logic for identifying component configuration files by checking for both component.yaml and component.yml extensions. Additionally, the ReadAndProcessComponentVendorConfigFile function has been updated to utilize this new function. Several variable declarations in ExecuteComponentVendorInternal have also been modified for consistency and clarity, using short variable declaration syntax.

Changes

File	Change Summary
internal/exec/vendor_component_utils.go	Added `findComponentConfigFile` function to check for `component.yaml` and `component.yml`. Updated `ReadAndProcessComponentVendorConfigFile` to use this function. Modified variable declarations in `ExecuteComponentVendorInternal` for clarity.

Poem

In the land of code where rabbits play,
We check for files in a brand new way!
With yaml and yml, we’ll never stray,
Streamlined variables brighten our day.
Hops of joy as functions align,
In the garden of code, all works out fine! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

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

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 94e0226 and 51e759b.

📒 Files selected for processing (1)

internal/exec/vendor_component_utils.go (3 hunks)

🧰 Additional context used

🔇 Additional comments (1)

internal/exec/vendor_component_utils.go (1)

Line range hint 1-438: Summary: Changes successfully implement PR objectives with minor suggestions for improvement.

The modifications in this file successfully implement support for both .yaml and .yml file extensions for component vendoring, aligning with the PR objectives. The changes also improve path handling for local files, enhancing the overall functionality of the component vendoring process.

Key improvements:

Added support for component.yml in addition to component.yaml.

Enhanced error messages to include both file extensions.

Improved path handling for local file sources.

Suggestions for further improvement:

Consider using constants for file extensions to improve maintainability.

Add comments to explain the purpose of new logic, especially for local file handling.

Overall, the changes are well-implemented and achieve the desired functionality. The suggested improvements are minor and aimed at enhancing code clarity and maintainability.

internal/exec/vendor_component_utils.go

osterman · 2024-10-15T20:12:05Z

@RoseSecurity I like option 2, but defer to @aknysh

internal/exec/vendor_component_utils.go

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 51e759b and 8f176fa.

📒 Files selected for processing (1)

internal/exec/vendor_component_utils.go (4 hunks)

🧰 Additional context used

🔇 Additional comments (2)

internal/exec/vendor_component_utils.go (2)

66-68: LGTM! Changes align with PR objective.

The modification to use findComponentConfigFile correctly implements the support for both .yaml and .yml file extensions. This change is consistent with the new function's implementation and fulfills the PR's objective.

Line range hint 1-450: Overall, the changes successfully implement the PR objectives.

The modifications in this file successfully add support for both .yml and .yaml file extensions for component vendoring. The new findComponentConfigFile function and the updates to ReadAndProcessComponentVendorConfigFile directly address the PR's main objective. Additional changes in ExecuteComponentVendorInternal improve code consistency and enhance local file handling.

The implementation aligns with the second solution discussed in the PR, which proposed modifying a constant and adding a helper function. While the constant wasn't modified, the helper function (findComponentConfigFile) was added to streamline the process of finding the configuration file.

Minor suggestions for adding comments have been made to improve code clarity. Overall, the changes are well-implemented and improve the functionality of the component vendoring process.

internal/exec/vendor_component_utils.go

github-actions · 2024-10-16T05:43:56Z

These changes were released in v1.91.0.

feat: initial support for yml files for component vendoring

51e759b

coderabbitai bot reviewed Oct 15, 2024

View reviewed changes

internal/exec/vendor_component_utils.go Outdated Show resolved Hide resolved

RoseSecurity and others added 2 commits October 15, 2024 16:59

Merge branch 'main' into support-yml-for-component-vendoring

178c877

add helper function

8f176fa

RoseSecurity commented Oct 15, 2024

View reviewed changes

internal/exec/vendor_component_utils.go Show resolved Hide resolved

RoseSecurity changed the title ~~feat: initial support for .yml and .yaml files for component vendoring~~ feat: support for .yml and .yaml file extensions for component vendoring Oct 15, 2024

osterman reviewed Oct 16, 2024

View reviewed changes

internal/exec/vendor_component_utils.go Show resolved Hide resolved

aknysh approved these changes Oct 16, 2024

View reviewed changes

aknysh marked this pull request as ready for review October 16, 2024 05:15

aknysh requested review from a team as code owners October 16, 2024 05:15

aknysh requested review from jamengual and kevcube October 16, 2024 05:15

aknysh added the minor New features that do not break anything label Oct 16, 2024

coderabbitai bot reviewed Oct 16, 2024

View reviewed changes

internal/exec/vendor_component_utils.go Show resolved Hide resolved

internal/exec/vendor_component_utils.go Show resolved Hide resolved

aknysh merged commit 7a25ba3 into cloudposse:main Oct 16, 2024

coderabbitai bot mentioned this pull request Oct 20, 2024

get atmos config and vendor from .yaml or .yml #736

Merged

This was referenced Nov 27, 2024

Added Support for Automatic Templated File Search for Atmos Imports #795

Merged

Fix vendor pull directory creation issue #782

Merged

This was referenced Dec 14, 2024

Replace path.Join with filepath.Join #856

Merged

refactor checkAtmosConfig #861

Closed

Uh oh!

Conversation

RoseSecurity commented Oct 15, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

what

alternative solutions

why

testing

references

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

osterman commented Oct 15, 2024

Uh oh!

coderabbitai bot commented Oct 15, 2024

Uh oh!

coderabbitai bot commented Oct 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

osterman commented Oct 15, 2024

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

RoseSecurity commented Oct 15, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 15, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)