Simplify the e2e test workflow by creating a composite action (#2978)

Move code to composite action in order to remove code duplication.
Dynatrace · Apr 9, 2024 · f25531b · f25531b
1 parent dd1f382
commit f25531b
Show file tree

Hide file tree

Showing 2 changed files with 142 additions and 102 deletions.
diff --git a/.github/actions/run-e2e/action.yaml b/.github/actions/run-e2e/action.yaml
@@ -0,0 +1,95 @@
+name: Run e2e tests
+description: Runs the e2e test in the specified environment
+inputs:
+  flc-namespace:
+    description: The namespace FLC uses
+    required: true
+  flc-environment:
+    description: The environment FLC uses
+    required: true
+  target-branch:
+    description: Target branch to run E2E tests over
+    required: true
+    default: main
+  tenant1-name:
+    description: The name of Tenant 1
+    required: true
+  tenant1-apitoken:
+    description: The API token of Tenant 1
+    required: true
+  tenant1-oteltoken:
+    description: The OTel token of Tenant 1
+    required: true
+  tenant1-oauth-client-id:
+    description: The OAuth client ID of Tenant 1
+    required: true
+  tenant1-oauth-secret:
+    description: The OAuth secret of Tenant 1
+    required: true
+  tenant2-name:
+    description: The name of Tenant 2
+    required: true
+  tenant2-apitoken:
+    description: The API token of Tenant 2
+    required: true
+  github-token:
+    description: The GitHub token
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Checkout workflow scripts from ref branch
+      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        path: ref
+    - name: Checkout target branch
+      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      with:
+        ref: ${{ github.event.inputs.target || 'main' }}
+        path: target
+    - name: Set up kubectl
+      uses: azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
+    - name: Set up go
+      uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
+      with:
+        go-version-file: "${{ github.workspace }}/target/go.mod"
+    - name: Set up helm
+      uses: azure/setup-helm@5119fcb9089d432beecbf79bb2c7915207344b78 # v3.5
+      with:
+        token: ${{ inputs.github-token }}
+    - name: Install gotestsum
+      shell: bash
+      run: go install gotest.tools/gotestsum@latest
+    - name: Create cluster
+      shell: bash
+      run: ref/.github/scripts/create-cluster.sh
+      env:
+        FLC_NAMESPACE: ${{ inputs.flc-namespace }}
+        FLC_ENVIRONMENT: ${{ inputs.flc-environment }}
+    - name: Run tests
+      shell: bash
+      run: ref/.github/scripts/run-e2e-tests.sh
+      env:
+        FLC_NAMESPACE: ${{ inputs.flc-namespace }}
+        FLC_ENVIRONMENT: ${{ inputs.flc-environment }}
+        TARGET_BRANCH: ${{ inputs.target-branch || 'main' }}
+        TENANT1_NAME: ${{ inputs.tenant1-name }}
+        TENANT1_APITOKEN: ${{ inputs.tenant1-apitoken }}
+        TENANT1_OTELTOKEN: ${{ inputs.tenant1-oteltoken }}
+        TENANT1_OAUTH_CLIENT_ID: ${{ inputs.tenant1-oauth-client-id }}
+        TENANT1_OAUTH_SECRET: ${{ inputs.tenant1-oauth-secret }}
+        TENANT2_NAME: ${{ inputs.tenant2-name }}
+        TENANT2_APITOKEN: ${{ inputs.tenant2-apitoken }}
+    - name: Destroy cluster
+      shell: bash
+      run: ref/.github/scripts/destroy-cluster.sh
+      env:
+        FLC_NAMESPACE: ${{ inputs.flc-namespace }}
+        FLC_ENVIRONMENT: ${{ inputs.flc-environment }}
+      if: always()
+    - name: Publish test results
+      uses: EnricoMi/publish-unit-test-result-action@v2
+      with:
+        files: target/results/*.xml
+      if: always()
diff --git a/.github/workflows/e2e-tests.yaml b/.github/workflows/e2e-tests.yaml
@@ -18,118 +18,63 @@ jobs:
   run-in-k8s:
     name: Run in Kubernetes latest (${{ github.event.inputs.target || 'main' }})
     environment: E2E
-    env:
-      FLC_NAMESPACE: dto-daily
-      FLC_ENVIRONMENT: dto-k8s-latest-flc
-      TARGET_BRANCH: ${{ github.event.inputs.target || 'main' }}
-      TENANT1_NAME: ${{ secrets.TENANT1_NAME }}
-      TENANT1_APITOKEN: ${{ secrets.TENANT1_APITOKEN }}
-      TENANT1_OTELTOKEN: ${{ secrets.TENANT1_OTELTOKEN }}
-      TENANT1_OAUTH_CLIENT_ID: ${{ secrets.TENANT1_OAUTH_CLIENT_ID }}
-      TENANT1_OAUTH_SECRET: ${{ secrets.TENANT1_OAUTH_SECRET }}
-      TENANT2_NAME: ${{ secrets.TENANT2_NAME }}
-      TENANT2_APITOKEN: ${{ secrets.TENANT2_APITOKEN }}
     runs-on:
-    - self-hosted
-    - operator-e2e
+      - self-hosted
+      - operator-e2e
     steps:
-    - name: Checkout workflow scripts from ref branch
-      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-      with:
-        path: ref
-    - name: Checkout target branch
-      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-      with:
-        ref: ${{ github.event.inputs.target || 'main' }}
-        path: target
-    - name: Set up kubectl
-      uses: azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
-    - name: Set up go
-      uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
-      with:
-        go-version-file: "${{ github.workspace }}/target/go.mod"
-    - name: Set up helm
-      uses: azure/setup-helm@5119fcb9089d432beecbf79bb2c7915207344b78 # v3.5
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-    - name: Install gotestsum
-      run: go install gotest.tools/gotestsum@latest
-    - name: Create cluster
-      run: ref/.github/scripts/create-cluster.sh
-    - name: Run tests
-      run: ref/.github/scripts/run-e2e-tests.sh
-    - name: Destroy cluster
-      run: ref/.github/scripts/destroy-cluster.sh
-      if: always()
-    - name: Publish test results
-      uses: EnricoMi/publish-unit-test-result-action@v2
-      with:
-        files: target/results/*.xml
-      if: always()
+      - name: Checkout
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: Run e2e test
+        uses: ./.github/actions/run-e2e
+        with:
+          flc-namespace: dto-daily
+          flc-environment: dto-k8s-latest-flc
+          target-branch: ${{ github.event.inputs.target }}
+          tenant1-name: ${{ secrets.TENANT1_NAME }}
+          tenant1-apitoken: ${{ secrets.TENANT1_APITOKEN }}
+          tenant1-oteltoken: ${{ secrets.TENANT1_OTELTOKEN }}
+          tenant1-oauth-client-id: ${{ secrets.TENANT1_OAUTH_CLIENT_ID }}
+          tenant1-oauth-secret: ${{ secrets.TENANT1_OAUTH_SECRET }}
+          tenant2-name: ${{ secrets.TENANT2_NAME }}
+          tenant2-apitoken: ${{ secrets.TENANT2_APITOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
   run-in-ocp:
     name: Run in OpenShift latest (${{ github.event.inputs.target || 'main' }})
     environment: E2E
-    env:
-      FLC_NAMESPACE: dto-daily
-      FLC_ENVIRONMENT: dto-ocp-latest-flc
-      TARGET_BRANCH: ${{ github.event.inputs.target || 'main' }}
-      TENANT1_NAME: ${{ secrets.TENANT1_NAME }}
-      TENANT1_APITOKEN: ${{ secrets.TENANT1_APITOKEN }}
-      TENANT1_OTELTOKEN: ${{ secrets.TENANT1_OTELTOKEN }}
-      TENANT1_OAUTH_CLIENT_ID: ${{ secrets.TENANT1_OAUTH_CLIENT_ID }}
-      TENANT1_OAUTH_SECRET: ${{ secrets.TENANT1_OAUTH_SECRET }}
-      TENANT2_NAME: ${{ secrets.TENANT2_NAME }}
-      TENANT2_APITOKEN: ${{ secrets.TENANT2_APITOKEN }}
     runs-on:
-    - self-hosted
-    - operator-e2e
+      - self-hosted
+      - operator-e2e
     steps:
-    - name: Checkout workflow scripts from ref branch
-      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-      with:
-        path: ref
-    - name: Checkout target branch
-      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-      with:
-        ref: ${{ github.event.inputs.target || 'main' }}
-        path: target
-    - name: Set up kubectl
-      uses: azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
-    - name: Set up go
-      uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
-      with:
-        go-version-file: "${{ github.workspace }}/target/go.mod"
-    - name: Set up helm
-      uses: azure/setup-helm@5119fcb9089d432beecbf79bb2c7915207344b78 # v3.5
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-    - name: Install gotestsum
-      run: go install gotest.tools/gotestsum@latest
-    - name: Create cluster
-      run: ref/.github/scripts/create-cluster.sh
-    - name: Run tests
-      run: ref/.github/scripts/run-e2e-tests.sh
-    - name: Destroy cluster
-      run: ref/.github/scripts/destroy-cluster.sh
-      if: always()
-    - name: Publish test results
-      uses: EnricoMi/publish-unit-test-result-action@v2
-      with:
-        files: target/results/*.xml
-      if: always()
+      - name: Checkout
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: Run e2e test
+        uses: ./.github/actions/run-e2e
+        with:
+          flc-namespace: dto-daily
+          flc-environment: dto-ocp-latest-flc
+          target-branch: ${{ github.event.inputs.target }}
+          tenant1-name: ${{ secrets.TENANT1_NAME }}
+          tenant1-apitoken: ${{ secrets.TENANT1_APITOKEN }}
+          tenant1-oteltoken: ${{ secrets.TENANT1_OTELTOKEN }}
+          tenant1-oauth-client-id: ${{ secrets.TENANT1_OAUTH_CLIENT_ID }}
+          tenant1-oauth-secret: ${{ secrets.TENANT1_OAUTH_SECRET }}
+          tenant2-name: ${{ secrets.TENANT2_NAME }}
+          tenant2-apitoken: ${{ secrets.TENANT2_APITOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
   notify-failure:
     name: Notify failure in Slack
     environment: E2E
-    needs: ["run-in-k8s", "run-in-ocp"]
+    needs: [ "run-in-k8s", "run-in-ocp" ]
     if: ${{ failure() || cancelled() }}
     runs-on:
-    - self-hosted
-    - operator-e2e
+      - self-hosted
+      - operator-e2e
     steps:
-    - name: Notify failure in Slack
-      uses: slackapi/slack-github-action@6c661ce58804a1a20f6dc5fbee7f0381b469e001 # v1.25.0
-      with:
-        channel-id: 'int-cp-operator'
-        slack-message: ":x: E2E tests failed on ${{ github.event.inputs.target || 'main' }} branch (${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})"
-      env:
-        SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+      - name: Notify failure in Slack
+        uses: slackapi/slack-github-action@6c661ce58804a1a20f6dc5fbee7f0381b469e001 # v1.25.0
+        with:
+          channel-id: 'int-cp-operator'
+          slack-message: ":x: E2E tests failed on ${{ github.event.inputs.target || 'main' }} branch (${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})"
+        env:
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}