@testomatio/reporter 2.1.0-beta.1-codeceptjs → 2.1.0-beta.2-codeceptjs

package/lib/client.js

@@ -179,7 +179,7 @@ class Client {
         /**
          * @type {TestData}
          */
-        const { rid, error = null, time = 0, example = null, files = [], filesBuffers = [], steps, code = null, title, file, suite_title, suite_id, test_id, timestamp, manuallyAttachedArtifacts, labels, } = testData;
+        const { rid, error = null, time = 0, example = null, files = [], filesBuffers = [], steps, code = null, title, file, suite_title, suite_id, test_id, timestamp, manuallyAttachedArtifacts, labels, overwrite, } = testData;
         let { message = '', meta = {} } = testData;
         // stringify meta values and limit keys and values length to 255
         meta = Object.entries(meta)
@@ -267,6 +267,7 @@ class Client {
             artifacts,
             meta,
             labels,
+            overwrite,
             ...(rootSuiteId && { root_suite_id: rootSuiteId }),
         };
         // debug('Adding test run...', data);

package/lib/replay.js

@@ -35,7 +35,10 @@ class Replay {
             throw new Error(`Debug file not found: ${debugFile}`);
         }
         const fileContent = fs_1.default.readFileSync(debugFile, 'utf-8');
-        const lines = fileContent.trim().split('\n').filter(line => line.trim() !== '');
+        const lines = fileContent
+            .trim()
+            .split('\n')
+            .filter(line => line.trim() !== '');
         if (lines.length === 0) {
             throw new Error('Debug file is empty');
         }
@@ -79,7 +82,8 @@ class Replay {
                                             // Merge artifacts arrays
                                             mergedTest.artifacts = [...(existingTest.artifacts || []), ...test[key]];
                                         }
-                                        else if (existingTest[key] === null || existingTest[key] === undefined ||
+                                        else if (existingTest[key] === null ||
+                                            existingTest[key] === undefined ||
                                             (Array.isArray(existingTest[key]) && existingTest[key].length === 0)) {
                                             // Use new value if existing is null/undefined/empty array
                                             mergedTest[key] = test[key];
@@ -145,7 +149,7 @@ class Replay {
             envVars,
             parseErrors,
             totalLines: lines.length,
-            runId
+            runId,
         };
     }
     /**
@@ -190,7 +194,7 @@ class Replay {
                 finishParams,
                 envVars,
                 runId,
-                dryRun: true
+                dryRun: true,
             };
         }
         // Create client and restore the run
@@ -213,13 +217,13 @@ class Replay {
         let failureCount = 0;
         for (const [index, test] of tests.entries()) {
             try {
-                await client.addTestRun(test.status, test);
+                await client.addTestRun(test.status, { ...test, overwrite: true });
                 successCount++;
                 this.onProgress({
                     current: index + 1,
                     total: tests.length,
                     test,
-                    success: true
+                    success: true,
                 });
             }
             catch (err) {
@@ -230,7 +234,7 @@ class Replay {
                     total: tests.length,
                     test,
                     success: false,
-                    error: err.message
+                    error: err.message,
                 });
             }
         }
@@ -243,7 +247,7 @@ class Replay {
             runParams,
             finishParams,
             envVars,
-            runId: runId || client.runId
+            runId: runId || client.runId,
         };
         this.onLog(`Successfully replayed ${successCount}/${tests.length} tests from debug file`);
         return result;

package/lib/xmlReader.js

@@ -186,6 +186,7 @@ class XmlReader {
             if (test.file)
                 r.file = test.file;
             r.create = true;
+            r.overwrite = true;
             if (r.status === 'Passed')
                 r.status = constants_js_1.STATUS.PASSED;
             if (r.status === 'Failed')
@@ -254,6 +255,7 @@ class XmlReader {
                         title,
                         suite_title,
                         run_time,
+                        retry: false,
                     });
                 });
             });
@@ -509,6 +511,7 @@ function reduceTestCases(prev, item) {
             root_suite_id: TESTOMATIO_SUITE,
             suite_title: suiteTitle,
             files,
+            retry: false,
         });
     });
     return prev;

package/package.json

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

package/src/adapter/webdriver.js

@@ -14,8 +14,10 @@ class WebdriverReporter extends WDIOReporter {
     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() {
@@ -40,7 +42,6 @@ class WebdriverReporter extends WDIOReporter {
 
   onRunnerStart() {
     // clear dir with artifacts/logs
-    //
     fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
   }
 
@@ -140,3 +141,10 @@ function getTestLogs(fullTestTitle) {
 }
 
 export default 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/src/bin/cli.js

@@ -7,7 +7,7 @@ import createDebugMessages from 'debug';
 import TestomatClient from '../client.js';
 import XmlReader from '../xmlReader.js';
 import { APP_PREFIX, STATUS } from '../constants.js';
-import { getPackageVersion } from '../utils/utils.js';
+import { cleanLatestRunId, getPackageVersion } from '../utils/utils.js';
 import { config } from '../config.js';
 import { readLatestRunId } from '../utils/utils.js';
 import pc from 'picocolors';
@@ -36,6 +36,8 @@ program
   .command('start')
   .description('Start a new run and return its ID')
   .action(async () => {
+    cleanLatestRunId();
+
     console.log('Starting a new Run on Testomat.io...');
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config.TESTOMATIO;
     const client = new TestomatClient({ apiKey });
@@ -70,6 +72,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')
@@ -100,25 +103,25 @@ program
 
     console.log(APP_PREFIX, `🚀 Running`, pc.green(command));
 
-    const runTests = () => {
+    const runTests = async () => {
       const testCmds = command.split(' ');
       const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
 
-      cmd.on('close', code => {
+      cmd.on('close', async code => {
         const emoji = code === 0 ? '🟢' : '🔴';
         console.log(APP_PREFIX, emoji, `Runner exited with ${pc.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();
     }
   });
 

package/src/client.js

@@ -10,7 +10,7 @@ import { glob } from 'glob';
 import path, { sep } from 'path';
 import { fileURLToPath } from 'node:url';
 import { S3Uploader } from './uploader.js';
-import { formatStep, storeRunId, validateSuiteId } from './utils/utils.js';
+import { formatStep, readLatestRunId, storeRunId, validateSuiteId } from './utils/utils.js';
 import { filesize as prettyBytes } from 'filesize';
 
 const debug = createDebugMessages('@testomatio/reporter:client');
@@ -34,7 +34,7 @@ class Client {
   constructor(params = {}) {
     this.paramsForPipesFactory = params;
     this.pipeStore = {};
-    this.runId = 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
@@ -139,6 +139,9 @@ class Client {
    * @returns {Promise<PipeResult[]>}
    */
   async addTestRun(status, testData) {
+    if (!this.pipes || !this.pipes.length)
+      this.pipes = await pipesFactory(this.paramsForPipesFactory || {}, this.pipeStore);
+
     // all pipes disabled, skipping
     if (!this.pipes?.filter(p => p.isEnabled).length) return [];
 
@@ -180,6 +183,7 @@ class Client {
       timestamp,
       manuallyAttachedArtifacts,
       labels,
+      overwrite,
     } = testData;
     let { message = '', meta = {} } = testData;
 
@@ -277,6 +281,7 @@ class Client {
       artifacts,
       meta,
       labels,
+      overwrite,
       ...(rootSuiteId && { root_suite_id: rootSuiteId }),
     };
 
@@ -308,7 +313,10 @@ 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 pipesFactory(this.paramsForPipesFactory || {}, this.pipeStore);
+    this.runId ||= readLatestRunId();
+
     debug('Updating run status...');
     // all pipes disabled, skipping
     if (!this.pipes?.filter(p => p.isEnabled).length) return Promise.resolve();

package/src/pipe/testomatio.js

@@ -3,7 +3,7 @@ import pc from 'picocolors';
 import { Gaxios } from 'gaxios';
 import JsonCycle from 'json-cycle';
 import { APP_PREFIX, STATUS, AXIOS_TIMEOUT, REPORTER_REQUEST_RETRIES } from '../constants.js';
-import { isValidUrl, foundedTestLog } from '../utils/utils.js';
+import { isValidUrl, foundedTestLog, readLatestRunId } from '../utils/utils.js';
 import { parseFilterParams, generateFilterRequestParams, setS3Credentials } from '../utils/pipe_utils.js';
 import { config } from '../config.js';
 
@@ -367,10 +367,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) return;
+
+    this.runId = this.runId || process.env.runId || this.store.runId || readLatestRunId();
+    if (!this.runId) {
+      console.warn(APP_PREFIX, pc.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/src/replay.js

@@ -33,7 +33,10 @@ export class Replay {
     }
 
     const fileContent = fs.readFileSync(debugFile, 'utf-8');
-    const lines = fileContent.trim().split('\n').filter(line => line.trim() !== '');
+    const lines = fileContent
+      .trim()
+      .split('\n')
+      .filter(line => line.trim() !== '');
 
     if (lines.length === 0) {
       throw new Error('Debug file is empty');
@@ -77,8 +80,11 @@ export class Replay {
                     } else if (key === 'artifacts' && Array.isArray(test[key]) && test[key].length > 0) {
                       // Merge artifacts arrays
                       mergedTest.artifacts = [...(existingTest.artifacts || []), ...test[key]];
-                    } else if (existingTest[key] === null || existingTest[key] === undefined || 
-                               (Array.isArray(existingTest[key]) && existingTest[key].length === 0)) {
+                    } else if (
+                      existingTest[key] === null ||
+                      existingTest[key] === undefined ||
+                      (Array.isArray(existingTest[key]) && existingTest[key].length === 0)
+                    ) {
                       // Use new value if existing is null/undefined/empty array
                       mergedTest[key] = test[key];
                     }
@@ -139,7 +145,7 @@ export class Replay {
       envVars,
       parseErrors,
       totalLines: lines.length,
-      runId
+      runId,
     };
   }
 
@@ -193,7 +199,7 @@ export class Replay {
         finishParams,
         envVars,
         runId,
-        dryRun: true
+        dryRun: true,
       };
     }
 
@@ -219,13 +225,13 @@ export class Replay {
 
     for (const [index, test] of tests.entries()) {
       try {
-        await client.addTestRun(test.status, test);
+        await client.addTestRun(test.status, { ...test, overwrite: true });
         successCount++;
         this.onProgress({
           current: index + 1,
           total: tests.length,
           test,
-          success: true
+          success: true,
         });
       } catch (err) {
         failureCount++;
@@ -235,7 +241,7 @@ export class Replay {
           total: tests.length,
           test,
           success: false,
-          error: err.message
+          error: err.message,
         });
       }
     }
@@ -250,7 +256,7 @@ export class Replay {
       runParams,
       finishParams,
       envVars,
-      runId: runId || client.runId
+      runId: runId || client.runId,
     };
 
     this.onLog(`Successfully replayed ${successCount}/${tests.length} tests from debug file`);
@@ -259,4 +265,4 @@ export class Replay {
   }
 }
 
-export default Replay; 
+export default Replay;

package/src/utils/utils.js

@@ -353,20 +353,38 @@ function storeRunId(runId) {
   fs.writeFileSync(filePath, runId);
 }
 
+/**
+ * 
+ * @returns {String|null} latest run ID
+ */
 function readLatestRunId() {
   try {
     const filePath = path.join(os.tmpdir(), `testomatio.latest.run`);
     const stats = fs.statSync(filePath);
     const diff = +new Date() - +stats.mtime;
     const diffHours = diff / 1000 / 60 / 60;
-    if (diffHours > 1) return;
+    if (diffHours > 1) return null;
 
-    return fs.readFileSync(filePath)?.toString()?.trim();
+    return fs.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.join(os.tmpdir(), `testomatio.latest.run`);
+    const runId = readLatestRunId();
+    if (fs.existsSync(filePath)) {
+      fs.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);
 
@@ -393,6 +411,7 @@ export function getPackageVersion() {
 
 export {
   ansiRegExp,
+  cleanLatestRunId,
   isSameTest,
   fetchSourceCode,
   fetchSourceCodeFromStackTrace,

package/src/xmlReader.js

@@ -217,6 +217,7 @@ class XmlReader {
       if (test.example) r.example = test.example;
       if (test.file) r.file = test.file;
       r.create = true;
+      r.overwrite = true;
       if (r.status === 'Passed') r.status = STATUS.PASSED;
       if (r.status === 'Failed') r.status = STATUS.FAILED;
       if (r.status === 'Skipped') r.status = STATUS.SKIPPED;
@@ -293,6 +294,7 @@ class XmlReader {
             title,
             suite_title,
             run_time,
+            retry: false,
           });
         });
       });
@@ -569,6 +571,7 @@ function reduceTestCases(prev, item) {
         root_suite_id: TESTOMATIO_SUITE,
         suite_title: suiteTitle,
         files,
+        retry: false,
       });
     });
   return prev;