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

Abstract a request counter's cycle logic from watch() #376

Merged
merged 1 commit into from Jul 30, 2021

Conversation

tylerferrara
Copy link
Contributor

What type of PR is this?

/kind feature
/kind design

What this PR does / why we need it:

This change separates sleep/log cycles from the watch() function within reqcounter. Abstracting this repeated logic from watch's anonymous goroutine allows for simple deterministic testing of sleep/log behavior. Now there is no need to TestWatch (#372), as it simply executes Cycle() indefinitely.

Which issue(s) this PR fixes:

Partially satisfies #358

Special notes for your reviewer:

This approach is much more favorable than previous attempts to test the logging of request counters. Since request counters spawn goroutines in watch(), advancing time forward involves complicated synchronization patterns to ensure a sleep/log cycle has finished. Instead, if we only test sleep/log behavior, we avoid unwanted complexity while still resulting in equivalent code coverage.

Supersedes: #372 #368 #369

Does this PR introduce a user-facing change?

NONE

Abstract sleep/log logic from a request counter's watch() function.

cc: @listx @amwat @justaugustus @kubernetes-sigs/release-engineering

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. kind/design Categorizes issue or PR as related to design. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 29, 2021
@k8s-ci-robot k8s-ci-robot added area/release-eng Issues or PRs related to the Release Engineering subproject sig/release Categorizes an issue or PR as relevant to SIG Release. wg/k8s-infra size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 29, 2021
@tylerferrara tylerferrara changed the title Abstract a request counter's cycle logic from watch(). [WIP] Abstract a request counter's cycle logic from watch(). Jul 29, 2021
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 29, 2021
@tylerferrara tylerferrara changed the title [WIP] Abstract a request counter's cycle logic from watch(). Abstract a request counter's cycle logic from watch(). Jul 29, 2021
@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 Jul 29, 2021
@tylerferrara tylerferrara changed the title Abstract a request counter's cycle logic from watch(). Abstract a request counter's cycle logic from watch() Jul 29, 2021
legacy/reqcounter/reqcounter_test.go Outdated Show resolved Hide resolved
legacy/reqcounter/reqcounter_test.go Outdated Show resolved Hide resolved
@listx
Copy link
Contributor

listx commented Jul 30, 2021

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 30, 2021
@listx
Copy link
Contributor

listx commented Jul 30, 2021

Thanks!

/hold cancel
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 30, 2021
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 30, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: listx, tylerferrara

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 Jul 30, 2021
@k8s-ci-robot k8s-ci-robot merged commit e3125c5 into kubernetes-sigs:master Jul 30, 2021
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. area/artifacts Issues or PRs related to the hosting of release artifacts for subprojects area/release-eng Issues or PRs related to the Release Engineering subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/design Categorizes issue or PR as related to design. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/release Categorizes an issue or PR as relevant to SIG Release. 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.

None yet

3 participants