testit-adapter-playwright 2.2.4 → 2.2.5

package/README.md

@@ -77,6 +77,26 @@ $ testit testrun complete
   --testrun-id $(cat tmp/output.txt) 
 ```
 
+#### Launch using GitLab repository
+To run your Playwright test's from GitLab to TestIT or in reverse order using "testit-adapter-playwright", you can take this .gitlab-ci.yml file example:
+
+```
+image: node:latest
+
+stages:
+  - run
+
+first-job:
+  stage: run
+  script:
+    - npm install
+    - npx playwright test
+  artifacts:
+    paths:
+      - node_modules/
+```
+
+
 ### Methods
 
 Methods can be used to specify information about autotest.
@@ -139,6 +159,23 @@ for (const name of people) {
 }
 ```
 
+#### Content types
+```
+  TEXT = "text/plain",
+  XML = "application/xml",
+  HTML = "text/html",
+  CSV = "text/csv",
+  TSV = "text/tab-separated-values",
+  CSS = "text/css",
+  URI = "text/uri-list",
+  SVG = "image/svg+xml",
+  PNG = "image/png",
+  JSON = "application/json",
+  ZIP = "application/zip",
+  WEBM = "video/webm",
+  JPEG = "image/jpeg",
+  MP4 = "video/mp4",
+```
 
 # Contributing
 

package/dist/converter.d.ts

@@ -2,11 +2,15 @@ import { TestCase, TestStep, TestResult } from "@playwright/test/reporter";
 import { TestStatus } from "@playwright/test";
 import { AutotestPost, AutotestResult, ShortStep, Step, Attachment } from "testit-js-commons";
 import { MetadataMessage } from "./labels";
-declare enum Status {
+export declare enum Status {
     PASSED = "Passed",
     FAILED = "Failed",
     SKIPPED = "Skipped"
 }
+export type StatusDetails = {
+    message?: string;
+    trace?: string;
+};
 export declare class Converter {
     static convertTestCaseToAutotestPost(autotestData: MetadataMessage): AutotestPost;
     static convertAutotestPostToAutotestResult(autotestData: MetadataMessage, test: TestCase, result: TestResult): AutotestResult;
@@ -16,9 +20,3 @@ export declare class Converter {
     static convertTestStepToStep(step: TestStep, attachmentsMap: Map<Attachment, TestStep>): Step;
     static convertStatus(status: TestStatus, expectedStatus: TestStatus): Status;
 }
-export type StatusDetails = {
-    message?: string;
-    trace?: string;
-};
-export declare const stripAscii: (str: string) => string;
-export {};

package/dist/converter.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stripAscii = exports.Converter = void 0;
+exports.Converter = exports.Status = void 0;
+const utils_1 = require("./utils");
 var Status;
 (function (Status) {
     Status["PASSED"] = "Passed";
     Status["FAILED"] = "Failed";
     Status["SKIPPED"] = "Skipped";
-})(Status || (Status = {}));
+})(Status || (exports.Status = Status = {}));
 class Converter {
     static convertTestCaseToAutotestPost(autotestData) {
         return {
@@ -29,32 +30,39 @@ class Converter {
             duration: result.duration,
             parameters: autotestData.params,
             attachments: autotestData.addAttachments,
-            message: autotestData.addMessage,
         };
         if (result.error) {
-            const status = getStatusDetails(result.error);
+            const status = (0, utils_1.getStatusDetails)(result.error);
             autotestResult.message = status.message;
             autotestResult.traces = status.trace;
         }
+        if (autotestData.addMessage) {
+            autotestResult.message = autotestData.addMessage;
+        }
         return autotestResult;
     }
     static convertTestStepsToShortSteps(steps) {
-        return steps.map(step => {
-            return this.convertTestStepToShortStep(step);
-        });
+        return steps
+            .filter((step) => (0, utils_1.isStep)(step))
+            .map(step => this.convertTestStepToShortStep(step));
     }
     static convertTestStepToShortStep(step) {
         return {
             title: step.title,
+            steps: step.steps.length !== 0 ? this.convertTestStepsToShortSteps(step.steps) : [],
         };
     }
     static convertTestStepsToSteps(steps, attachmentsMap) {
-        return steps.map(step => this.convertTestStepToStep(step, attachmentsMap));
+        return steps
+            .filter((step) => (0, utils_1.isStep)(step))
+            .map(step => this.convertTestStepToStep(step, attachmentsMap));
     }
     static convertTestStepToStep(step, attachmentsMap) {
+        const steps = step.steps.length !== 0 ? this.convertTestStepsToSteps(step.steps, attachmentsMap) : [];
         return {
             title: step.title,
-            outcome: step.error ? Status.FAILED : Status.PASSED,
+            outcome: step.error || !(0, utils_1.isAllStepsWithPassedOutcome)(steps) ? Status.FAILED : Status.PASSED,
+            steps: steps,
             attachments: [...attachmentsMap.keys()].filter((attachmentId) => attachmentsMap.get(attachmentId) === step),
         };
     }
@@ -70,19 +78,3 @@ class Converter {
     ;
 }
 exports.Converter = Converter;
-const getStatusDetails = (error) => {
-    const message = error.message && (0, exports.stripAscii)(error.message);
-    let trace = error.stack && (0, exports.stripAscii)(error.stack);
-    if (trace && message && trace.startsWith(`Error: ${message}`)) {
-        trace = trace.substr(message.length + "Error: ".length);
-    }
-    return {
-        message: message,
-        trace: trace,
-    };
-};
-const stripAscii = (str) => {
-    return str.replace(asciiRegex, "");
-};
-exports.stripAscii = stripAscii;
-const asciiRegex = new RegExp("[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))", "g");

package/dist/reporter.d.ts

@@ -15,8 +15,9 @@ declare class TmsReporter implements Reporter {
     strategy: IStrategy;
     private readonly additions;
     private testCache;
-    private stepCache;
-    private attachmentSteps;
+    private stepsMap;
+    private attachmentStepsCache;
+    private attachmentsMap;
     private globalStartTime;
     private loadTestPromises;
     constructor(options: ReporterOptions);

package/dist/reporter.js

@@ -16,12 +16,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const testit_js_commons_1 = require("testit-js-commons");
 const converter_1 = require("./converter");
-const stepAttachRegexp = /^stepattach_(\w{8}-\w{4}-\w{4}-\w{4}-\w{12})_/i;
+const utils_1 = require("./utils");
 class TmsReporter {
     constructor(options) {
         this.testCache = new Array();
-        this.stepCache = new Map();
-        this.attachmentSteps = new Map();
+        this.stepsMap = new Map();
+        this.attachmentStepsCache = new Array();
+        this.attachmentsMap = new Map();
         this.globalStartTime = new Date();
         this.loadTestPromises = new Array();
         this.options = { suiteTitle: true, detail: true, ...options };
@@ -44,13 +45,20 @@ class TmsReporter {
         if (!this.testCache.includes(test)) {
             return;
         }
+        if (step.title.match(utils_1.stepAttachRegexp)) {
+            this.attachmentStepsCache.push(step);
+            return;
+        }
         if (step.category !== "test.step") {
             return;
         }
-        if (this.stepCache.get(step)) {
+        if (step.parent) {
+            return;
+        }
+        if (this.stepsMap.get(step)) {
             return;
         }
-        this.stepCache.set(step, test);
+        this.stepsMap.set(step, test);
     }
     async onEnd() {
         await Promise.all(this.loadTestPromises);
@@ -87,6 +95,13 @@ class TmsReporter {
         };
         for (const attachment of result.attachments) {
             if (!attachment.body) {
+                if (attachment.path && attachment.name !== "screenshot") {
+                    const content = testit_js_commons_1.Utils.readBuffer(attachment.path);
+                    await this.additions.addAttachments(content, attachment.name)
+                        .then((ids) => {
+                        autotestData.addAttachments?.push(...ids);
+                    });
+                }
                 continue;
             }
             if (attachment.contentType === "application/vnd.tms.metadata+json") {
@@ -129,14 +144,11 @@ class TmsReporter {
                 }
                 continue;
             }
-            if (attachment.name.match(stepAttachRegexp)) {
-                const step = [...this.stepCache.keys()].find((step) => step.title === attachment.name);
-                if (step) {
-                    this.stepCache.delete(step);
-                }
-                await this.additions.addAttachments(attachment.body, attachment.name.replace(stepAttachRegexp, "")).then((ids) => {
+            if (attachment.name.match(utils_1.stepAttachRegexp)) {
+                const step = this.attachmentStepsCache.find((step) => step.title === attachment.name);
+                await this.additions.addAttachments(attachment.body, attachment.name.replace(utils_1.stepAttachRegexp, "")).then((ids) => {
                     if (step?.parent) {
-                        this.attachmentSteps.set(ids[0], step.parent);
+                        this.attachmentsMap.set(ids[0], step.parent);
                         return;
                     }
                     autotestData.addAttachments?.push(...ids);
@@ -146,12 +158,17 @@ class TmsReporter {
         return autotestData;
     }
     async loadTest(test, result) {
-        const autotest = converter_1.Converter.convertTestCaseToAutotestPost(await this.getAutotestData(test, result));
-        const steps = [...this.stepCache.keys()].filter((step) => this.stepCache.get(step) === test);
+        const autotestData = await this.getAutotestData(test, result);
+        const autotest = converter_1.Converter.convertTestCaseToAutotestPost(autotestData);
+        const steps = [...this.stepsMap.keys()].filter((step) => this.stepsMap.get(step) === test);
+        const stepResults = converter_1.Converter.convertTestStepsToSteps(steps, this.attachmentsMap);
+        if (!(0, utils_1.isAllStepsWithPassedOutcome)(stepResults)) {
+            result.status = "failed";
+        }
         autotest.steps = converter_1.Converter.convertTestStepsToShortSteps(steps);
-        await this.strategy.loadAutotest(autotest, converter_1.Converter.convertStatus(result.status, test.expectedStatus) == "Passed");
-        const autotestResult = converter_1.Converter.convertAutotestPostToAutotestResult(await this.getAutotestData(test, result), test, result);
-        autotestResult.stepResults = converter_1.Converter.convertTestStepsToSteps(steps, this.attachmentSteps);
+        await this.strategy.loadAutotest(autotest, converter_1.Converter.convertStatus(result.status, test.expectedStatus) == converter_1.Status.PASSED);
+        const autotestResult = converter_1.Converter.convertAutotestPostToAutotestResult(autotestData, test, result);
+        autotestResult.stepResults = stepResults;
         await this.strategy.loadTestRun([autotestResult]);
     }
 }

package/dist/utils.d.ts

@@ -0,0 +1,11 @@
+import { TestError, TestStep } from "@playwright/test/reporter";
+import { Step } from "testit-js-commons";
+export type StatusDetails = {
+    message?: string;
+    trace?: string;
+};
+export declare function getStatusDetails(error: TestError): StatusDetails;
+export declare function isAllStepsWithPassedOutcome(steps: Step[]): boolean;
+export declare function isStep(step: TestStep): boolean;
+export declare function stripAscii(str: string): string;
+export declare const stepAttachRegexp: RegExp;

package/dist/utils.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stepAttachRegexp = void 0;
+exports.getStatusDetails = getStatusDetails;
+exports.isAllStepsWithPassedOutcome = isAllStepsWithPassedOutcome;
+exports.isStep = isStep;
+exports.stripAscii = stripAscii;
+const converter_1 = require("./converter");
+function getStatusDetails(error) {
+    const message = error.message && stripAscii(error.message);
+    let trace = error.stack && stripAscii(error.stack);
+    if (trace && message && trace.startsWith(`Error: ${message}`)) {
+        trace = trace.substr(message.length + "Error: ".length);
+    }
+    return {
+        message: message,
+        trace: trace,
+    };
+}
+;
+function isAllStepsWithPassedOutcome(steps) {
+    return !steps.find((step) => step.outcome === converter_1.Status.FAILED);
+}
+function isStep(step) {
+    return step.category === "test.step" && !step.title.match(exports.stepAttachRegexp);
+}
+function stripAscii(str) {
+    return str.replace(asciiRegex, "");
+}
+;
+exports.stepAttachRegexp = /^stepattach_(\w{8}-\w{4}-\w{4}-\w{4}-\w{12})_/i;
+const asciiRegex = new RegExp("[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))", "g");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testit-adapter-playwright",
-  "version": "2.2.4",
+  "version": "2.2.5",
   "description": "Playwright adapter for Test IT",
   "license": "Apache-2.0",
   "author": {
@@ -40,7 +40,7 @@
     "prettier": "^3.0.1"
   },
   "dependencies": {
-    "testit-js-commons": "~2.2.4"
+    "testit-js-commons": "~2.2.5"
   },
   "files": [
     "dist"