chore: add the Next.js e2e test suite (#1782)

* chore: all the tests

* chore: fix eslint

* chore: parallelise e2e tests

* chore: don't fail fast

* chore: unignore modules and use node-fetch

* chore: very parallel

* chore: don't mock fetch 🤦

* chore: remove disabled tests

* chore: test with node 18

* chore: switchable fetch

* chore: remove irrelevant tests

* chore: remove disabled test

* chore: add reporter

* chore: no concurrency

* chore: try to fix jest

* chore: fix test command

* chore: artifact file path

* chore: use site build command

* chore: download artifacts

* chore: report per-chunk

* chore: update syntax

* chore: report to summary

* chore: do annotate

* chore: update and add summary

* chore: rearrange

* chore: combine tests

* chore: fix test

* chore: rearrange and disable failing suites

* chore: skip broken ntl and fail faster

* chore: disable suite

* chore: skip failing tests

* chore: add ability to run disabled tests

* chore: add comments to workflow file

* chore: one worker per file

* chore: oops

* chore: make path relative to test dir

* chore: conditionally skip

* chore: enable middleware-responses test

* chore: run all tests once

* chore: don't run disabled tests

* fix: ensure responses are Responses

* chore: re-enable test

* chore: run all tests

* chore: enable another suite

* fix: better headers.getAll polyfill

* chore: enable middleware-redirects suite

* chore: conditionally enable req body tests

* chore: disable failing tests

* chore: add test readme doc

* chore: remove eslint changes

Author: ascorbic

.github/workflows/e2e-next.yml

@@ -6,19 +6,77 @@ on:
     branches: [main]
 
 jobs:
+  setup:
+    runs-on: ubuntu-latest
+    outputs:
+      test-files: ${{ steps['set-test-files'].outputs['test-files'] }}
+    steps:
+      - uses: actions/checkout@v3
+      - run: npm install
+      - id: set-test-files
+        name: Get test files
+        # Extracts the list of all test files as JSON and trims to be relative to the test dir to be easier to read
+        run:
+          echo "test-files=$(npx jest -c test/e2e/jest.config.js --listTests --json | jq -cM 'map(.[env.PWD | length +
+          10:])')" >> $GITHUB_OUTPUT
+          # echo "test-files=$(npx jest -c test/e2e/jest.config.all.js --listTests --json | jq -cM 'map(.[env.PWD | length
+          # + 10:])')" >> $GITHUB_OUTPUT
+
   test:
-    name: E2E tests
     runs-on: ubuntu-latest
+    name: test (${{ matrix.test-file }})
+    needs:
+      - setup
+    strategy:
+      fail-fast: false
+      matrix:
+        # Creates a job for each chunk ID. This will be assigned one or more test files to run
+        test-file: ${{ fromJson(needs.setup.outputs['test-files']) }}
     steps:
-      - uses: actions/checkout@v2
-      - name: Installing with LTS Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: 'lts/*'
-      - name: NPM Install
-        run: npm install
-      - name: Run Next.js e2e test suite
-        run: npm run test:next
+      - uses: actions/checkout@v3
+      - run: npm install
+      - name: Run tests
+        run: npx jest --reporters=jest-junit --reporters=default -c test/e2e/jest.config.all.js ${{ matrix.test-file }}
         env:
           NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_BOT_AUTH_TOKEN }}
           NETLIFY_SITE_ID: 1d5a5c76-d445-4ae5-b694-b0d3f2e2c395
+          # RUN_SKIPPED_TESTS: true
+      # - uses: phoenix-actions/test-reporting@v10
+      #   if: ${{ always() }}
+      #   name: Report Test Results
+      #   # Generates annotations for the test failures
+      #   id: test-report
+      #   with:
+      #     name: E2E Test chunk ${{ matrix.chunk }}
+      #     path: 'reports/**/*.xml' # Path to test results (inside artifact .zip)
+      #     output-to: 'checks'
+      #     max-annotations: 49 # Maximum number of annotations to be created
+      #     reporter: jest-junit # Format of test results
+
+      - uses: actions/upload-artifact@v3
+        # upload test results
+        if: ${{ always() }}
+        name: Upload test results
+        with:
+          name: test-results
+          path: reports/jest-*.xml
+  report:
+    runs-on: ubuntu-latest
+    if: ${{ always() }}
+    needs:
+      - test
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          path: reports
+      - name: Combine reports
+        # The test reporter can handle multiple files, but these have random filenames so the output is better when combined
+        run: npx junit-report-merger test-results.xml reports/**/*.xml
+      - uses: phoenix-actions/test-reporting@v10
+        with:
+          name: Jest Tests
+          output-to: 'step-summary'
+          path: 'test-results.xml'
+          max-annotations: 49
+          reporter: jest-junit

.gitignore

@@ -150,3 +150,6 @@ packages/*/lib
 
 # Cypress
 cypress/screenshots
+
+# Test cases have node module fixtures
+!test/**/node_modules