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

Cleanup unit tests to use idiomatic Go. #5916

Merged
merged 1 commit into from
Dec 27, 2022
Merged

Cleanup unit tests to use idiomatic Go. #5916

merged 1 commit into from
Dec 27, 2022

Conversation

bendory
Copy link
Contributor

@bendory bendory commented Dec 22, 2022

Changes

This PR is a follow-on from #5904 (comment) to make spire tests more readable, easier to understand, and conformant with idiomatic Golang style.

There are no expected functional changes in this PR.

Changes:

  • spire_mock_test.go: Renamed test functions from TestSpireMock_* --> TestMock_*
  • spire_test.go:
    • Renamed test functions from TestSpire_* --> Test*
    • use concise helper function names -(style guide)
    • in-lined test data in place of testSingleTaskRun(), testSinglePipelineResourceResults() helpers
    • eliminated unnecessary helper functions (genPr() and success := func()...)
    • localized setup to just the tests that need it (style guide)
    • use naming conventions got, want in tests

/kind cleanup

Ref: #5899

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • [N/A] Has Docs included if any changes are user facing
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • [N/A] Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • [N/A] Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Dec 22, 2022
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 22, 2022
@bendory
Copy link
Contributor Author

bendory commented Dec 22, 2022

ping @ijschwabacher

@bendory
Copy link
Contributor Author

bendory commented Dec 22, 2022

/kind cleanup

@bendory
Copy link
Contributor Author

bendory commented Dec 22, 2022

/test check-pr-has-kind-label

@tekton-robot
Copy link
Collaborator

@bendory: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

  • /test pull-tekton-pipeline-alpha-integration-tests
  • /test pull-tekton-pipeline-build-tests
  • /test pull-tekton-pipeline-integration-tests
  • /test tekton-pipeline-unit-tests

The following commands are available to trigger optional jobs:

  • /test pull-tekton-pipeline-go-coverage

Use /test all to run all jobs.

In response to this:

/test check-pr-has-kind-label

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.

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 22, 2022
@bendory
Copy link
Contributor Author

bendory commented Dec 22, 2022

/assign @afrittoli

ec := NewEntrypointerAPIClient(cfg)
defer ec.Close()

if _, err := ec.Sign(ctx, nil); !errors.Is(err, context.DeadlineExceeded) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Wait, we're passing in context.Background() and we want to get context.DeadlineExceeded? So we're effectively testing that the timeout is used here? Is this an admission that there are potentially too many dependencies on that method to move the timeout back out into the caller?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The implementation as written has its own embedded timeout, and IDK the implications of changing that implementation to move the timeout up to the caller. This was a pre-existing test that I have rewritten into idiomatic Go using errors.Is rather than generically checking that an error was returned (which is what the old test did).

I agree that this implementation could be better, but that's not my current focus. 🙈

pkg/spire/spire_test.go Outdated Show resolved Hide resolved
pkg/spire/spire_test.go Outdated Show resolved Hide resolved
pkg/spire/spire_test.go Outdated Show resolved Hide resolved
pkg/spire/spire_test.go Outdated Show resolved Hide resolved
pkg/spire/spire_test.go Outdated Show resolved Hide resolved
pkg/spire/spire_test.go Outdated Show resolved Hide resolved
This PR is a follow-on from #5904 (comment)

There are no expected functional changes in this PR.

/kind cleanup
@tekton-robot
Copy link
Collaborator

@bendory: cat image

In response to this:

not today 😸
/meow

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.

@bendory
Copy link
Contributor Author

bendory commented Dec 23, 2022

/test tekton-pipeline-unit-tests

@abayer
Copy link
Contributor

abayer commented Dec 27, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Dec 27, 2022
@tekton-robot tekton-robot merged commit 55d6682 into tektoncd:main Dec 27, 2022
@bendory bendory deleted the cleanup branch December 28, 2022 03:22
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. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. 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.

6 participants