fix: Allow patches with empty files with multiple newlines or comments #5771

jchanam · 2024-09-27T09:58:16Z

Right now, when a file is empty, the patches given by the resmap (sm patches) or the jsonpatch is nil. When the file has only comments in it (virtually empty if we think about changes to be made) or multiple newlines, the result given by said functions is an empty slice.

I've changed the check for when we can't allow to have a patch that is valid for both SM and JSON, so it allows empty changes (both nil or empty slices).

Extra comments:

I think that it'd be better to change the functions and return a nil object, instead of an empty slice, but I'm unsure on where to do those changes.
Also, I can't make the tests to run locally as they complain for the content file to be empty, and that should not be the case as it's perfectly ok for the built binary to use empty patches.

I'll be more than happy to work on these two with some help or guidance.

…a patch

k8s-ci-robot · 2024-09-27T09:58:18Z

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

k8s-ci-robot · 2024-09-27T09:58:25Z

Welcome @jchanam!

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-09-27T09:58:26Z

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

jchanam · 2024-10-14T14:45:04Z

Hi @stormqueen1990 @varshaprasad96,

Could I get some help in getting this approved?

Thank you!

stormqueen1990 · 2024-11-08T19:04:59Z

Hi @stormqueen1990 @varshaprasad96,

Could I get some help in getting this approved?

Thank you!

Hi there, @jchanam!

I am taking a look at this and got a bit confused with the comment you made in the PR description about the tests. Do you mean that tests are currently failing locally?

stormqueen1990 · 2024-11-08T19:09:07Z

/test all

jchanam · 2024-11-18T08:25:21Z

Hi @stormqueen1990 ,

Yes, I meant that. It looks like there are a test checking if the input is not empty, but the goal of my code is testing specifically that, as it should not fail. If we add a file to kustomize that is empty, it should simply not produce any output, instead of failing.

Also, now the tests here say that there's a diff found on the file I've modified. How can I fix that or change extra code so the tests continue?

Thank you!

plugin/builtin/patchtransformer/PatchTransformer_test.go

stormqueen1990 · 2024-11-26T19:48:59Z

/test all

Signed-off-by: Julio Chana <[email protected]>

jchanam · 2024-12-26T15:48:47Z

@stormqueen1990 Sorry for the late response. I think I was able to follow your guidance and fix the tests.

jchanam · 2024-12-26T15:49:03Z

/retest

k8s-ci-robot · 2024-12-26T15:49:17Z

@jchanam: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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 · 2025-01-15T21:08:54Z

@stormqueen1990 Sorry for the late response. I think I was able to follow your guidance and fix the tests.

Hi there, @jchanam! Thanks for updating this!

stormqueen1990 · 2025-01-15T21:10:45Z

/retest

jchanam · 2025-01-16T15:03:51Z

@stormqueen1990 looks like the tests were not run. Could you please force them in any way? thank you!

jchanam · 2025-01-17T14:18:24Z

@stormqueen1990 Could you please help me with the linter errors?

Error: plugin/builtin/patchtransformer/PatchTransformer_test.go:1128:29: test helper function should start from t.Helper() (thelper)
`, someDeploymentResources, func(t *testing.T, err error) {
                            ^
Error: plugin/builtin/patchtransformer/PatchTransformer_test.go:1154:29: test helper function should start from t.Helper() (thelper)
`, someDeploymentResources, func(t *testing.T, err error) {

I don't understand why it's complaining when I've followed the same structure as for other tests

stormqueen1990 · 2025-01-17T14:58:42Z

@stormqueen1990 Could you please help me with the linter errors?

Error: plugin/builtin/patchtransformer/PatchTransformer_test.go:1128:29: test helper function should start from t.Helper() (thelper)
`, someDeploymentResources, func(t *testing.T, err error) {
                            ^
Error: plugin/builtin/patchtransformer/PatchTransformer_test.go:1154:29: test helper function should start from t.Helper() (thelper)
`, someDeploymentResources, func(t *testing.T, err error) {

I don't understand why it's complaining when I've followed the same structure as for other tests

Hi @jchanam, our linter requires test helper functions to have an invocation to t.Helper() at the beginning. You just need to add that statement as the first statement in the helper function. This is standard Go, you can read more about it here: https://pkg.go.dev/testing#T.Helper. I apologize for not seeing (and flagging) it earlier.

As for the tests, /test all and /retest will only trigger the Prow presubmit tests. You can check the logs for those tests by clicking the details in the kustomize-presubmit-master check in your pull request status.

Signed-off-by: Julio Chana <[email protected]>

jchanam · 2025-01-17T15:09:56Z

@stormqueen1990 Thank you so much for the explanation! I've just added them and pushed the changes.

stormqueen1990

/lgtm

jchanam · 2025-01-23T16:14:08Z

@stormqueen1990 what is the following step now that the PR passed all the tests? Could this PR be merged?

stormqueen1990 · 2025-01-26T16:09:11Z

@stormqueen1990 what is the following step now that the PR passed all the tests? Could this PR be merged?

Hi there, @jchanam! The next step is the review and then approval by a maintainer (I am just a reviewer). Once one of the maintainers approve this pull request using /approve it will be merged automatically by Prow. You can read more about the pull request process in Kubernetes projects in the Contributor Documentation: https://www.kubernetes.dev/docs/guide/pull-requests/

jchanam · 2025-02-17T16:34:41Z

Hi!

I'm still waiting for any maintainer to approve and merge this. Is there any way to ping anyone so they can check this?

stormqueen1990 · 2025-02-17T16:43:40Z

Hi!

I'm still waiting for any maintainer to approve and merge this. Is there any way to ping anyone so they can check this?

@koba1t or @varshaprasad96: could you please take a look at this PR when you get a chance?

stormqueen1990 · 2025-02-17T16:45:00Z

/ok-to-test

koba1t · 2025-02-26T01:34:24Z

/assign

jchanam · 2025-03-14T12:38:09Z

Hi! Could we have this PR merged please?

koba1t · 2025-03-17T02:05:42Z

Thanks @jchanam

/lgtm
/approve

k8s-ci-robot · 2025-03-17T02:05:49Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jchanam, koba1t

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:

~~OWNERS~~ [koba1t]

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

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [kubernetes-sigs/kustomize](https://github.com/kubernetes-sigs/kustomize) | minor | `v5.6.0` -> `v5.7.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>kubernetes-sigs/kustomize (kubernetes-sigs/kustomize)</summary> ### [`v5.7.0`](https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize/v5.7.0) [Compare Source](kubernetes-sigs/kustomize@kustomize/v5.6.0...kustomize/v5.7.0) #### Feature kubernetes-sigs/kustomize#5630: Add static value source for replacement kubernetes-sigs/kustomize#5921: feat: Add images suport for Image Volumes kubernetes-sigs/kustomize#5771: fix: Allow patches with empty files with multiple newlines or comments kubernetes-sigs/kustomize#5865: feat(helm): allow the use of devel alias for helmcharts #### fix kubernetes-sigs/kustomize#5846: fix: Get version from the BuildInfo.Main.Version if not found in deps and build flag kubernetes-sigs/kustomize#5859: fix: Don't panic on multiple $patch: delete strategic merge patches in a single patch file kubernetes-sigs/kustomize#5877: fix: make private one field in replacements transformer struct that had a missing JSON tag #### Dependencies [#5847](kubernetes-sigs/kustomize#5847): replace deplecated package github.com/google/shlex with github.com/carapace-sh/carapace-shlex [#5873](kubernetes-sigs/kustomize#5873): Bump to github.com/spf13/viper v1.20.0 [#5931](kubernetes-sigs/kustomize#5931): Drop usage of forked copies of goyaml.v2 and goyaml.v3 #### chore kubernetes-sigs/kustomize#5882: Set Git messages to English for TestRemoteLoad\_LocalProtocol [#5934](kubernetes-sigs/kustomize#5934): Update kyaml to v0.20.0 [#5935](kubernetes-sigs/kustomize#5935): Update cmd/config to v0.20.0 [#5936](kubernetes-sigs/kustomize#5936): Update api to v0.20.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

kubernetes-sigs#5771) * fix: Add test, when an empty patch file is given, it should not fail * fix: Add code so there's no error given if an empty file is given as a patch * chore: Generate plugin with pluginator * chore: fix tests Signed-off-by: Julio Chana <[email protected]> * Add t.helper() at start of test function Signed-off-by: Julio Chana <[email protected]> --------- Signed-off-by: Julio Chana <[email protected]>

jchanam added 2 commits September 27, 2024 11:34

fix: Add test, when an empty patch file is given, it should not fail

1e3d875

fix: Add code so there's no error given if an empty file is given as …

5952169

…a patch

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 27, 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 Sep 27, 2024

k8s-ci-robot requested review from stormqueen1990 and varshaprasad96 September 27, 2024 09:58

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

jchanam commented Nov 18, 2024

View reviewed changes

plugin/builtin/patchtransformer/PatchTransformer_test.go Show resolved Hide resolved

chore: Generate plugin with pluginator

bfd408c

chore: fix tests

6e60747

Signed-off-by: Julio Chana <[email protected]>

Add t.helper() at start of test function

bec1276

Signed-off-by: Julio Chana <[email protected]>

stormqueen1990 reviewed Jan 17, 2025

View reviewed changes

k8s-ci-robot assigned stormqueen1990 Jan 17, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 17, 2025

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 17, 2025

k8s-ci-robot assigned koba1t Feb 26, 2025

koba1t added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Feb 26, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 17, 2025

k8s-ci-robot merged commit 31b3754 into kubernetes-sigs:master Mar 17, 2025
11 checks passed

jchanam deleted the fix-allow-patches-with-empty-files branch March 17, 2025 10:36

fix: Allow patches with empty files with multiple newlines or comments #5771

fix: Allow patches with empty files with multiple newlines or comments #5771

Uh oh!

Conversation

jchanam commented Sep 27, 2024

Uh oh!

k8s-ci-robot commented Sep 27, 2024

Uh oh!

k8s-ci-robot commented Sep 27, 2024

Uh oh!

k8s-ci-robot commented Sep 27, 2024

Uh oh!

jchanam commented Oct 14, 2024

Uh oh!

stormqueen1990 commented Nov 8, 2024

Uh oh!

stormqueen1990 commented Nov 8, 2024

Uh oh!

jchanam commented Nov 18, 2024

Uh oh!

Uh oh!

stormqueen1990 commented Nov 26, 2024

Uh oh!

jchanam commented Dec 26, 2024

Uh oh!

jchanam commented Dec 26, 2024

Uh oh!

k8s-ci-robot commented Dec 26, 2024

Uh oh!

stormqueen1990 commented Jan 15, 2025

Uh oh!

stormqueen1990 commented Jan 15, 2025

Uh oh!

jchanam commented Jan 16, 2025

Uh oh!

jchanam commented Jan 17, 2025

Uh oh!

stormqueen1990 commented Jan 17, 2025

Uh oh!

jchanam commented Jan 17, 2025

Uh oh!

stormqueen1990 left a comment

Choose a reason for hiding this comment

Uh oh!

jchanam commented Jan 23, 2025

Uh oh!

stormqueen1990 commented Jan 26, 2025

Uh oh!

jchanam commented Feb 17, 2025

Uh oh!

stormqueen1990 commented Feb 17, 2025

Uh oh!

stormqueen1990 commented Feb 17, 2025

Uh oh!

koba1t commented Feb 26, 2025

Uh oh!

jchanam commented Mar 14, 2025

Uh oh!

koba1t commented Mar 17, 2025

Uh oh!

k8s-ci-robot commented Mar 17, 2025

Uh oh!

Uh oh!

Uh oh!