feat(Spanner): Add workflow dispatch options to run specific test suites or individual tests within Spanner PR (#3337)

* feat(Spanner): Add workflow dispatch options to run specific test suites or individual tests within Spanner PR

* feat: add conditional execution logic to Spanner PR workflow jobs.

Author: pratickchokhani

.github/workflows/spanner-load-tests.yml

@@ -21,6 +21,11 @@ on:
   # at 02:00 weekly on every Tuesday.
   - cron: '0 2 * * 2'
   workflow_dispatch:
+    inputs:
+      specific_test:
+        description: 'Specific Load Test (passed to -Dtest=)'
+        required: false
+        type: string
 
 permissions: write-all
 
@@ -102,7 +107,8 @@ jobs:
         --it-artifact-bucket="cloud-teleport-testing-it-gitactions" \
         --lt-export-project="cloud-teleport-testing" \
         --lt-export-dataset="performance_tests" \
-        --lt-export-table="template_performance_metrics"
+        --lt-export-table="template_performance_metrics" \
+        --test="${{ github.event.inputs.specific_test }}"
     - name: Upload Load Test Observer Report
       uses: actions/upload-artifact@v6
       if: always() # always run even if the previous step fails

.github/workflows/spanner-pr.yml

@@ -43,6 +43,11 @@ on:
   schedule:
   - cron: "3 */12 * * *"
   workflow_dispatch:
+    inputs:
+      specific_test:
+        description: 'Specific Integration Test (passed to -Dtest=)'
+        required: false
+        type: string
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -101,6 +106,8 @@ jobs:
   java_unit_tests:
     name: Unit Tests
     needs: [java_build]
+    # Skip if event is workflow_dispatch and inputs.specific_test is set.
+    if: github.event_name != 'workflow_dispatch' || github.event.inputs.specific_test == ''
     timeout-minutes: 60
     runs-on: [self-hosted, spanner-it]
     steps:
@@ -133,7 +140,9 @@ jobs:
       uses: ./.github/actions/cleanup-java-env
   java_integration_smoke_tests_templates:
     name: Dataflow Templates Integration Smoke Tests
+    # Skip if event is workflow_dispatch and inputs.specific_test is set.
     needs: [spotless_check, checkstyle_check, java_build, java_unit_tests]
+    if: github.event_name != 'workflow_dispatch' || github.event.inputs.specific_test == ''
     timeout-minutes: 60
     # Run on any runner that matches all the specified runs-on values.
     runs-on: [self-hosted, spanner-it]
@@ -167,6 +176,12 @@ jobs:
   java_integration_tests_templates:
     name: Dataflow Templates Integration Tests
     needs: [java_integration_smoke_tests_templates]
+    # Continue if previous workflows is skipped.
+    if: |
+      always() && 
+      (contains(needs.*.result, 'success') || contains(needs.*.result, 'skipped')) &&
+      !contains(needs.*.result, 'failure') &&
+      !contains(needs.*.result, 'cancelled')
     timeout-minutes: 180
     # Run on any runner that matches all the specified runs-on values.
     runs-on: [self-hosted, spanner-it]
@@ -184,7 +199,8 @@ jobs:
         --it-project="span-cloud-teleport-testing" \
         --it-artifact-bucket="span-cloud-teleport-testing-it-gitactions" \
         --it-private-connectivity="datastream-connect-2" \
-        --it-cloud-proxy-host="10.128.0.16"
+        --it-cloud-proxy-host="10.128.0.16" \
+        --test="${{ github.event.inputs.specific_test }}"
     - name: Upload Integration Tests Report
       uses: actions/upload-artifact@v6
       if: always() # always run even if the previous step fails

cicd/cmd/run-it-smoke-tests/main.go

@@ -72,7 +72,9 @@ func main() {
 		flags.CloudProxyHost(),
 		flags.CloudProxyMySqlPort(),
 		flags.CloudProxyPostgresPort(),
-		flags.CloudProxyPassword())
+		flags.CloudProxyPassword(),
+		mvnFlags.SpecificTest(flags.TestToRun()),
+		mvnFlags.FailIfNoTests(flags.TestToRun() != ""))
 	if err != nil {
 		log.Fatalf("%v\n", err)
 	}

cicd/cmd/run-it-tests/main.go

@@ -75,7 +75,9 @@ func main() {
 		flags.CloudProxyPostgresPort(),
 		flags.CloudProxyPassword(),
 		flags.UnifiedWorkerHarnessContainerImage(),
-		flags.CloudProxyPassword())
+		flags.CloudProxyPassword(),
+		mvnFlags.SpecificTest(flags.TestToRun()),
+		mvnFlags.FailIfNoTests(flags.TestToRun() != ""))
 	if err != nil {
 		log.Fatalf("%v\n", err)
 	}

cicd/cmd/run-load-test-observer/main.go

@@ -74,7 +74,9 @@ func main() {
 		flags.CloudProxyHost(),
 		flags.CloudProxyMySqlPort(),
 		flags.CloudProxyPostgresPort(),
-		flags.CloudProxyPassword())
+		flags.CloudProxyPassword(),
+		mvnFlags.SpecificTest(flags.TestToRun()),
+		mvnFlags.FailIfNoTests(flags.TestToRun() != ""))
 	if err != nil {
 		log.Fatalf("%v\n", err)
 	}

cicd/cmd/run-load-tests/main.go

@@ -74,7 +74,9 @@ func main() {
 		flags.CloudProxyHost(),
 		flags.CloudProxyMySqlPort(),
 		flags.CloudProxyPostgresPort(),
-		flags.CloudProxyPassword())
+		flags.CloudProxyPassword(),
+		mvnFlags.SpecificTest(flags.TestToRun()),
+		mvnFlags.FailIfNoTests(flags.TestToRun() != ""))
 	if err != nil {
 		log.Fatalf("%v\n", err)
 	}

cicd/cmd/run-unit-tests/main.go

@@ -39,6 +39,8 @@ func main() {
 		mvnFlags.SkipIntegrationTests(),
 		mvnFlags.FailAtTheEnd(),
 		mvnFlags.ThreadCount(8),
+		mvnFlags.SpecificTest(flags.TestToRun()),
+		mvnFlags.FailIfNoTests(flags.TestToRun() != ""),
 		mvnFlags.InternalMaven())
 	if err != nil {
 		log.Fatalf("%v\n", err)

cicd/internal/flags/common-flags.go

@@ -34,6 +34,7 @@ const (
 // Avoid making these vars public.
 var (
 	modulesToBuild string
+	testToRun      string
 	moduleMap      = map[string][]string{
 		ALL:     {},
 		DEFAULT: {},
@@ -76,6 +77,7 @@ var (
 // Registers all common flags. Must be called before flag.Parse().
 func RegisterCommonFlags() {
 	flag.StringVar(&modulesToBuild, "modules-to-build", ALL, "List of modules to build/run commands against")
+	flag.StringVar(&testToRun, "test", "", "Specific test to run")
 }
 
 // Returns all modules to build.
@@ -102,3 +104,8 @@ func ModulesToBuild() []string {
 	}
 	return strings.Split(m, ",")
 }
+
+// Returns the specific test to run.
+func TestToRun() string {
+	return testToRun
+}

cicd/internal/workflows/maven-workflows.go

@@ -61,6 +61,8 @@ type MavenFlags interface {
 	StaticSpannerInstance(string) string
 	SpannerHost(string) string
 	InternalMaven() string
+	SpecificTest(string) string
+	FailIfNoTests(bool) string
 }
 
 type mvnFlags struct{}
@@ -163,6 +165,20 @@ func (*mvnFlags) InternalMaven() string {
 	return "--settings=.mvn/settings.xml"
 }
 
+func (*mvnFlags) SpecificTest(test string) string {
+	if test == "" {
+		return ""
+	}
+	return "-Dtest=" + test
+}
+
+func (*mvnFlags) FailIfNoTests(skip bool) string {
+	if skip {
+		return "-Dsurefire.failIfNoSpecifiedTests=false"
+	}
+	return ""
+}
+
 func NewMavenFlags() MavenFlags {
 	return &mvnFlags{}
 }