testit-adapter-cypress 3.7.6 → 3.7.8

package/README.md

@@ -1,5 +1,5 @@
 # Test IT TMS adapters for Cypress
-![Test IT](https://raw.githubusercontent.com/testit-tms/adapters-js/master/images/banner.png)
+![Test IT](https://raw.githubusercontent.com/testit-tms/adapters-js/main/images/banner.png)
 
 ## Getting Started
 
@@ -158,14 +158,14 @@ describe('example to-do app', () => {
     tms.addDescription('Test description');
     tms.addLabels('label1', 'label2');
     tms.addTags('tag1', 'tag2');
-    tms.addLinks([
+    tms.addLinks(
       {
         url: 'https://www.google.com',
         title: 'Google',
         description: 'This is a link to Google',
         type: 'Related',
       },
-    ]);
+    );
     tms.addParameter("name", "value");
     tms.addNameSpace("namespace");
     tms.addClassName("classname");

package/dist/browser/runtime.d.ts

@@ -1,30 +1,26 @@
-import { Label, Link, Status } from "testit-js-commons";
+import { Link } from "testit-js-commons";
 import type { AttachmentOptions, TestRuntime } from "./types.js";
-import type { StatusDetails } from "../models/types.js";
 export declare const initTestRuntime: () => void;
 export declare const getTestRuntime: () => TmsCypressTestRuntime;
 declare class TmsCypressTestRuntime implements TestRuntime {
     #private;
     constructor();
-    addLabels(...labels: Label[]): PromiseLike<void>;
+    addLabels(...labels: string[]): PromiseLike<void>;
     addTags(...tags: string[]): PromiseLike<void>;
     addLinks(...links: Link[]): PromiseLike<void>;
     addWorkItemIds(...workItemIds: string[]): PromiseLike<void>;
     addParameter(name: string, value: string): PromiseLike<void>;
-    addDescription(markdown: string): PromiseLike<void>;
-    addTitle(markdown: string): PromiseLike<void>;
-    addDisplayName(name: string): PromiseLike<void>;
-    addNameSpace(name: string): PromiseLike<void>;
-    addClassName(name: string): PromiseLike<void>;
+    addDescription(description: string): PromiseLike<void>;
+    addTitle(title: string): PromiseLike<void>;
+    addDisplayName(displayName: string): PromiseLike<void>;
+    addNameSpace(namespace: string): PromiseLike<void>;
+    addClassName(classname: string): PromiseLike<void>;
     addAttachments(name: string, content: Buffer | string, options: AttachmentOptions): PromiseLike<void>;
     addAttachmentsFromPath(name: string, path: string, options: Omit<AttachmentOptions, "encoding">): PromiseLike<void>;
     addGlobalAttachments(name: string, content: Buffer | string, options: AttachmentOptions): PromiseLike<void>;
     addGlobalAttachmentsFromPath(name: string, path: string, options: Omit<AttachmentOptions, "encoding">): PromiseLike<void>;
-    addMessage(details: StatusDetails): PromiseLike<void>;
-    logStep(name: string, status?: Status, error?: Error): PromiseLike<void>;
+    addMessage(message: string): PromiseLike<void>;
     step<T = void>(name: string, body: () => T | PromiseLike<T>): Cypress.ThenReturn<T, T>;
-    stepDisplayName(name: string): PromiseLike<void>;
-    stepParameter(name: string, value: string): PromiseLike<void>;
     flushTmsMessagesToTask(taskName: string): void;
     flushTmsMessagesToTaskAsync(taskName: string): Cypress.Chainable<unknown> | undefined;
 }

package/dist/browser/runtime.js

@@ -4,10 +4,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _TmsCypressTestRuntime_instances, _TmsCypressTestRuntime_resetMessages, _TmsCypressTestRuntime_enqueueMessageAsync, _TmsCypressTestRuntime_dequeueAllMessages, _TmsCypressTestRuntime_buildAttachmentContent, _TmsCypressTestRuntime_normalizeAttachmentContent, _TmsCypressTestRuntime_isSerializedBuffer, _TmsCypressTestRuntime_isInOriginContext;
+var _TmsCypressTestRuntime_instances, _TmsCypressTestRuntime_resetMessages, _TmsCypressTestRuntime_enqueueMessageAsync, _TmsCypressTestRuntime_dequeueAllMessages, _TmsCypressTestRuntime_buildAttachmentContent, _TmsCypressTestRuntime_normalizeAttachmentContent, _TmsCypressTestRuntime_isSerializedBuffer;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTestRuntime = exports.initTestRuntime = void 0;
-const testit_js_commons_1 = require("testit-js-commons");
 const state_js_1 = require("./state.js");
 const steps_js_1 = require("./steps.js");
 const utils_js_1 = require("./utils.js");
@@ -65,43 +64,43 @@ class TmsCypressTestRuntime {
             },
         });
     }
-    addDescription(markdown) {
+    addDescription(description) {
         return __classPrivateFieldGet(this, _TmsCypressTestRuntime_instances, "m", _TmsCypressTestRuntime_enqueueMessageAsync).call(this, {
             type: "metadata",
             data: {
-                description: markdown,
+                description,
             },
         });
     }
-    addTitle(markdown) {
+    addTitle(title) {
         return __classPrivateFieldGet(this, _TmsCypressTestRuntime_instances, "m", _TmsCypressTestRuntime_enqueueMessageAsync).call(this, {
             type: "metadata",
             data: {
-                title: markdown,
+                title,
             },
         });
     }
-    addDisplayName(name) {
+    addDisplayName(displayName) {
         return __classPrivateFieldGet(this, _TmsCypressTestRuntime_instances, "m", _TmsCypressTestRuntime_enqueueMessageAsync).call(this, {
             type: "metadata",
             data: {
-                displayName: name,
+                displayName,
             },
         });
     }
-    addNameSpace(name) {
+    addNameSpace(namespace) {
         return __classPrivateFieldGet(this, _TmsCypressTestRuntime_instances, "m", _TmsCypressTestRuntime_enqueueMessageAsync).call(this, {
             type: "metadata",
             data: {
-                namespace: name,
+                namespace,
             },
         });
     }
-    addClassName(name) {
+    addClassName(classname) {
         return __classPrivateFieldGet(this, _TmsCypressTestRuntime_instances, "m", _TmsCypressTestRuntime_enqueueMessageAsync).call(this, {
             type: "metadata",
             data: {
-                classname: name,
+                classname,
             },
         });
     }
@@ -153,27 +152,12 @@ class TmsCypressTestRuntime {
             },
         });
     }
-    addMessage(details) {
+    addMessage(message) {
         return __classPrivateFieldGet(this, _TmsCypressTestRuntime_instances, "m", _TmsCypressTestRuntime_enqueueMessageAsync).call(this, {
-            type: "global_error",
-            data: details,
-        });
-    }
-    logStep(name, status = testit_js_commons_1.Status.PASSED, error) {
-        if (__classPrivateFieldGet(this, _TmsCypressTestRuntime_instances, "m", _TmsCypressTestRuntime_isInOriginContext).call(this)) {
-            (0, steps_js_1.startTmsApiStep)(name);
-            (0, steps_js_1.stopCurrentTmsApiStep)(status, error ? (0, utils_js_1.getMessageAndTraceFromError)(error) : undefined);
-            return Cypress.Promise.resolve();
-        }
-        return cy
-            .wrap(steps_js_1.TMS_STEP_CMD_SUBJECT, { log: false })
-            .then(() => {
-            (0, steps_js_1.startTmsApiStep)(name);
-            return Cypress.Promise.resolve();
-        })
-            .then(() => {
-            (0, steps_js_1.stopCurrentTmsApiStep)(status, error ? (0, utils_js_1.getMessageAndTraceFromError)(error) : undefined);
-            return Cypress.Promise.resolve();
+            type: "metadata",
+            data: {
+                message,
+            },
         });
     }
     step(name, body) {
@@ -188,22 +172,6 @@ class TmsCypressTestRuntime {
             return result;
         });
     }
-    stepDisplayName(name) {
-        return __classPrivateFieldGet(this, _TmsCypressTestRuntime_instances, "m", _TmsCypressTestRuntime_enqueueMessageAsync).call(this, {
-            type: "step_metadata",
-            data: {
-                name,
-            },
-        });
-    }
-    stepParameter(name, value) {
-        return __classPrivateFieldGet(this, _TmsCypressTestRuntime_instances, "m", _TmsCypressTestRuntime_enqueueMessageAsync).call(this, {
-            type: "step_metadata",
-            data: {
-                parameters: [{ name, value }],
-            },
-        });
-    }
     flushTmsMessagesToTask(taskName) {
         const messages = __classPrivateFieldGet(this, _TmsCypressTestRuntime_instances, "m", _TmsCypressTestRuntime_dequeueAllMessages).call(this);
         if (messages.length) {
@@ -249,36 +217,4 @@ _TmsCypressTestRuntime_instances = new WeakSet(), _TmsCypressTestRuntime_resetMe
     }
     const candidate = content;
     return candidate.type === "Buffer" && Array.isArray(candidate.data);
-}, _TmsCypressTestRuntime_isInOriginContext = function _TmsCypressTestRuntime_isInOriginContext() {
-    try {
-        const hasOriginContext = !!window.cypressOriginContext;
-        const hasOriginWindow = !!window.cypressOriginWindow;
-        if (hasOriginContext || hasOriginWindow) {
-            return true;
-        }
-        const baseUrl = Cypress.config("baseUrl");
-        const currentOrigin = window.location.origin;
-        if (baseUrl && currentOrigin !== baseUrl) {
-            return true;
-        }
-        const cypressInstance = window.Cypress;
-        if (cypressInstance && cypressInstance.state && cypressInstance.state("origin")) {
-            return true;
-        }
-        try {
-            const cyExists = typeof cy !== "undefined";
-            const cyTaskExists = typeof cy.task !== "undefined";
-            // In cy.origin context, cy.task may not be available or may throw
-            if (!cyExists || !cyTaskExists) {
-                return true;
-            }
-        }
-        catch (error) {
-            return true;
-        }
-        return false;
-    }
-    catch (error) {
-        return true;
-    }
 };

package/dist/browser/types.d.ts

@@ -1,5 +1,4 @@
-import type { StatusDetails } from "../models/types.js";
-import { Label, Link, Status } from "testit-js-commons";
+import { Link } from "testit-js-commons";
 export declare enum ContentType {
     PNG = "image/png",
     MP4 = "video/mp4",
@@ -14,8 +13,8 @@ export interface AttachmentOptions {
     body?: Buffer;
 }
 export interface TestRuntime {
-    addLabels(...labels: Label[]): PromiseLike<void>;
-    addTags(...tags: String[]): PromiseLike<void>;
+    addLabels(...labels: string[]): PromiseLike<void>;
+    addTags(...tags: string[]): PromiseLike<void>;
     addLinks(...links: Link[]): PromiseLike<void>;
     addWorkItemIds(...workItemIds: string[]): PromiseLike<void>;
     addParameter(name: string, value: string): PromiseLike<void>;
@@ -26,10 +25,7 @@ export interface TestRuntime {
     addAttachmentsFromPath(name: string, path: string, options: Omit<AttachmentOptions, "encoding">): PromiseLike<void>;
     addGlobalAttachments(name: string, content: Buffer | string, options: AttachmentOptions): PromiseLike<void>;
     addGlobalAttachmentsFromPath(name: string, path: string, options: Omit<AttachmentOptions, "encoding">): PromiseLike<void>;
-    addMessage(details: StatusDetails): PromiseLike<void>;
-    logStep(name: string, status?: Status, error?: Error): PromiseLike<void>;
+    addMessage(message: string): PromiseLike<void>;
     step<T>(name: string, body: () => T | PromiseLike<T>): PromiseLike<T>;
-    stepDisplayName(name: string): PromiseLike<void>;
-    stepParameter(name: string, value: string): PromiseLike<void>;
 }
 export declare const noopRuntime: TestRuntime;

package/dist/browser/types.js

@@ -23,8 +23,5 @@ exports.noopRuntime = {
     addGlobalAttachments: () => noop,
     addGlobalAttachmentsFromPath: () => noop,
     addMessage: () => noop,
-    logStep: () => noop,
     step: (_, body) => Promise.resolve(body()),
-    stepDisplayName: () => noop,
-    stepParameter: () => noop,
 };

package/dist/converter.d.ts

@@ -1,5 +1,6 @@
 import type { AutotestPost, AutotestResult, Outcome } from "testit-js-commons";
-import { Label, Link } from "testit-js-commons";
+import { Link } from "testit-js-commons";
+import { StatusDetails } from "./models/types";
 export interface StepData {
     id: string;
     name: string;
@@ -13,6 +14,7 @@ export interface StepData {
     };
     attachmentIds: string[];
     children: StepData[];
+    parameters?: Record<string, string>;
 }
 export interface TestData {
     fullNameSuffix: string;
@@ -21,7 +23,7 @@ export interface TestData {
     title?: string;
     namespace?: string;
     classname?: string;
-    labels: Label[];
+    labels: string[];
     tags: string[];
     links: Link[];
     workItemIds: string[];
@@ -29,14 +31,11 @@ export interface TestData {
     stop?: number;
     outcome: Outcome;
     duration?: number;
-    statusDetails?: {
-        message?: string;
-        trace?: string;
-    };
+    statusDetails?: StatusDetails;
+    message?: string;
     steps: StepData[];
     attachmentIds: string[];
     parameters?: Record<string, string>;
-    properties?: Record<string, string>;
     externalKey: string;
 }
 export declare function toAutotestPost(specPath: string, t: TestData): AutotestPost;

package/dist/converter.js

@@ -20,6 +20,8 @@ function stepDataToStep(s) {
         step.duration = s.stop - s.start;
     if (s.statusDetails?.message)
         step.info = s.statusDetails.message;
+    if (s.parameters)
+        step.parameters = s.parameters;
     return step;
 }
 function stepDataToShortStep(s) {
@@ -32,7 +34,6 @@ function toAutotestPost(specPath, t) {
     const fullName = `${specPath}#${t.fullNameSuffix}`;
     const externalId = testit_js_commons_1.Utils.getHash(fullName);
     const name = (t.displayName ?? t.fullNameSuffix).replace(/#/g, " > ");
-    const labels = t.labels?.map((l) => ({ name: l.name })) ?? [];
     return {
         externalId,
         name,
@@ -41,9 +42,9 @@ function toAutotestPost(specPath, t) {
         workItemIds: t.workItemIds,
         namespace: t.namespace,
         classname: t.classname,
-        links: t.links?.length ? t.links : undefined,
-        labels: labels.length ? labels : undefined,
-        tags: t.tags?.length ? t.tags : undefined,
+        links: t.links?.length ? t.links : [],
+        labels: t.labels?.map((l) => ({ name: l })) ?? [],
+        tags: t.tags?.length ? t.tags : [],
         steps: t.steps.map(s => stepDataToShortStep(s)),
         externalKey: t.externalKey,
     };
@@ -73,12 +74,14 @@ function toAutotestResult(externalId, t, outcome, extraAttachmentIds = []) {
     if (t.parameters) {
         result.parameters = t.parameters;
     }
-    if (t.properties) {
-        result.properties = t.properties;
+    if (t.message) {
+        result.message = t.message;
     }
-    if (t.statusDetails?.message)
+    else if (t.statusDetails?.message) {
         result.message = t.statusDetails.message;
-    if (t.statusDetails?.trace)
+    }
+    if (t.statusDetails?.trace) {
         result.traces = t.statusDetails.trace;
+    }
     return result;
 }

package/dist/models/types.d.ts

@@ -106,7 +106,7 @@ export type CypressTestStartMessage = {
         name: string;
         fullNameSuffix: string;
         start: number;
-        labels: Label[];
+        labels: string[];
         tags: string[];
         links: Link[];
         workItemIds: string[];

package/dist/reporter.js

@@ -311,12 +311,11 @@ class TmsCypress {
             if (data.tags?.length) {
                 current.tags.push(...data.tags);
             }
+            if (data.workItemIds?.length) {
+                current.workItemIds.push(...data.workItemIds);
+            }
             if (data.links?.length) {
-                current.links.push(...data.links.map((l) => ({
-                    url: l.url,
-                    title: l.title ?? l.url,
-                    description: l.description,
-                })));
+                current.links.push(...data.links);
             }
             if (data.parameters?.length) {
                 current.parameters ?? (current.parameters = {});
@@ -327,15 +326,24 @@ class TmsCypress {
             if (data.description) {
                 current.description = data.description;
             }
-            else if (data.descriptionHtml && !current.description) {
-                current.description = data.descriptionHtml;
-            }
             if (data.displayName) {
                 current.displayName = data.displayName;
             }
             if (data.title) {
                 current.title = data.title;
             }
+            if (data.message) {
+                current.message = data.message;
+            }
+            if (data.details) {
+                current.statusDetails = data.details;
+            }
+            if (data.namespace) {
+                current.namespace = data.namespace;
+            }
+            if (data.classname) {
+                current.classname = data.classname;
+            }
         });
         const { videoOnFailOnly = false, ...rest } = config;
         this.videoOnFailOnly = videoOnFailOnly;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testit-adapter-cypress",
-  "version": "3.7.6",
+  "version": "3.7.8",
   "description": "Cypress adapter for Test IT",
   "license": "Apache-2.0",
   "author": {
@@ -42,7 +42,7 @@
     "@types/node": "^20.14.2"
   },
   "dependencies": {
-    "testit-js-commons": "3.7.6"
+    "testit-js-commons": "3.7.8"
   },
   "files": [
     "dist"