Merge remote-tracking branch 'origin/main' into mael/pnpm-lockfile

Author: arcanis

.claude/skills/running-tests.md

@@ -0,0 +1,36 @@
+# Running Tests
+
+## Prerequisites
+
+Before running tests, you must build the release binaries:
+
+```bash
+cargo build --release
+```
+
+## Running Integration Tests
+
+Use the following command to run integration tests:
+
+```bash
+yarn test:integration <jest cli options>
+```
+
+For example:
+- Run all tests: `yarn test:integration`
+- Run a specific test file: `yarn test:integration path/to/test.ts`
+- Run tests matching a pattern: `yarn test:integration -t "pattern"`
+- Run in watch mode: `yarn test:integration --watch`
+
+## Reading spawn logs
+
+You can access the logs of any Yarn command spawned within a test by adding the `JEST_LOG_SPAWNS=1` environment variable.
+
+## Creating temporary projects
+
+You can setup temporary projects by:
+
+1. Creating a new temporary folder
+2. Adding an empty `package.json` file
+3. Running `yarn switch link path/to/target/Release/yarn-bin` inside this temporary folder
+4. Subsequent `yarn` commands should then use the local binary

.cursor/rules/tests.mdc

@@ -0,0 +1,21 @@
+FROM ubuntu:24.04
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends \
+    bash \
+    ca-certificates \
+    curl \
+    git \
+    jq \
+    nodejs \
+    npm \
+    python3 \
+    python-is-python3 \
+  && rm -rf /var/lib/apt/lists/*
+
+COPY entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]

.github/actions/run-e2e-sandbox/Dockerfile

@@ -0,0 +1,21 @@
+name: Run E2E Sandbox
+description: Run an e2e shell test inside a Docker action sandbox and stream logs
+
+inputs:
+  test-name:
+    description: E2E test name (filename without .sh extension)
+    required: true
+  log-file:
+    description: Relative path to the log file to write in repository root
+    required: true
+
+outputs:
+  exit-code:
+    description: Exit code returned by the test script
+
+runs:
+  using: docker
+  image: Dockerfile
+  args:
+    - ${{ inputs.test-name }}
+    - ${{ inputs.log-file }}

.github/actions/run-e2e-sandbox/action.yml

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+TEST_NAME="${1:-}"
+LOG_FILE="${2:-}"
+WORKSPACE="${GITHUB_WORKSPACE:-/github/workspace}"
+
+if [[ -z "${TEST_NAME}" ]]; then
+  echo "Missing required argument: test-name" >&2
+  echo "exit-code=2" >> "${GITHUB_OUTPUT}"
+  exit 0
+fi
+
+if [[ -z "${LOG_FILE}" ]]; then
+  echo "Missing required argument: log-file" >&2
+  echo "exit-code=2" >> "${GITHUB_OUTPUT}"
+  exit 0
+fi
+
+if [[ "${LOG_FILE}" != /* ]]; then
+  LOG_FILE="${WORKSPACE}/${LOG_FILE}"
+fi
+
+mkdir -p "$(dirname "${LOG_FILE}")"
+export HOME="${HOME:-/tmp/e2e-home}"
+mkdir -p "${HOME}"
+
+cd "${WORKSPACE}"
+chmod +x "${WORKSPACE}/tests/e2e/${TEST_NAME}.sh"
+
+set +e
+bash "${WORKSPACE}/scripts/e2e/run.sh" "${TEST_NAME}" 2>&1 | tee "${LOG_FILE}"
+exit_code=${PIPESTATUS[0]}
+set -e
+
+echo "exit-code=${exit_code}" >> "${GITHUB_OUTPUT}"
+exit 0

.github/actions/run-e2e-sandbox/entrypoint.sh

@@ -3,8 +3,14 @@ name: Build
 on:
   push:
     branches: [main]
+    paths-ignore:
+      - 'documentation/**'
+      - 'README.md'
   pull_request:
     branches: [main]
+    paths-ignore:
+      - 'documentation/**'
+      - 'README.md'
 
 env:
   CARGO_TERM_COLOR: always
@@ -98,7 +104,11 @@ jobs:
 
       - name: Generate the test report
         run: |
+          chmod +x artifacts/{yarn,yarn-bin}
+
           export TEST_BINARY=$(pwd)/artifacts/yarn-bin
+          export TEST_SWITCH_BINARY=$(pwd)/artifacts/yarn
+
           yarn ./tests/acceptance-tests jest --json --outputFile=$(pwd)/report.json || true
 
       - name: Upload test report

.github/workflows/build.yml

@@ -0,0 +1,195 @@
+name: E2E
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  CARGO_TERM_COLOR: always
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"
+
+jobs:
+  discover-e2e:
+    name: Discover E2E tests
+    runs-on: ubuntu-latest
+    outputs:
+      tests: ${{ steps.discover.outputs.tests }}
+
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Build matrix data
+        id: discover
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          mapfile -t tests < <(find tests/e2e -maxdepth 1 -type f -name '*.sh' | sort)
+          if [[ "${#tests[@]}" -eq 0 ]]; then
+            echo "No e2e tests found" >&2
+            exit 1
+          fi
+
+          matrix_json="$(printf '%s\n' "${tests[@]}" | jq -R -s -c 'split("\n")[:-1]')"
+          echo "tests=${matrix_json}" >> "$GITHUB_OUTPUT"
+          echo "Discovered e2e tests: ${matrix_json}"
+
+  build-e2e-binary:
+    name: Build e2e binary
+    runs-on: ubuntu-latest
+    needs: [discover-e2e]
+
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Rust cache
+        uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2.8.0
+        with:
+          shared-key: e2e-linux-release
+
+      - name: Build yarn-bin
+        shell: bash
+        run: |
+          set -euo pipefail
+          cargo build -r -p zpm
+          tar -czf e2e-binary-yarn-bin.tgz -C target/release yarn-bin
+
+      - name: Upload e2e binary
+        uses: actions/upload-artifact@v4
+        with:
+          name: e2e-binary-yarn-bin
+          path: e2e-binary-yarn-bin.tgz
+
+  run-e2e:
+    name: Run ${{ matrix.test }}
+    runs-on: ubuntu-latest
+    needs: [discover-e2e, build-e2e-binary]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.discover-e2e.outputs.tests) }}
+
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Download e2e binary
+        uses: actions/download-artifact@v4
+        with:
+          name: e2e-binary-yarn-bin
+          path: .
+
+      - name: Extract e2e binary
+        shell: bash
+        run: |
+          set -euo pipefail
+          mkdir -p target/release
+          tar -xzf e2e-binary-yarn-bin.tgz -C target/release
+
+      - name: Resolve test metadata
+        id: meta
+        shell: bash
+        run: |
+          set -euo pipefail
+          test_name="$(basename "${{ matrix.test }}" .sh)"
+          echo "test_name=${test_name}" >> "$GITHUB_OUTPUT"
+
+      - name: Prepare e2e artifact paths
+        id: artifact-paths
+        shell: bash
+        env:
+          TEST_SCRIPT: ${{ matrix.test }}
+          TEST_NAME: ${{ steps.meta.outputs.test_name }}
+        run: |
+          set -euo pipefail
+          artifact_dir="e2e-artifacts/${TEST_NAME}"
+          log_file="${artifact_dir}/run.log"
+          status_file="${artifact_dir}/status.json"
+          mkdir -p "${artifact_dir}"
+
+          echo "artifact_dir=${artifact_dir}" >> "$GITHUB_OUTPUT"
+          echo "log_file=${log_file}" >> "$GITHUB_OUTPUT"
+          echo "status_file=${status_file}" >> "$GITHUB_OUTPUT"
+
+      - name: Run test in Docker sandbox action
+        id: run-in-sandbox
+        uses: ./.github/actions/run-e2e-sandbox
+        with:
+          test-name: ${{ steps.meta.outputs.test_name }}
+          log-file: ${{ steps.artifact-paths.outputs.log_file }}
+
+      - name: Write test status
+        id: write-status
+        shell: bash
+        env:
+          TEST_SCRIPT: ${{ matrix.test }}
+          STATUS_FILE: ${{ steps.artifact-paths.outputs.status_file }}
+          EXIT_CODE: ${{ steps.run-in-sandbox.outputs.exit-code || '1' }}
+        run: |
+          set -euo pipefail
+          jq -n \
+            --arg test "${TEST_SCRIPT}" \
+            --argjson exitCode "${EXIT_CODE}" \
+            '{test:$test, exitCode:$exitCode}' > "${STATUS_FILE}"
+
+      - name: Fail job if test failed
+        if: ${{ steps.run-in-sandbox.outputs.exit-code != '0' }}
+        shell: bash
+        run: |
+          set -euo pipefail
+          exit 1
+
+      - name: Upload e2e logs and status
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: e2e-result-${{ steps.meta.outputs.test_name }}
+          path: e2e-artifacts/${{ steps.meta.outputs.test_name }}
+          if-no-files-found: warn
+
+  report-e2e-failures:
+    name: Report e2e failures
+    runs-on: ubuntu-latest
+    needs: [run-e2e]
+    if: always() && github.ref == 'refs/heads/main'
+    permissions:
+      contents: read
+      issues: write
+
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Download e2e result artifacts
+        continue-on-error: true
+        uses: actions/download-artifact@v4
+        with:
+          path: e2e-artifacts
+          pattern: e2e-result-*
+          merge-multiple: false
+
+      - name: Create or update GitHub issues for failing tests
+        env:
+          E2E_ARTIFACTS_DIR: e2e-artifacts
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        shell: bash
+        run: |
+          yarn node --experimental-strip-types scripts/e2e/report-failures.ts