Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jchanam
Copy link

@jchanam jchanam commented Sep 27, 2024

Fixes #5487

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.

@k8s-ci-robot
Copy link
Contributor

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 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
Copy link
Contributor

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 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
Copy link
Contributor

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.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jchanam
Once this PR has been reviewed and has the lgtm label, please assign knverey 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:

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 k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 27, 2024
@jchanam
Copy link
Author

jchanam commented Oct 14, 2024

Hi @stormqueen1990 @varshaprasad96,

Could I get some help in getting this approved?

Thank you!

@stormqueen1990
Copy link
Member

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
Copy link
Member

/test all

@k8s-ci-robot
Copy link
Contributor

@jchanam: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
kustomize-presubmit-master 5952169 link true /test kustomize-presubmit-master

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

patch file with comments only not supported anymore in 5.2.1 (was supported in 5.1.1)
3 participants