Skip to content

🐛 Fix builders WithLogger method #1166

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Sep 17, 2020
Merged

🐛 Fix builders WithLogger method #1166

merged 2 commits into from
Sep 17, 2020

Conversation

databus23
Copy link
Contributor

@databus23 databus23 commented Sep 16, 2020 •
edited
Loading

The logger in the Builder struct is not used anywhere. Instead we need to set it in the controller options.

@k8s-ci-robot k8s-ci-robot added 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. labels Sep 16, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @databus23. 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 the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 16, 2020
@databus23
Copy link
Contributor Author

/assign @vincepri

vincepri
vincepri approved these changes Sep 16, 2020
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
/assign @alvaroaleman

@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 16, 2020
alvaroaleman
alvaroaleman reviewed Sep 16, 2020
View reviewed changes
Copy link
Member

@alvaroaleman alvaroaleman left a comment

Choose a reason for hiding this comment

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

@databus23 Could you add a test for this?

@vincepri
Copy link
Member

/ok-to-test
/milestone v0.7.x

@k8s-ci-robot k8s-ci-robot added this to the v0.7.x milestone Sep 16, 2020
@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 16, 2020
@databus23
Copy link
Contributor Author

databus23 commented Sep 16, 2020 •
edited
Loading

@alvaroaleman Unfortunately I don't really have time to attend to this. I just noticed that WithLogger is doing nothing and I am going to use WithOptions for now to set the logger.

@vincepri
Copy link
Member

/test pull-controller-runtime-test-master

@databus23
Copy link
Contributor Author

@alvaroaleman Looking at the tests, it should be fairly easy to add a test. Let me try to add a test for this.

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 16, 2020
@vincepri vincepri added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Sep 16, 2020
alvaroaleman
alvaroaleman reviewed Sep 16, 2020
View reviewed changes
pkg/builder/controller_test.go
WithLogger(logger).
Build(noop)
Expect(err).NotTo(HaveOccurred())
Expect(instance).NotTo(BeNil())
Copy link
Member

Choose a reason for hiding this comment

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

That test will also succeed without your code changes - Please test that you get the same logger as you inserted, not that you get any logger

Copy link
Contributor Author

@databus23 databus23 Sep 17, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

No it does not. I tested it. Without my changes the test fails with:

logger expected log.NullLogger but found *zapr.zapLogger

Copy link
Contributor Author

Choose a reason for hiding this comment

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

While the test was working I made it more explicit by using a minimal custom testLogger.
Without my changes the test now fails with:

logger expected *builder.testLogger but found *zapr.zapLogger

@databus23
Add a test for WithLogger
165310a 
Signed-off-by: Fabian Ruff <[email protected]>
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 17, 2020
alvaroaleman
alvaroaleman approved these changes Sep 17, 2020
View reviewed changes
Copy link
Member

@alvaroaleman alvaroaleman left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 17, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman, databus23, 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:
  • OWNERS [alvaroaleman,vincepri]

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 merged commit 15e8171 into kubernetes-sigs:master Sep 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vincepri vincepri vincepri approved these changes

@alvaroaleman alvaroaleman alvaroaleman approved these changes

@pwittrock pwittrock Awaiting requested review from pwittrock

Assignees

@vincepri vincepri

@alvaroaleman alvaroaleman

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/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Milestone
v0.7.x
Development

Successfully merging this pull request may close these issues.
4 participants
@databus23 @k8s-ci-robot @vincepri @alvaroaleman