@uuv/playwright 2.0.2 → 2.1.0

package/dist/cucumber/preprocessor/gen/generate.d.ts

@@ -5,9 +5,11 @@ import { GherkinDocument, Pickle } from "@cucumber/messages";
 export declare class PWFile {
     doc: GherkinDocument;
     private pickles;
+    private readonly tags?;
     private lines;
     private keywordsMap?;
-    constructor(doc: GherkinDocument, pickles: Pickle[]);
+    private tagsExpression;
+    constructor(doc: GherkinDocument, pickles: Pickle[], tags?: string | undefined);
     get content(): string;
     get language(): string;
     build(): this;

package/dist/cucumber/preprocessor/gen/generate.js

@@ -22,18 +22,28 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PWFile = void 0;
 const formatter = __importStar(require("./formatter"));
 const i18n_1 = require("./i18n");
+const tag_expressions_1 = __importDefault(require("@cucumber/tag-expressions"));
 class PWFile {
     doc;
     pickles;
+    tags;
     lines = [];
     keywordsMap;
-    constructor(doc, pickles) {
+    tagsExpression;
+    constructor(doc, pickles, tags) {
         this.doc = doc;
         this.pickles = pickles;
+        this.tags = tags;
+        if (tags) {
+            this.tagsExpression = (0, tag_expressions_1.default)(tags);
+        }
     }
     get content() {
         return this.lines.join("\n");
@@ -71,7 +81,17 @@ class PWFile {
             return this.getBeforeEach(background);
         }
         if (scenario) {
-            return this.getScenarioLines(scenario);
+            if (this.tagsExpression) {
+                if (this.tagsExpression.evaluate(scenario.tags.map(tag => tag.name))) {
+                    return this.getScenarioLines(scenario);
+                }
+                else {
+                    return [];
+                }
+            }
+            else {
+                return this.getScenarioLines(scenario);
+            }
         }
         throw new Error(`Empty child: ${JSON.stringify(child)}`);
     }

package/dist/cucumber/preprocessor/gen/index.d.ts

@@ -3,5 +3,6 @@ export type GenOptions = {
     outputDir?: string;
     cucumberConfig?: string;
     cwd?: string;
+    tags?: string;
 };
 export declare function generateTestFiles(inputOptions?: GenOptions): Promise<Map<string, GherkinDocument>>;

package/dist/cucumber/preprocessor/gen/index.js

@@ -17,9 +17,9 @@ const defaults = {
     cwd: process.cwd(),
 };
 async function generateTestFiles(inputOptions) {
-    const { outputDir, cwd, cucumberConfig } = Object.assign({}, defaults, inputOptions);
+    const { outputDir, cwd, cucumberConfig, tags } = Object.assign({}, defaults, inputOptions);
     const features = await loadFeatures({ file: cucumberConfig }, { cwd });
-    const files = buildFiles(features);
+    const files = buildFiles(features, tags);
     const paths = (0, save_1.saveFiles)(files, node_path_1.default.join(cwd, outputDir));
     const mapOfFile = new Map();
     paths.forEach((path, index) => mapOfFile.set(path, Array.from(features.keys())[index]));
@@ -32,9 +32,9 @@ async function loadFeatures(options, environment) {
     handleParseErrors(parseErrors);
     return groupByDocument(filteredPickles);
 }
-function buildFiles(features) {
+function buildFiles(features, tags) {
     const files = [];
-    features.forEach((pickles, doc) => files.push(new generate_1.PWFile(doc, pickles).build()));
+    features.forEach((pickles, doc) => files.push(new generate_1.PWFile(doc, pickles, tags).build()));
     return files;
 }
 function groupByDocument(filteredPickles) {

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

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

package/dist/lib/runner-playwright.js

@@ -48,10 +48,11 @@ const child_process_1 = __importStar(require("child_process"));
 const uuv_playwright_reporter_helper_1 = require("../reporter/uuv-playwright-reporter-helper");
 const path_1 = __importDefault(require("path"));
 exports.UUVPlaywrightCucumberMapFile = ".uuv-playwright-cucumber-map.json";
-async function bddGen(tempDir) {
+async function bddGen(tempDir, env) {
     try {
         const mapOfFile = await (0, gen_1.generateTestFiles)({
             outputDir: tempDir,
+            tags: env.TAGS
         });
         const content = [];
         mapOfFile.forEach((value, key) => {
@@ -112,7 +113,7 @@ function translateFeatures(tempDir, configDir) {
         console.log(chalk_1.default.gray(`[WRITE] ${generatedFile} written successfully`));
     });
 }
-function runPlaywright(mode, configDir, generateHtmlReport = false, env, targetTestFile) {
+function runPlaywright(mode, configDir, browser = "chromium", 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 {
@@ -122,10 +123,14 @@ function runPlaywright(mode, configDir, generateHtmlReport = false, env, targetT
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
         process.env.CONFIG_DIR = configDir;
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        process.env.browser = browser;
         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)}`;
+        // eslint-disable-next-line max-len
+        const command = `npx playwright test --project=${browser} -c ${configFile} ${mode === "open" ? "--ui" : ""}${getTargetTestFileForPlawright(targetTestFile)}`;
         console.log(chalk_1.default.gray(`Running ${command}`));
         (0, child_process_1.execSync)(command, { stdio: "inherit" });
     }
@@ -137,22 +142,35 @@ function getTargetTestFileForPlawright(targetTestFile) {
     if (!targetTestFile) {
         return "";
     }
-    return targetTestFile
+    return ` ${targetTestFile
         .replaceAll("uuv/e2e/", ".uuv-features-gen/uuv/e2e/")
-        .replaceAll(".feature", ".feature.spec.js");
+        .replaceAll(".feature", ".feature.spec.js")}`;
 }
-async function executePreprocessor(tempDir, configDir) {
+async function executePreprocessor(tempDir, configDir, env) {
     console.log("running preprocessor...");
-    await bddGen(tempDir);
+    await bddGen(tempDir, env);
     translateFeatures(tempDir, configDir);
     console.log("preprocessor executed");
 }
 exports.executePreprocessor = executePreprocessor;
-async function run(mode, tempDir = "uuv/.features-gen/e2e", configDir = "uuv", generateHtmlReport = false, env, targetTestFile) {
-    await executePreprocessor(tempDir, configDir);
+async function run(mode, tempDir = "uuv/.features-gen/e2e", configDir = "uuv", argv) {
+    const { browser, env, targetTestFile } = extractArgs(argv);
+    await executePreprocessor(tempDir, configDir, env);
     if (mode === "open") {
-        child_process_1.default.fork(path_1.default.join(__dirname, "watch-test-files"), [tempDir, configDir]);
+        child_process_1.default.fork(path_1.default.join(__dirname, "watch-test-files"), [tempDir, configDir, env]);
     }
-    runPlaywright(mode, configDir, generateHtmlReport, env, targetTestFile);
+    runPlaywright(mode, configDir, browser, argv.generateHtmlReport, env, targetTestFile);
 }
 exports.run = run;
+function extractArgs(argv) {
+    const browser = argv.browser;
+    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)}`);
+    if (targetTestFile) {
+        console.debug(`  -> targetTestFile: ${targetTestFile}`);
+    }
+    return { browser, env, targetTestFile };
+}

package/dist/lib/uuv-cli.js

@@ -43,32 +43,12 @@ async function main() {
             process.exit(1);
     }
     console.info(`UUV command ${command} executed`);
-    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)}`);
-        if (targetTestFile) {
-            console.debug(`  -> targetTestFile: ${targetTestFile}`);
-        }
-        return { browser, env, targetTestFile };
-    }
     function openPlaywright(argv) {
-        // TODO Implementer les paramètres env en json
-        //const { env } = extractArgs(argv);
-        return (0, runner_playwright_1.run)("open", FEATURE_GEN_DIR, PROJECT_DIR);
+        return (0, runner_playwright_1.run)("open", FEATURE_GEN_DIR, PROJECT_DIR, argv);
     }
     function runE2ETests(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, env, targetTestFile)
+        return (0, runner_playwright_1.run)("e2e", FEATURE_GEN_DIR, PROJECT_DIR, argv)
             .then(async (result) => {
             console.log(`Status ${chalk_1.default.green("success")}`);
         })

package/dist/lib/watch-test-files.js

@@ -22,6 +22,7 @@ const chokidar_1 = __importDefault(require("chokidar"));
 const chalk_1 = __importDefault(require("chalk"));
 const tempDir = process.argv[2];
 const configDir = process.argv[3];
+const env = process.argv[4];
 if (!tempDir || !configDir) {
     console.log(chalk_1.default.redBright("An error occurred during test files watching"));
     process.exit(-1);
@@ -31,16 +32,16 @@ chokidar_1.default.watch(`${configDir}/e2e/**/*.feature`, {
 })
     .on("change", async (event, path) => {
     console.log(chalk_1.default.yellowBright("\nRefreshing test files..."));
-    await (0, runner_playwright_1.executePreprocessor)(tempDir, configDir);
+    await (0, runner_playwright_1.executePreprocessor)(tempDir, configDir, env);
     console.log(chalk_1.default.yellowBright("Test files refreshed\n"));
 })
     .on("add", async (path) => {
     console.log(chalk_1.default.yellowBright(`\nFile ${path} has been added`));
-    await (0, runner_playwright_1.executePreprocessor)(tempDir, configDir);
+    await (0, runner_playwright_1.executePreprocessor)(tempDir, configDir, env);
     console.log(chalk_1.default.yellowBright("Test files refreshed\n"));
 })
     .on("unlink", async (path) => {
     console.log(chalk_1.default.yellowBright(`\nFile ${path} has been removed`));
-    await (0, runner_playwright_1.executePreprocessor)(tempDir, configDir);
+    await (0, runner_playwright_1.executePreprocessor)(tempDir, configDir, env);
     console.log(chalk_1.default.yellowBright("Test files refreshed\n"));
 });

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

@@ -77,5 +77,6 @@ declare class UuvPlaywrightReporterHelper {
     private teamcityAddName;
     private teamcityAddDuration;
     private teamcityAddCustomField;
+    private getTagsParameter;
 }
 export default UuvPlaywrightReporterHelper;

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

@@ -14,6 +14,7 @@ const nanoid_1 = require("nanoid");
 const chalk_1 = __importDefault(require("chalk"));
 const chalk_table_1 = __importDefault(require("chalk-table"));
 const uuv_custom_formatter_1 = require("./uuv-custom-formatter");
+const tag_expressions_1 = __importDefault(require("@cucumber/tag-expressions"));
 const NANOS_IN_SECOND = 1000000000;
 const NANOS_IN_MILLISSECOND = 1000000;
 var GeneratedReportType;
@@ -331,6 +332,8 @@ class UuvPlaywrightReporterHelper {
     initializeCucumberReportNdJson(suite, featureFiles) {
         featureFiles.forEach(featureFile => {
             const originalFile = this.getOriginalFeatureFile(featureFile);
+            const tagsParameter = this.getTagsParameter();
+            const tagsExpression = (0, tag_expressions_1.default)(tagsParameter ? tagsParameter : "");
             if (originalFile) {
                 const currentEnvelopes = (0, gherkin_1.generateMessages)(fs_1.default.readFileSync(originalFile).toString(), originalFile, messages_1.SourceMediaType.TEXT_X_CUCUMBER_GHERKIN_PLAIN, {
                     includeSource: true,
@@ -339,7 +342,20 @@ class UuvPlaywrightReporterHelper {
                     includePickles: true
                 });
                 const currentQuery = new gherkin_utils_1.Query();
-                currentEnvelopes.forEach(envelope => currentQuery.update(envelope));
+                currentEnvelopes
+                    .map(envelope => {
+                    if (tagsParameter && envelope?.gherkinDocument?.feature) {
+                        envelope.gherkinDocument.feature.children = envelope.gherkinDocument.feature.children.filter(child => child.scenario?.tags && tagsExpression.evaluate(child.scenario.tags.map(tag => tag.name)));
+                    }
+                    return envelope;
+                })
+                    .filter(envelope => {
+                    if (tagsParameter && envelope?.pickle?.steps) {
+                        return tagsExpression.evaluate(envelope.pickle.tags.map(pickleTag => pickleTag.name));
+                    }
+                    return true;
+                })
+                    .forEach(envelope => currentQuery.update(envelope));
                 this.queries.set(originalFile, currentQuery);
                 this.envelopes = this.envelopes.concat(currentEnvelopes);
                 this.featureFileAndTestCaseStatusMap.set(originalFile, []);
@@ -403,9 +419,23 @@ class UuvPlaywrightReporterHelper {
         await formatter.parseCucumberJson(inputMessageFile, outputFormattedFileJson);
     }
     generateHtmlReportFromJson(reportDirHtml, reportDirJson) {
+        const UNKNOWN_VALUE = "unknown";
         multiple_cucumber_html_reporter_1.default.generate({
             jsonDir: reportDirJson,
-            reportPath: reportDirHtml
+            reportPath: reportDirHtml,
+            metadata: {
+                browser: {
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore
+                    name: process.env.browser,
+                    version: UNKNOWN_VALUE
+                },
+                device: UNKNOWN_VALUE,
+                platform: {
+                    name: UNKNOWN_VALUE,
+                    version: UNKNOWN_VALUE,
+                },
+            },
         });
     }
     async generateHtmlReport() {
@@ -520,5 +550,10 @@ class UuvPlaywrightReporterHelper {
     teamcityAddCustomField(fieldName, value) {
         return `${fieldName}='${value}'`;
     }
+    getTagsParameter() {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        return process.env.TAGS;
+    }
 }
 exports.default = UuvPlaywrightReporterHelper;

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

@@ -15,7 +15,8 @@ class UuvPlawrightReporter {
         console.info(chalk_1.default.yellow(`Starting the run with ${suite.allTests().length} tests`));
     }
     onError(error) {
-        console.dir(chalk_1.default.red(error));
+        console.error(chalk_1.default.red("An error occured: "));
+        console.dir(error);
     }
     onTestBegin(test, result) {
         const startTimestamp = this.helper.getTimestamp(result.startTime);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/playwright",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A solution to facilitate the writing and execution of E2E tests understandable by any human being using cucumber(BDD) and playwright",
@@ -38,15 +38,16 @@
     "postinstall": "node postinstall.js",
     "serverTest:run": "ts-node playwright/run-test-app.ts 9002",
     "test:run": "ts-node test.ts run",
-    "test:open": "ts-node test.ts open",
+    "test:open": "ts-node test.ts open --",
     "test:alone:run": "npx playwright test",
     "test:format": "ts-node format-cucumber-report.ts",
-    "test": "npm run test:run"
+    "test": "npm run test:run --"
   },
   "dependencies": {
     "@cucumber/cucumber": "9.6.0",
+    "@cucumber/tag-expressions": "^6.0.0",
     "@playwright/test": "1.33.0",
-    "@uuv/runner-commons": "2.0.2",
+    "@uuv/runner-commons": "2.1.0",
     "axe-core": "4.8.2",
     "axe-playwright": "1.2.3",
     "chalk": "4.1.2",