testit-adapter-cypress 4.0.4 → 4.1.0

package/README.md

@@ -12,6 +12,10 @@ npm install testit-adapter-cypress
 
 ### Configuration
 
+#### Log level
+
+The adapter includes a custom logger; the default level is `warn`. Set another level at runtime with the `LOG_LEVEL` environment variable: `error`, `warn`, `info`, or `debug`.
+
 | Description                                                                                                                                                                                                                                                                                                                                                                            | File property                     | Environment variable                       |
 |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|--------------------------------------------|
 | Location of the TMS instance                                                                                                                                                                                                                                                                                                                                                           | url                               | TMS_URL                                    |
@@ -24,6 +28,7 @@ npm install testit-adapter-cypress
 | It enables/disables certificate validation (**It's optional**). Default value - true                                                                                                                                                                                                                                                                                                   | certValidation                    | TMS_CERT_VALIDATION                        |
 | Mode of automatic creation test cases (**It's optional**). Default value - false. The adapter supports following modes:<br/>true - in this mode, the adapter will create a test case linked to the created autotest (not to the updated autotest)<br/>false - in this mode, the adapter will not create a test case                                                                    | automaticCreationTestCases        | TMS_AUTOMATIC_CREATION_TEST_CASES          |
 | Mode of automatic updation links to test cases (**It's optional**). Default value - false. The adapter supports following modes:<br/>true - in this mode, the adapter will update links to test cases<br/>false - in this mode, the adapter will not update link to test cases                                                                                                         | automaticUpdationLinksToTestCases | TMS_AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES |
+| Logger level, default value is `warn`, available values: [`error`, `warn`, `info`, `debug`] | | LOG_LEVEL |
 
 Add Adapter to Cypress file configuration:
 

package/dist/browser/lifecycle.js

@@ -7,6 +7,7 @@ const state_js_1 = require("./state.js");
 const steps_js_1 = require("./steps.js");
 const utils_js_1 = require("./utils.js");
 const status_js_1 = require("../models/status.js");
+const testit_js_commons_1 = require("testit-js-commons");
 const reportRunStart = () => {
     (0, state_js_1.enqueueRuntimeMessage)({
         type: "cypress_run_start",
@@ -219,9 +220,9 @@ const logTmsRootAfterError = (context, err) => {
     // We play safe and swallow errors here to keep the original 'after all' error.
     try {
         // eslint-disable-next-line no-console
-        console.error(`Unexpected error when reporting the failure of ${context.test?.title ?? "'after all'"}`);
+        testit_js_commons_1.logger.error(`Unexpected error when reporting the failure of ${context.test?.title ?? "'after all'"}`);
         // eslint-disable-next-line no-console
-        console.error(err);
+        testit_js_commons_1.logger.error(err);
     }
     catch { }
 };

package/dist/reporter.d.ts

@@ -13,6 +13,7 @@ export declare class TmsCypress {
     #private;
     private strategy;
     private additions;
+    private readonly importRealtime;
     specContextByAbsolutePath: Map<string, TestItSpecContext>;
     videoOnFailOnly: boolean;
     constructor(config?: TmsCypressConfig);

package/dist/reporter.js

@@ -37,7 +37,7 @@ 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 _TmsCypress_endAllSpecs, _TmsCypress_applySpecMessages, _TmsCypress_startRun, _TmsCypress_startSuite, _TmsCypress_stopSuite, _TmsCypress_startHook, _TmsCypress_stopHook, _TmsCypress_startTest, _TmsCypress_passTest, _TmsCypress_failTest, _TmsCypress_skipTest, _TmsCypress_addSkippedTest, _TmsCypress_stopTest, _TmsCypress_startStep, _TmsCypress_stopStep, _TmsCypress_finalizeStep, _TmsCypress_handleAttachmentPath, _TmsCypress_handleAttachmentContent, _TmsCypress_applyRuntimeMessage;
+var _TmsCypress_endAllSpecs, _TmsCypress_applySpecMessages, _TmsCypress_startRun, _TmsCypress_startSuite, _TmsCypress_stopSuite, _TmsCypress_startHook, _TmsCypress_stopHook, _TmsCypress_startTest, _TmsCypress_passTest, _TmsCypress_failTest, _TmsCypress_skipTest, _TmsCypress_addSkippedTest, _TmsCypress_stopTest, _TmsCypress_sendTestResult, _TmsCypress_startStep, _TmsCypress_stopStep, _TmsCypress_finalizeStep, _TmsCypress_handleAttachmentPath, _TmsCypress_handleAttachmentContent, _TmsCypress_applyRuntimeMessage;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tmsCypress = exports.TmsCypress = void 0;
 const fs = __importStar(require("fs"));
@@ -109,6 +109,10 @@ class TmsCypress {
             const context = this.specContextByAbsolutePath.get(specAbsolutePath);
             if (!context)
                 return;
+            if (this.importRealtime) {
+                this.specContextByAbsolutePath.delete(specAbsolutePath);
+                return;
+            }
             let videoAttachmentIds = [];
             if ((!this.videoOnFailOnly || context.failed) && cypressVideoPath) {
                 try {
@@ -175,10 +179,10 @@ class TmsCypress {
                         __classPrivateFieldGet(this, _TmsCypress_skipTest, "f").call(this, context, message.data);
                         break;
                     case "cypress_skipped_test":
-                        __classPrivateFieldGet(this, _TmsCypress_addSkippedTest, "f").call(this, context, message.data);
+                        await __classPrivateFieldGet(this, _TmsCypress_addSkippedTest, "f").call(this, context, message.data);
                         break;
                     case "cypress_test_end":
-                        __classPrivateFieldGet(this, _TmsCypress_stopTest, "f").call(this, context, message.data);
+                        await __classPrivateFieldGet(this, _TmsCypress_stopTest, "f").call(this, context, message.data);
                         break;
                     case "cypress_step_start":
                         __classPrivateFieldGet(this, _TmsCypress_startStep, "f").call(this, context, message.data);
@@ -265,7 +269,7 @@ class TmsCypress {
                     context.currentTestData.statusDetails = data.statusDetails;
             }
         });
-        _TmsCypress_addSkippedTest.set(this, (context, data) => {
+        _TmsCypress_addSkippedTest.set(this, async (context, data) => {
             const alreadyAdded = context.completedTests.some((c) => c.fullNameSuffix === data.fullNameSuffix) ||
                 (context.currentTestData?.fullNameSuffix === data.fullNameSuffix);
             if (alreadyAdded)
@@ -284,9 +288,13 @@ class TmsCypress {
                 attachmentIds: [],
                 externalKey: data.fullNameSuffix,
             };
+            if (this.importRealtime) {
+                await __classPrivateFieldGet(this, _TmsCypress_sendTestResult, "f").call(this, context.specPath, t);
+                return;
+            }
             context.completedTests.push(t);
         });
-        _TmsCypress_stopTest.set(this, (context, data) => {
+        _TmsCypress_stopTest.set(this, async (context, data) => {
             var _a;
             if (context.currentTestData) {
                 context.currentTestData.duration = data.duration;
@@ -294,12 +302,29 @@ class TmsCypress {
                     context.currentTestData.stop = context.currentTestData.start + data.duration;
                 }
                 (_a = context.currentTestData).outcome ?? (_a.outcome = status_js_1.Status.PASSED);
-                context.completedTests.push(context.currentTestData);
+                if (this.importRealtime) {
+                    await __classPrivateFieldGet(this, _TmsCypress_sendTestResult, "f").call(this, context.specPath, context.currentTestData);
+                }
+                else {
+                    context.completedTests.push(context.currentTestData);
+                }
                 context.currentTestData = null;
             }
             context.stepStack = [];
             context.stepsByFrontEndId.clear();
         });
+        _TmsCypress_sendTestResult.set(this, async (specPath, testData, extraAttachmentIds = []) => {
+            const posixSpecPath = specPath.replace(/\\/g, "/");
+            const autotest = (0, converter_js_1.toAutotestPost)(posixSpecPath, testData);
+            testit_js_commons_1.logger.debug("[cypress] sendTestResult", {
+                externalId: autotest.externalId,
+                outcome: testData.outcome,
+                steps: testData.steps?.length ?? 0,
+            });
+            await this.strategy.loadAutotest(autotest, testData.outcome);
+            const result = (0, converter_js_1.toAutotestResult)(autotest.externalId, testData, testData.outcome, extraAttachmentIds);
+            await this.strategy.loadTestRun([result]);
+        });
         _TmsCypress_startStep.set(this, (context, data) => {
             const step = {
                 id: data.id,
@@ -422,12 +447,14 @@ class TmsCypress {
         this.videoOnFailOnly = videoOnFailOnly;
         const adapterConfig = rest.tmsOptions ?? rest;
         const composed = new testit_js_commons_1.ConfigComposer().compose(adapterConfig);
+        this.importRealtime = Boolean(composed.importRealtime);
         this.strategy = testit_js_commons_1.StrategyFactory.create(composed);
         this.additions = new testit_js_commons_1.Additions(composed);
+        testit_js_commons_1.logger.debug("[cypress] reporter init", { importRealtime: this.importRealtime });
     }
 }
 exports.TmsCypress = TmsCypress;
-_TmsCypress_endAllSpecs = new WeakMap(), _TmsCypress_applySpecMessages = new WeakMap(), _TmsCypress_startRun = new WeakMap(), _TmsCypress_startSuite = new WeakMap(), _TmsCypress_stopSuite = new WeakMap(), _TmsCypress_startHook = new WeakMap(), _TmsCypress_stopHook = new WeakMap(), _TmsCypress_startTest = new WeakMap(), _TmsCypress_passTest = new WeakMap(), _TmsCypress_failTest = new WeakMap(), _TmsCypress_skipTest = new WeakMap(), _TmsCypress_addSkippedTest = new WeakMap(), _TmsCypress_stopTest = new WeakMap(), _TmsCypress_startStep = new WeakMap(), _TmsCypress_stopStep = new WeakMap(), _TmsCypress_finalizeStep = new WeakMap(), _TmsCypress_handleAttachmentPath = new WeakMap(), _TmsCypress_handleAttachmentContent = new WeakMap(), _TmsCypress_applyRuntimeMessage = new WeakMap();
+_TmsCypress_endAllSpecs = new WeakMap(), _TmsCypress_applySpecMessages = new WeakMap(), _TmsCypress_startRun = new WeakMap(), _TmsCypress_startSuite = new WeakMap(), _TmsCypress_stopSuite = new WeakMap(), _TmsCypress_startHook = new WeakMap(), _TmsCypress_stopHook = new WeakMap(), _TmsCypress_startTest = new WeakMap(), _TmsCypress_passTest = new WeakMap(), _TmsCypress_failTest = new WeakMap(), _TmsCypress_skipTest = new WeakMap(), _TmsCypress_addSkippedTest = new WeakMap(), _TmsCypress_stopTest = new WeakMap(), _TmsCypress_sendTestResult = new WeakMap(), _TmsCypress_startStep = new WeakMap(), _TmsCypress_stopStep = new WeakMap(), _TmsCypress_finalizeStep = new WeakMap(), _TmsCypress_handleAttachmentPath = new WeakMap(), _TmsCypress_handleAttachmentContent = new WeakMap(), _TmsCypress_applyRuntimeMessage = new WeakMap();
 const getRuntimeConfigDefaults = (config = {}) => ({
     stepsFromCommands: {
         maxArgumentLength: config.stepsFromCommands?.maxArgumentLength ?? utils_js_1.DEFAULT_RUNTIME_CONFIG.stepsFromCommands.maxArgumentLength,

package/package.json

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