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

runTestWithVersions() in CONTRIBUTING.md #362

Merged
merged 1 commit into from
Feb 13, 2023
Merged

Conversation

kmoe
Copy link
Member

@kmoe kmoe commented Feb 9, 2023

The runTestVersions() function has been effectively renamed to runTestWithVersions() and its behaviour modified by #354 (e2etest/util_test.go) and #359 (e2etest/util_test.go) since the contributing docs were written.

Is CONTRIBUTING.md still correct?

Copy link
Member

@radeksimko radeksimko left a comment

Choose a reason for hiding this comment

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

I think that a lot of the confusion in tests generally comes from all the abstraction layers which lead to us hard-coding versions we test against, instead of managing versions entirely outside of tests and skipping any tests which we know aren't relevant to run for the given version.

TL;DR I think we should just drop runTestWithVersions entirely - but of course that won't be a single LOC change 😅

Having it correctly documented in the meantime makes sense!

Copy link
Contributor

@bendbennett bendbennett left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Copy link
Member

@radditude radditude left a comment

Choose a reason for hiding this comment

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

Ah, I missed these in #359! 🙌🏻

To @radeksimko's point, I briefly went down a rabbit hole of trying to write a helper that would allow specifying a version constraint instead of a list of versions, so someone could express something like "run this test against minor versions greater than 1.0" or "run this test on all minor versions between 0.12 and 0.15" without listing out the versions manually. Maybe it would be an interesting path to explore in the future?

@kmoe kmoe merged commit 615df2e into main Feb 13, 2023
@kmoe kmoe deleted the kmoe/runtestwithversions-doc branch February 13, 2023 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants