testit-adapter-codecept 5.0.9-TMS-5.8 → 5.1.0

package/README.md

@@ -140,12 +140,14 @@ $ npx codeceptjs run --grep "$(cat tmp/filter.txt)"
 Methods can be used to specify information about autotest.
 
 Description of metadata methods:
-- `workItemIds` - a method that links autotests with manual tests. Receives the array of manual tests' IDs
+- `workItemId` - a method that links an autotest with a manual test. Receives a single globalId
+- `workItemIds` - deprecated, use `workItemId` instead
 - `displayName` - internal autotest name (used in Test IT)
 - `externalId` - unique internal autotest ID (used in Test IT)
 - `title` - autotest name specified in the autotest card. If not specified, the name from the displayName method is used
 - `description` - autotest description specified in the autotest card
 - `labels` - labels listed in the autotest card
+- `layer` - test pyramid layer in the autotest card (source **Run**). Use `TestLayers` from `testit-js-commons` for recommended values, or any custom string
 - `tags` - tags listed in the autotest card
 - `link` - links listed in the autotest card
 - `namespace` - directory in the TMS system
@@ -170,6 +172,7 @@ Scenario(
     title: 'Title',
     description: 'Description',
     labels: ['Custom label'],
+    layer: 'API',
     links: [
       {
         title: 'Google about this error',
@@ -179,7 +182,7 @@ Scenario(
         hasInfo: true
       }
     ],
-    workItemIds: ['1140']
+    workItemId: '1140'
   },
   ({ I }) => {
     I.amOnPage('https://github.com');

package/build/bootstrap.js

@@ -3,13 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const codeceptjs_1 = require("codeceptjs");
 const testit_js_commons_1 = require("testit-js-commons");
 const builders_1 = require("./builders");
-module.exports = async function (options) {
+module.exports = async function () {
     const config = new testit_js_commons_1.ConfigComposer().compose();
     const strategy = testit_js_commons_1.StrategyFactory.create(config);
     const helper = codeceptjs_1.container.helpers("TestITHelper");
     await strategy.setup();
+    let finalized = false;
+    const finalize = async () => {
+        if (finalized) {
+            return;
+        }
+        finalized = true;
+        await strategy.teardown();
+    };
     codeceptjs_1.event.dispatcher.on(codeceptjs_1.event.test.finished, (test) => {
         codeceptjs_1.recorder.add("transferTestAndRuns", async () => {
+            // Keep sync-storage LastStatus fresh; otherwise Force Work X fires after ~60s of in_progress.
+            await strategy.touchWorker();
             const autotest = builders_1.TestsBuilder.build(test);
             await strategy.loadAutotest(autotest, test.state);
             const result = await new builders_1.ResultBuilder(config).build(test, helper.metadata);
@@ -17,7 +27,20 @@ module.exports = async function (options) {
             helper.metadata = {};
         });
     });
+    // Single-process `codeceptjs run` — workers.after never fires.
+    codeceptjs_1.event.dispatcher.on(codeceptjs_1.event.all.result, () => {
+        if (process.env.RUNS_WITH_WORKERS) {
+            return;
+        }
+        codeceptjs_1.recorder.add("testitTeardown", async () => {
+            await finalize();
+        });
+    });
+    // Parallel `codeceptjs run-workers`.
+    codeceptjs_1.event.dispatcher.on(codeceptjs_1.event.workers.result, async () => {
+        await finalize();
+    });
     codeceptjs_1.event.dispatcher.on(codeceptjs_1.event.workers.after, async () => {
-        await strategy.teardown();
+        await finalize();
     });
 };

package/build/builders/result.builder.js

@@ -10,7 +10,7 @@ class ResultBuilder {
         this.additions = new testit_js_commons_1.Additions(config);
     }
     async build(test, metadata) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _a, _b, _c, _d, _e, _f, _g;
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
         const { _beforeEach, _afterEach, _afterAll, _beforeAll } = test.parent;
@@ -24,7 +24,7 @@ class ResultBuilder {
             ...this.reduceAfterOrBeforeSuites(_beforeAll),
         ];
         let traces = typeof ((_e = test === null || test === void 0 ? void 0 : test.err) === null || _e === void 0 ? void 0 : _e.cliMessage) === "function" ? test.err.cliMessage() : (_f = test === null || test === void 0 ? void 0 : test.err) === null || _f === void 0 ? void 0 : _f.stack;
-        let message = (_g = metadata === null || metadata === void 0 ? void 0 : metadata.message) !== null && _g !== void 0 ? _g : null;
+        let message = metadata === null || metadata === void 0 ? void 0 : metadata.message;
         // If TMS_IS_CI env is true, trim traces and message to 20 chars and log this
         if (process.env.TMS_IS_CI === "true") {
             if (typeof traces === "string" && traces.length > 20) {
@@ -37,17 +37,17 @@ class ResultBuilder {
             }
         }
         return {
-            autoTestExternalId: (_h = (0, utils_1.useDefaultHash)(test)) !== null && _h !== void 0 ? _h : (0, utils_1.useCompositeHash)(test),
+            autoTestExternalId: (_g = (0, utils_1.useDefaultHash)(test)) !== null && _g !== void 0 ? _g : (0, utils_1.useCompositeHash)(test),
             links: metadata === null || metadata === void 0 ? void 0 : metadata.links,
             startedOn: new Date(test.startedAt),
             duration: test.duration,
             attachments: await this.loadAttachments(test, metadata),
-            parameters,
+            parameters: Object.keys(parameters).length > 0 ? parameters : undefined,
             traces: traces,
             teardownResults,
             setupResults,
             completedOn: test.duration ? new Date(test.startedAt + test.duration) : undefined,
-            message: message,
+            message,
             outcome: test.state === "passed" ? "Passed" : "Failed",
             stepResults: this.buildManySteps(test.steps),
         };

package/build/builders/test.builder.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TestsBuilder = void 0;
 const utils_1 = require("../common/utils");
+const testit_js_commons_1 = require("testit-js-commons");
 class TestsBuilder {
     static build(test) {
         var _a, _b, _c, _d, _e, _f;
@@ -15,6 +16,7 @@ class TestsBuilder {
             title: config === null || config === void 0 ? void 0 : config.title,
             name: (_a = config === null || config === void 0 ? void 0 : config.displayName) !== null && _a !== void 0 ? _a : test.title,
             labels: ((_b = config === null || config === void 0 ? void 0 : config.labels) !== null && _b !== void 0 ? _b : []).map((label) => ({ name: label })),
+            layer: config === null || config === void 0 ? void 0 : config.layer,
             tags: (_c = config === null || config === void 0 ? void 0 : config.tags) !== null && _c !== void 0 ? _c : [],
             description: (_d = config === null || config === void 0 ? void 0 : config.description) !== null && _d !== void 0 ? _d : "",
             steps: this.buildManySteps(test.steps),
@@ -24,6 +26,7 @@ class TestsBuilder {
             externalId: (_f = (0, utils_1.useDefaultHash)(test)) !== null && _f !== void 0 ? _f : (0, utils_1.useCompositeHash)(test),
             namespace: config === null || config === void 0 ? void 0 : config.nameSpace,
             classname: config === null || config === void 0 ? void 0 : config.className,
+            workItemIds: resolveWorkItemIds(config),
             externalKey: test.title,
         };
     }
@@ -38,3 +41,13 @@ class TestsBuilder {
     }
 }
 exports.TestsBuilder = TestsBuilder;
+function resolveWorkItemIds(config) {
+    var _a;
+    if ((_a = config === null || config === void 0 ? void 0 : config.workItemIds) === null || _a === void 0 ? void 0 : _a.length) {
+        testit_js_commons_1.logger.warn("workItemIds is deprecated. Use workItemId with a single globalId instead.");
+    }
+    if (config === null || config === void 0 ? void 0 : config.workItemId) {
+        return [config.workItemId];
+    }
+    return config === null || config === void 0 ? void 0 : config.workItemIds;
+}

package/build/types/origin.type.d.ts

@@ -7,8 +7,13 @@ export declare namespace Origin {
         externalId?: string;
         links: Link[];
         labels?: string[];
+        layer?: string;
         tags?: string[];
-        workItemIds?: [];
+        workItemId?: string;
+        /**
+         * @deprecated Use workItemId with a single globalId instead.
+         */
+        workItemIds?: string[];
         classname?: string;
         namespace?: string;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testit-adapter-codecept",
-  "version": "5.0.9-TMS-5.8",
+  "version": "5.1.0",
   "description": "Codecept adapter for Test IT",
   "keywords": [],
   "author": {
@@ -15,7 +15,7 @@
     "watch": "tsc -p tsconfig.json -w"
   },
   "dependencies": {
-    "testit-js-commons": "5.0.9-TMS-5.8"
+    "testit-js-commons": "5.1.0"
   },
   "devDependencies": {
     "@codeceptjs/configure": "^0.10.0",