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

🐛 Enhances the webhook test template. #4151

Merged

Conversation

mogsie
Copy link
Contributor

@mogsie mogsie commented Sep 9, 2024

The webhook scaffold had some oddly indented regions, resulting in the generated source code having a mix of tabs and spaces, and was generally looking quite ugly.

The gomega asserions are too chatty; errors, and return values are checked after first being assigned as variables in scope. This is not needed, and Gomega checks all of this for us:

  • Expect(someFunc()).Error().To(HaveOccurred()) checks both the error, but also that the other return values are zero or nil.
  • Expect(someFunc()).To(ContainSubstring("X")) checks both the return value and verifies that the error is nil.

Fixes #4148. Part of #4135.

  • Fixes odd indentation, now it is in line with the other scaffolds
  • Simplifies gomega assertions, to use fewer statements
  • Updated the cronjob tutorial's tests too

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 9, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @mogsie. 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 k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 9, 2024
@mogsie mogsie marked this pull request as ready for review September 9, 2024 22:15
@k8s-ci-robot 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 Sep 9, 2024
@mogsie mogsie force-pushed the enhance-webhook-template branch from 18dae99 to d2fdc73 Compare September 9, 2024 22:21
The webhook scaffold had some oddly indented regions, resulting in the
generated source code having a mix of tabs and spaces, and was generally
looking quite ugly.

The gomega asserions are too chatty; errors, and return values are
checked after first being assigned as variables in scope. This is not
needed, and Gomega checks all of this for us:

Expect(someFunc()).Error().To(HaveOccurred()) checks both the error, but also that the other return values are zero or nil.
Expect(someFunc()).To(ContainSubstring("X")) checks both the return value and verifies that the error is nil.

- Indentation
- simplify gomega assertions
@mogsie mogsie force-pushed the enhance-webhook-template branch from d2fdc73 to 5d564d2 Compare September 9, 2024 22:22
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Sep 9, 2024
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.

Thank you 🥇
It is great!

/lgtm
/approved
/ok-to-test

@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 Sep 10, 2024
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 10, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, mogsie

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 Sep 10, 2024
@k8s-ci-robot k8s-ci-robot merged commit 09e4b2d into kubernetes-sigs:master Sep 10, 2024
21 checks passed
@mogsie mogsie deleted the enhance-webhook-template branch September 10, 2024 06:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

Enhance webhook_test template
3 participants