fix: open skaffold-overrides.yaml: no such file or directory since up grading to skaffold "v2.15.0" (#9788) #9849
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
Summary of Changes
Hello @vellotis, 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 addresses a critical bug where the skaffold-overrides.yaml file was prematurely deleted, leading to 'no such file or directory' errors during Helm rendering. The fix involves refactoring the file creation and deletion logic, moving the responsibility for cleanup to the calling function (generateHelmManifest). This ensures the temporary overrides file is available for the entire duration it's needed by Helm, and then correctly removed. The changes also include new unit tests to validate the corrected behavior and new test utility functions.
Highlights
- File Handling Refactor: The logic for creating and managing the lifecycle of the
skaffold-overrides.yamlfile has been extracted from thetemplateArgsfunction inargs.goand moved to the higher-levelgenerateHelmManifestfunction inhelm.go. - Deferred File Deletion: The deletion of
skaffold-overrides.yamlis now properly deferred within thegenerateHelmManifestfunction. This ensures the file exists for the duration of Helm rendering and is cleaned up afterwards, resolving the 'no such file or directory' error. - New Helper Function: A new helper function,
generateSkaffoldOverrides, was introduced inhelm.goto encapsulate the creation of theskaffold-overrides.yamlfile and return a cleanup function (closure) to its caller. - Improved Test Coverage: Comprehensive unit tests have been added in a new file (
helm_test.go) for thegenerateSkaffoldOverridesfunction, covering scenarios for no overrides, successful file creation and deletion, and error handling during file operations or YAML marshaling. - Test Utilities: New utility functions (
CheckFileNotExist,CheckFileExist) were added to thetestutilpackage to facilitate more robust file system assertions in tests.
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 or fill out our survey to provide feedback.
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. ↩
There was a problem hiding this comment.
Code Review
This pull request correctly fixes a bug where skaffold-overrides.yaml was deleted prematurely by moving the deferred file removal to the caller function. The addition of unit tests for the new generateSkaffoldOverrides function is a great improvement.
I've identified a few areas for improvement:
- A minor simplification in the error handling and defer logic in
helm.go. - A typo in a new test function name.
- More importantly, the new test helper functions
CheckFileExistandCheckFileNotExistintestutil/util.gohave correctness issues in their error handling which could lead to incorrect test outcomes. I've provided suggestions to make them more robust.
520cdec to
56a0591
Compare
…grading to skaffold "v2.15.0" (GoogleContainerTools#9788)
56a0591 to
c491b26
Compare
|
@vellotis Thank you for submitting this fix! |
Fixes: #9788
Description
The creation of
skaffold-overrides.yamlwas handled inside the Helm template arguments generation function. Thedeferto delete this file was also performed inside the same function. As a result the outer function requiring theskaffold-overrides.yamlwhile executing Helm rendering threwopen skaffold-overrides.yaml: no such file or directory.This fix moves the
skaffold-overrides.yamlfile deletion to the caller function.