Create integration test environment variable handler (#475)

Skip integration tests unless the "INTEGRATION" environment variable is set
Azure · Dec 11, 2024 · 1a8d5f0 · 1a8d5f0
1 parent 0db0e6b
commit 1a8d5f0
Show file tree

Hide file tree

Showing 12 changed files with 38 additions and 18 deletions.
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -29,4 +29,4 @@ jobs:
       run: go build -mod=vendor -v ./...
 
     - name: Test
-      run: go test -race -mod=vendor -v -timeout=30m ./...
+      run: INTEGRATION=1 go test -race -mod=vendor -v -timeout=30m ./...
diff --git a/Makefile b/Makefile
@@ -40,7 +40,7 @@ clean:
 .PHONY: clean
 
 test:
-	go test -timeout 30m ./...
+	INTEGRATION=1 go test -timeout 30m ./...
 .PHONY: test
 
 default:

diff --git a/ingestor/adx/uploader_test.go b/ingestor/adx/uploader_test.go
@@ -1,18 +1,19 @@
-//go:build !disableDocker
-
 package adx
 
 import (
 	"context"
 	"testing"
 
+	"github.com/Azure/adx-mon/pkg/testutils"
 	"github.com/Azure/adx-mon/pkg/testutils/kustainer"
 	"github.com/Azure/azure-kusto-go/kusto"
 	"github.com/stretchr/testify/require"
 	"github.com/testcontainers/testcontainers-go"
 )
 
 func TestClusterRequiresDirectIngest(t *testing.T) {
+	testutils.IntegrationTest(t)
+
 	ctx := context.Background()
 	k, err := kustainer.Run(ctx, "mcr.microsoft.com/azuredataexplorer/kustainer-linux:latest", kustainer.WithStarted())
 	testcontainers.CleanupContainer(t, k)

diff --git a/ingestor/cluster/coordinator_test.go b/ingestor/cluster/coordinator_test.go
@@ -1,5 +1,3 @@
-//go:build !disableDocker
-
 package cluster
 
 import (
@@ -263,6 +261,8 @@ func (l *fakePodLister) Pods(namespace string) v12.PodNamespaceLister {
 }
 
 func TestCoordinatorInK8s(t *testing.T) {
+	testutils.IntegrationTest(t)
+
 	// This is an integration test where a Coordinator is created using a k3s cluster
 	// configuration and a statefulset is then created that matches the Coordinator's
 	// peer predicate. What we're testing is that the Coordinator is correctly utilizing

diff --git a/ingestor/storage/kql_functions_test.go b/ingestor/storage/kql_functions_test.go
@@ -1,5 +1,3 @@
-//go:build !disableDocker
-
 package storage_test
 
 import (
@@ -22,6 +20,8 @@ import (
 )
 
 func TestFunctions(t *testing.T) {
+	testutils.IntegrationTest(t)
+
 	scheme := clientgoscheme.Scheme
 	require.NoError(t, clientgoscheme.AddToScheme(scheme))
 	require.NoError(t, v1.AddToScheme(scheme))

diff --git a/pkg/crd/crd_test.go b/pkg/crd/crd_test.go
@@ -1,5 +1,3 @@
-//go:build !disableDocker
-
 package crd_test
 
 import (
@@ -44,6 +42,8 @@ func (s *TestStore) Count() int32 {
 }
 
 func TestCRD(t *testing.T) {
+	testutils.IntegrationTest(t)
+
 	crdPath := filepath.Join(t.TempDir(), "crd.yaml")
 	require.NoError(t, testutils.CopyFile("../../kustomize/bases/functions_crd.yaml", crdPath))
 	fnCrdPath := filepath.Join(t.TempDir(), "fn-crd.yaml")

diff --git a/pkg/testutils/collector/collector_test.go b/pkg/testutils/collector/collector_test.go
@@ -1,18 +1,19 @@
-//go:build !disableDocker
-
 package collector_test
 
 import (
 	"context"
 	"testing"
 	"time"
 
+	"github.com/Azure/adx-mon/pkg/testutils"
 	"github.com/Azure/adx-mon/pkg/testutils/collector"
 	"github.com/stretchr/testify/require"
 	"github.com/testcontainers/testcontainers-go"
 )
 
 func TestCollector(t *testing.T) {
+	testutils.IntegrationTest(t)
+
 	ctx, cancel := context.WithTimeout(context.Background(), 15*time.Minute)
 	defer cancel()
 

diff --git a/pkg/testutils/ingestor/ingestor_test.go b/pkg/testutils/ingestor/ingestor_test.go
@@ -1,18 +1,19 @@
-//go:build !disableDocker
-
 package ingestor_test
 
 import (
 	"context"
 	"testing"
 	"time"
 
+	"github.com/Azure/adx-mon/pkg/testutils"
 	"github.com/Azure/adx-mon/pkg/testutils/ingestor"
 	"github.com/stretchr/testify/require"
 	"github.com/testcontainers/testcontainers-go"
 )
 
 func TestIngestor(t *testing.T) {
+	testutils.IntegrationTest(t)
+
 	ctx, cancel := context.WithTimeout(context.Background(), 15*time.Minute)
 	defer cancel()
 

diff --git a/pkg/testutils/integration_test.go b/pkg/testutils/integration_test.go
@@ -16,6 +16,8 @@ import (
 )
 
 func TestIntegration(t *testing.T) {
+	testutils.IntegrationTest(t)
+
 	// An extra generous timeout for the test. The test should run in
 	// about 5 minutes, but when running with the race detector, it
 	// can take longer.

diff --git a/pkg/testutils/kql_verify_test.go b/pkg/testutils/kql_verify_test.go
@@ -1,5 +1,3 @@
-//go:build !disableDocker
-
 package testutils_test
 
 import (
@@ -13,6 +11,8 @@ import (
 )
 
 func TestTableExists(t *testing.T) {
+	testutils.IntegrationTest(t)
+
 	k, err := kustainer.Run(context.Background(), "mcr.microsoft.com/azuredataexplorer/kustainer-linux:latest", kustainer.WithStarted())
 	testcontainers.CleanupContainer(t, k)
 	require.NoError(t, err)
@@ -22,6 +22,8 @@ func TestTableExists(t *testing.T) {
 }
 
 func TestTableHasRows(t *testing.T) {
+	testutils.IntegrationTest(t)
+
 	k, err := kustainer.Run(context.Background(), "mcr.microsoft.com/azuredataexplorer/kustainer-linux:latest", kustainer.WithStarted())
 	testcontainers.CleanupContainer(t, k)
 	require.NoError(t, err)

diff --git a/pkg/testutils/skip.go b/pkg/testutils/skip.go
@@ -0,0 +1,13 @@
+package testutils
+
+import (
+	"os"
+	"testing"
+)
+
+func IntegrationTest(t *testing.T) {
+	t.Helper()
+	if os.Getenv("INTEGRATION") == "" {
+		t.Skip("skipping integration tests, set environment variable INTEGRATION")
+	}
+}
diff --git a/pkg/testutils/uploader_test.go b/pkg/testutils/uploader_test.go
@@ -1,5 +1,3 @@
-//go:build !disableDocker
-
 package testutils_test
 
 import (
@@ -16,6 +14,8 @@ import (
 )
 
 func TestUploader(t *testing.T) {
+	testutils.IntegrationTest(t)
+
 	var (
 		database = "NetDefaultDB"
 		table    = "Table_0"