fix: consider the user agent, #1091

Author: luifr10

.github/workflows/uuv-github-ci.yml

@@ -404,6 +404,59 @@ jobs:
           path: tests/integration/runner-playwright/uuv/reports/e2e/junit-report.xml
           reporter: jest-junit
 
+  integration-tests-playwright-yarn:
+    runs-on: ubuntu-22.04
+    container:
+      image: e2etesting/uuv
+    needs: [ lint, unit-tests, build, build-electron ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Cache node modules
+        uses: actions/cache@v4
+        with:
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('./package-lock.json') }}
+          path: |
+            node_modules
+            packages/assistant/node_modules
+            packages/docs/node_modules
+            packages/a11y/node_modules
+            packages/runner-commons/node_modules
+            packages/runner-cypress/node_modules
+            packages/runner-playwright/node_modules
+            packages/vscode-extension/node_modules
+            packages/a11y-dashboard/node_modules
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: build-artifacts
+          path: packages
+      - name: Use Node.js ${{ inputs.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version:
+            ${{env.NODE_VERSION}}
+      - run: npm ci
+      - name: Package runner-playwright
+        run: mkdir -p ./dist/packages && npx nx package a11y && npx nx package runner-commons && npx nx package runner-playwright
+      - name: Running playwright integration tests with yarn
+        env:
+          UUV_BASE_URL: ${{env.UUV_BASE_URL}}
+        run: cd ./tests/integration && chmod 755 ./integration-tests-yarn-runner-playwright.sh && ./integration-tests-yarn-runner-playwright.sh
+      - name: Upload uuv test artifact
+        uses: actions/upload-artifact@v4
+        if: success() || failure()
+        with:
+          name: integration-tests-playwright-yarn-artifacts
+          path: |
+            tests/integration/runner-playwright/uuv/reports
+      - name: Test Report
+        uses: MichaelVoelkel/test-reporter@main
+        if: success() || failure()
+        with:
+          name: Report - Integration Tests - Playwright (Yarn)
+          path: tests/integration/runner-playwright/uuv/reports/e2e/junit-report.xml
+          reporter: jest-junit
+
   lint:
     runs-on: ubuntu-22.04
     needs: install
@@ -422,7 +475,7 @@ jobs:
 
   release:
     if: github.ref == 'refs/heads/main'
-    needs: [ integration-tests-cypress, integration-tests-playwright, unit-tests-a11y, unit-tests-playwright, unit-tests-cypress, integration-tests-assistant, unit-tests-runner-flutter, build-docker, build-gradle ]
+    needs: [ integration-tests-cypress, integration-tests-playwright, integration-tests-playwright-yarn, unit-tests-a11y, unit-tests-playwright, unit-tests-cypress, integration-tests-assistant, unit-tests-runner-flutter, build-docker, build-gradle ]
     runs-on: ubuntu-22.04
     environment: release
     steps:

packages/runner-playwright/postinstall.js

@@ -37,10 +37,14 @@ function copyFileIfMissing(fileToCopy, originFolder, destFolder) {
     }
 }
 
+function getUserAgent() {
+    return process.env["npm_config_user_agent"]?.startsWith("yarn") ? "yarn" : "npx";
+}
+
 function main () {
     if (fs.existsSync(`${PROJECT_DIR}/package.json`) && !fs.existsSync(`${PROJECT_DIR}/.no-postinstall`)) {
         copyFileIfMissing("playwright.config.ts", `${TARGET_CONFIG_DIR}`, `${PROJECT_DIR}/uuv`);
-        execSync("npx playwright install", { stdio: "inherit" });
+        execSync(`${getUserAgent()} playwright install`, { stdio: "inherit" });
     } else {
         console.log("postinstall - Nothing to copy");
     }

packages/runner-playwright/src/lib/runner-playwright.ts

@@ -36,7 +36,7 @@ export class UUVCliPlaywrightRunner implements UUVCliRunner {
     async prepare(options: Partial<UUVCliOptions>) {
         try {
             console.log("running preprocessor...");
-            this.executeSystemCommand(`npx bddgen -c ${this.projectDir}/playwright.config.ts`);
+            this.executeSystemCommand(`${getUserAgent()} bddgen -c ${this.projectDir}/playwright.config.ts`);
             console.log("preprocessor executed\n");
         } catch (e) {
             console.warn(chalk.redBright("An error occured during preprocessor, please be sure to use existing step definitions"));
@@ -117,7 +117,7 @@ export class UUVCliPlaywrightRunner implements UUVCliRunner {
     private buildCommand(options: Partial<UUVCliOptions>, configFile: string, reporter: string): string {
         return _.trimEnd(
             [
-                "npx",
+                getUserAgent(),
                 "playwright",
                 "test",
                 `--project="${options.browser}"`,
@@ -156,11 +156,15 @@ function executeSystemCommandHelper(command: string) {
 export function executePreprocessor(projectDir: string): boolean {
     console.log("running preprocessor...");
     try {
-        executeSystemCommandHelper(`npx bddgen -c ${projectDir}/playwright.config.ts`);
+        executeSystemCommandHelper(`${getUserAgent()} bddgen -c ${projectDir}/playwright.config.ts`);
         console.log("preprocessor executed\n");
         return true;
     } catch (e) {
         console.warn(chalk.redBright("An error occured during preprocessor, please be sure to use existing step definitions"));
         return false;
     }
 }
+
+function getUserAgent(): string {
+    return process.env["npm_config_user_agent"]?.startsWith("yarn") ? "yarn" : "npx";
+}

tests/integration/integration-tests-yarn-runner-playwright.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+
+set -o pipefail
+set -o errexit
+
+source functions.sh
+RUNNER_NAME='playwright'
+WORKING_DIR="runner-${RUNNER_NAME}"
+RUNNER_DIR="../../../packages/runner-${RUNNER_NAME}"
+NPM_PACKAGE_COMMONS=$(ls ../../dist/packages/uuv-runner-commons-*)
+NPM_PACKAGE_A11Y=$(ls ../../dist/packages/uuv-a11y-*)
+NPM_PACKAGE_PLAYWRIGHT=$(ls ../../dist/packages/uuv-playwright-*)
+
+log "I" "Cleaning existing directory"
+if [ -d "$WORKING_DIR" ]; then rm -Rf $WORKING_DIR; fi
+
+log "I" "Creating directory"
+mkdir -p "$WORKING_DIR"
+cp "tsconfig.${RUNNER_NAME}.json" "$WORKING_DIR/tsconfig.json"
+cp "tsconfig.${RUNNER_NAME}.e2e.json" "$WORKING_DIR/tsconfig.e2e.json"
+mkdir -p "$WORKING_DIR/uuv/cucumber/step_definitions"
+cp "my-custom-step-definitions.${RUNNER_NAME}.ts" "$WORKING_DIR/uuv/cucumber/step_definitions/my-custom-step-definitions.ts"
+cd "$WORKING_DIR"
+
+log "I" "Creating new npm project"
+yarn init -y
+cp -f "../package-playwright.json" "package.json"
+A11Y_VERSION="../$NPM_PACKAGE_A11Y"
+sed -i "s|to-replace|${A11Y_VERSION}|" package.json
+
+log "I" "Installing npm dependencies"
+yarn add -D "../$NPM_PACKAGE_COMMONS" "../$NPM_PACKAGE_PLAYWRIGHT"
+
+log "I" "Copying test files and dependencies"
+cp -R "${RUNNER_DIR}/e2e/" ./uuv
+cp "../custom-step-definition.feature" ./uuv/e2e
+rm ./uuv/e2e/ko.feature
+mkdir -p ./uuv/playwright/fixtures
+cp -R "${RUNNER_DIR}/playwright/fixtures/" ./uuv/playwright
+
+log "I" "Replace baseUurl"
+sed -i 's/http:\/\/localhost:4200/https:\/\/e2e-test-quest.github.io\/simple-webapp\//g' uuv/playwright.config.ts
+
+log "I" "Running e2e test"
+if ! yarn uuv e2e --generateHtmlReport --generateJunitReport --generateA11yReport; then
+    log "E" "An error occured during e2e testing"
+    exit 1
+fi
+
+log "I" "Ended"