Fix/test playwright

.github/workflows/test-playwright.yml

@@ -52,14 +52,25 @@ on:
         default: '--with-deps'
         required: false
         type: string
+      PLAYWRIGHT_CLI_ARGS:
+        description: Arguments and flags for `npx playwright test`. When set SCRIPT_NAME will be ignored.
+        default: ''
+        required: false
+        type: string
       PRE_SCRIPT:
         description: Run custom shell code before executing the test runner.
         default: ''
         required: false
         type: string
       SCRIPT_NAME:
-        description: The name of a custom script to run the tests.
-        required: true
+        description: The name of a custom npm script to run the tests. Ignored when PLAYWRIGHT_GREP is set.
+        default: ''
+        required: false
+        type: string
+      WORK_DIR:
+        description: Working directory for npm install, Playwright install, and test execution.
+        default: '.'
+        required: false
         type: string
     secrets:
       ENV_FILE_DATA:
@@ -111,7 +122,8 @@ jobs:
 
       - name: Set up node cache mode
         run: |
-          if [ -f "${GITHUB_WORKSPACE}/package-lock.json" ] || [ -f "${GITHUB_WORKSPACE}/npm-shrinkwrap.json" ]; then
+          WORK_DIR="${{ inputs.WORK_DIR }}"
+          if [ -f "${GITHUB_WORKSPACE}/${WORK_DIR}/package-lock.json" ] || [ -f "${GITHUB_WORKSPACE}/${WORK_DIR}/npm-shrinkwrap.json" ]; then
             echo "NODE_CACHE_MODE=npm" >> $GITHUB_ENV
           else
             echo "No lock files found or unknown package manager"
@@ -143,26 +155,41 @@ jobs:
           cache: ${{ env.NODE_CACHE_MODE }}
 
       - name: Install dependencies
+        working-directory: ${{ inputs.WORK_DIR }}
         run: npm ${{ env.NODE_CACHE_MODE == 'npm' && 'ci' || 'install' }}
 
       - name: Install Playwright dependencies
+        working-directory: ${{ inputs.WORK_DIR }}
         run: |
           npx playwright install ${{ inputs.PLAYWRIGHT_BROWSER_ARGS }}
 
+      - name: Create environment file
+        working-directory: ${{ inputs.WORK_DIR }}
+        run: |
+          touch .env.ci
+          echo "${{ secrets.ENV_FILE_DATA }}" >> .env.ci
+
       - name: Execute custom code before executing the test script
+        working-directory: ${{ inputs.WORK_DIR }}
+        env:
+          GH_TOKEN: ${{ github.token }}
         run: |
+          set -a && source .env.ci && set +a
           ${{ inputs.PRE_SCRIPT }}
 
       - name: Run script for test
         id: run-script
         continue-on-error: true
+        working-directory: ${{ inputs.WORK_DIR }}
         run: |
-          touch .env.ci
-          echo "${{ secrets.ENV_FILE_DATA }}" >> .env.ci
           # Ensure .env.ci is deleted on exit
           trap 'rm -f .env.ci' EXIT
 
-          npm run ${{ inputs.SCRIPT_NAME }}
+          if [ -n "${{ inputs.PLAYWRIGHT_CLI_ARGS }}" ]; then
+            npx playwright test ${{ inputs.PLAYWRIGHT_CLI_ARGS }}
+          else
+            npm run ${{ inputs.SCRIPT_NAME }}
+          fi
 
       - name: Upload artifact
         if: always()
@@ -179,4 +206,4 @@ jobs:
         if: steps.run-script.outcome == 'failure'
         run: |
           echo "Tests failed! Check the artifacts for details."
-          exit 1
+          exit 1

docs/test-playwright.md

@@ -5,8 +5,8 @@ This workflow executes Playwright-based tests in a controlled and isolated envir
 The workflow can:
 
 - execute a building step, both for node and PHP environments (if the PHP version is provided and a `composer.json` file is present)
-- create an environment variables file named `.env.ci` dedicated to the test step; load this file using `dotenv-ci` directly in your test script, e.g., `./node_modules/.bin/dotenv -e .env.ci -- npm run e2e`
-- execute the tests using Playwright
+- create an environment variables file named `.env.ci` dedicated to the test step; load this file using `dotenv-ci` directly in your test script, e.g., `./node_modules/.bin/dotenv -e .env.ci -- npm run e2e`. The file is also sourced before `PRE_SCRIPT`, making all variables available as environment variables.
+- execute the tests using Playwright — either via a custom npm script or directly with `--grep`, `--grep-invert`, and `--project` filters
 - upload the artifacts
 
 **Simplest possible example:**
@@ -40,14 +40,20 @@ jobs:
 | `NPM_REGISTRY_DOMAIN`           | `'https://npm.pkg.github.com/'` | Domain of the private npm registry                                                                |
 | `PHP_VERSION`                   | `'8.2'`                         | PHP version with which the dependencies are installed                                             |
 | `PLAYWRIGHT_BROWSER_ARGS`       | `'--with-deps'`                 | Set of arguments passed to `npx playwright install`                                               |
-| `PRE_SCRIPT`                    | `''`                            | Run custom shell code before executing the test script                                            |
-| `SCRIPT_NAME`                   |                                 | The name of a custom script to run the tests                                                      | 
+| `PLAYWRIGHT_GREP`               | `''`                            | Grep pattern to filter tests. When any Playwright flag is set, `SCRIPT_NAME` is ignored and `npx playwright test` is used directly |
+| `PLAYWRIGHT_GREP_INVERT`        | `''`                            | Grep pattern to exclude tests. Passed as `--grep-invert` flag. When any Playwright flag is set, `SCRIPT_NAME` is ignored and `npx playwright test` is used directly |
+| `PLAYWRIGHT_PROJECT`            | `''`                            | Playwright project name from `playwright.config`. When any Playwright flag is set, `SCRIPT_NAME` is ignored and `npx playwright test` is used directly |
+| `PRE_SCRIPT`                    | `''`                            | Run custom shell code before executing the test script. `GH_TOKEN` and all `ENV_FILE_DATA` variables are available |
+| `SCRIPT_NAME`                   | `''`                            | The name of a custom npm script to run the tests. Ignored when any Playwright flag is set         |
+| `WORK_DIR`                      | `'.'`                           | Working directory for npm install, Playwright install, PRE_SCRIPT, and test execution             |
+
+> **Note:** Setting any combination of `PLAYWRIGHT_GREP`, `PLAYWRIGHT_GREP_INVERT`, or `PLAYWRIGHT_PROJECT` will bypass `SCRIPT_NAME` and run `npx playwright test` directly with the specified flags.
 
 ### Secrets
 
 | Name                  | Description                                                                              |
 |-----------------------|------------------------------------------------------------------------------------------|
-| `ENV_FILE_DATA`       | Additional environment variables for the tests                                           |
+| `ENV_FILE_DATA`       | Additional environment variables for the tests. Also sourced before `PRE_SCRIPT`         |
 | `COMPOSER_AUTH_JSON`  | Authentication for privately hosted packages and repositories as a JSON formatted object |
 | `NPM_REGISTRY_TOKEN`  | Authentication for the private npm registry                                              |
 | `GITHUB_USER_EMAIL`   | Email address for the GitHub user configuration                                          |
@@ -88,6 +94,59 @@ jobs:
       NPM_REGISTRY_TOKEN: ${{ secrets.DEPLOYBOT_PACKAGES_READ_ACCESS_TOKEN}}
 ```
 
+**Example with subdirectory and grep mode:**
+
+```yml
+name: E2E Testing
+
+on:
+  workflow_dispatch:
+    inputs:
+      TEST_SUITE:
+        description: 'Test suite to run'
+        required: true
+        default: 'critical'
+        type: choice
+        options:
+          - smoke
+          - critical
+          - all
+          - grep
+      TEST_GREP_PATTERN:
+        description: 'Grep pattern (only used when TEST_SUITE == "grep")'
+        required: false
+        type: string
+      TEST_GREP_INVERT_PATTERN:
+        description: 'Grep invert pattern (only used when TEST_SUITE == "grep")'
+        required: false
+        type: string
+      TEST_PROJECT:
+        description: 'Playwright project name (only used when TEST_SUITE == "grep")'
+        required: false
+        default: 'all'
+        type: string
+
+jobs:
+  e2e-playwright:
+    uses: inpsyde/reusable-workflows/.github/workflows/test-playwright.yml@main
+    with:
+      WORK_DIR: 'tests/qa'
+      ARTIFACT_PATH: |
+        tests/qa/artifacts/*
+        tests/qa/playwright-report/
+      SCRIPT_NAME: ${{ inputs.TEST_SUITE != 'grep' && format('test:{0}', inputs.TEST_SUITE) || '' }}
+      PLAYWRIGHT_GREP: ${{ inputs.TEST_SUITE == 'grep' && inputs.TEST_GREP_PATTERN || '' }}
+      PLAYWRIGHT_GREP_INVERT: ${{ inputs.TEST_SUITE == 'grep' && inputs.TEST_GREP_INVERT_PATTERN || '' }}
+      PLAYWRIGHT_PROJECT: ${{ inputs.TEST_SUITE == 'grep' && inputs.TEST_PROJECT || '' }}
+      NODE_VERSION: 22
+      PLAYWRIGHT_BROWSER_ARGS: 'chromium --with-deps'
+      PRE_SCRIPT: |
+        gh run download ${{ github.run_id }} -n my-plugin -D resources/files
+        npm run setup:env
+    secrets:
+      ENV_FILE_DATA: ${{ secrets.ENV_FILE_DATA }}
+```
+
 **Example of secrets:**
 
 For `ENV_FILE_DATA`: