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

[sanaasy]

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:

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

[k8s-ci-robot]

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]

The committers listed above are authorized under a signed CLA.

• ✅ login: sanaasy / name: Sanaa Syed (8db4c4b, b679598)

[k8s-ci-robot]

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]

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]

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

Edit: this is done!

[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?

[sanaasy]

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]

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!

[sanaasy]

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! 👋🏻

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]

/test all

[stormqueen1990]

/label tide/merge-method-squash

[stormqueen1990]

Found a few more bits!

[stormqueen1990]

Thank you very much for your contribution! 🙏🏻

/lgtm

[stormqueen1990]

/label tide/merge-method-squash

[varshaprasad96]

Suggested change

	log.Println(copyutil.PrettyFileDiff(originalBuild, localizedBuild))
	log.Println(copyutil.PrettyFileDiff(originalBuild, localizedBuild))

Curious: Is it intentional to add this log statement and explicitly mention the diff?

[sanaasy]

Yes! This is what the KEP outlined:

The command indicates success if the outputs match and throws an error with a diff summary otherwise. 

https://github.com/kubernetes-sigs/kustomize/blob/master/proposals/22-04-localize-command.md

[sanaasy]

/lgtm

[k8s-ci-robot]

@sanaasy: you cannot LGTM your own PR.

In response to this:

/lgtm

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-sigs/prow repository.

[k8s-ci-robot]

@kushp: changing LGTM is restricted to collaborators

In response to this:

/lgtm

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-sigs/prow repository.

[stormqueen1990]

/lgtm
/ok-to-test

[stormqueen1990]

/remove-label tide/merge-method-squash

[varshaprasad96]

The changes look good!

@sanaasy Thanks for the contribution!
@stormqueen1990 Thanks for reviewing and following this through! :))

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: christianh814, sanaasy, varshaprasad96

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

The pull request process is described here

Needs approval from an approver in each of these files:

• kustomize/OWNERS [varshaprasad96]

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

[k8s-ci-robot]

New changes are detected. LGTM label has been removed.

[sanaasy]

@stormqueen1990 @varshaprasad96 👋 hello again! After Varsha had approved the PR, it ran into a lint error. I've fixed the line that was too long and split it up using string concatenation and have retested the lint, the build locally and the test files. Could you two have another look? Thank you again! Hopefully this should be the last step.