chore(catalyst): CATALYST-1297 Use test matrix

Author: jordanarldt

.github/workflows/basic.yml

@@ -87,127 +87,31 @@ jobs:
         run: pnpm run test
 
   e2e-tests:
-    name: E2E Functional Tests
+    name: E2E Functional Tests (${{ matrix.name }})
 
     runs-on: ubuntu-latest
 
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 2
-
-      - uses: pnpm/action-setup@v3
-
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: ".nvmrc"
-          cache: "pnpm"
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Install Playwright browsers
-        run: pnpm exec playwright install --with-deps chromium webkit
-        working-directory: ./core
-
-      - name: Build catalyst-client
-        run: pnpm --filter @bigcommerce/catalyst-client build
-
-      - name: Build catalyst-core
-        run: pnpm --filter @bigcommerce/catalyst-core build
-
-      - name: Start server
-        run: |
-          pnpm start &
-          npx wait-on http://localhost:3000 --timeout 60000
-        working-directory: ./core
-        env:
-          PORT: 3000
-          AUTH_SECRET: ${{ secrets.TESTS_AUTH_SECRET }}
-          AUTH_TRUST_HOST: ${{ vars.TESTS_AUTH_TRUST_HOST }}
-          BIGCOMMERCE_TRUSTED_PROXY_SECRET: ${{ secrets.BIGCOMMERCE_TRUSTED_PROXY_SECRET }}
-          TESTS_LOCALE: ${{ vars.TESTS_LOCALE }}
-          DEFAULT_REVALIDATE_TARGET: 1
-
-      - name: Run E2E tests
-        run: pnpm exec playwright test tests/ui/e2e
-        working-directory: ./core
-        env:
-          PLAYWRIGHT_TEST_BASE_URL: http://localhost:3000
-
-      - name: Upload test results
-        if: ${{ !cancelled() }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: playwright-report
-          path: ./core/.tests/reports/
-          retention-days: 3
-
-  e2e-tests-no-trailing:
-    name: E2E Functional Tests (TRAILING_SLASH=false)
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 2
-
-      - uses: pnpm/action-setup@v3
-
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: ".nvmrc"
-          cache: "pnpm"
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Install Playwright browsers
-        run: pnpm exec playwright install --with-deps chromium
-        working-directory: ./core
-
-      - name: Build catalyst-client
-        run: pnpm --filter @bigcommerce/catalyst-client build
-
-      - name: Build catalyst-core
-        run: pnpm --filter @bigcommerce/catalyst-core build
-
-      - name: Start server
-        run: |
-          pnpm start &
-          npx wait-on http://localhost:3000 --timeout 60000
-        working-directory: ./core
-        env:
-          PORT: 3000
-          AUTH_SECRET: ${{ secrets.TESTS_AUTH_SECRET }}
-          AUTH_TRUST_HOST: ${{ vars.TESTS_AUTH_TRUST_HOST }}
-          BIGCOMMERCE_TRUSTED_PROXY_SECRET: ${{ secrets.BIGCOMMERCE_TRUSTED_PROXY_SECRET }}
-          TESTS_LOCALE: ${{ vars.TESTS_LOCALE }}
-          TRAILING_SLASH: false
-
-      - name: Run E2E tests
-        run: pnpm exec playwright test tests/ui/e2e --grep @no-trailing-slash
-        working-directory: ./core
-        env:
-          PLAYWRIGHT_TEST_BASE_URL: http://localhost:3000
-
-      - name: Upload test results
-        if: ${{ !cancelled() }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: playwright-report-no-trailing
-          path: ./core/.tests/reports/
-          retention-days: 3
-
-  e2e-tests-alternate-locale:
-    name: E2E Functional Tests (alternate locale)
-
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - name: default
+            browsers: chromium webkit
+            test-filter: tests/ui/e2e
+            trailing-slash: true
+            locale-var: TESTS_LOCALE
+            artifact-name: playwright-report
+          - name: TRAILING_SLASH=false
+            browsers: chromium
+            test-filter: tests/ui/e2e --grep @no-trailing-slash
+            trailing-slash: false
+            locale-var: TESTS_LOCALE
+            artifact-name: playwright-report-no-trailing
+          - name: alternate locale
+            browsers: chromium
+            test-filter: tests/ui/e2e --grep @alternate-locale
+            trailing-slash: true
+            locale-var: TESTS_ALTERNATE_LOCALE
+            artifact-name: playwright-report-alternate-locale
 
     steps:
       - name: Checkout code
@@ -227,7 +131,7 @@ jobs:
         run: pnpm install --frozen-lockfile
 
       - name: Install Playwright browsers
-        run: pnpm exec playwright install --with-deps chromium
+        run: pnpm exec playwright install --with-deps ${{ matrix.browsers }}
         working-directory: ./core
 
       - name: Build catalyst-client
@@ -246,10 +150,12 @@ jobs:
           AUTH_SECRET: ${{ secrets.TESTS_AUTH_SECRET }}
           AUTH_TRUST_HOST: ${{ vars.TESTS_AUTH_TRUST_HOST }}
           BIGCOMMERCE_TRUSTED_PROXY_SECRET: ${{ secrets.BIGCOMMERCE_TRUSTED_PROXY_SECRET }}
-          TESTS_LOCALE: ${{ vars.TESTS_ALTERNATE_LOCALE }}
+          TESTS_LOCALE: ${{ vars[matrix.locale-var] }}
+          TRAILING_SLASH: ${{ matrix.trailing-slash }}
+          DEFAULT_REVALIDATE_TARGET: ${{ matrix.name == 'default' && '1' || '' }}
 
       - name: Run E2E tests
-        run: pnpm exec playwright test tests/ui/e2e --grep @alternate-locale
+        run: pnpm exec playwright test ${{ matrix.test-filter }}
         working-directory: ./core
         env:
           PLAYWRIGHT_TEST_BASE_URL: http://localhost:3000
@@ -258,6 +164,6 @@ jobs:
         if: ${{ !cancelled() }}
         uses: actions/upload-artifact@v4
         with:
-          name: playwright-report-alternate-locale
+          name: ${{ matrix.artifact-name }}
           path: ./core/.tests/reports/
           retention-days: 3