@uuv/playwright 1.7.3 → 1.8.0

package/dist/lib/runner-playwright.d.ts

@@ -17,4 +17,4 @@ export interface UUVPlaywrightCucumberMapItem {
     generatedFile: string;
 }
 export declare const UUVPlaywrightCucumberMapFile = ".uuv-playwright-cucumber-map.json";
-export declare function run(mode: "open" | "e2e", tempDir?: string, configDir?: string, generateHtmlReport?: boolean): Promise<void>;
+export declare function run(mode: "open" | "e2e", tempDir?: string, configDir?: string, generateHtmlReport?: boolean, env?: any, targetTestFile?: string): Promise<void>;

package/dist/lib/runner-playwright.js

@@ -88,7 +88,7 @@ function translateFeatures(tempDir, configDir) {
         console.log(chalk_1.default.gray(`[WRITE] ${generatedFile} written successfully`));
     });
 }
-function runPlaywright(mode, configDir, generateHtmlReport = false) {
+function runPlaywright(mode, configDir, generateHtmlReport = false, env, targetTestFile) {
     const configFile = `${configDir}/playwright.config.ts`;
     const reportType = generateHtmlReport ? uuv_playwright_reporter_helper_1.GeneratedReportType.HTML : uuv_playwright_reporter_helper_1.GeneratedReportType.CONSOLE;
     try {
@@ -98,7 +98,10 @@ function runPlaywright(mode, configDir, generateHtmlReport = false) {
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
         process.env.CONFIG_DIR = configDir;
-        const command = `npx playwright test --project=chromium -c ${configFile} ${mode === "open" ? "--ui" : ""}`;
+        if (env) {
+            Object.keys(env).forEach(key => process.env[key] = env[key]);
+        }
+        const command = `npx playwright test --project=chromium -c ${configFile} ${mode === "open" ? "--ui" : ""} ${getTargetTestFileForPlawright(targetTestFile)}`;
         console.log(chalk_1.default.gray(`Running ${command}`));
         (0, child_process_1.execSync)(command, { stdio: "inherit" });
     }
@@ -106,14 +109,22 @@ function runPlaywright(mode, configDir, generateHtmlReport = false) {
         process.exit(-1);
     }
 }
+function getTargetTestFileForPlawright(targetTestFile) {
+    if (!targetTestFile) {
+        return "";
+    }
+    return targetTestFile
+        .replaceAll("uuv/e2e/", ".uuv-features-gen/uuv/e2e/")
+        .replaceAll(".feature", ".feature.spec.js");
+}
 async function executePreprocessor(tempDir, configDir) {
     console.log("running preprocessor...");
     await bddGen(tempDir);
     translateFeatures(tempDir, configDir);
     console.log("preprocessor executed");
 }
-async function run(mode, tempDir = "uuv/.features-gen/e2e", configDir = "uuv", generateHtmlReport = false) {
+async function run(mode, tempDir = "uuv/.features-gen/e2e", configDir = "uuv", generateHtmlReport = false, env, targetTestFile) {
     await executePreprocessor(tempDir, configDir);
-    runPlaywright(mode, configDir, generateHtmlReport);
+    runPlaywright(mode, configDir, generateHtmlReport, env, targetTestFile);
 }
 exports.run = run;

package/dist/lib/uuv-cli.js

@@ -46,10 +46,14 @@ async function main() {
     function extractArgs(argv) {
         const browser = argv.browser ? argv.browser : "chrome";
         const env = argv.env ? JSON.parse(argv.env.replace(/'/g, "\"")) : {};
+        const targetTestFile = argv.targetTestFile ? argv.targetTestFile : null;
         console.debug("Variables: ");
         console.debug(`  -> browser: ${browser}`);
         console.debug(`  -> env: ${JSON.stringify(env)}`);
-        return { browser, env };
+        if (targetTestFile) {
+            console.debug(`  -> targetTestFile: ${targetTestFile}`);
+        }
+        return { browser, env, targetTestFile };
     }
     function openPlaywright(argv) {
         // TODO Implementer les paramètres env en json
@@ -57,14 +61,14 @@ async function main() {
         return (0, runner_playwright_1.run)("open", FEATURE_GEN_DIR, PROJECT_DIR);
     }
     function runE2ETests(argv) {
-        const { browser, env } = extractArgs(argv);
+        const { browser, env, targetTestFile } = extractArgs(argv);
         // TODO Manage HTML Report
         // Creating needed dirs
         // if (!fs.existsSync(JSON_REPORT_DIR)) {
         //   fs.mkdirSync(JSON_REPORT_DIR, { recursive: true });
         // }
         // Running Tests
-        return (0, runner_playwright_1.run)("e2e", FEATURE_GEN_DIR, PROJECT_DIR, argv.generateHtmlReport)
+        return (0, runner_playwright_1.run)("e2e", FEATURE_GEN_DIR, PROJECT_DIR, argv.generateHtmlReport, env, targetTestFile)
             .then(async (result) => {
             console.log(`Status ${chalk_1.default.green("success")}`);
         })

package/dist/reporter/uuv-playwright-reporter-helper.d.ts

@@ -10,6 +10,7 @@ declare class UuvPlaywrightReporterHelper {
     testDir: string;
     private queries;
     envelopes: Envelope[];
+    private featureFileAndTestCaseStatusMap;
     private testCasesAndTestCasesStartedIdMap;
     private testCasesAndPickleIdMap;
     private testCasesTestStepStartedIdMap;
@@ -36,6 +37,8 @@ declare class UuvPlaywrightReporterHelper {
     }): void;
     private getTestStepKey;
     createTestCaseFinishedEnvelope(test: TestCase, result: TestResult, featureFile: string, endTimestamp: any): void;
+    private logTeamcityTestEnd;
+    private logTeamcitySuiteFinishedIfNeeded;
     private addResultErrors;
     private createTestCaseErrorAttachmentsEnvelope;
     private initConsoleReportIfNotExists;
@@ -55,6 +58,7 @@ declare class UuvPlaywrightReporterHelper {
     private loadUUVPlaywrightCucumberMap;
     private initializeCucumberReportNdJson;
     private populateTestCasesAndPickleIdMap;
+    private updateTestcaseStatus;
     private generateTestStep;
     private createStepDefinitionEnvelope;
     private getFeatureFiles;
@@ -67,5 +71,11 @@ declare class UuvPlaywrightReporterHelper {
     logTestEnd(testCase: TestCase, result: TestResult): void;
     private getResultIcon;
     private getTestCaseTitle;
+    logTeamCity(line: any): void;
+    private teamcityFlowId;
+    private teamcityFlowIdAndParentFlowId;
+    private teamcityAddName;
+    private teamcityAddDuration;
+    private teamcityAddCustomField;
 }
 export default UuvPlaywrightReporterHelper;

package/dist/reporter/uuv-playwright-reporter-helper.js

@@ -42,6 +42,7 @@ class UuvPlaywrightReporterHelper {
     testDir;
     queries = new Map();
     envelopes = [];
+    featureFileAndTestCaseStatusMap = new Map();
     testCasesAndTestCasesStartedIdMap = new Map();
     testCasesAndPickleIdMap = new Map();
     testCasesTestStepStartedIdMap = new Map();
@@ -87,6 +88,7 @@ class UuvPlaywrightReporterHelper {
             this.testCasesAndTestCasesStartedIdMap.set(test.id, testCaseStartedId);
             this.initConsoleReportIfNotExists(featureFile);
         }
+        this.logTeamCity(`##teamcity[testStarted ${this.teamcityAddName(test.title)} ${this.teamcityFlowIdAndParentFlowId(test.title, featureFile)} ${this.teamcityAddCustomField("locationHint", "test://" + featureFile)} ]`);
     }
     createTestStepStartedEnvelope(test, step, featureFile, startTimestamp) {
         const currentQuery = this.queries.get(featureFile);
@@ -180,6 +182,8 @@ class UuvPlaywrightReporterHelper {
         return `${location.file.replaceAll("\\", "_")}-${location.line}-${location.column}`;
     }
     createTestCaseFinishedEnvelope(test, result, featureFile, endTimestamp) {
+        this.logTeamcityTestEnd(result, test, featureFile);
+        this.updateTestcaseStatus(featureFile, test.id, "done");
         const currentQuery = this.queries.get(featureFile);
         if (currentQuery) {
             if (result.status === "skipped" || result.status === "failed") {
@@ -199,6 +203,28 @@ class UuvPlaywrightReporterHelper {
             this.addResultErrors(result, test, featureFile);
             this.createTestCaseErrorAttachmentsEnvelope(testCaseStartedId, result);
         }
+        this.logTeamcitySuiteFinishedIfNeeded(featureFile);
+    }
+    logTeamcityTestEnd(result, test, featureFile) {
+        switch (result.status) {
+            case "passed":
+                this.logTeamCity(`##teamcity[testFinished ${this.teamcityAddName(test.title)} ${this.teamcityFlowIdAndParentFlowId(test.title, featureFile)} ${this.teamcityAddDuration(result)} ]`);
+                break;
+            case "failed":
+                this.logTeamCity(`##teamcity[testFailed ${this.teamcityAddName(test.title)} ${this.teamcityFlowIdAndParentFlowId(test.title, featureFile)} type='comparisonFailure' message='Test failed' ]`);
+                this.logTeamCity(`##teamcity[testFinished ${this.teamcityAddName(test.title)} ${this.teamcityFlowIdAndParentFlowId(test.title, featureFile)} ${this.teamcityAddDuration(result)} ]`);
+                break;
+            default:
+                this.logTeamCity(`##teamcity[testIgnored ${this.teamcityAddName(test.title)} ${this.teamcityFlowIdAndParentFlowId(test.title, featureFile)} ]`);
+        }
+    }
+    logTeamcitySuiteFinishedIfNeeded(featureFile) {
+        const featureTestCaseStatus = this.featureFileAndTestCaseStatusMap.get(featureFile);
+        if (featureTestCaseStatus) {
+            if (Object.entries(featureTestCaseStatus).find(([, value]) => value === "todo") === undefined) {
+                this.logTeamCity(`##teamcity[testSuiteFinished ${this.teamcityAddName(featureFile)} ${this.teamcityFlowId(featureFile)} ]`);
+            }
+        }
     }
     addResultErrors(result, test, featureFile) {
         result.errors.forEach(error => {
@@ -231,6 +257,7 @@ class UuvPlaywrightReporterHelper {
     }
     initConsoleReportIfNotExists(featureFile) {
         if (!this.consoleReportMap.get(featureFile)) {
+            this.logTeamCity(`##teamcity[testSuiteStarted ${this.teamcityAddName(featureFile)} ${this.teamcityFlowId(featureFile)} ${this.teamcityAddCustomField("locationHint", "suite://" + featureFile)} ]`);
             this.consoleReportMap.set(featureFile, new ReportOfFeature());
         }
     }
@@ -316,18 +343,27 @@ class UuvPlaywrightReporterHelper {
                 currentEnvelopes.forEach(envelope => currentQuery.update(envelope));
                 this.queries.set(originalFile, currentQuery);
                 this.envelopes = this.envelopes.concat(currentEnvelopes);
-                this.populateTestCasesAndPickleIdMap(currentQuery, suite, featureFile);
+                this.featureFileAndTestCaseStatusMap.set(originalFile, []);
+                this.populateTestCasesAndPickleIdMap(currentQuery, suite, featureFile, originalFile);
             }
         });
     }
-    populateTestCasesAndPickleIdMap(currentQuery, suite, featureFile) {
+    populateTestCasesAndPickleIdMap(currentQuery, suite, featureFile, originalFile) {
         const pickles = currentQuery.getPickles();
         const featureFileTestSuite = suite.allTests()
             .filter(testCase => testCase.location.file === featureFile);
         featureFileTestSuite.forEach((testCase, index) => {
             this.testCasesAndPickleIdMap.set(testCase.id, pickles[index].id);
+            this.updateTestcaseStatus(originalFile, testCase.id, "todo");
         });
     }
+    updateTestcaseStatus(originalFile, testCaseId, newStatus) {
+        const featureTestCaseStatus = this.featureFileAndTestCaseStatusMap.get(originalFile);
+        if (featureTestCaseStatus) {
+            featureTestCaseStatus[`${testCaseId}`] = newStatus;
+            this.featureFileAndTestCaseStatusMap.set(originalFile, featureTestCaseStatus);
+        }
+    }
     generateTestStep(currentQuery, test) {
         const pickleId = this.testCasesAndPickleIdMap.get(test.id);
         return currentQuery.getPickles()
@@ -447,5 +483,27 @@ class UuvPlaywrightReporterHelper {
         const message = `${testCase.title}  (${result.duration}ms)`;
         return !testCase.ok() ? chalk_1.default.redBright(message) : chalk_1.default.gray(message);
     }
+    logTeamCity(line) {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        if (process.env.enableTeamcityLogging) {
+            console.log(line);
+        }
+    }
+    teamcityFlowId(name) {
+        return "flowId='" + name.replaceAll("'", "|'") + "'";
+    }
+    teamcityFlowIdAndParentFlowId(name, parentName) {
+        return "flowId='" + name.replaceAll("'", "|'") + "' parent='" + parentName.replaceAll("'", "|'") + "'";
+    }
+    teamcityAddName(name) {
+        return "name='" + name.replaceAll("'", "|'") + "'";
+    }
+    teamcityAddDuration(result) {
+        return "duration='" + result.duration + "'";
+    }
+    teamcityAddCustomField(fieldName, value) {
+        return `${fieldName}='${value}'`;
+    }
 }
 exports.default = UuvPlaywrightReporterHelper;

package/dist/reporter/uuv-playwright-reporter.js

@@ -11,6 +11,7 @@ class UuvPlawrightReporter {
         const startTimestamp = this.helper.getTimestamp();
         // console.log(`Starting the run with ${suite.allTests().length} tests`);
         this.helper.createTestRunStartedEnvelope(config, suite, startTimestamp);
+        this.helper.logTeamCity("##teamcity[progressStart 'Running UUV Tests']");
         console.info(chalk_1.default.yellow(`Starting the run with ${suite.allTests().length} tests`));
     }
     onError(error) {
@@ -46,8 +47,8 @@ class UuvPlawrightReporter {
         // console.log(`Finished test ${test.title}: ${result.status}`);
         const featureFile = this.helper.getOriginalFeatureFile(test.location.file);
         if (featureFile) {
-            this.helper.createTestCaseFinishedEnvelope(test, result, featureFile, endTimestamp);
             this.helper.logTestEnd(test, result);
+            this.helper.createTestCaseFinishedEnvelope(test, result, featureFile, endTimestamp);
         }
     }
     async onEnd(result) {
@@ -64,6 +65,7 @@ class UuvPlawrightReporter {
         else {
             console.error(chalk_1.default.red(`Tests executed with status: ${result.status}`));
         }
+        this.helper.logTeamCity("##teamcity[progressFinish 'Running UUV Tests']");
     }
 }
 exports.default = UuvPlawrightReporter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/playwright",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A solution to run E2E tests written in cucumber(BDD) with playwright.",
@@ -46,7 +46,7 @@
   "dependencies": {
     "@cucumber/cucumber": "9.3.0",
     "@playwright/test": "1.33.0",
-    "@uuv/runner-commons": "1.6.2",
+    "@uuv/runner-commons": "1.6.3",
     "axe-core": "4.7.2",
     "axe-playwright": "1.2.3",
     "chalk": "4.1.2",