-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Conversation
`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
/test pull-tekton-pipeline-go-coverage |
1 similar comment
/test pull-tekton-pipeline-go-coverage |
/lgtm |
/test pull-tekton-pipeline-alpha-integration-tests |
/assign |
[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 |
Changes
isSuccessful
is an unexported function, so it did not have testsper 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 worksas 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:
Release Notes