@testomatio/reporter 2.1.0-beta.2-codeceptjs → 2.1.0-beta.3-filter-plan

package/lib/adapter/webdriver.js

@@ -48,8 +48,9 @@ class WebdriverReporter extends reporter_1.default {
         options = Object.assign(options, { stdout: true });
         this._addTestPromises = [];
         this._isSynchronising = false;
-        // NOTE: new functionality; may break everything
-        this.client.createRun();
+        // run is created by cli, if enabling the row below, it mat lead to multiple runs being created
+        // thus, need to check if process.env.runId is set and/or add more checks to avoid creating multiple runs
+        // this.client.createRun();
     }
     get isSynchronised() {
         return this._isSynchronising === false;
@@ -68,7 +69,6 @@ class WebdriverReporter extends reporter_1.default {
     }
     onRunnerStart() {
         // clear dir with artifacts/logs
-        //
         utils_js_1.fileSystem.clearDir(constants_js_1.TESTOMAT_TMP_STORAGE_DIR);
     }
     onTestStart(test) {
@@ -153,3 +153,9 @@ function getTestLogs(fullTestTitle) {
     return logs;
 }
 module.exports = WebdriverReporter;
+/* INVESTIGATION RESULTS:
+  If you run tests in parallel, the WDIO creates a separate process for each parallel instance.
+  As a result, there is own WDIOReporter instance for each parallel process.
+  This means, its impossible to create or finish run, because can't understand if its was already created
+  in other process or not.
+*/

package/lib/bin/cli.js

@@ -38,6 +38,7 @@ program
     .command('start')
     .description('Start a new run and return its ID')
     .action(async () => {
+    (0, utils_js_1.cleanLatestRunId)();
     console.log('Starting a new Run on Testomat.io...');
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
     const client = new client_js_1.default({ apiKey });
@@ -66,6 +67,7 @@ program
 });
 program
     .command('run')
+    .alias('test')
     .description('Run tests with the specified command')
     .argument('<command>', 'Test runner command')
     .option('--filter <filter>', 'Additional execution filter')
@@ -91,24 +93,24 @@ program
         }
     }
     console.log(constants_js_1.APP_PREFIX, `🚀 Running`, picocolors_1.default.green(command));
-    const runTests = () => {
+    const runTests = async () => {
         const testCmds = command.split(' ');
         const cmd = (0, cross_spawn_1.spawn)(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
-        cmd.on('close', code => {
+        cmd.on('close', async (code) => {
             const emoji = code === 0 ? '🟢' : '🔴';
             console.log(constants_js_1.APP_PREFIX, emoji, `Runner exited with ${picocolors_1.default.bold(code)}`);
             if (apiKey) {
                 const status = code === 0 ? 'passed' : 'failed';
-                client.updateRunStatus(status, true);
+                await client.updateRunStatus(status, true);
             }
             process.exit(code);
         });
     };
     if (apiKey) {
-        client.createRun().then(runTests);
+        await client.createRun().then(runTests);
     }
     else {
-        runTests();
+        await runTests();
     }
 });
 // program

package/lib/client.d.ts

@@ -13,7 +13,7 @@ export class Client {
     constructor(params?: {});
     paramsForPipesFactory: {};
     pipeStore: {};
-    runId: `${string}-${string}-${string}-${string}-${string}`;
+    runId: string;
     queue: Promise<void>;
     version: any;
     executionList: Promise<void>;

package/lib/client.js

@@ -68,7 +68,7 @@ class Client {
     constructor(params = {}) {
         this.paramsForPipesFactory = params;
         this.pipeStore = {};
-        this.runId = (0, crypto_1.randomUUID)(); // will be replaced by real run id
+        this.runId = '';
         this.queue = Promise.resolve();
         // @ts-ignore this line will be removed in compiled code, because __dirname is defined in commonjs
         const pathToPackageJSON = path_1.default.join(__dirname, '../package.json');
@@ -158,6 +158,8 @@ class Client {
      * @returns {Promise<PipeResult[]>}
      */
     async addTestRun(status, testData) {
+        if (!this.pipes || !this.pipes.length)
+            this.pipes = await (0, index_js_1.pipesFactory)(this.paramsForPipesFactory || {}, this.pipeStore);
         // all pipes disabled, skipping
         if (!this.pipes?.filter(p => p.isEnabled).length)
             return [];
@@ -292,7 +294,9 @@ class Client {
      * @param {boolean} [isParallel] - Whether the current test run was executed in parallel with other tests.
      * @returns {Promise<any>} - A Promise that resolves when finishes the run.
      */
-    updateRunStatus(status, isParallel = false) {
+    async updateRunStatus(status, isParallel = false) {
+        this.pipes ||= await (0, index_js_1.pipesFactory)(this.paramsForPipesFactory || {}, this.pipeStore);
+        this.runId ||= (0, utils_js_1.readLatestRunId)();
         debug('Updating run status...');
         // all pipes disabled, skipping
         if (!this.pipes?.filter(p => p.isEnabled).length)

package/lib/pipe/testomatio.js

@@ -113,7 +113,8 @@ class TestomatioPipe {
             const resp = await this.client.request({
                 method: 'GET',
                 url: '/api/test_grep',
-                params: q
+                params: q.params,
+                responseType: q.responseType
             });
             if (Array.isArray(resp.data?.tests) && resp.data?.tests?.length > 0) {
                 (0, utils_js_1.foundedTestLog)(constants_js_1.APP_PREFIX, resp.data.tests);
@@ -331,11 +332,14 @@ class TestomatioPipe {
      * Adds a test to the batch uploader (or reports a single test if batch uploading is disabled)
      */
     addTest(data) {
-        this.isEnabled = this.apiKey ?? this.isEnabled;
+        this.isEnabled = !!(this.apiKey ?? this.isEnabled);
         if (!this.isEnabled)
             return;
-        if (!this.runId)
+        this.runId = this.runId || process.env.runId || this.store.runId || (0, utils_js_1.readLatestRunId)();
+        if (!this.runId) {
+            console.warn(constants_js_1.APP_PREFIX, picocolors_1.default.red('Run ID is not set, skipping test reporting'));
             return;
+        }
         // add test ID + run ID
         if (data.rid)
             data.rid = `${this.runId}-${data.rid}`;

package/lib/utils/utils.d.ts

@@ -2,6 +2,7 @@ export function getPackageVersion(): any;
 export const TEST_ID_REGEX: RegExp;
 export const SUITE_ID_REGEX: RegExp;
 export function ansiRegExp(): RegExp;
+export function cleanLatestRunId(): void;
 export function isSameTest(test: any, t: any): boolean;
 export function fetchSourceCode(contents: any, opts?: {}): string;
 export function fetchSourceCodeFromStackTrace(stack?: string): string;
@@ -29,7 +30,11 @@ export function isValidUrl(s: any): boolean;
  * @returns {String|null} suiteId
  */
 export function parseSuite(suiteTitle: string): string | null;
-export function readLatestRunId(): string;
+/**
+ *
+ * @returns {String|null} latest run ID
+ */
+export function readLatestRunId(): string | null;
 /**
  * Used to remove color codes
  * @param {*} input

package/lib/utils/utils.js

@@ -38,6 +38,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateSuiteId = exports.testRunnerHelper = exports.specificTestInfo = exports.parseSuite = exports.isValidUrl = exports.humanize = exports.getTestomatIdFromTestTitle = exports.getCurrentDateTime = exports.foundedTestLog = exports.fileSystem = exports.fetchFilesFromStackTrace = exports.fetchIdFromOutput = exports.fetchIdFromCode = exports.fetchSourceCodeFromStackTrace = exports.fetchSourceCode = exports.isSameTest = exports.ansiRegExp = exports.SUITE_ID_REGEX = exports.TEST_ID_REGEX = void 0;
 exports.getPackageVersion = getPackageVersion;
+exports.cleanLatestRunId = cleanLatestRunId;
 exports.formatStep = formatStep;
 exports.readLatestRunId = readLatestRunId;
 exports.removeColorCodes = removeColorCodes;
@@ -391,6 +392,10 @@ function storeRunId(runId) {
     const filePath = path_1.default.join(os_1.default.tmpdir(), `testomatio.latest.run`);
     fs_1.default.writeFileSync(filePath, runId);
 }
+/**
+ *
+ * @returns {String|null} latest run ID
+ */
 function readLatestRunId() {
     try {
         const filePath = path_1.default.join(os_1.default.tmpdir(), `testomatio.latest.run`);
@@ -398,13 +403,27 @@ function readLatestRunId() {
         const diff = +new Date() - +stats.mtime;
         const diffHours = diff / 1000 / 60 / 60;
         if (diffHours > 1)
-            return;
-        return fs_1.default.readFileSync(filePath)?.toString()?.trim();
+            return null;
+        return fs_1.default.readFileSync(filePath)?.toString()?.trim() ?? null;
     }
     catch (e) {
+        console.warn('Could not read latest run ID from file: ', e);
         return null;
     }
 }
+function cleanLatestRunId() {
+    try {
+        const filePath = path_1.default.join(os_1.default.tmpdir(), `testomatio.latest.run`);
+        const runId = readLatestRunId();
+        if (fs_1.default.existsSync(filePath)) {
+            fs_1.default.unlinkSync(filePath);
+        }
+        debug(`Cleaned latest run ID (${runId}) file`, filePath);
+    }
+    catch (e) {
+        console.warn('Could not clean latest run ID file: ', e);
+    }
+}
 function formatStep(step, shift = 0) {
     const prefix = ' '.repeat(shift);
     const lines = [];
@@ -427,6 +446,8 @@ function getPackageVersion() {
 
 module.exports.getPackageVersion = getPackageVersion;
 
+module.exports.cleanLatestRunId = cleanLatestRunId;
+
 module.exports.formatStep = formatStep;
 
 module.exports.readLatestRunId = readLatestRunId;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.1.0-beta.2-codeceptjs",
+  "version": "2.1.0-beta.3-filter-plan",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"