[ci] Lint on non-test code importing packages from /tests #3214
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joshua-kim
approved these changes
Jul 22, 2024
ARR4N
approved these changes
Jul 23, 2024
abi87
approved these changes
Jul 23, 2024
StephenButtolph
approved these changes
Jul 26, 2024
marun
force-pushed
the
ci-lint-tests-import
branch
from
5d13a33
to
deae8a2
Compare
|
Rebased |
ARR4N
reviewed
Jul 26, 2024
scripts/lint.sh
Outdated
| IMPORT_FROM_TESTS=$( echo "${NON_TEST_GO_FILES}" | xargs grep -l '"github.com/ava-labs/tests/'); | ||
| IMPORT_TEST_PKG=$( echo "${NON_TEST_GO_FILES}" | xargs grep -lP '"github.com/ava-labs/.*?test"'); | ||
| IMPORT_FROM_TESTS=$( echo "${NON_TEST_GO_FILES}" | xargs grep -l '"github.com/ava-labs/avalanchego/tests/'); | ||
| IMPORT_TEST_PKG=$( echo "${NON_TEST_GO_FILES}" | xargs grep -lP '"github.com/ava-labs/avalanchego/.*?test'); |
There was a problem hiding this comment.
The closing double-quote was deliberate, to ensure that the package name ends in test. This will now just allow anything with test in the path to be ok.
Is that something we're ok with? I tend to err on the side of precision, but can see the benefit in opening it up like this.
There was a problem hiding this comment.
I think we're in bikeshedding territory either way, so I'll revert the removal.
This avoids having to redundantly tag test code in `/tests` with `go:build test` or supply `--tags test` on every ginkgo invocation.
marun
force-pushed
the
ci-lint-tests-import
branch
from
deae8a2
to
8532371
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This avoids having to redundantly tag test code in
/testswithgo:build testor supply--tags teston every ginkgo invocation.How was this tested
/teststo non-test code and witnessing a failure:Non-test Go files importing test-only packages MUST have '//go:build test' tag: /home/me/src/avalanchego/master/main/main.go