ci: setup cypress, e2e tests workflow, and local webpack e2e test

.changeset/heavy-brooms-switch.md

@@ -0,0 +1,2 @@
+---
+---

.github/actions/node-and-build/action.yml

@@ -22,6 +22,7 @@ runs:
         path: |
           **/node_modules
           **/dist/
+          /home/runner/.cache/Cypress
         key: ${{ runner.os }}-build-artifacts-${{ github.sha }}
         restore-keys: |
           ${{ runner.os }}-build-artifacts-

.github/integ-config/local-integ-all.yml

@@ -0,0 +1,7 @@
+tests:
+  - test_name: webpack_data_gen2
+    desc: 'Webpack 5'
+    framework: webpack
+    sample_name: basic-bundle
+    spec: bundle
+    browser: [chrome]

.github/workflows/callable-local-e2e-test.yml

@@ -0,0 +1,133 @@
+name: E2E Test
+run-name: e2e.${{ inputs.test_name }}
+
+on:
+  workflow_call:
+    inputs:
+      test_name:
+        required: true
+        type: string
+      framework:
+        required: true
+        type: string
+      sample_name:
+        required: true
+        type: string
+      spec:
+        required: true
+        type: string
+      browser:
+        required: true
+        type: string
+      backend:
+        required: true
+        type: string
+      timeout_minutes:
+        required: true
+        type: number
+      retry_count:
+        required: true
+        type: number
+      npm_script:
+        required: false
+        type: string
+      npm_script_args:
+        required: false
+        type: number
+      env:
+        required: false
+        type: string
+
+jobs:
+  e2e-test:
+    name: E2E ${{ inputs.test_name }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        browser:
+          - ${{ fromJson(inputs.browser) }}
+        sample_name:
+          - ${{ fromJson(inputs.sample_name) }}
+      fail-fast: false
+    timeout-minutes: ${{ inputs.timeout_minutes }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@24cb9080177205b6e8c946b17badbe402adc938f # v3.4.0 https://github.com/actions/checkout/commit/24cb9080177205b6e8c946b17badbe402adc938f
+        with:
+          path: amplify-data
+      - name: Setup node and build the repository
+        uses: ./amplify-data/.github/actions/node-and-build
+      - name: Load Verdaccio with AmplifyData
+        uses: ./amplify-data/.github/actions/load-verdaccio-with-amplify-data
+      - name: Make script executable
+        run: chmod +x ./amplify-data/scripts/retry-npm-script.sh
+      - name: Run cypress tests for ${{ inputs.test_name }} dev
+        shell: bash
+        working-directory: ./amplify-data
+        env:
+          E2E_FRAMEWORK: ${{ inputs.framework }}
+          E2E_SAMPLE_NAME: ${{ matrix.sample_name }}
+          E2E_SPEC: ${{ inputs.spec }}
+          E2E_BROWSER: ${{ matrix.browser }}
+          E2E_BACKEND: ${{ inputs.backend }}
+          E2E_RETRY_COUNT: ${{ inputs.retry_count }}
+          E2E_TEST_NAME: ${{ inputs.test_name }}
+          E2E_NPM_SCRIPT: ${{ inputs.npm_script }}
+          E2E_ENV: ${{ inputs.env }}
+        run: |
+          if [ -z "$E2E_NPM_SCRIPT" ]; then
+            ../amplify-data/scripts/retry-npm-script.sh -s \
+            "ci:test \
+            $E2E_FRAMEWORK \
+            $E2E_SAMPLE_NAME \
+            $E2E_SPEC \
+            $E2E_BROWSER \
+            dev \
+            $E2E_BACKEND \
+            --env $(echo $E2E_ENV | jq -r 'tostring')" \
+            $E2E_NPM_SCRIPT \
+            -n $E2E_RETRY_COUNT
+          else
+            echo "Skipping specialized yarn script execution in the dev environment."
+          fi
+      - name: Run cypress tests for ${{ inputs.test_name }} prod
+        shell: bash
+        working-directory: ./amplify-data
+        env:
+          E2E_FRAMEWORK: ${{ inputs.framework }}
+          E2E_SAMPLE_NAME: ${{ matrix.sample_name }}
+          E2E_SPEC: ${{ inputs.spec }}
+          E2E_BROWSER: ${{ matrix.browser }}
+          E2E_BACKEND: ${{ inputs.backend }}
+          E2E_RETRY_COUNT: ${{ inputs.retry_count }}
+          E2E_TEST_NAME: ${{ inputs.test_name }}
+          E2E_NPM_SCRIPT: ${{ inputs.npm_script }}
+          E2E_NPM_SCRIPT_ARGS: ${{ inputs.npm_script_args }}
+          E2E_ENV: ${{ inputs.env }}
+        run: |
+          if [ -z "$E2E_NPM_SCRIPT" ]; then
+            ../amplify-data/scripts/retry-npm-script.sh -s \
+            "ci:test \
+            $E2E_FRAMEWORK \
+            $E2E_SAMPLE_NAME \
+            $E2E_SPEC \
+            $E2E_BROWSER \
+            prod \
+            $E2E_BACKEND \
+            --env $(echo $E2E_ENV | jq -r 'tostring')" \
+            $E2E_NPM_SCRIPT \
+            -n $E2E_RETRY_COUNT
+          else
+            npm run "$E2E_NPM_SCRIPT" "$E2E_NPM_SCRIPT_ARGS"
+          fi
+      - name: Upload artifact
+        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2 https://github.com/actions/upload-artifact/commit/0b7f8abb1508181956e8e162db84b466c27e18ce
+        if: failure()
+        with:
+          name: ${{ inputs.test_name }}
+          if-no-files-found: ignore
+          path: |
+            cypress/videos
+            cypress/screenshots
+          retention-days: 14

.github/workflows/callable-local-e2e-tests.yml

@@ -26,3 +26,41 @@ jobs:
       - name: Run tests
         working-directory: ./amplify-data
         run: npm run e2e-node:test
+
+  e2e-prep:
+    name: Get E2E test config
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          path: amplify-data
+      - name: Read integ config files
+        id: load_config
+        run: |
+          echo "INTEG_CONFIG=$(cat .github/integ-config/local-integ-all.yml | yq '.tests' -o=json | jq -c .)" >> $GITHUB_OUTPUT
+        working-directory: ./amplify-data
+    outputs:
+      integ-config: ${{ steps.load_config.outputs.INTEG_CONFIG }}
+
+  e2e-test-runner:
+    name: E2E test runnner
+    needs: e2e-prep
+    secrets: inherit
+    strategy:
+      matrix:
+        integ-config: ${{ fromJson(needs.e2e-prep.outputs.integ-config) }}
+      fail-fast: false
+    uses: ./.github/workflows/callable-local-e2e-test.yml
+    with:
+      test_name: ${{ matrix.integ-config.test_name }}
+      framework: ${{ matrix.integ-config.framework }}
+      spec: ${{ matrix.integ-config.spec || '' }}
+      sample_name: ${{ toJSON(matrix.integ-config.sample_name) || '[""]' }}
+      browser: ${{ toJSON(matrix.integ-config.browser) || '[""]' }}
+      backend: ${{ matrix.integ-config.backend }}
+      timeout_minutes: ${{ matrix.integ-config.timeout_minutes || 35 }}
+      retry_count: ${{ matrix.integ-config.retry_count || 3 }}
+      npm_script: ${{ matrix.integ-config.npm_script || '' }}
+      npm_script_args: ${{ matrix.integ-config.npm_script_args || 15 }}
+      env: ${{ matrix.integ-config.env && toJSON(matrix.integ-config.env) || '{}' }}

.github/workflows/callable-release-verification.yml

@@ -14,6 +14,9 @@ jobs:
     needs:
       - prebuild-ubuntu
     uses: ./.github/workflows/callable-unit-tests.yml
+  # NOTE: "local-e2e" is a temporal naming to distinguish them from those pulled 
+  # from amplify-js-samples-staging. Should be renamed once we move all e2e tests
+  # to the amplify-data repo.
   local-e2e:
     needs:
       - prebuild-ubuntu

.gitignore

@@ -19,4 +19,8 @@ packages/*/temp
 
 # rollup
 **/.rollup.cache
-**/buildMeta
+**/buildMeta
+
+# cypress
+cypress/videos
+cypress/screenshots

cypress.config.ts

@@ -0,0 +1,14 @@
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+  includeShadowDom: true,
+  defaultCommandTimeout: 30000,
+  experimentalWebKitSupport: true,
+  experimentalModifyObstructiveThirdPartyCode: true,
+  e2e: {
+    baseUrl: 'http://localhost:3000/',
+    specPattern: 'cypress/e2e/**/*.spec.cy.{ts,js}',
+    excludeSpecPattern: ['**/__snapshots__/*', '**/__image_snapshots__/*'],
+  },
+  chromeWebSecurity: false,
+});

cypress/e2e/webpack/bundle.spec.cy.ts

@@ -0,0 +1,8 @@
+describe('webpack spec', () => {
+  it('passes', () => {
+    cy.visit('http://localhost:3000');
+    cy.request('/main.bundle.js').then((response) => {
+      cy.log('main.bundle.js content:', response.body);
+    });
+  });
+});

cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

cypress/support/commands.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

cypress/support/e2e.ts

@@ -0,0 +1,17 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'

cypress/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "lib": ["esnext", "dom"],
+    "types": ["cypress"]
+  },
+  "include": ["**/*.ts", "../cypress.config.ts"]
+}

e2e-TEST-COVERAGE.md

@@ -2,21 +2,21 @@
 
 The following table outlines the current e2e test coverage for various runtimes and environments in our project:
 
-| Runtime/Environment | Status |
-|---------------------|-----------|
-| Chrome           | [✅](.github/workflows/callable-e2e-test.yml) | 
-| Node             | [✅](packages/e2e-tests/node/jest.config.ts) | 
-| Webpack                |    	⚠️     | 
-| Rollup                 | 	⚠️        |
-| Metro                    | 	⚠️      |
-| React Natives            | 	⚠️      |
+| Runtime/Environment | Status                                                                          |
+| ------------------- | ------------------------------------------------------------------------------- |
+| Chrome              | [✅](.github/workflows/callable-e2e-test.yml)                                   |
+| Node                | [✅](packages/e2e-tests/node/jest.config.ts)                                    |
+| Webpack             | [✅](packages/e2e-tests/cypress-samples/webpack/basic-bundle/webpack.config.js) |
+| Rollup              | ⚠️                                                                              |
+| Metro               | ⚠️                                                                              |
+| React Natives       | ⚠️                                                                              |
 
 Legend:
+
 - ✅ Fully covered by e2e tests
 - ⚠️ In progress
 - N/A Not applicable or not planned
 
 ## Notes
 
 - Click on the icons in the table to view relevant e2e test configurations or workflows.
-