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

TEP-0090: Test isSuccessful #4974

Merged
merged 1 commit into from
Jun 14, 2022
Merged

Conversation

jerop
Copy link
Member

@jerop jerop commented Jun 14, 2022

Changes

isSuccessful is an unexported function, so it did not have tests
per the in guidelines. The recommendation is to not
test unexported function, and if needed to move the function into
a package, test it then export the function. However, this is hard
to do for the resources package because of cyclic dependencies. We
already have tests for another unexported function - isFailure -
and discussions to make exceptions for that guideline are ongoing.

In this change, we add tests for isSuccessful to ensure it works
as expected, as we prepare to make changes to the function to support
Matrix.

/kind misc

Submitter Checklist

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

  • [n/a] Docs included if any changes are user facing
  • Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Release notes block below has been filled in (if there are no user facing changes, use release note "NONE")

Release Notes

NONE

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/misc Categorizes issue or PR as a miscellaneuous one. labels Jun 14, 2022
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 14, 2022
@jerop jerop changed the title Add tests for isSuccessful TEP-0090: Test isSuccessful Jun 14, 2022
@jerop jerop changed the title TEP-0090: Test isSuccessful Test isSuccessful Jun 14, 2022
`isSuccessful` is an unexported function, so it did not have tests
per the in [guidelines][guidelines]. The recommendation is to not
test unexported function, and if needed to move the function into
a package, test it then export the function. However, this is hard
to do for the resources package because of cyclic dependencies. We
already have tests for another unexported function - `isFailure` -
and discussions to make exceptions for that guideline are ongoing.

In this change, we add tests for `isSuccessful` to ensure it works
as expected, as we prepare to make changes to the function to support
`Matrix`.

[guidelines]: https://github.com/tektoncd/community/blob/ac0ae1b304ef515e8099f772f42b91aac1b26e6b/standards.md#tests
@jerop
Copy link
Member Author

jerop commented Jun 14, 2022

/test pull-tekton-pipeline-go-coverage

1 similar comment
@jerop
Copy link
Member Author

jerop commented Jun 14, 2022

/test pull-tekton-pipeline-go-coverage

@abayer
Copy link
Contributor

abayer commented Jun 14, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 14, 2022
@jerop
Copy link
Member Author

jerop commented Jun 14, 2022

/test pull-tekton-pipeline-alpha-integration-tests

@lbernick
Copy link
Member

/assign

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

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 Jun 14, 2022
@tekton-robot tekton-robot merged commit 63a6f65 into tektoncd:main Jun 14, 2022
@jerop jerop deleted the test-issuccessful branch June 15, 2022 14:23
@jerop jerop changed the title Test isSuccessful TEP-0090: Test isSuccessful Jun 24, 2022
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/misc Categorizes issue or PR as a miscellaneuous one. 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.

5 participants