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.

Sign up for GitHub

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

Jump to bottom

Fix vendor pull directory creation issue #782

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+1 −1
Open

Fix vendor pull directory creation issue #782

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cf24006
folder creation vendor fix
Cerebrovinny Nov 14, 2024
1b5f112
display error logic
Cerebrovinny Nov 15, 2024
3159dbd
Revert "display error logic"
Cerebrovinny Nov 15, 2024
59a9602
restore condition to continue vendor process if not exists
Cerebrovinny Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion internal/exec/vendor_utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ func ExecuteVendorPullCommand(cmd *cobra.Command, args []string) error {

// Check `vendor.yaml`
vendorConfig, vendorConfigExists, foundVendorConfigFile, err := ReadAndProcessVendorConfigFile(cliConfig, cfg.AtmosVendorConfigFileName)
if err != nil {
if vendorConfigExists && err != nil {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should log a warning to make it easier to debug

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coderabbitai any suggestions?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@osterman, we can add a warning log when the vendor config file does not exist to make debugging easier. This way, we inform the user and allow the process to continue.

🧠 Learnings used 
Learnt from: Cerebrovinny
PR: cloudposse/atmos#737
File: internal/exec/vendor_utils.go:131-141
Timestamp: 2024-11-12T05:52:05.088Z
Learning: In the `ReadAndProcessVendorConfigFile` function in `internal/exec/vendor_utils.go`, the existence of the vendor config file is already checked, so additional file existence checks may be unnecessary.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coderabbitai please make the suggestion

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@osterman, to implement the warning log, we can modify the ReadAndProcessVendorConfigFile function to log a warning when the vendor config file does not exist and allow the process to continue. Here's how we can adjust the code:

In ReadAndProcessVendorConfigFile, after attempting to locate the vendor config file, check if the file does not exist, log a warning, set vendorConfigFileExists to false, and return without an error:

// After attempting to find the vendor config file
if !vendorConfigFileExists {
    u.LogWarning(cliConfig, fmt.Sprintf("Vendor config file '%s' does not exist. Proceeding without vendor configurations.", vendorConfigFile))
    return vendorConfig, vendorConfigFileExists, "", nil
}

In the calling function ExecuteVendorPullCommand, adjust the error handling condition to remove the check for vendorConfigExists, since the absence of the file is no longer an error:

- if vendorConfigExists && err != nil {
+ if err != nil {
    return err
}

This way, if the vendor config file is not present, a warning will be logged, and the process will continue without interruption.

Let me know if this approach works for you.

🧠 Learnings used 
Learnt from: Cerebrovinny
PR: cloudposse/atmos#737
File: internal/exec/vendor_utils.go:131-141
Timestamp: 2024-11-12T05:52:05.088Z
Learning: In the `ReadAndProcessVendorConfigFile` function in `internal/exec/vendor_utils.go`, the existence of the vendor config file is already checked, so additional file existence checks may be unnecessary.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Cerebrovinny ☝️

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

return err
}

Expand Down