From 465b453bba8c0a16e72c6843f843e39f923bb460 Mon Sep 17 00:00:00 2001
From: Alan Greene <github.com@alangreene.net>
Date: Mon, 9 Dec 2024 01:03:35 +0000
Subject: [PATCH] Add GitHub Actions workflow for E2E tests

Run tests for read-only and read-write mode in parallel across
multiple Kubernetes versions.

Upload artifacts (logs, screen recordings) in case of failure.

Changes to the test script are backwards compatible so existing
use such as the nightly s390x / ppc64le tests on dogfooding continue
to work as expected.
---
 .github/workflows/e2e.yml          | 111 +++++++++++++++++++++++++++++
 test/e2e-tests-kind-read-only.env  |   3 +
 test/e2e-tests-kind-read-write.env |   3 +
 test/e2e-tests.sh                  |  14 +++-
 4 files changed, 129 insertions(+), 2 deletions(-)
 create mode 100644 .github/workflows/e2e.yml
 create mode 100644 test/e2e-tests-kind-read-only.env
 create mode 100644 test/e2e-tests-kind-read-write.env

diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
new file mode 100644
index 000000000..ec9564690
--- /dev/null
+++ b/.github/workflows/e2e.yml
@@ -0,0 +1,111 @@
+name: E2E
+
+permissions:
+  contents: read
+
+on:
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: ["main"]
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  e2e-tests:
+    name: E2E tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        k8s-name:
+          - k8s-oldest
+          - k8s-plus-one
+
+        dashboard-mode:
+          - read-only
+          - read-write
+
+        # k8s-name above is used to give stable naming of the checks for branch
+        # protection config. Map name to corresponding version for use in steps
+        include:
+          - k8s-name: k8s-oldest
+            k8s-version: v1.29.x
+          - k8s-name: k8s-plus-one
+            k8s-version: v1.30.x
+
+    env:
+      GOPATH: ${{ github.workspace }}
+      GO111MODULE: on
+      KO_DOCKER_REPO: registry.local:5000/tekton
+      CLUSTER_DOMAIN: c${{ github.run_id }}.local
+      ARTIFACTS: ${{ github.workspace }}/artifacts
+
+    steps:
+      - name: Harden runner
+        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+        with:
+          egress-policy: audit
+
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          path: ${{ github.workspace }}/src/github.com/tektoncd/dashboard
+
+      - name: Checkout setup-kind.sh
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          repository: tektoncd/pipeline
+          ref: d306d649df2dbd2badaba6a90459efd05c753d2f
+          path: scripts
+          sparse-checkout: |
+            hack/setup-kind.sh
+          sparse-checkout-cone-mode: false
+
+      - name: Set up Go 1.22
+        uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
+        with:
+          go-version: 1.22.5
+
+      - name: Install dependencies
+        working-directory: ./
+        run: |
+          echo '::group::install ko'
+          curl -L https://github.com/ko-build/ko/releases/download/v0.15.4/ko_0.15.4_Linux_x86_64.tar.gz | tar xzf - ko
+          chmod +x ./ko
+          sudo mv ko /usr/local/bin
+          echo '::endgroup::'
+
+          echo '::group::create required folders'
+          mkdir -p "${ARTIFACTS}"
+          echo '::endgroup::'
+
+          echo "${GOPATH}/bin" >> "$GITHUB_PATH"
+
+      - name: Run tests
+        working-directory: ${{ github.workspace }}/src/github.com/tektoncd/dashboard
+        run: |
+          ${{ github.workspace }}/scripts/hack/setup-kind.sh \
+            --registry-url $(echo ${KO_DOCKER_REPO} | cut -d'/' -f 1) \
+            --cluster-suffix c${{ github.run_id }}.local \
+            --nodes 3 \
+            --k8s-version ${{ matrix.k8s-version }} \
+            --e2e-script ./test/e2e-tests-prow.sh \
+            --e2e-env ./test/e2e-tests-kind-${{ matrix.dashboard-mode }}.env
+
+      - name: Upload test results
+        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
+        with:
+          name: ${{ matrix.k8s-version }}-${{ matrix.dashboard-mode }}
+          path: ${{ env.ARTIFACTS }}
+
+      # - name: Collect resources from cluster
+      #   uses: chainguard-dev/actions/kind-diag@94389dc7faf4ef9040df90498419535e1bdcb60e # main
+      #   if: ${{ failure() }}
+      #   with:
+      #     artifact-name: ${{ matrix.k8s-version }}-${{ matrix.dashboard-mode }}-logs
+      #     namespace-resources: pods,taskruns,pipelineruns
diff --git a/test/e2e-tests-kind-read-only.env b/test/e2e-tests-kind-read-only.env
new file mode 100644
index 000000000..0949dabff
--- /dev/null
+++ b/test/e2e-tests-kind-read-only.env
@@ -0,0 +1,3 @@
+KO_DOCKER_REPO=registry.local:5000
+SKIP_INITIALIZE=true
+DASHBOARD_MODE=read-only
diff --git a/test/e2e-tests-kind-read-write.env b/test/e2e-tests-kind-read-write.env
new file mode 100644
index 000000000..ef136c997
--- /dev/null
+++ b/test/e2e-tests-kind-read-write.env
@@ -0,0 +1,3 @@
+KO_DOCKER_REPO=registry.local:5000
+SKIP_INITIALIZE=true
+DASHBOARD_MODE=read-write
diff --git a/test/e2e-tests.sh b/test/e2e-tests.sh
index 63cd9c20e..b71887eee 100755
--- a/test/e2e-tests.sh
+++ b/test/e2e-tests.sh
@@ -131,8 +131,18 @@ header "Test Dashboard default namespace"
 export DASHBOARD_NAMESPACE=tekton-pipelines
 export TENANT_NAMESPACE=""
 
-test_dashboard ${PLATFORM} --read-write
-test_dashboard ${PLATFORM}
+if [ -z "$DASHBOARD_MODE" ]; then
+  echo "Running tests for both install modes"
+  test_dashboard ${PLATFORM} --read-write
+  test_dashboard ${PLATFORM}
+fi
+
+if [ "$DASHBOARD_MODE" = "read-write" ]; then
+  test_dashboard ${PLATFORM} --read-write
+fi
+if [ "$DASHBOARD_MODE" = "read-only" ]; then
+  test_dashboard ${PLATFORM}
+fi
 
 header "Test Dashboard custom namespace"
 if [ -z "$TEST_CUSTOM_INSTALL_NAMESPACE" ]; then