Run kustomize build with kustomize localize and add a no-verify flag. #5544

sanaasy · 2024-02-18T20:14:31Z

Context

Closes issue: #5276

This PR adds functionality to auto-run kustomize build when the kustomize localize command is run. . This will run when --no-verify is not specified as false by the user or not specified at all when running the localize command. When the --no-verify flag is added, this check will be skipped.

🎩 Tophatted by doing:

make kustomize
~/go/bin/kustomize localize . localized-results
~/go/bin/kustomize localize . localized-results --no-verify
~/go/bin/kustomize localize . localized-results --scope "/Desktop"

k8s-ci-robot · 2024-02-18T20:14:33Z

This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

linux-foundation-easycla · 2024-02-18T20:14:35Z

The committers listed above are authorized under a signed CLA.

✅ login: sanaasy / name: Sanaa Syed (37ff927, af17fb8, 70e1b71, facafce, 3e0e54a, 2320042, 81503cb, b71c4d1, 2ccdf4e, cdd73c1)

k8s-ci-robot · 2024-02-18T20:14:39Z

Welcome @sanaasy!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kustomize has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2024-02-18T20:14:40Z

Hi @sanaasy. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

sanaasy · 2024-02-18T20:16:09Z

I'm still working on tests for this issue so keeping this in draft!

Edit: this is done!

k8s-ci-robot · 2024-02-27T03:12:56Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: christianh814, sanaasy
Once this PR has been reviewed and has the lgtm label, please assign stormqueen1990 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

kustomize/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

stormqueen1990

Hello there, @sanaasy! 👋

Thank you very much for your contribution.

With regards to using exec.Command, I am not sure if I understand the reasoning for choosing it over invoking the build command function directly, since localize and build are relatively co-located in the codebase. Would you mind elaborating on that decision?

kustomize/commands/localize/localize.go

sanaasy · 2024-02-28T03:11:25Z

With regards to using exec.Command, I am not sure if I understand the reasoning for choosing it over invoking the build command function directly, since localize and build are relatively co-located in the codebase. Would you mind elaborating on that decision?

Sure! When I first wrote the code, I didn't see that the build command makeBuildCommand from the commands package was exported to be used anywhere in the code. I chose to exec this way to remove the dependency on building the command itself in the localize file and executing the Run command. If this is the preferred method though, I am happy to change it!

stormqueen1990 · 2024-03-05T00:22:56Z

Sure! When I first wrote the code, I didn't see that the build command makeBuildCommand from the commands package was exported to be used anywhere in the code. I chose to exec this way to remove the dependency on building the command itself in the localize file and executing the Run command. If this is the preferred method though, I am happy to change it!

Hi there, @sanaasy! Sorry for the delay in responding!

I have some concerns with the exec.Command() approach. Specifically, this approach requires the executable to be present in $PATH, and because it shells out to a separate command, it might be running build in a version that yields a result different from what the caller would yield.

The scenario I have in mind is something like this:

I have a system-wide installation of Kustomize that exists under /usr/bin/kustomize, which is at version v4.5.7.
I downloaded v5.3.0 to /home/myuser/bin/kustomize.
I run /home/myuser/bin/kustomize localize, expecting that build will also be run from this instance.
Instead, kustomize localize shells out to /usr/bin/kustomize (the $PATH installation), which could have a different API (and might yield a different result).

Please let me know if my understanding is incorrect, or if this scenario doesn't make sense!

…e localize command is run.

sanaasy · 2024-03-05T16:34:12Z

I have some concerns with the exec.Command() approach. Specifically, this approach requires the executable to be present in $PATH, and because it shells out to a separate command, it might be running build in a version that yields a result different from what the caller would yield.

That's a fair callout! I have updated the PR to use the local build commands instead and have verified that things work as expected. If you could take another look please!

stormqueen1990

Hi there, @sanaasy! 👋🏻

Apologies for my delayed response! I took a look at the KEP for the localize command and found a few points that need changes.

Let me know if these make sense!

kustomize/commands/localize/localize.go

kustomize/commands/localize/localize_test.go

kustomize/commands/localize/localize.go

stormqueen1990

Hi there, @sanaasy! 👋🏻

Thank you for your contribution! 🙏🏻

This PR is well on its way, I just have a couple of suggestions in terms of test coverage.

stormqueen1990 · 2024-05-06T02:03:04Z

kustomize/commands/localize/localize_test.go

+  - name: helmTest
+    repo: testRepo


If you'd like to have something that pulls real content from somewhere, we have quite a few usages of

- name: external-dns repo: oci://registry-1.docker.io/bitnamicharts/

in tests.

stormqueen1990 · 2024-05-06T02:06:21Z

kustomize/commands/localize/localize_test.go

@@ -66,6 +82,58 @@ func TestScopeFlag(t *testing.T) {
 	loctest.CheckFs(t, testDir.String(), expected, actual)
 }

+func TestNoVerifyFlag(t *testing.T) {
+	kustomization := map[string]string{
+		"kustomization.yaml": `namePrefix: test-


I think it would be interesting to have an extra test case here with some localizable content. Perhaps a resource such as https://raw.githubusercontent.com/kubernetes-sigs/kustomize/v1.0.6/examples/helloWorld/deployment.yaml could be a good candidate (since it is part of this repo)?

stormqueen1990 · 2024-05-06T02:13:03Z

/test all

stormqueen1990 · 2024-05-06T02:13:19Z

/label tide/merge-method-squash

stormqueen1990

Found a few more bits!

stormqueen1990 · 2024-05-06T02:14:49Z

kustomize/commands/localize/localize.go

+				}
+
+				if localizedBuild == originalBuild {
+					log.Printf("VERIFICATION SUCCESS: `kustomize build` for %s and %s are the same after localization.", args.target, dst)


minor: I think this log could benefit of having a line break at the end, since Printf() won't add it by default.

stormqueen1990 · 2024-05-06T02:15:21Z

kustomize/commands/localize/localize.go

+					log.Printf("VERIFICATION SUCCESS: `kustomize build` for %s and %s are the same after localization.", args.target, dst)
+				} else {
+					log.Println(copyutil.PrettyFileDiff(originalBuild, localizedBuild))
+					log.Fatalf("VERFICATION FAILED: `kustomize build` for %s and %s are different after localization.", args.target, dst)


Would be nice to have a line break at the end of this message as well.

stormqueen1990 · 2024-05-06T02:17:39Z

kustomize/commands/localize/localize.go

@@ -62,6 +68,26 @@ kustomize localize https://github.com/kubernetes-sigs/kustomize//api/krusty/test
 			if err != nil {
 				return errors.Wrap(err)
 			}
+
+			if !f.noVerify && f.scope == "" {


localize with verification should still work even if --scope is specified.

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Feb 18, 2024

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 18, 2024

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 18, 2024

k8s-ci-robot requested review from ncapps and stormqueen1990 February 18, 2024 20:14

sanaasy marked this pull request as draft February 18, 2024 20:14

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 18, 2024

sanaasy force-pushed the sanaasy/add-no-verify-flag branch 4 times, most recently from b32e146 to a58784b Compare February 22, 2024 21:04

sanaasy force-pushed the sanaasy/add-no-verify-flag branch from a58784b to 874ec03 Compare February 27, 2024 01:15

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Feb 27, 2024

sanaasy force-pushed the sanaasy/add-no-verify-flag branch from 874ec03 to c576b85 Compare February 27, 2024 01:19

sanaasy marked this pull request as ready for review February 27, 2024 01:54

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 27, 2024

k8s-ci-robot requested a review from varshaprasad96 February 27, 2024 01:54

christianh814 approved these changes Feb 27, 2024

View reviewed changes

stormqueen1990 reviewed Feb 27, 2024

View reviewed changes

kustomize/commands/localize/localize.go Outdated Show resolved Hide resolved

sanaasy commented Feb 27, 2024

View reviewed changes

kustomize/commands/localize/localize.go Outdated Show resolved Hide resolved

sanaasy force-pushed the sanaasy/add-no-verify-flag branch from cf48606 to cc2aff7 Compare March 5, 2024 03:44

Add --no-verify flag configs along with kustomize build when kustomiz…

facafce

…e localize command is run.

sanaasy force-pushed the sanaasy/add-no-verify-flag branch from cc2aff7 to facafce Compare March 5, 2024 16:34

stormqueen1990 reviewed Mar 10, 2024

View reviewed changes

refactoring and working on failure test

37ff927

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 15, 2024

stormqueen1990 reviewed Mar 24, 2024

View reviewed changes

kustomize/commands/localize/localize.go Show resolved Hide resolved

sanaasy and others added 6 commits March 27, 2024 22:57

test commit on all refactoring changes

70e1b71

this is just a test commit with all my debugging

3e0e54a

pretty print

cdd73c1

adding scope back

2320042

start fixing up failing build test

2ccdf4e

clean up based on error cases

81503cb

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 3, 2024

finalize test

af17fb8

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 3, 2024

remove changes to build file

b71c4d1

stormqueen1990 reviewed May 6, 2024

View reviewed changes

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label May 6, 2024

stormqueen1990 reviewed May 6, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Run kustomize build with kustomize localize and add a no-verify flag. #5544

Run kustomize build with kustomize localize and add a no-verify flag. #5544

sanaasy commented Feb 18, 2024 •

edited

k8s-ci-robot commented Feb 18, 2024

linux-foundation-easycla bot commented Feb 18, 2024 •

edited

k8s-ci-robot commented Feb 18, 2024

k8s-ci-robot commented Feb 18, 2024

sanaasy commented Feb 18, 2024 •

edited

k8s-ci-robot commented Feb 27, 2024

stormqueen1990 left a comment

sanaasy commented Feb 28, 2024

stormqueen1990 commented Mar 5, 2024

sanaasy commented Mar 5, 2024

stormqueen1990 left a comment

stormqueen1990 left a comment

stormqueen1990 May 6, 2024

stormqueen1990 May 6, 2024

stormqueen1990 commented May 6, 2024

stormqueen1990 commented May 6, 2024

stormqueen1990 left a comment

stormqueen1990 May 6, 2024

stormqueen1990 May 6, 2024

stormqueen1990 May 6, 2024

Run kustomize build with kustomize localize and add a no-verify flag. #5544

Are you sure you want to change the base?

Run kustomize build with kustomize localize and add a no-verify flag. #5544

Conversation

sanaasy commented Feb 18, 2024 • edited

Context

🎩 Tophatted by doing:

k8s-ci-robot commented Feb 18, 2024

linux-foundation-easycla bot commented Feb 18, 2024 • edited

k8s-ci-robot commented Feb 18, 2024

k8s-ci-robot commented Feb 18, 2024

sanaasy commented Feb 18, 2024 • edited

k8s-ci-robot commented Feb 27, 2024

stormqueen1990 left a comment

Choose a reason for hiding this comment

sanaasy commented Feb 28, 2024

stormqueen1990 commented Mar 5, 2024

sanaasy commented Mar 5, 2024

stormqueen1990 left a comment

Choose a reason for hiding this comment

stormqueen1990 left a comment

Choose a reason for hiding this comment

stormqueen1990 May 6, 2024

Choose a reason for hiding this comment

stormqueen1990 May 6, 2024

Choose a reason for hiding this comment

stormqueen1990 commented May 6, 2024

stormqueen1990 commented May 6, 2024

stormqueen1990 left a comment

Choose a reason for hiding this comment

stormqueen1990 May 6, 2024

Choose a reason for hiding this comment

stormqueen1990 May 6, 2024

Choose a reason for hiding this comment

stormqueen1990 May 6, 2024

Choose a reason for hiding this comment

sanaasy commented Feb 18, 2024 •

edited

linux-foundation-easycla bot commented Feb 18, 2024 •

edited

sanaasy commented Feb 18, 2024 •

edited