@testomatio/reporter 2.0.1-beta-ignore-xml → 2.1.0-beta-nightwatch

package/lib/adapter/nightwatch.d.ts

@@ -0,0 +1,4 @@
+declare namespace _default {
+    function write(results: any, options: any, done: any): Promise<void>;
+}
+export default _default;

package/lib/adapter/nightwatch.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_js_1 = __importDefault(require("../client.js"));
+const config_js_1 = require("../config.js");
+const constants_1 = require("../constants");
+const utils_js_1 = require("../utils/utils.js");
+const apiKey = config_js_1.config.TESTOMATIO;
+const client = new client_js_1.default({ apiKey });
+module.exports = {
+    write: async (results, options, done) => {
+        await client.createRun();
+        const testFiles = results.modules;
+        for (const fileName in testFiles) {
+            // in nightwatch: object containing tests from a single file
+            const testModule = testFiles[fileName];
+            // passed and failed tests (tests with assertions)
+            const completedTests = testModule.completed;
+            // skipped tests (skipped by user or tests without assertions)
+            const skippedTests = testModule.skipped;
+            const tags = testModule.tags || [];
+            // if test file contains multiple suites, the last suite name is used as a name 🤷‍♂️
+            // no other places which contain suite name (even inside test object)
+            const suiteTitle = testModule.name;
+            for (const testTitle in completedTests) {
+                const test = completedTests[testTitle];
+                let status;
+                switch (test.status) {
+                    case 'pass':
+                        status = constants_1.STATUS.PASSED;
+                        break;
+                    case 'fail':
+                        status = constants_1.STATUS.FAILED;
+                        break;
+                    // probably not required (because skipped tests are in separate array), but just in case
+                    case 'skip':
+                        status = constants_1.STATUS.SKIPPED;
+                        console.info('Skipped test is in completed tests array:', test, 'Not expected behavior.');
+                        break;
+                    default:
+                        console.error('Test status processing error:', test.status);
+                }
+                const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(testTitle);
+                client.addTestRun(status, {
+                    error: { name: test.assertions?.[0]?.name, message: test.assertions?.[0]?.message, stack: test.stackTrace },
+                    file: testModule.modulePath?.replace(process.cwd(), ''),
+                    message: test.assertions?.[0]?.message,
+                    rid: `${testModule.uuid || ''}_${testTitle || ''}`,
+                    stack: test.stackTrace,
+                    suite_title: suiteTitle,
+                    tags,
+                    test_id: testId,
+                    time: test.timeMs,
+                    title: testTitle,
+                });
+            }
+            // just array with skipped tests titles, no any other info
+            for (const testTitle of skippedTests) {
+                client.addTestRun(constants_1.STATUS.SKIPPED, {
+                    suite_title: suiteTitle,
+                    tags,
+                    rid: `${testModule.uuid || ''}_${testTitle || ''}`,
+                    title: testTitle,
+                });
+            }
+        }
+        /**
+         * @type {'passed' | 'failed' | 'finished'}
+         */
+        let runStatus = 'finished';
+        if (results.failed)
+            runStatus = 'failed';
+        else if (results.passed)
+            runStatus = 'passed';
+        await client.updateRunStatus(runStatus);
+        done();
+    },
+};

package/lib/client.js

@@ -98,7 +98,7 @@ class Client {
         }
         try {
             const filterPipe = this.pipes.find(p => p.constructor.name.toLowerCase() === `${pipe.toLowerCase()}pipe`);
-            if (!filterPipe.isEnabled) {
+            if (!filterPipe?.isEnabled) {
                 // TODO:for the future for the another pipes
                 console.warn(constants_js_1.APP_PREFIX, `At the moment processing is available only for the "testomatio" key. Example: "testomatio:tag-name=xxx"`);
                 return;

package/lib/config.js

@@ -9,10 +9,10 @@ const debug_1 = __importDefault(require("debug"));
 const debug = (0, debug_1.default)('@testomatio/reporter:config');
 /* for possibility to use multiple env files (reading different paths)
 const envFileVars = dotenv.config({ path: '.env' }).parsed; */
-if (process.env.TESTOMATIO_API_KEY) {
+if (process.env.TESTOMATIO_API_KEY && !process.env.TESTOMATIO) {
     process.env.TESTOMATIO = process.env.TESTOMATIO_API_KEY;
 }
-if (process.env.TESTOMATIO_TOKEN) {
+if (process.env.TESTOMATIO_TOKEN && !process.env.TESTOMATIO) {
     process.env.TESTOMATIO = process.env.TESTOMATIO_TOKEN;
 }
 if (process.env.TESTOMATIO === 'undefined')

package/lib/pipe/html.d.ts

@@ -15,6 +15,7 @@ declare class HtmlPipe {
     templateFolderPath: string;
     templateHtmlPath: string;
     createRun(): Promise<void>;
+    prepareRun(): Promise<void>;
     updateRun(): void;
     /**
      * Add test data to the result array for saving. As a result of this function, we get a result object to save.

package/lib/pipe/html.js

@@ -53,6 +53,7 @@ class HtmlPipe {
     async createRun() {
         // empty
     }
+    async prepareRun() { }
     updateRun() {
         // empty
     }

package/lib/pipe/testomatio.d.ts

@@ -31,7 +31,7 @@ declare class TestomatioPipe implements Pipe {
     groupTitle: any;
     env: string;
     label: string;
-    axios: any;
+    axios: import("axios").AxiosInstance;
     proceed: string;
     jiraId: string;
     runId: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.0.1-beta-ignore-xml",
+  "version": "2.1.0-beta-nightwatch",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"
@@ -123,6 +123,7 @@
     "./lib/adapter/mocha/mocha.js": "./lib/adapter/mocha.js",
     "./mocha": "./lib/adapter/mocha.js",
     "./lib/adapter/playwright.js": "./lib/adapter/playwright.js",
+    "./nightwatch": "./lib/adapter/nightwatch.js",
     "./playwright": "./lib/adapter/playwright.js",
     "./vitest": "./lib/adapter/vitest.js",
     "./lib/adapter/webdriver.js": "./lib/adapter/webdriver.js",

package/src/adapter/nightwatch.js

@@ -0,0 +1,88 @@
+import TestomatClient from '../client.js';
+import { config } from '../config.js';
+import { STATUS } from '../constants';
+import { getTestomatIdFromTestTitle } from '../utils/utils.js';
+
+const apiKey = config.TESTOMATIO;
+const client = new TestomatClient({ apiKey });
+
+export default {
+  write: async (results, options, done) => {
+    await client.createRun();
+
+    const testFiles = results.modules;
+
+    for (const fileName in testFiles) {
+      // in nightwatch: object containing tests from a single file
+      const testModule = testFiles[fileName];
+
+      // passed and failed tests (tests with assertions)
+      const completedTests = testModule.completed;
+
+      // skipped tests (skipped by user or tests without assertions)
+      const skippedTests = testModule.skipped;
+
+      const tags = testModule.tags || [];
+
+      // if test file contains multiple suites, the last suite name is used as a name 🤷‍♂️
+      // no other places which contain suite name (even inside test object)
+      const suiteTitle = testModule.name;
+
+      for (const testTitle in completedTests) {
+        const test = completedTests[testTitle];
+        let status;
+        switch (test.status) {
+          case 'pass':
+            status = STATUS.PASSED;
+            break;
+          case 'fail':
+            status = STATUS.FAILED;
+            break;
+          // probably not required (because skipped tests are in separate array), but just in case
+          case 'skip':
+            status = STATUS.SKIPPED;
+            console.info('Skipped test is in completed tests array:', test, 'Not expected behavior.');
+            break;
+          default:
+            console.error('Test status processing error:', test.status);
+        }
+
+        const testId = getTestomatIdFromTestTitle(testTitle);
+
+        client.addTestRun(status, {
+          error: { name: test.assertions?.[0]?.name, message: test.assertions?.[0]?.message, stack: test.stackTrace },
+          file: testModule.modulePath?.replace(process.cwd(), ''),
+          message: test.assertions?.[0]?.message,
+          rid: `${testModule.uuid || ''}_${testTitle || ''}`,
+          stack: test.stackTrace,
+          suite_title: suiteTitle,
+          tags,
+          test_id: testId,
+          time: test.timeMs,
+          title: testTitle,
+        });
+      }
+
+      // just array with skipped tests titles, no any other info
+      for (const testTitle of skippedTests) {
+        client.addTestRun(STATUS.SKIPPED, {
+          suite_title: suiteTitle,
+          tags,
+          rid: `${testModule.uuid || ''}_${testTitle || ''}`,
+          title: testTitle,
+        });
+      }
+    }
+
+    /**
+     * @type {'passed' | 'failed' | 'finished'}
+     */
+    let runStatus = 'finished';
+    if (results.failed) runStatus = 'failed';
+    else if (results.passed) runStatus = 'passed';
+
+    await client.updateRunStatus(runStatus);
+
+    done();
+  },
+};

package/src/client.js

@@ -79,7 +79,7 @@ class Client {
     try {
       const filterPipe = this.pipes.find(p => p.constructor.name.toLowerCase() === `${pipe.toLowerCase()}pipe`);
 
-      if (!filterPipe.isEnabled) {
+      if (!filterPipe?.isEnabled) {
         // TODO:for the future for the another pipes
         console.warn(
           APP_PREFIX,

package/src/config.js

@@ -6,10 +6,10 @@ const debug = createDebugMessages('@testomatio/reporter:config');
 /* for possibility to use multiple env files (reading different paths)
 const envFileVars = dotenv.config({ path: '.env' }).parsed; */
 
-if (process.env.TESTOMATIO_API_KEY) {
+if (process.env.TESTOMATIO_API_KEY && !process.env.TESTOMATIO) {
   process.env.TESTOMATIO = process.env.TESTOMATIO_API_KEY;
 }
-if (process.env.TESTOMATIO_TOKEN) {
+if (process.env.TESTOMATIO_TOKEN && !process.env.TESTOMATIO) {
   process.env.TESTOMATIO = process.env.TESTOMATIO_TOKEN;
 }
 

package/src/pipe/html.js

@@ -66,6 +66,8 @@ class HtmlPipe {
     // empty
   }
 
+  async prepareRun() {}
+
   updateRun() {
     // empty
   }

package/src/xmlReader.js

@@ -226,7 +226,7 @@ class XmlReader {
 
     return {
       status,
-      create_tests: !process.env.IGNORE_NEW_TESTS,
+      create_tests: true,
       tests_count: parseInt(counters.total, 10),
       passed_count: parseInt(counters.passed, 10),
       skipped_count: parseInt(counters.notExecuted, 10),