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

Testing: Lint for unparallelized tests without explicit reason #4746

Merged
merged 4 commits into from
Nov 4, 2022
Merged

Testing: Lint for unparallelized tests without explicit reason #4746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3fec0d3
Include paralleltest in `golangci` linting
jdtzmn Oct 25, 2022
5a022d6
Fix tests that are explicitly not supposed to be parallel
jdtzmn Nov 1, 2022
5bbc0b4
Disable paralleltest linter in existing packages for now
jdtzmn Oct 27, 2022
0e01e02
Disable additional pre-revision packages with paralleltest errors
jdtzmn Nov 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ linters:
- revive
- staticcheck
- typecheck
- paralleltest

severity:
default-severity: error
Expand Down Expand Up @@ -115,6 +116,10 @@ issues:
# - revive
- staticcheck
- typecheck
# Ignore missing parallel tests in existing packages
- path: (agreement|catchup|cmd|config|crypto|daemon|data|gen|ledger|logging|netdeploy|network|node|protocol|rpcs|shared|stateproof|test|tools|util).*_test.go
linters:
- paralleltest
# Add all linters here -- Comment this block out for testing linters
- path: test/linttest/lintissues\.go
linters:
Expand Down
4 changes: 1 addition & 3 deletions data/transactions/logic/assembler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2800,10 +2800,8 @@ func TestGetSpec(t *testing.T) {
require.Equal(t, "unknown opcode: nonsense", ops.Errors[1].Err.Error())
}

func TestAddPseudoDocTags(t *testing.T) {
func TestAddPseudoDocTags(t *testing.T) { //nolint:paralleltest // Not parallel because it modifies pseudoOps and opDocByName which are global maps
partitiontest.PartitionTest(t)
// Not parallel because it modifies pseudoOps and opDocByName which are global maps
// t.Parallel()
defer func() {
delete(pseudoOps, "tests")
delete(opDocByName, "multiple")
Expand Down
8 changes: 2 additions & 6 deletions data/transactions/logic/evalAppTxn_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1761,9 +1761,7 @@ int 1
`

for _, unified := range []bool{true, false} {
t.Run(fmt.Sprintf("unified=%t", unified), func(t *testing.T) {
// t.Parallel() NO! unified variable is actually shared

t.Run(fmt.Sprintf("unified=%t", unified), func(t *testing.T) { //nolint:paralleltest // NO t.Parallel(). unified variable is actually shared
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this linter actually complain about every t.Run too? Or just top-level func Test*?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also t.Run(). For a full list of the errors it catches: https://github.com/kunwardeep/paralleltest#examples

Copy link
Contributor

Choose a reason for hiding this comment

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

Nevermind, I see it does.

ep, parentTx, ledger := MakeSampleEnv()
ep.Proto.UnifyInnerTxIDs = unified

Expand Down Expand Up @@ -2226,10 +2224,8 @@ func TestInnerTxIDCaching(t *testing.T) {
parentAppID := basics.AppIndex(888)
childAppID := basics.AppIndex(222)

for _, unified := range []bool{true, false} {
for _, unified := range []bool{true, false} { //nolint:paralleltest // NO t.Parallel(). unified variable is actually shared
t.Run(fmt.Sprintf("unified=%t", unified), func(t *testing.T) {
// t.Parallel() NO! unified variable is actually shared

ep, parentTx, ledger := MakeSampleEnv()
ep.Proto.UnifyInnerTxIDs = unified

Expand Down