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

Unexport RPRT member functions used within resources pkg only #4949

Merged
merged 1 commit into from
Jun 8, 2022

Conversation

jerop
Copy link
Member

@jerop jerop commented Jun 8, 2022

Changes

Some member functions of ResolvedPipelineRunTask are exported but they are used within the resources package only: IsDone, IsSuccessful, IsFailure, IsRunning, HasRemainingRetries, IsCancelled, IsConditionStatusFalse, and IsStarted.

These functions, except IsDone, are not tested but the exported functions that use them within the resources package are tested.

In this change, we unexport the above member functions that are used within resources package only. We do not add tests for the now-unexported functions as recommended in guidelines, but we can add them later if we change the guidelines.

Follow up to refactor done in PR: #4943

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
  • [n/a] 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

cc @pritidesai

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 8, 2022
Copy link
Member

@imjasonh imjasonh left a comment

Choose a reason for hiding this comment

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

/lgtm

🎉

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

jerop commented Jun 8, 2022

/kind cleanup

@tekton-robot tekton-robot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Jun 8, 2022
@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 8, 2022
@jerop
Copy link
Member Author

jerop commented Jun 8, 2022

/test pull-tekton-pipeline-go-coverage

@jerop
Copy link
Member Author

jerop commented Jun 8, 2022

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

Some member functions of ResolvedPipelineRunTask are exported but they are used
within the resources package only: `IsDone`, `IsSuccessful`, `IsFailure`, `IsRunning`
`HasRemainingRetries`, `IsCancelled`, `IsConditionStatusFalse`, and `IsStarted`.

These functions, except `IsDone`, are not tested but the exported functions that
use them within the resources package are tested.

In this change, we unexport the above member functions that are used within resources
package only. We do not add tests for the now-unexported functions as recommended
in [guidelines][guidelines], but we can add them later if we change the guideline.

[guidelines]: https://github.com/tektoncd/community/blob/ac0ae1b304ef515e8099f772f42b91aac1b26e6b/standards.md#tests
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Jun 8, 2022
@jerop
Copy link
Member Author

jerop commented Jun 8, 2022

@imjasonh @abayer @dibyom - had to rebase to fix merge conflicts when #4950 got merged, please take another look

@jerop
Copy link
Member Author

jerop commented Jun 8, 2022

/retest

@abayer
Copy link
Contributor

abayer commented Jun 8, 2022

/lgtm

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

jerop commented Jun 8, 2022

/retest

@tekton-robot tekton-robot merged commit a4b3468 into tektoncd:main Jun 8, 2022
@jerop jerop deleted the unexport-rprt-functions branch June 9, 2022 00:06
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/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.

5 participants