feat: auto-build images for skaffold verify #9942
Conversation
When no --build-artifacts flag is provided, skaffold verify now automatically builds the artifacts referenced in verify test cases. This improves UX by allowing `skaffold verify` to work out of the box without requiring a separate build step. Fixes GoogleContainerTools#9506
|
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. |
Summary of ChangesHello @rophy, 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 enhances the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a useful feature to automatically build artifacts for skaffold verify when they are not pre-built. The implementation looks good, with new logic in doVerify to handle the auto-build path and a new helper function targetArtifactsForVerify to select the correct artifacts. The addition of unit tests for the new logic is also great. I have one suggestion to improve the robustness and efficiency of the new targetArtifactsForVerify function.
| func targetArtifactsForVerify(configs []util.VersionedConfig) []*latest.Artifact { | ||
| verifyImgs := getVerifyImgs(configs) | ||
|
|
||
| var artifacts []*latest.Artifact | ||
| for _, cfg := range configs { | ||
| for _, artifact := range cfg.(*latest.SkaffoldConfig).Build.Artifacts { | ||
| // Only include artifacts that are referenced in verify test cases | ||
| if verifyImgs[artifact.ImageName] { | ||
| artifacts = append(artifacts, artifact) | ||
| } | ||
| } | ||
| } | ||
| return artifacts | ||
| } |
There was a problem hiding this comment.
This function can be made more robust and slightly more efficient with a couple of changes:
- Early exit: If
getVerifyImgsreturns no images, we can exit early instead of iterating through all artifacts. - Safe type assertion: The type assertion
cfg.(*latest.SkaffoldConfig)will panic ifcfgis not of the expected type. Using the_, okform is safer. - Pre-allocation: We can pre-allocate the
artifactsslice with a capacity based on the number of verify images to avoid potential reallocations.
func targetArtifactsForVerify(configs []util.VersionedConfig) []*latest.Artifact {
verifyImgs := getVerifyImgs(configs)
if len(verifyImgs) == 0 {
return nil
}
artifacts := make([]*latest.Artifact, 0, len(verifyImgs))
for _, cfg := range configs {
skaffoldConfig, ok := cfg.(*latest.SkaffoldConfig)
if !ok {
continue
}
for _, artifact := range skaffoldConfig.Build.Artifacts {
// Only include artifacts that are referenced in verify test cases
if verifyImgs[artifact.ImageName] {
artifacts = append(artifacts, artifact)
}
}
}
return artifacts
}There was a problem hiding this comment.
Thanks for the review! I addressed 2 of the 3 suggestions:
✅ Early exit - Applied
✅ Pre-allocation - Applied
❌ Safe type assertion - Not applied. The existing code in cmd/skaffold/app/cmd/ consistently uses direct type assertions (cfg.(*latest.SkaffoldConfig)) without the safe form - see dev.go:69, exec.go:99, build.go:101, filter.go:159,163,180, deploy.go:48. The safe form is only used in pkg/skaffold/. To maintain consistency within this package, I kept the direct assertion.
1 participant
Fixes: #9506
Description
When no
--build-artifactsflag is provided,skaffold verifynow automatically builds the artifacts referenced in verify test cases. Only artifacts whose image names are used in verify containers are built.Changes:
doVerify()to callr.Build()when no pre-built artifacts are providedtargetArtifactsForVerify()to filter build artifacts to only those referenced in verify test casesgetVerifyImgs()andtargetArtifactsForVerify()User facing changes
Before:
$ skaffold verify Error: no tag provided for image [bootstrap]Workaround required:
After:
Automatically builds images referenced in verify test cases, then runs verification
Existing behavior preserved when
--build-artifactsis provided:Uses pre-built images, no build phase