test(integration): refactor to run db integration test as matrix (#1018)

Co-authored-by: David May <[email protected]>
go-vela · Dec 6, 2023 · 5e1a7d3 · 5e1a7d3
1 parent fb12fdd
commit 5e1a7d3
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 7 deletions.
diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml
@@ -10,12 +10,19 @@ on:
 
 # pipeline to execute
 jobs:
-  database:
+  database_postgres:
     runs-on: ubuntu-latest
 
+    strategy:
+      matrix:
+        # support should be n-1 here
+        postgres_version:
+          - postgres:15-alpine
+          - postgres:16-alpine
+
     services:
       postgres:
-        image: postgres:15-alpine@sha256:35ce2187f2f7fb75e8e79493e13743596c21eb3789ff41ece145ae04d06e93a5
+        image: ${{ matrix.postgres_version }}
         env:
           POSTGRES_DB: vela
           POSTGRES_PASSWORD: notARealPassword12345
@@ -30,6 +37,27 @@ jobs:
 
     env:
       POSTGRES_ADDR: postgres://vela:notARealPassword12345@localhost:5432/vela
+
+    steps:
+      - name: clone
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+
+      - name: install go
+        uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # v4
+        with:
+          # use version from go.mod file
+          go-version-file: 'go.mod'
+          cache: true
+          check-latest: true
+
+      - name: testing with ${{ matrix.postgres_version }}
+        run: |
+          DB_DRIVER=postgres make integration-test
+
+  database_sql:
+    runs-on: ubuntu-latest
+
+    env:
       SQLITE_ADDR: vela.db
 
     steps:
@@ -44,6 +72,6 @@ jobs:
           cache: true
           check-latest: true
 
-      - name: test
+      - name: testing with sqlite
         run: |
-          make integration-test
+          DB_DRIVER=sqlite make integration-test
diff --git a/Makefile b/Makefile
@@ -89,12 +89,25 @@ fix:
 	@echo "### Fixing Go Code"
 	@go fix ./...
 
-# The `integration-test` target is intended to run all integration tests for the Go source code.
+# The `integration-test` target is intended to run all database integration
+# tests for the Go source code.
+#
+# Optionally target specific database drivers by passing a variable
+# named "DB_DRIVER" to the make command. This assumes that test names
+# coincide with database driver names.
+#
+# Example: "DB_DRIVER=postgres make integration-test"
+# will only run integration tests for the postgres driver.
 .PHONY: integration-test
 integration-test:
 	@echo
-	@echo "### Integration Testing"
-	INTEGRATION=1 go test -run TestDatabase_Integration ./...
+	@if [ -n "$(DB_DRIVER)" ]; then \
+		echo "### DB Integration Testing ($(DB_DRIVER))"; \
+		INTEGRATION=1 go test -run TestDatabase_Integration/$(DB_DRIVER) ./...; \
+	else \
+		echo "### DB Integration Testing"; \
+		INTEGRATION=1 go test -run TestDatabase_Integration ./...; \
+	fi
 
 # The `test` target is intended to run
 # the tests for the Go source code.