Action inputs to dispatch n-runs of a single test in CI

.github/workflows/run-tests.yml

@@ -13,6 +13,21 @@ on:
       commit:
         description: "Commit SHA"
         required: true
+      run_single_functional_test:
+        description: "Whether to run a single test. If so, the rest of the input fields are required."
+        type: boolean
+        default: false
+      n_runs:
+        description: "[Single Test Only] Number of times to repeat the single test per database type"
+        type: number
+        default: 1
+      test_name:
+        description: "[Single Test Only] Name of the test suite to run, include -testify.m flag here if desired (i.e. 'TestAcquireShard_DeadlineExceededErrorSuite' or 'TestFunctionalSuite -testify.m=TestUpdateWorkflow')"
+        type: string
+      timeout_minutes:
+        description: "[Single Test Only] Github Action timeout in minutes"
+        type: number
+        default: 120
 
 concurrency: # Auto-cancel existing runs in the PR when a new commit is pushed
   group: run-tests-${{ github.head_ref || github.run_id }}
@@ -29,7 +44,9 @@ env:
   BUILDKITE_ANALYTICS_TOKEN: ${{ secrets.BUILDKITE_ANALYTICS_TOKEN }}
 
 jobs:
+
   misc-checks:
+    if: ${{ inputs.run_single_functional_test != true }}
     name: Misc checks
     strategy:
       fail-fast: false
@@ -79,6 +96,7 @@ jobs:
       - run: docker compose -f ${{ env.DOCKER_COMPOSE_FILE }} pull
 
   unit-test:
+    if: ${{ inputs.run_single_functional_test != true }}
     name: Unit test
     needs: misc-checks
     strategy:
@@ -106,6 +124,7 @@ jobs:
         run: make upload-test-results
 
   integration-test:
+    if: ${{ inputs.run_single_functional_test != true }}
     name: Integration test
     needs: [misc-checks, cache-docker-images]
     strategy:
@@ -145,21 +164,47 @@ jobs:
         run: |
           docker compose -f ${{ env.DOCKER_COMPOSE_FILE }} down -v
 
+
+  set-up-functional-test:
+    name: Set up functional test
+    runs-on: ubuntu-20.04
+    outputs:
+      shard_indices: ${{ steps.generate_output.outputs.shard_indices }}
+      total_shards: ${{ steps.generate_output.outputs.shards }}
+      single_test_args: ${{ steps.generate_output.outputs.single_test_args }}
+      functional_test_timeout: ${{ steps.generate_output.outputs.timeout }}
+    steps:
+      - id: generate_output
+        run: |
+          shards=3
+          timeout=30
+          if [[ "${{ inputs.run_single_functional_test }}" == "true" ]]; then
+            shards=1
+            timeout=${{ inputs.timeout_minutes }}
+            single_test_args="-test.run ${{ inputs.test_name }} -count ${{ inputs.n_runs }}"
+          fi
+          {
+            echo "shard_indices=[$(seq -s, 0 $((shards-1)))]"
+            echo "shards=$shards"
+            echo "timeout=$timeout"
+            echo "single_test_args=$single_test_args" 
+          } >> "$GITHUB_OUTPUT"
+
   functional-test:
     name: Functional test
-    needs: [misc-checks, cache-docker-images]
+    needs: [cache-docker-images, set-up-functional-test]
     strategy:
       fail-fast: false
       matrix:
         runs-on: [ubuntu-20.04]
+        shard_index: ${{ fromJson(needs.set-up-functional-test.outputs.shard_indices) }}
         name:
           - cass_es
           # - cass_es8
           - sqlite
           - mysql8
           - postgres12
           - postgres12_pgx
-        shard_index: [0, 1, 2]
         include:
           - name: cass_es
             persistence_type: nosql
@@ -187,10 +232,12 @@ jobs:
             containers: [postgresql]
     runs-on: ${{ matrix.runs-on }}
     env:
-      TEST_TOTAL_SHARDS: 3
+      TEST_TOTAL_SHARDS: ${{ needs.set-up-functional-test.outputs.total_shards }}
       TEST_SHARD_INDEX: ${{ matrix.shard_index }}
       PERSISTENCE_TYPE: ${{ matrix.persistence_type }}
       PERSISTENCE_DRIVER: ${{ matrix.persistence_driver }}
+      SINGLE_TEST_ARGS: ${{ needs.set-up-functional-test.outputs.single_test_args }}
+      FUNCTIONAL_TEST_TIMEOUT: ${{ needs.set-up-functional-test.outputs.functional_test_timeout }}
     steps:
       - uses: ScribeMD/[email protected]
         with:
@@ -212,7 +259,7 @@ jobs:
           docker compose -f ${{ env.DOCKER_COMPOSE_FILE }} up -d ${{ join(matrix.containers, ' ') }}
 
       - name: Run functional test
-        timeout-minutes: 30 # make sure this is larger than the test timeout in the Makefile
+        timeout-minutes: ${{ fromJSON(env.FUNCTIONAL_TEST_TIMEOUT) }} # make sure this is larger than the test timeout in the Makefile
         run: make functional-test-coverage
 
       - name: Upload test results
@@ -225,6 +272,7 @@ jobs:
           docker compose -f ${{ env.DOCKER_COMPOSE_FILE }} down -v
 
   functional-test-xdc:
+    if: ${{ inputs.run_single_functional_test != true }}
     name: Functional test xdc
     needs: [misc-checks, cache-docker-images]
     strategy:
@@ -292,6 +340,7 @@ jobs:
           docker compose -f ${{ env.DOCKER_COMPOSE_FILE }} down -v
 
   functional-test-ndc:
+    if: ${{ inputs.run_single_functional_test != true }}
     name: Functional test ndc
     needs: [misc-checks, cache-docker-images]
     strategy:
@@ -359,6 +408,7 @@ jobs:
           docker compose -f ${{ env.DOCKER_COMPOSE_FILE }} down -v
 
   test-status:
+    if: ${{ inputs.run_single_functional_test != true }}
     name: Test Status
     needs:
       - unit-test
@@ -367,7 +417,6 @@ jobs:
       - functional-test-xdc
       - functional-test-ndc
     runs-on: ubuntu-20.04
-    if: always()
     env:
       RESULTS: ${{ toJSON(needs.*.result) }}
     steps:

Makefile

@@ -386,8 +386,15 @@ pre-build-functional-test-coverage: prepare-coverage-test
 
 functional-test-coverage: prepare-coverage-test
 	@printf $(COLOR) "Run functional tests with coverage with $(PERSISTENCE_DRIVER) driver..."
+	$(GOTESTSUM) --junitfile $(NEW_REPORT) -- \
+		$(FUNCTIONAL_TEST_ROOT) -shuffle on -timeout=$(TEST_TIMEOUT) $(TEST_ARGS) $(SINGLE_TEST_ARGS) $(TEST_TAG_FLAG) \
+		 -persistenceType=$(PERSISTENCE_TYPE) -persistenceDriver=$(PERSISTENCE_DRIVER) \
+		 $(FUNCTIONAL_TEST_COVERPKG) -coverprofile=$(NEW_COVER_PROFILE)
+
+functional-test-n-times: prepare-coverage-test
+	@printf $(COLOR) "Run functional test $(TEST_NAME) $(N_RUNS) times with $(PERSISTENCE_DRIVER) driver..."
 	@$(GOTESTSUM) --junitfile $(NEW_REPORT) -- \
-		$(FUNCTIONAL_TEST_ROOT) -shuffle on -timeout=$(TEST_TIMEOUT) $(TEST_ARGS) $(TEST_TAG_FLAG) -persistenceType=$(PERSISTENCE_TYPE) -persistenceDriver=$(PERSISTENCE_DRIVER) $(FUNCTIONAL_TEST_COVERPKG) -coverprofile=$(NEW_COVER_PROFILE)
+		$(FUNCTIONAL_TEST_ROOT) -shuffle on -timeout=$(TEST_TIMEOUT) $(TEST_ARGS) -test.run $(TEST_NAME) -count $(N_TEST_RUNS) $(TEST_TAG_FLAG) -persistenceType=$(PERSISTENCE_TYPE) -persistenceDriver=$(PERSISTENCE_DRIVER)
 
 functional-test-xdc-coverage: prepare-coverage-test
 	@printf $(COLOR) "Run functional test for cross DC with coverage with $(PERSISTENCE_DRIVER) driver..."