fix(nx-payload): run e2e for a specific package manager and fix docker tests

Fixes COD-99, COD-117, COD-122

Author: hakalb

.env.local

@@ -23,7 +23,13 @@ NX_SKIP_NX_CACHE=false
 # If set to `true`, will print debug information useful for troubleshooting.
 NX_VERBOSE_LOGGING=false
 
-### `nx-plugins` variables ###
+### Plugins variables ###
 
-# E2E package manager; `bun`, `npm`, `pnpm`, `yarn`, `infer`
-E2E_PACKAGE_MANAGER=
+# If set to `true`, will print E2E debug information useful for troubleshooting.
+CDWR_DEBUG_LOGGING=true
+
+# Package manager to use in E2E tests; `npm`, `pnpm`, `yarn` (todo: `bun`)
+CDWR_E2E_PACKAGE_MANAGER=
+
+# Verdaccio host; 'localhost' is default Linux and 'host.docker.internal' is for macOS and Windows
+CDWR_E2E_VERDACCIO_HOST='host.docker.internal'

.github/workflows/ci.yml

@@ -22,4 +22,4 @@ jobs:
       - uses: ./.github/actions/test
         with:
           codecov-token: ${{ secrets.CODECOV_TOKEN }}
-          nx-cloud: ${{ contains(github.head_ref || github.ref_name, 'renovate') == false }}
+          nx-cloud: ${{ contains(github.head_ref || github.ref_name, 'renovate') == false && vars.NX_NO_CLOUD != 'true' }}

.github/workflows/e2e-matrix.yml

@@ -11,12 +11,6 @@ on:
     branches:
       - master
   workflow_dispatch:
-    inputs:
-      debug-enabled:
-        type: boolean
-        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
-        required: false
-        default: false
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.number || github.ref }}
@@ -27,25 +21,18 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os:
-          - ubuntu-latest
-          - windows-latest
-        node_version:
-          - 20
-          - 18
-        exclude:
-          - os: windows-latest
-            node_version: 18
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node: [20]
 
-    name: Cache install (${{ matrix.os }}, node v${{ matrix.node_version }})
+    name: Cache install (${{ matrix.os }}, node v${{ matrix.node }})
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
       - name: Set node
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node_version }}
+          node-version: ${{ matrix.node }}
           cache: 'yarn'
 
       - name: Cache node_modules
@@ -54,7 +41,7 @@ jobs:
         with:
           lookup-only: true
           path: '**/node_modules'
-          key: ${{ runner.os }}-modules-${{ matrix.node_version }}-${{ github.run_id }}
+          key: ${{ matrix.os }}-modules-${{ matrix.node }}-${{ github.run_id }}
 
       - name: Install packages
         if: steps.cache-modules.outputs.cache-hit != 'true'
@@ -68,91 +55,141 @@ jobs:
     timeout-minutes: 90
     strategy:
       matrix:
-        os:
-          - ubuntu-latest
-          - windows-latest
-        node_version:
-          - 20
-          - 18
-        package_manager:
-          - npm
-          # - yarn
-          # - pnpm
-        project:
-          - nx-payload-e2e
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node: [20]
+        pm: [npm, pnpm, yarn]
+        project: [nx-payload-e2e]
         include:
-          # os short names
-          - os: ubuntu-latest
-            os_name: 'Linux'
-          - os: windows-latest
-            os_name: 'Windows'
-          # test timeouts
-          - os: ubuntu-latest
-            os_timeout: 60
-          - os: windows-latest
-            os_timeout: 60
-          # configurations
           - os: ubuntu-latest
-            configuration: ''
+            name: Linux
+            timeout: 30
+            configuration: 'skip-docker'
+            verdaccio: localhost
+          - os: macos-latest
+            name: macOS
+            timeout: 30
+            configuration: skip-docker
           - os: windows-latest
-            # will skip docker build test since node image doesn't exist running inside a windows container
-            configuration: 'windows'
+            name: Windows
+            timeout: 60
+            configuration: skip-docker
         exclude:
-          # windows: only npm 20
-          - os: windows-latest
-            package_manager: yarn
+          - os: macos-latest
+            pm: pnpm
+          - os: macos-latest
+            pm: yarn
           - os: windows-latest
-            package_manager: pnpm
+            pm: pnpm
           - os: windows-latest
-            node_version: 18
+            pm: yarn
       fail-fast: false
 
-    name: E2E ${{ matrix.os_name }}/${{ matrix.package_manager }}/${{ matrix.node_version }} ${{ join(matrix.project) }}
+    name: E2E ${{ matrix.os }}/${{ matrix.pm }}/${{ matrix.node }} ${{ join(matrix.project) }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Use Node.js ${{ matrix.node_version }}
+      - name: Install PNPM
+        run: npm install -g @pnpm/exe@8
+
+      - name: Use Node.js ${{ matrix.node }}
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node_version }}
+          node-version: ${{ matrix.node }}
           cache: 'yarn'
 
       - name: Cache node_modules
         id: cache-modules
         uses: actions/cache@v4
         with:
           path: '**/node_modules'
-          key: ${{ runner.os }}-modules-${{ matrix.node_version }}-${{ github.run_id }}
+          key: ${{ runner.os }}-modules-${{ matrix.node }}-${{ github.run_id }}
 
       - name: Install packages
         run: yarn install --immutable
 
-      - name: Set starting timestamp
-        id: before-e2e
-        run: |
-          echo "timestamp=$(date +%s)" >> $GITHUB_OUTPUT
-
       - name: Run e2e tests
         id: e2e-run
         run: yarn nx e2e ${{ matrix.project }} -c ${{ matrix.configuration }}
-        timeout-minutes: ${{ matrix.os_timeout }}
+        timeout-minutes: ${{ matrix.timeout }}
         env:
+          CDWR_E2E_PACKAGE_MANAGER: ${{ matrix.pm }}
+          CDWR_E2E_VERDACCIO_HOST: ${{ matrix.verdaccio }}
+          CDWR_DEBUG_LOGGING: 'true'
           NX_CACHE_DIRECTORY: 'tmp'
           NX_PERF_LOGGING: 'false'
-          NX_NO_CLOUD: ${{ contains(github.head_ref || github.ref_name, 'renovate') }}
+          NX_NO_CLOUD: ${{ contains(github.head_ref || github.ref_name, 'renovate') || vars.NX_NO_CLOUD == 'true' }}
           # NX_DAEMON defaults to 'true' unless explicitly set to 'false'
           NX_DAEMON: ${{ env.NX_DAEMON == 'false' && 'false' || 'true' }}
           # NX_VERBOSE_LOGGING defaults to 'false' unless explicitly set to 'true'
-          NX_VERBOSE_LOGGING: ${{ env.NX_VERBOSE_LOGGING == 'true' && 'true' || 'false' }}
-          E2E_PACKAGE_MANAGER: ${{ env.E2E_PACKAGE_MANAGER }}
+          NX_VERBOSE_LOGGING: ${{ vars.NX_VERBOSE_LOGGING == 'true' && 'true' || 'false' }}
+          # Yarn workarounds
+          YARN_ENABLE_HARDENED_MODE: ${{ vars.YARN_ENABLE_HARDENED_MODE == 'true' && 1 || 0 }}
+          # TODO: fix flaky yarn lock issues when running `create-nx-workspace`
+          YARN_ENABLE_IMMUTABLE_INSTALLS: ${{ vars.YARN_ENABLE_IMMUTABLE_INSTALLS }}
+      - name: Save test result
+        if: always()
+        run: |
+          echo '{"os": "${{ matrix.os }}", "pm": "${{ matrix.pm }}", "node": "${{ matrix.node }}", "configuration": "${{ matrix.configuration }}", "status": "${{ job.status }}"}' > results-${{ matrix.os }}-${{ matrix.pm }}-${{ matrix.node }}.json
+        shell: bash
 
-      - name: Setup tmate session
-        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug-enabled && failure() }}
-        uses: mxschmitt/action-tmate@v3.18
-        timeout-minutes: 15
-        env:
-          # disable sudo for windows debugging
-          sudo: ${{ matrix.os != 'windows-latest' }}
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: results-${{ matrix.os }}-${{ matrix.pm }}-${{ matrix.node }}
+          path: results-${{ matrix.os }}-${{ matrix.pm }}-${{ matrix.node }}.json
+
+  summary:
+    name: E2E Test Summary
+    needs: e2e
+    runs-on: ubuntu-latest
+    if: always()
+    steps:
+      - name: Download all workflow run artifacts
+        uses: actions/download-artifact@v4
         with:
-          sudo: ${{ env.sudo }}
+          path: artifacts
+          pattern: results-*
+          merge-multiple: true
+      - name: Create summary
+        run: |
+          echo "# E2E Test Results Summary" > summary.md
+          echo "" >> summary.md
+          echo "| OS | Package Manager | Node Version | Configuration | Status |" >> summary.md
+          echo "|----|-----------------|--------------| ------------ | ------ |" >> summary.md
+          for artifact in artifacts/*.json; do
+            if [ -f "$artifact" ]; then
+              os=$(jq -r '.os' "$artifact")
+              pm=$(jq -r '.pm' "$artifact")
+              configuration=$(jq -r '.configuration' "$artifact")
+              node=$(jq -r '.node' "$artifact")
+              status=$(jq -r '.status' "$artifact")
+              echo "| $os | $pm | $node | $configuration | $status |" >> summary.md
+            fi
+          done
+
+          echo "" >> summary.md
+          echo "## Detailed Results" >> summary.md
+          echo "" >> summary.md
+          echo "<details><summary>Click to expand</summary>" >> summary.md
+          for artifact in artifacts/*.json; do
+            echo "$(basename $artifact)" >> summary.md
+            echo "" >> summary.md
+            echo '```json' >> summary.md
+            echo "" >> summary.md
+            jq -s '.' $artifact >> summary.md
+            echo "" >> summary.md
+            echo '```' >> summary.md
+            echo "" >> summary.md
+          done
+          echo "</details>" >> summary.md
+
+      - name: Upload summary artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: e2e-test-summary
+          path: summary.md
+
+      - name: Output summary
+        run: cat summary.md >> $GITHUB_STEP_SUMMARY

.verdaccio/config.yml

@@ -7,14 +7,9 @@ uplinks:
     url: https://registry.npmjs.org/
     maxage: 60m
 
-# TODO: Codeware plugins needs to be stored in local registry during e2e tests, but all other packages can be proxied to npmjs.
-# There's a problem during e2e where public packages have localhost in lock file and install within Docker container are refused to connect.
-# Is it because e2e runs inside Docker containers and Verdaccio is running on host machine?
-# Is the problem inside Verdaccio configuration or Docker compose configuration?
+# give all users (including non-authenticated users) full access because it is a local registry
 packages:
   '@cdwr/*':
-    # give all users (including non-authenticated users) full access
-    # because it is a local registry
     access: $all
     publish: $all
     unpublish: $all
@@ -30,7 +25,7 @@ packages:
     proxy: npmjs
 
 # log settings
-logs:
+log:
   type: stdout
   format: pretty
   level: warn

e2e/nx-payload-e2e/project.json

@@ -3,6 +3,8 @@
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "projectType": "application",
   "sourceRoot": "e2e/nx-payload-e2e/src",
+  "tags": ["scope:e2e"],
+  "implicitDependencies": ["create-nx-payload", "nx-payload"],
   "targets": {
     "e2e": {
       "executor": "@nx/jest:jest",
@@ -11,11 +13,11 @@
         "runInBand": true
       },
       "configurations": {
-        "windows": { "testPathIgnorePatterns": ["docker"] }
-      },
-      "dependsOn": ["create-nx-payload:build", "nx-payload:build"]
+        "docker": { "testPathPattern": ["docker"] },
+        "skip-docker": {
+          "testPathIgnorePatterns": ["docker"]
+        }
+      }
     }
-  },
-  "tags": ["scope:e2e"],
-  "implicitDependencies": ["create-nx-payload", "nx-payload"]
+  }
 }