Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

🐛 Generate deterministic ordering for webhook manifests #779

Merged
merged 3 commits into from
Apr 19, 2023
Merged

🐛 Generate deterministic ordering for webhook manifests #779

merged 3 commits into from
Apr 19, 2023

Conversation

terassyi
Copy link
Contributor

What

This PR modified to generate webhook manifests sorted by name and added tests.

Why

Now we get differently ordered manifests every time.
It isn't easy to compare generated manifests.

Please see #730 for more information.

@terassyi
fix to sort makers
4ce8785 
Signed-off-by: terasihma <tomoya-terashima@cybozu.co.jp>
@terassyi
fix testcase
cdeaf78 
Signed-off-by: terasihma <tomoya-terashima@cybozu.co.jp>
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Feb 20, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Feb 20, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @terassyi!

It looks like this is your first PR to kubernetes-sigs/controller-tools 🎉. 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/controller-tools 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 Feb 20, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @terassyi. 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.

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. 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 20, 2023
@terassyi terassyi mentioned this pull request Feb 20, 2023
Closed
JoelSpeed
JoelSpeed reviewed Feb 20, 2023
View reviewed changes
pkg/webhook/parser_integration_test.go Outdated
Expect(yaml.UnmarshalStrict(expectedFile, expectedManifest)).To(Succeed())

By("comparing the manifest")
assertSame(actualManifest, expectedManifest)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How often does this fail without your code change? Do we need to run this test say 5 or 10 times to have any confidence in this fix?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We get differently ordered manifests every time because of converting from map.

Do we need to run this test say 5 or 10 times to have any confidence in this fix?

Yes, I agree we should run it enough times.

@terassyi
fix test to compare many times
90bc9ca 
Signed-off-by: terasihma <tomoya-terashima@cybozu.co.jp>
@terassyi terassyi requested review from JoelSpeed and removed request for droot and pwittrock February 21, 2023 03:46
JoelSpeed
JoelSpeed reviewed Feb 21, 2023
View reviewed changes
Copy link
Contributor

@JoelSpeed JoelSpeed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test

No further feedback from me right now, lets check the tests

pkg/webhook/parser_integration_test.go
@@ -175,6 +175,55 @@ var _ = Describe("Webhook Generation From Parsing to CustomResourceDefinition",
assertSame(actualMutating, expectedMutating)
assertSame(actualValidating, expectedValidating)
})

It("should generate the ordered webhook definitions", func() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shame we aren't using ginkgo V2 as you could use MustPassRepeatedly(10) if we were, maybe a future improvement

@k8s-ci-robot 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 21, 2023
camilamacedo86
camilamacedo86 approved these changes Apr 19, 2023
View reviewed changes
Copy link
Member

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems fine for me either.
I would say that is more like ✨ then a bug fix.

However, it is a nit.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 19, 2023
vincepri
vincepri approved these changes Apr 19, 2023
View reviewed changes
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, terassyi, vincepri

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:

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 19, 2023
@k8s-ci-robot k8s-ci-robot merged commit 9616218 into kubernetes-sigs:master Apr 19, 2023
@terassyi terassyi mentioned this pull request Apr 25, 2023
Closed
@renovate renovate bot mentioned this pull request Oct 11, 2024
Open
1 task
@renovate renovate bot mentioned this pull request Oct 30, 2024
Open
1 task
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@JoelSpeed JoelSpeed JoelSpeed left review comments

@vincepri vincepri vincepri approved these changes

@camilamacedo86 camilamacedo86 camilamacedo86 approved these changes

Assignees

@camilamacedo86 camilamacedo86

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@terassyi @k8s-ci-robot @vincepri @camilamacedo86 @JoelSpeed