feat(testutil): add testutil.IsParallel()

johnstcn · johnstcn · commit 6d36ddaa8545 · 2024-08-23T14:15:28.000+01:00
diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -269,8 +269,8 @@ func NewOptions(t testing.TB, options *Options) (func(http.Handler), context.Can
 		options.DeploymentValues = DeploymentValues(t)
 	}
 	// This value is not safe to run in parallel.
-	if options.DeploymentValues.DisableOwnerWorkspaceExec {
-		t.Logf("WARNING: DisableOwnerWorkspaceExec is set, this is not safe in parallel tests!")
+	if options.DeploymentValues.DisableOwnerWorkspaceExec.Value() && testutil.IsParallel(t) {
+		t.Fatal("DisableOwnerWorkspaceExec is set, this is not safe in parallel tests!")
 	}
 
 	// If no ratelimits are set, disable all rate limiting for tests.
diff --git a/testutil/parallel.go b/testutil/parallel.go
@@ -0,0 +1,17 @@
+package testutil
+
+import "testing"
+
+// IsParallel determines whether the current test is running with parallel set.
+// The Go standard library does not currently expose this. However, we can easily
+// determine this using the fact that a call to t.Setenv() after t.Parallel() will panic.
+func IsParallel(t testing.TB) (parallel bool) {
+	t.Helper()
+	defer func() {
+		if r := recover(); r != nil {
+			parallel = true
+		}
+	}()
+	t.Setenv(t.Name()+"_PARALLEL", "")
+	return parallel
+}
diff --git a/testutil/parallel_test.go b/testutil/parallel_test.go
@@ -0,0 +1,19 @@
+package testutil_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/v2/testutil"
+)
+
+// nolint:paralleltest // this is the whole point
+func Test_IsParallel_False(t *testing.T) {
+	require.False(t, testutil.IsParallel(t))
+}
+
+func Test_IsParallel_True(t *testing.T) {
+	t.Parallel()
+	require.True(t, testutil.IsParallel(t))
+}

Original file line number	Diff line number	Diff line change
`@@ -269,8 +269,8 @@ func NewOptions(t testing.TB, options *Options) (func(http.Handler), context.Can`
`269`	`269`	`options.DeploymentValues = DeploymentValues(t)`
`270`	`270`	`}`
`271`	`271`	`// This value is not safe to run in parallel.`
`272`		`- if options.DeploymentValues.DisableOwnerWorkspaceExec {`
`273`		`- t.Logf("WARNING: DisableOwnerWorkspaceExec is set, this is not safe in parallel tests!")`
	`272`	`+ if options.DeploymentValues.DisableOwnerWorkspaceExec.Value() && testutil.IsParallel(t) {`
	`273`	`+ t.Fatal("DisableOwnerWorkspaceExec is set, this is not safe in parallel tests!")`
`274`	`274`	`}`
`275`	`275`
`276`	`276`	`// If no ratelimits are set, disable all rate limiting for tests.`