testit-adapter-playwright 2.0.1 → 2.1.0

package/README.md

@@ -96,6 +96,7 @@ Description of methods:
 - `testit.addLinks` - links in the autotest result
 - `testit.addAttachments` - uploading files in the autotest result
 - `testit.addMessage` - information about autotest in the autotest result
+- `testit.step` - information about step in the autotest result
 
 ### Examples
 
@@ -122,6 +123,9 @@ test('All annotations', async () => {
   ]);
 
   testit.addAttachment('file01.txt', 'Content', {contentType: "text/markdown",});
+
+  await testit.step("step with title", async () => {
+  });
 });
 ```
 

package/dist/converter.d.ts

@@ -1,6 +1,6 @@
-import { TestCase, TestResult } from "@playwright/test/reporter";
+import { TestCase, TestStep, TestResult } from "@playwright/test/reporter";
 import { TestStatus } from "@playwright/test";
-import { AutotestPost, AutotestResult } from "testit-js-commons";
+import { AutotestPost, AutotestResult, ShortStep, Step, Attachment } from "testit-js-commons";
 import { MetadataMessage } from "./labels";
 declare enum Status {
     PASSED = "Passed",
@@ -10,6 +10,10 @@ declare enum Status {
 export declare class Converter {
     static convertTestCaseToAutotestPost(autotestData: MetadataMessage): AutotestPost;
     static convertAutotestPostToAutotestResult(autotestData: MetadataMessage, test: TestCase, result: TestResult): AutotestResult;
+    static convertTestStepsToShortSteps(steps: TestStep[]): ShortStep[];
+    static convertTestStepToShortStep(step: TestStep): ShortStep;
+    static convertTestStepsToSteps(steps: TestStep[], attachmentsMap: Map<Attachment, TestStep>): Step[];
+    static convertTestStepToStep(step: TestStep, attachmentsMap: Map<Attachment, TestStep>): Step;
     static convertStatus(status: TestStatus, expectedStatus: TestStatus): Status;
 }
 export type StatusDetails = {

package/dist/converter.js

@@ -37,6 +37,26 @@ class Converter {
         }
         return autotestResult;
     }
+    static convertTestStepsToShortSteps(steps) {
+        return steps.map(step => {
+            return this.convertTestStepToShortStep(step);
+        });
+    }
+    static convertTestStepToShortStep(step) {
+        return {
+            title: step.title,
+        };
+    }
+    static convertTestStepsToSteps(steps, attachmentsMap) {
+        return steps.map(step => this.convertTestStepToStep(step, attachmentsMap));
+    }
+    static convertTestStepToStep(step, attachmentsMap) {
+        return {
+            title: step.title,
+            outcome: step.error ? Status.FAILED : Status.PASSED,
+            attachments: [...attachmentsMap.keys()].filter((attachmentId) => attachmentsMap.get(attachmentId) === step),
+        };
+    }
     static convertStatus(status, expectedStatus) {
         if (status === "skipped") {
             return Status.SKIPPED;

package/dist/labels.d.ts

@@ -37,8 +37,8 @@ declare enum ContentType {
 }
 type Parameters = Record<string, string>;
 export declare class testit {
-    static addAttachment(name: string, content: Buffer | string, options: ContentType | string | Pick<AttachmentOptions, "contentType">): Promise<void>;
     private static addMetadataAttachment;
+    static addAttachment(name: string, content: Buffer | string, options: ContentType | string | Pick<AttachmentOptions, "contentType">): Promise<void>;
     private static mapParams;
     static workItemIds(value: string[]): Promise<void>;
     static displayName(value: string): Promise<void>;
@@ -52,5 +52,6 @@ export declare class testit {
     static addLinks(value: Link[]): Promise<void>;
     static addMessage(value: string): Promise<void>;
     static params(value: any): Promise<void>;
+    static step<T>(name: string, body: () => Promise<T>): Promise<T>;
 }
 export {};

package/dist/labels.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.testit = void 0;
+const crypto_1 = require("crypto");
 const test_1 = __importDefault(require("@playwright/test"));
 var ContentType;
 (function (ContentType) {
@@ -23,19 +24,22 @@ var ContentType;
     ContentType["MP4"] = "video/mp4";
 })(ContentType || (ContentType = {}));
 class testit {
-    static async addAttachment(name, content, options) {
-        const contentType = typeof options === "string" ? options : options.contentType;
-        await test_1.default.info().attach(name, {
-            body: content,
-            contentType,
-        });
-    }
     static async addMetadataAttachment(metadata) {
         await test_1.default.info().attach("tms-metadata.json", {
             contentType: "application/vnd.tms.metadata+json",
             body: Buffer.from(JSON.stringify(metadata), "utf8"),
         });
     }
+    static async addAttachment(name, content, options) {
+        const stepName = `stepattach_${(0, crypto_1.randomUUID)()}_${name}`;
+        const contentType = typeof options === "string" ? options : options.contentType;
+        await this.step(stepName, async () => {
+            await test_1.default.info().attach(stepName, {
+                body: content,
+                contentType,
+            });
+        });
+    }
     static async mapParams(params) {
         switch (typeof params) {
             case 'string':
@@ -115,5 +119,8 @@ class testit {
             params: await this.mapParams(value),
         });
     }
+    static step(name, body) {
+        return test_1.default.step(name, body);
+    }
 }
 exports.testit = testit;

package/dist/reporter.d.ts

@@ -1,5 +1,5 @@
 import { FullConfig } from "@playwright/test";
-import { Reporter, Suite, TestCase, TestResult } from "@playwright/test/reporter";
+import { Reporter, Suite, TestCase, TestResult, TestStep } from "@playwright/test/reporter";
 import { IStrategy } from "testit-js-commons";
 export type ReporterOptions = {
     detail?: boolean;
@@ -15,11 +15,14 @@ declare class TmsReporter implements Reporter {
     strategy: IStrategy;
     private readonly additions;
     private testCache;
+    private stepCache;
+    private attachmentSteps;
     private globalStartTime;
     constructor(options: ReporterOptions);
     onBegin(config: FullConfig, suite: Suite): void;
     onTestBegin(test: TestCase): void;
     onTestEnd(test: TestCase, result: TestResult): Promise<void>;
+    onStepBegin(test: TestCase, _result: TestResult, step: TestStep): void;
     onEnd(): void;
     addSkippedResults(): void;
     printsToStdio(): boolean;

package/dist/reporter.js

@@ -16,9 +16,12 @@ 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;
 class TmsReporter {
     constructor(options) {
         this.testCache = new Array();
+        this.stepCache = new Map();
+        this.attachmentSteps = new Map();
         this.globalStartTime = new Date();
         this.options = { suiteTitle: true, detail: true, ...options };
         const config = new testit_js_commons_1.ConfigComposer().compose();
@@ -35,8 +38,24 @@ class TmsReporter {
     }
     async onTestEnd(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);
+        autotest.steps = converter_1.Converter.convertTestStepsToShortSteps(steps);
         await this.strategy.loadAutotest(autotest, converter_1.Converter.convertStatus(result.status, test.expectedStatus) == "Passed");
-        await this.strategy.loadTestRun([converter_1.Converter.convertAutotestPostToAutotestResult(await this.getAutotestData(test, result), test, result)]);
+        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.loadTestRun([autotestResult]);
+    }
+    onStepBegin(test, _result, step) {
+        if (!this.testCache.includes(test)) {
+            return;
+        }
+        if (step.category !== "test.step") {
+            return;
+        }
+        if (this.stepCache.get(step)) {
+            return;
+        }
+        this.stepCache.set(step, test);
     }
     onEnd() {
         this.addSkippedResults();
@@ -71,7 +90,7 @@ class TmsReporter {
             addAttachments: []
         };
         for (const attachment of result.attachments) {
-            if (!attachment.body || !attachment.path) {
+            if (!attachment.body) {
                 continue;
             }
             if (attachment.contentType === "application/vnd.tms.metadata+json") {
@@ -111,9 +130,19 @@ class TmsReporter {
                 }
                 continue;
             }
-            await this.additions.addAttachments(attachment.body.toString(), attachment.name).then((ids) => {
-                autotestData.addAttachments?.push(...ids);
-            });
+            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.toString(), attachment.name.replace(stepAttachRegexp, "")).then((ids) => {
+                    if (step?.parent) {
+                        this.attachmentSteps.set(ids[0], step.parent);
+                        return;
+                    }
+                    autotestData.addAttachments?.push(...ids);
+                });
+            }
         }
         return autotestData;
     }

package/package.json

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