testit-adapter-playwright 3.2.9 → 3.2.10-TMS-5.4

package/dist/labels.d.ts

@@ -19,7 +19,7 @@ interface AttachmentOptions {
     contentType: ContentType | string;
     fileExtension?: string;
 }
-declare enum ContentType {
+export declare enum ContentType {
     TEXT = "text/plain",
     XML = "application/xml",
     HTML = "text/html",
@@ -33,7 +33,15 @@ declare enum ContentType {
     ZIP = "application/zip",
     WEBM = "video/webm",
     JPEG = "image/jpeg",
-    MP4 = "video/mp4"
+    MP4 = "video/mp4",
+    MD = "text/markdown"
+}
+export declare enum Extensions {
+    PNG = ".png",
+    JPEG = ".jpg",
+    ZIP = ".zip",
+    WEBM = ".webm",
+    MD = ".md"
 }
 type Parameters = Record<string, string>;
 export declare class testit {

package/dist/labels.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testit = void 0;
+exports.testit = exports.Extensions = exports.ContentType = void 0;
 const crypto_1 = require("crypto");
 const test_1 = __importDefault(require("@playwright/test"));
 var ContentType;
@@ -22,7 +22,16 @@ var ContentType;
     ContentType["WEBM"] = "video/webm";
     ContentType["JPEG"] = "image/jpeg";
     ContentType["MP4"] = "video/mp4";
-})(ContentType || (ContentType = {}));
+    ContentType["MD"] = "text/markdown";
+})(ContentType || (exports.ContentType = ContentType = {}));
+var Extensions;
+(function (Extensions) {
+    Extensions["PNG"] = ".png";
+    Extensions["JPEG"] = ".jpg";
+    Extensions["ZIP"] = ".zip";
+    Extensions["WEBM"] = ".webm";
+    Extensions["MD"] = ".md";
+})(Extensions || (exports.Extensions = Extensions = {}));
 class testit {
     static async addMetadataAttachment(metadata) {
         await test_1.default.info().attach("tms-metadata.json", {

package/dist/models/result.d.ts

@@ -2,13 +2,27 @@ import { TestStatus } from "@playwright/test";
 import { TestError } from "@playwright/test/reporter";
 export interface Result {
     status: TestStatus;
-    attachments: Array<{
-        name: string;
-        contentType: string;
-        path?: string;
-        body?: Buffer;
-    }>;
+    attachments: Array<ResultAttachment>;
     duration: number;
     error?: TestError;
     errors: Array<TestError>;
 }
+export interface ResultAttachment {
+    /**
+     * Attachment name.
+     */
+    name: string;
+    /**
+     * Content type of this attachment to properly present in the report, for example `'application/json'` or
+     * `'image/png'`.
+     */
+    contentType: string;
+    /**
+     * Optional path on the filesystem to the attached file.
+     */
+    path?: string;
+    /**
+     * Optional attachment body used instead of a file.
+     */
+    body?: Buffer;
+}

package/dist/reporter.d.ts

@@ -10,7 +10,6 @@ export type ReporterOptions = {
 declare class TmsReporter implements Reporter {
     config: FullConfig;
     suite: Suite;
-    resultsDir: string;
     options: ReporterOptions;
     strategy: IStrategy;
     private readonly additions;
@@ -23,6 +22,7 @@ declare class TmsReporter implements Reporter {
     onBegin(config: FullConfig, suite: Suite): void;
     onTestBegin(test: TestCase): void;
     onTestEnd(test: TestCase, result: TestResult): void;
+    private _processAttachmentsWithExtensions;
     onStepBegin(test: TestCase, _result: TestResult, step: TestStep): void;
     onEnd(): Promise<void>;
     addSkippedResults(): Promise<void>;

package/dist/reporter.js

@@ -39,12 +39,16 @@ class TmsReporter {
     onTestEnd(test, result) {
         this.loadTestPromises.push(this.loadTest(test, {
             status: result.status,
-            attachments: result.attachments,
+            attachments: this._processAttachmentsWithExtensions(result),
             duration: result.duration,
             errors: result.errors,
             error: result.error,
         }));
     }
+    // fix issues with trace and video files on playwright
+    _processAttachmentsWithExtensions(result) {
+        return result.attachments.map(utils_1.processAttachmentExtensions);
+    }
     onStepBegin(test, _result, step) {
         if (!this.testCache.includes(test)) {
             return;
@@ -94,7 +98,7 @@ 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);
+                    const content = testit_js_commons_1.Utils.readBufferSync(attachment.path);
                     await this.additions.addAttachments(content, attachment.name)
                         .then((ids) => {
                         autotestData.addAttachments?.push(...ids);
@@ -144,7 +148,8 @@ class TmsReporter {
             }
             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) => {
+                await this.additions.addAttachments(attachment.body, attachment.name.replace(utils_1.stepAttachRegexp, ""))
+                    .then((ids) => {
                     if (step?.parent) {
                         this.attachmentsMap.set(ids[0], step.parent);
                         return;

package/dist/utils.d.ts

@@ -1,5 +1,6 @@
 import { TestError, TestStep } from "@playwright/test/reporter";
 import { Step } from "testit-js-commons";
+import { ResultAttachment } from "./models/result";
 export type StatusDetails = {
     message?: string;
     trace?: string;
@@ -9,3 +10,4 @@ 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;
+export declare function processAttachmentExtensions(attachment: ResultAttachment): ResultAttachment;

package/dist/utils.js

@@ -5,12 +5,15 @@ exports.getStatusDetails = getStatusDetails;
 exports.isAllStepsWithPassedOutcome = isAllStepsWithPassedOutcome;
 exports.isStep = isStep;
 exports.stripAscii = stripAscii;
+exports.processAttachmentExtensions = processAttachmentExtensions;
 const converter_1 = require("./converter");
+const labels_1 = require("./labels");
 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);
+        const prefixLength = message.length + "Error: ".length;
+        trace = trace.substring(prefixLength);
     }
     return {
         message: message,
@@ -30,3 +33,34 @@ function stripAscii(str) {
 ;
 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");
+function processAttachmentExtensions(attachment) {
+    switch (attachment.contentType) {
+        case labels_1.ContentType.ZIP:
+            if (!attachment.name.includes(labels_1.Extensions.ZIP)) {
+                attachment.name += labels_1.Extensions.ZIP;
+            }
+            return attachment;
+        case labels_1.ContentType.PNG:
+            if (!attachment.name.includes(labels_1.Extensions.PNG)) {
+                attachment.name += labels_1.Extensions.PNG;
+            }
+            return attachment;
+        case labels_1.ContentType.WEBM:
+            if (!attachment.name.includes(labels_1.Extensions.WEBM)) {
+                attachment.name += labels_1.Extensions.WEBM;
+            }
+            return attachment;
+        case labels_1.ContentType.MD:
+            if (!attachment.name.includes(labels_1.Extensions.MD)) {
+                attachment.name += labels_1.Extensions.MD;
+            }
+            return attachment;
+        case labels_1.ContentType.JPEG:
+            if (!attachment.name.includes(labels_1.Extensions.JPEG)) {
+                attachment.name += labels_1.Extensions.JPEG;
+            }
+            return attachment;
+        default:
+            return attachment;
+    }
+}

package/package.json

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