Extract functional test steps into reusable composite action

akhileshsingh85 · akhileshsingh85 · commit a59d509155b6 · 2026-04-22T16:10:34.000-07:00
All kind-based functional test jobs now delegate to
.github/actions/functional-test, which owns: Go setup, kind cluster
creation, TLS cert fix, dep-update, optional test image build,
make functionaltest, and debug artifact upload.

Callers pass k8s-version, suite, go-version (or go-version-file),
and optional flags for image override, debug info, and golden file
updates.
diff --git a/.github/actions/functional-test/action.yaml b/.github/actions/functional-test/action.yaml
@@ -0,0 +1,117 @@
+name: Run Functional Tests
+description: >
+  Sets up a kind cluster, installs dependencies, and runs a functional test
+  suite. Optionally overrides the collector image and uploads debug artifacts.
+
+inputs:
+  k8s-version:
+    description: 'Kubernetes version for the kind cluster (e.g. v1.34.3)'
+    required: true
+  suite:
+    description: 'Test suite to run (passed as SUITE= to make functionaltest)'
+    required: true
+  go-version:
+    description: 'Go version to install'
+    required: false
+    default: ''
+  go-version-file:
+    description: 'Path to go.mod to determine Go version (used when go-version is not set)'
+    required: false
+    default: ''
+  build-test-images:
+    description: 'Whether to build and load test images into kind'
+    required: false
+    default: 'true'
+  update-expected-results:
+    description: 'Whether to update golden file expected test results'
+    required: false
+    default: 'false'
+  kubernetes-debug-info:
+    description: 'Whether to collect and upload k8s debug info'
+    required: false
+    default: 'false'
+  artifact-suffix:
+    description: 'Suffix for the k8s debug info artifact name'
+    required: false
+    default: ''
+  otelcol-image-repo:
+    description: 'Override for the collector image repository'
+    required: false
+    default: ''
+  otelcol-image-tag:
+    description: 'Override for the collector image tag'
+    required: false
+    default: ''
+
+runs:
+  using: composite
+  steps:
+    - name: Set KUBECONFIG for all steps
+      shell: bash
+      run: echo "KUBECONFIG=/tmp/kube-config-splunk-otel-collector-chart-functional-testing" >> "$GITHUB_ENV"
+
+    - name: Set up Go
+      uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6
+      with:
+        go-version: ${{ inputs.go-version != '' && inputs.go-version || '' }}
+        go-version-file: ${{ inputs.go-version-file != '' && inputs.go-version-file || '' }}
+        cache-dependency-path: '**/go.sum'
+
+    - name: Create kind cluster
+      uses: helm/kind-action@ef37e7f390d99f746eb8b610417061a60e82a6cc # v1.14.0
+      with:
+        node_image: kindest/node:${{ inputs.k8s-version }}
+        kubectl_version: ${{ inputs.k8s-version }}
+        cluster_name: kind
+        config: ./.github/workflows/configs/kind-config.yaml
+
+    - name: Fix kubelet TLS server certificates
+      shell: bash
+      run: |
+        kubectl get csr -o=jsonpath='{range.items[?(@.spec.signerName=="kubernetes.io/kubelet-serving")]}{.metadata.name}{" "}{end}' | xargs kubectl certificate approve
+
+    - name: Update dependencies
+      shell: bash
+      run: make dep-update
+
+    - name: Build and load test images into kind
+      if: inputs.build-test-images == 'true'
+      shell: bash
+      run: make kind-build-test-images
+
+    - name: Run functional tests
+      id: run-functional-tests
+      shell: bash
+      env:
+        KUBE_TEST_ENV: kind
+        K8S_VERSION: ${{ inputs.k8s-version }}
+        OTELCOL_IMAGE_REPO: ${{ inputs.otelcol-image-repo }}
+        OTELCOL_IMAGE_TAG: ${{ inputs.otelcol-image-tag }}
+      run: |
+        TEARDOWN_BEFORE_SETUP=true \
+          UPDATE_EXPECTED_RESULTS=${{ inputs.update-expected-results }} \
+          SUITE=${{ inputs.suite }} \
+          make functionaltest
+
+    - name: Collect Kubernetes Cluster debug info
+      if: always() && (steps.run-functional-tests.outcome == 'failure' || inputs.kubernetes-debug-info == 'true')
+      shell: bash
+      run: |
+        cd tools
+        ./splunk_kubernetes_debug_info.sh
+
+    - name: Upload Kubernetes Cluster debug info
+      if: always() && (steps.run-functional-tests.outcome == 'failure' || inputs.kubernetes-debug-info == 'true')
+      uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
+      with:
+        name: k8s-debug-info${{ inputs.artifact-suffix != '' && format('-{0}', inputs.artifact-suffix) || '' }}
+        path: tools/splunk_kubernetes_debug_info_*
+        retention-days: 5
+
+    - name: Upload updated expected results
+      if: always() && inputs.update-expected-results == 'true'
+      uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
+      with:
+        name: updated_expected_results${{ inputs.artifact-suffix != '' && format('-{0}', inputs.artifact-suffix) || '' }}
+        path: ./functional_tests/**/*.yaml
+        retention-days: 5
diff --git a/.github/workflows/dev-image-test.yaml b/.github/workflows/dev-image-test.yaml
@@ -1,8 +1,8 @@
 name: Dev Image Tests
 
 on:
-  schedule:
-    - cron: "0 6 * * *"
+  pull_request:
+    types: [labeled]
   workflow_dispatch:
     inputs:
       collector_image:
@@ -27,6 +27,9 @@ env:
 
 jobs:
   get-test-matrix:
+    if: >
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'pull_request' && github.event.label.name == 'run-dev-image-test')
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
@@ -42,62 +45,25 @@ jobs:
     name: K8s ${{ matrix.k8s-kind-version }} / ${{ matrix.test-job }}
     runs-on: ubuntu-latest
     needs: get-test-matrix
-    env:
-      KUBECONFIG: /tmp/kube-config-splunk-otel-collector-chart-functional-testing
-      KUBE_TEST_ENV: kind
-      KUBERNETES_DEBUG_INFO: ${{ github.event.inputs.KUBERNETES_DEBUG_INFO || 'false' }}
     strategy:
       fail-fast: false
       matrix: ${{ fromJSON(needs.get-test-matrix.outputs.matrix) }}
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
-      - uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6
-        with:
-          go-version: ${{ env.GO_VERSION }}
-          cache-dependency-path: '**/go.sum'
 
-      - name: Set collector image overrides
+      - name: Parse collector image input
+        id: parse-image
         run: |
           IMAGE="${{ github.event.inputs.collector_image || 'quay.io/signalfx/splunk-otel-collector-dev:latest' }}"
-          echo "OTELCOL_IMAGE_REPO=${IMAGE%:*}" >> "$GITHUB_ENV"
-          echo "OTELCOL_IMAGE_TAG=${IMAGE##*:}" >> "$GITHUB_ENV"
+          echo "repo=${IMAGE%:*}" >> "$GITHUB_OUTPUT"
+          echo "tag=${IMAGE##*:}" >> "$GITHUB_OUTPUT"
 
-      - name: Create kind cluster
-        uses: helm/kind-action@ef37e7f390d99f746eb8b610417061a60e82a6cc # v1.14.0
+      - uses: ./.github/actions/functional-test
         with:
-          node_image: kindest/node:${{ matrix.k8s-kind-version }}
-          kubectl_version: ${{ matrix.k8s-kind-version }}
-          cluster_name: kind
-          config: ./.github/workflows/configs/kind-config.yaml
-
-      - name: Fix kubelet TLS server certificates
-        run: |
-          kubectl get csr -o=jsonpath='{range.items[?(@.spec.signerName=="kubernetes.io/kubelet-serving")]}{.metadata.name}{" "}{end}' | xargs kubectl certificate approve
-
-      - name: Update dependencies
-        run: make dep-update
-
-      - name: Build and load test images into kind
-        run: make kind-build-test-images
-
-      - name: Run functional tests
-        id: run-functional-tests
-        env:
-          K8S_VERSION: ${{ matrix.k8s-kind-version }}
-        run: |
-          TEARDOWN_BEFORE_SETUP=true SUITE=${{ matrix.test-job }} make functionaltest
-
-      - name: Collect Kubernetes Cluster debug info on failure
-        if: always() && (steps.run-functional-tests.outcome == 'failure' || env.KUBERNETES_DEBUG_INFO == 'true')
-        id: collect-debug-info
-        run: |
-          cd tools
-          ./splunk_kubernetes_debug_info.sh
-
-      - name: Upload Kubernetes Cluster debug info
-        if: always() && (steps.run-functional-tests.outcome == 'failure' || env.KUBERNETES_DEBUG_INFO == 'true')
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
-        with:
-          name: k8s-debug-info-${{ matrix.test-job }}-${{ matrix.k8s-kind-version }}
-          path: tools/splunk_kubernetes_debug_info_*
-          retention-days: 5
+          k8s-version: ${{ matrix.k8s-kind-version }}
+          suite: ${{ matrix.test-job }}
+          go-version: ${{ env.GO_VERSION }}
+          kubernetes-debug-info: ${{ github.event.inputs.KUBERNETES_DEBUG_INFO || 'false' }}
+          artifact-suffix: ${{ matrix.test-job }}-${{ matrix.k8s-kind-version }}
+          otelcol-image-repo: ${{ steps.parse-image.outputs.repo }}
+          otelcol-image-tag: ${{ steps.parse-image.outputs.tag }}
diff --git a/.github/workflows/functional_test_v2.yaml b/.github/workflows/functional_test_v2.yaml
@@ -49,8 +49,7 @@ jobs:
 
   kubernetes-test:
     env:
-      KUBECONFIG: /tmp/kube-config-splunk-otel-collector-chart-functional-testing
-      KUBE_TEST_ENV: kind
+      KUBE_TEST_ENV: kind 
       UPDATE_EXPECTED_RESULTS: ${{ github.event.inputs.UPDATE_EXPECTED_RESULTS || 'false' }}
       KUBERNETES_DEBUG_INFO: ${{ github.event.inputs.KUBERNETES_DEBUG_INFO || 'false' }}
     needs: get-test-matrix
@@ -61,53 +60,14 @@ jobs:
     continue-on-error: ${{ contains(github.event.pull_request.labels.*.name, 'Ignore Tests') }}
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
-      - uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6
+      - uses: ./.github/actions/functional-test
         with:
+          k8s-version: ${{ matrix.k8s-kind-version }}
+          suite: ${{ matrix.test-job }}
           go-version: ${{ env.GO_VERSION }}
-          cache-dependency-path: '**/go.sum'
-      - name: Create kind cluster
-        uses: helm/kind-action@ef37e7f390d99f746eb8b610417061a60e82a6cc # v1.14.0
-        with:
-          node_image: kindest/node:${{ matrix.k8s-kind-version }}
-          kubectl_version: ${{ matrix.k8s-kind-version }}
-          cluster_name: kind
-          config: ./.github/workflows/configs/kind-config.yaml
-      - name: Fix kubelet TLS server certificates
-        run: |
-          kubectl get csr -o=jsonpath='{range.items[?(@.spec.signerName=="kubernetes.io/kubelet-serving")]}{.metadata.name}{" "}{end}' | xargs kubectl certificate approve
-      - name: Update dependencies
-        run: |
-          make dep-update
-      - name: Build and load test images into kind
-        run: |
-          make kind-build-test-images
-      - name: run functional tests
-        id: run-functional-tests
-        env:
-          K8S_VERSION: ${{ matrix.k8s-kind-version }}
-        run: |
-          TEARDOWN_BEFORE_SETUP=true UPDATE_EXPECTED_RESULTS=${{ env.UPDATE_EXPECTED_RESULTS }} SUITE=${{ matrix.test-job }} make functionaltest
-      - name: Collect Kubernetes Cluster debug info on failure
-        if: always() && (steps.run-functional-tests.outcome == 'failure' || env.KUBERNETES_DEBUG_INFO == 'true')
-        id: collect-debug-info
-        run: |
-          echo "Functional tests failed. Collecting debug info for current state of the Kubernetes cluster..."
-          cd tools
-          ./splunk_kubernetes_debug_info.sh
-      - name: Upload Kubernetes Cluster debug info
-        if: always() && (steps.run-functional-tests.outcome == 'failure' || env.KUBERNETES_DEBUG_INFO == 'true')
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
-        with:
-          name: k8s-debug-info-${{ matrix.test-job }}-${{ matrix.k8s-kind-version }}
-          path: tools/splunk_kubernetes_debug_info_*
-          retention-days: 5
-      - name: Upload updated files artifact
-        if: always() && env.UPDATE_EXPECTED_RESULTS == 'true'
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
-        with:
-          name: updated_expected_results-${{ matrix.test-job }}-${{ matrix.k8s-kind-version }}
-          path: ./functional_tests/**/*.yaml
-          retention-days: 5
+          update-expected-results: ${{ env.UPDATE_EXPECTED_RESULTS }}
+          kubernetes-debug-info: ${{ env.KUBERNETES_DEBUG_INFO }}
+          artifact-suffix: ${{ matrix.test-job }}-${{ matrix.k8s-kind-version }}
 
   eks-test:
     name: Test helm install in EKS - credentials needed
diff --git a/.github/workflows/instrumentation_cr_test.yaml b/.github/workflows/instrumentation_cr_test.yaml
@@ -15,35 +15,10 @@ jobs:
     continue-on-error: ${{ contains(github.event.pull_request.labels.*.name, 'Ignore Tests') }}
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
-      - uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6
+      - uses: ./.github/actions/functional-test
         with:
+          k8s-version: v1.34.3
+          suite: instrumentation_cr
           go-version-file: functional_tests/go.mod
-          cache-dependency-path: functional_tests/go.sum
-      - name: Create kind cluster
-        uses: helm/kind-action@ef37e7f390d99f746eb8b610417061a60e82a6cc # v1.14.0
-        with:
-          node_image: kindest/node:v1.34.3
-          kubectl_version: v1.34.3
-          cluster_name: kind
-          config: ./.github/workflows/configs/kind-config.yaml
-      - name: Fix kubelet TLS server certificates
-        run: |
-          kubectl get csr -o=jsonpath='{range.items[?(@.spec.signerName=="kubernetes.io/kubelet-serving")]}{.metadata.name}{" "}{end}' | xargs kubectl certificate approve
-      - name: Update Helm dependencies
-        run: make dep-update
-      - name: Run instrumentation CR e2e tests
-        id: run-e2e
-        run: make functionaltest SUITE=instrumentation_cr
-      - name: Collect Kubernetes Cluster debug info on failure
-        if: always() && steps.run-e2e.outcome == 'failure'
-        run: |
-          echo "Instrumentation CR tests failed. Collecting debug info..."
-          cd tools
-          ./splunk_kubernetes_debug_info.sh
-      - name: Upload Kubernetes Cluster debug info
-        if: always() && steps.run-e2e.outcome == 'failure'
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
-        with:
-          name: k8s-debug-info-instrumentation-cr
-          path: tools/splunk_kubernetes_debug_info_*
-          retention-days: 5
+          build-test-images: 'false'
+          artifact-suffix: instrumentation-cr
