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.

Sign up for GitHub

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

Jump to bottom

Refactor common util functions for /test #7369

Merged
merged 1 commit into from
Dec 4, 2023
Merged

Refactor common util functions for /test #7369

merged 1 commit into from
Dec 4, 2023

Conversation

JeromeJu
Copy link
Member

@JeromeJu JeromeJu commented Nov 15, 2023 •
edited
Loading

Changes

Prior to this commit, the uitl functions for e2e tests are distributed over multiple test files in /test. And we had to tag specific test files for unrelevant test suites that needs such util functions. For example, init_test has the 'conformance' build tag on it, which is not necessarily the case as conformance test suite does not need the inti_test but needs the setup there.

This commit cleans up the util functions separated across different test files and put them into /test/util so that we can tag the appropriate test files for build only.

/kind cleanup

Submitter Checklist

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

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • 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
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • 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 Nov 15, 2023
@tekton-robot tekton-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Nov 15, 2023
@JeromeJu JeromeJu marked this pull request as draft November 15, 2023 21:50
@tekton-robot tekton-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. labels Nov 15, 2023
@JeromeJu JeromeJu marked this pull request as ready for review November 15, 2023 23:57
@tekton-robot tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 15, 2023
vdemeester
vdemeester reviewed Nov 17, 2023
View reviewed changes
test/init_test.go Outdated Show resolved Hide resolved
@JeromeJu JeromeJu force-pushed the refactor-test-common branch from 5f14d78 to 3314561 Compare November 17, 2023 13:46
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Yongxuanzhang

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 Nov 21, 2023
@JeromeJu
Refactor common util functions for /test
ce9b053 
Prior to this commit, the uitl functions for e2e tests are distributed
over multiple test files in /test. And we had to tag specific test
files for unrelevant test suites that needs such util functions. For
example, init_test has the 'conformance' build tag on it, which is not
necessarily the case as conformance test suite does not need the
inti_test but needs the setup there.

This commit cleans up the util functions separated across different test
files and put them into /test/util so that we can tag the appropriate
test files for build only.
@JeromeJu JeromeJu force-pushed the refactor-test-common branch from 3314561 to ce9b053 Compare December 4, 2023 18:01
QuanZhang-William
QuanZhang-William reviewed Dec 4, 2023
View reviewed changes
test/util.go
@@ -0,0 +1,319 @@
//go:build conformance || e2e || examples
Copy link
Member

Choose a reason for hiding this comment

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

Do we really need the tag here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yep they are used for build tags for e2e/conformance/examples test. If we delete them, they'd all encounter build failure.

Copy link
Member Author

@JeromeJu JeromeJu Dec 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

And the reason for this refactor is to let all new integration test suite with new tag not to rely on the "e2e" tag where previously those init and setup lived in.

@QuanZhang-William
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Dec 4, 2023
@tekton-robot tekton-robot merged commit a179226 into tektoncd:main Dec 4, 2023
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuanZhang-William QuanZhang-William QuanZhang-William left review comments

@vdemeester vdemeester vdemeester left review comments

@Yongxuanzhang Yongxuanzhang Yongxuanzhang approved these changes

@afrittoli afrittoli Awaiting requested review from afrittoli

@dibyom dibyom Awaiting requested review from dibyom

@abayer abayer Awaiting requested review from abayer

Assignees

@QuanZhang-William QuanZhang-William

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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesnt merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@JeromeJu @tekton-robot @QuanZhang-William @vdemeester @Yongxuanzhang