@testomatio/reporter 2.7.1 → 2.7.2

package/src/pipe/github.js

@@ -3,9 +3,10 @@ import path from 'path';
 import pc from 'picocolors';
 import humanizeDuration from 'humanize-duration';
 import merge from 'lodash.merge';
-import { APP_PREFIX, testomatLogoURL } from '../constants.js';
+import { testomatLogoURL } from '../constants.js';
 import { ansiRegExp, isSameTest } from '../utils/utils.js';
 import { statusEmoji, fullName } from '../utils/pipe_utils.js';
+import { log } from '../utils/log.js';
 
 const debug = createDebugMessages('@testomatio/reporter:pipe:github');
 
@@ -191,9 +192,9 @@ class GitHubPipe {
       debug('Comment URL:', url);
       this.store.githubUrl = url;
 
-      console.log(APP_PREFIX, pc.yellow('GitHub'), `Report created: ${pc.magenta(url)}`);
+      log.info(pc.yellow('GitHub'), `Report created: ${pc.magenta(url)}`);
     } catch (err) {
-      console.log(APP_PREFIX, pc.yellow('GitHub'), `Couldn't create GitHub report ${err}`);
+      log.info(pc.yellow('GitHub'), `Couldn't create GitHub report ${err}`);
     }
   }
 

package/src/pipe/gitlab.js

@@ -7,6 +7,7 @@ import path from 'path';
 import { APP_PREFIX, testomatLogoURL } from '../constants.js';
 import { ansiRegExp, isSameTest } from '../utils/utils.js';
 import { statusEmoji, fullName } from '../utils/pipe_utils.js';
+import { log } from '../utils/log.js';
 
 const debug = createDebugMessages('@testomatio/reporter:pipe:gitlab');
 
@@ -183,7 +184,7 @@ class GitLabPipe {
       // eslint-disable-next-line max-len
       const commentURL = `${this.ENV.CI_PROJECT_URL}/-/merge_requests/${this.ENV.CI_MERGE_REQUEST_IID}#note_${commentID}`;
 
-      console.log(APP_PREFIX, pc.yellow('GitLab'), `Report created: ${pc.magenta(commentURL)}`);
+      log.info(pc.yellow('GitLab'), `Report created: ${pc.magenta(commentURL)}`);
     } catch (err) {
       console.error(
         APP_PREFIX,

package/src/pipe/index.js

@@ -1,7 +1,6 @@
 import fs from 'fs';
 import path from 'path';
 import pc from 'picocolors';
-import { APP_PREFIX } from '../constants.js';
 import TestomatioPipe from './testomatio.js';
 import GitHubPipe from './github.js';
 import GitLabPipe from './gitlab.js';
@@ -10,6 +9,7 @@ import HtmlPipe from './html.js';
 import CoveragePipe from './coverage.js';
 import { BitbucketPipe } from './bitbucket.js';
 import { DebugPipe } from './debug.js';
+import { log } from '../utils/log.js';
 
 export async function pipesFactory(params, opts) {
   const extraPipes = [];
@@ -29,14 +29,14 @@ export async function pipesFactory(params, opts) {
       try {
         PipeClass = await import(pipeDef);
       } catch (err) {
-        console.log(APP_PREFIX, `Can't load module Testomatio pipe module from ${pipeDef}`);
+        log.info(`Can't load module Testomatio pipe module from ${pipeDef}`);
         continue;
       }
 
       try {
         extraPipes.push(new PipeClass(params, opts));
       } catch (err) {
-        console.log(APP_PREFIX, `Can't instantiate Testomatio for ${pipeDef}`, err);
+        log.info(`Can't instantiate Testomatio for ${pipeDef}`, err);
         continue;
       }
     }
@@ -56,15 +56,13 @@ export async function pipesFactory(params, opts) {
 
   const pipesEnabled = pipes.filter(p => p.isEnabled);
 
-  console.log(
-    APP_PREFIX,
+  log.info(
     pc.cyan('Pipes:'),
     pc.cyan(pipesEnabled.map(p => p.toString()).join(', ') || 'No pipes enabled'),
   );
 
   if (!pipesEnabled.length) {
-    console.log(
-      APP_PREFIX,
+    log.info(
       pc.dim('If you want to use Testomatio reporter, pass your token as TESTOMATIO env variable'),
     );
   }

package/src/pipe/testomatio.js

@@ -12,6 +12,7 @@ import {
 } from '../utils/utils.js';
 import { parseFilterParams, generateFilterRequestParams, setS3Credentials } from '../utils/pipe_utils.js';
 import { config } from '../config.js';
+import { log } from '../utils/log.js';
 
 const debug = createDebugMessages('@testomatio/reporter:pipe:testomatio');
 
@@ -65,10 +66,12 @@ class TestomatioPipe {
       const sha = getGitCommitSha();
       if (sha) {
         this.title = `Shared Run - ${sha}`;
-        console.log(APP_PREFIX, `🔄 Auto-generated title for shared run: ${this.title}`);
+        log.info(`🔄 Auto-generated title for shared run: ${this.title}`);
       } else {
-        console.log(APP_PREFIX, pc.red('Failed to resolve git commit SHA for shared run title.'));
-        console.log(APP_PREFIX, 'Please run the tests inside a Git repository or set TESTOMATIO_TITLE explicitly.');
+        log.warn(
+          pc.red('Failed to resolve git commit SHA for shared run title.'),
+          'Please run the tests inside a Git repository or set TESTOMATIO_TITLE explicitly.',
+        );
       }
     }
     this.groupTitle = params.groupTitle || process.env.TESTOMATIO_RUNGROUP_TITLE;
@@ -106,7 +109,7 @@ class TestomatioPipe {
 
     if (!isValidUrl(this.url.trim())) {
       this.isEnabled = false;
-      console.error(APP_PREFIX, pc.red(`Error creating report on Testomat.io, report url '${this.url}' is invalid`));
+      log.error(pc.red(`Error creating report on Testomat.io, report url '${this.url}' is invalid`));
     }
   }
 
@@ -117,7 +120,7 @@ class TestomatioPipe {
    */
   #formatData(data) {
     data.api_key = this.apiKey;
-    data.create = this.createNewTests;
+    if (data.create === undefined) data.create = this.createNewTests;
 
     // add test ID + run ID
     if (data.rid) data.rid = `${this.runId}-${data.rid}`;
@@ -177,9 +180,9 @@ class TestomatioPipe {
         return resp.data.tests;
       }
 
-      console.log(APP_PREFIX, `⛔  No tests found for your --filter --> ${type}=${id}`);
+      log.warn(`⛔  No tests found for your --filter --> ${type}=${id}`);
     } catch (err) {
-      console.error(APP_PREFIX, `🚩 Error getting Testomat.io test grepList: ${err}`);
+      log.error(`🚩 Error getting Testomat.io test grepList: ${err}`);
     }
   }
 
@@ -262,8 +265,8 @@ class TestomatioPipe {
         this.runPublicUrl = resp.data.public_url;
         this.store.runUrl = this.runUrl;
         this.store.runPublicUrl = this.runPublicUrl;
-        console.log(APP_PREFIX, '📊 Using existing run. Report ID:', this.runId);
-        console.log(APP_PREFIX, '📊 Report URL:', pc.magenta(this.runUrl));
+        log.info('📊 Using existing run. Report ID:', this.runId);
+        log.info('📊 Report URL:', pc.magenta(this.runUrl));
       }
       return;
     }
@@ -287,7 +290,7 @@ class TestomatioPipe {
       this.store.runUrl = this.runUrl;
       this.store.runPublicUrl = this.runPublicUrl;
       this.store.runId = this.runId;
-      console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId);
+      log.info('📊 Report created. Report ID:', this.runId);
       process.env.runId = this.runId;
       debug('Run created', this.runId);
     } catch (err) {
@@ -355,7 +358,7 @@ class TestomatioPipe {
           this.#logFailedResponse(err);
           printCreateIssue();
         } else {
-          console.log(APP_PREFIX, pc.blue(data?.title || ''), "Report couldn't be processed", err);
+          log.info(pc.blue(data?.title || ''), "Report couldn't be processed", err);
         }
       });
   };
@@ -406,7 +409,7 @@ class TestomatioPipe {
           this.#logFailedResponse(err);
           printCreateIssue();
         } else {
-          console.log(APP_PREFIX, "Report couldn't be processed", err);
+          log.info("Report couldn't be processed", err);
         }
       });
   };
@@ -420,7 +423,7 @@ class TestomatioPipe {
 
     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'));
+      log.warn(pc.red('Run ID is not set, skipping test reporting'));
       return;
     }
 
@@ -495,21 +498,21 @@ class TestomatioPipe {
         });
 
         if (this.runUrl) {
-          console.log(APP_PREFIX, '📊 Report Saved. Report URL:', pc.magenta(this.runUrl));
+          log.warn('📊 Report URL:', pc.magenta(this.runUrl));
         }
         if (this.runPublicUrl) {
-          console.log(APP_PREFIX, '🌟 Public URL:', pc.magenta(this.runPublicUrl));
+          log.info('🌟 Public URL:', pc.magenta(this.runPublicUrl));
         }
       }
       if (this.runUrl && this.proceed) {
         const notFinishedMessage = pc.yellow(pc.bold('Run was not finished because of $TESTOMATIO_PROCEED'));
-        console.log(APP_PREFIX, `📊 ${notFinishedMessage}. Report URL: ${pc.magenta(this.runUrl)}`);
-        console.log(APP_PREFIX, `🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx @testomatio/reporter finish`);
+        log.warn(`📊 ${notFinishedMessage}. Report URL: ${pc.magenta(this.runUrl)}`);
+        log.warn(`🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx @testomatio/reporter finish`);
       }
 
       if (this.hasUnmatchedTests) {
         console.log('');
-        console.log(APP_PREFIX, pc.yellow(pc.bold('⚠️ Some reported tests were not found in Testomat.io project')));
+        log.warn(pc.yellow(pc.bold('⚠️ Some reported tests were not found in Testomat.io project')));
         console.log(
           APP_PREFIX,
           `If you use Testomat.io as a reporter only, please re-run tests using ${pc.bold('TESTOMATIO_CREATE=1')}`,
@@ -518,14 +521,18 @@ class TestomatioPipe {
           APP_PREFIX,
           `But to keep your tests consistent it is recommended to ${pc.bold('import tests first')}`,
         );
-        console.log(APP_PREFIX, 'If tests were imported but still not matched, assign test IDs to your tests.');
-        console.log(APP_PREFIX, 'You can do that automatically via command line tools:');
-        console.log(APP_PREFIX, pc.bold('npx check-tests ... --update-ids'), 'See: https://bit.ly/js-update-ids');
-        console.log(APP_PREFIX, 'or for Cucumber:');
-        console.log(APP_PREFIX, pc.bold('npx check-cucumber ... --update-ids'), 'See: https://bit.ly/bdd-update-ids');
+        log.info(
+          'If tests were imported but still not matched, assign test IDs to your tests.',
+          'You can do that automatically via command line tools:',
+          pc.bold('npx check-tests ... --update-ids'),
+          'See: https://bit.ly/js-update-ids',
+          'or for Cucumber:',
+          pc.bold('npx check-cucumber ... --update-ids'),
+          'See: https://bit.ly/bdd-update-ids',
+        );
       }
     } catch (err) {
-      console.log(APP_PREFIX, 'Error updating status, skipping...', err);
+      log.info('Error updating status, skipping...', err);
       if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG) this.#logFailedResponse(err);
       printCreateIssue();
     }
@@ -541,7 +548,7 @@ class TestomatioPipe {
       clearInterval(this.batch.intervalFunction);
       this.batch.intervalFunction = null;
       this.batch.isEnabled = false;
-    }              
+    }
     this.batch.tests = [];
   }
 

package/src/uploader.js

@@ -8,6 +8,7 @@ import promiseRetry from 'promise-retry';
 import pc from 'picocolors';
 import { APP_PREFIX } from './constants.js';
 import { filesize as prettyBytes } from 'filesize';
+import { log } from './utils/log.js';
 
 const debug = createDebugMessages('@testomatio/reporter:file-uploader');
 
@@ -133,7 +134,7 @@ export class S3Uploader {
     } catch (e) {
       this.failedUploads.push({ path: file.path, size: file.size });
       debug('S3 uploading error:', e);
-      console.log(APP_PREFIX, 'Upload failed:', e.message, '\nConfig:\n', this.getMaskedConfig());
+      log.info('Upload failed:', e.message, '\nConfig:\n', this.getMaskedConfig());
     }
   }
 
@@ -160,7 +161,7 @@ export class S3Uploader {
     const diffHours = diff / 1000 / 60 / 60;
     debug('Diff hours:', diffHours);
     if (diffHours > 3) {
-      console.log(APP_PREFIX, "Artifacts file is too old, can't process artifacts. Please re-run the tests.");
+      log.info("Artifacts file is too old, can't process artifacts. Please re-run the tests.");
       return [];
     }
 

package/src/utils/log.js

@@ -0,0 +1,87 @@
+import { APP_PREFIX } from '../constants.js';
+
+/**
+ * Log levels for the Testomat.io reporter.
+ * A message is logged if its level is <= the current log level.
+ * @example
+ * TESTOMATIO_LOG_LEVEL=ERROR npx codeceptjs run  // Only errors
+ * TESTOMATIO_LOG_LEVEL=WARN npx codeceptjs run   // Warnings and errors
+ * TESTOMATIO_LOG_LEVEL=INFO npx codeceptjs run   // Info, warnings, errors (default)
+ */
+export const LOG_LEVELS = {
+  ERROR: 0,
+  WARN: 1,
+  INFO: 2,
+};
+
+/**
+ * Get the current log level from TESTOMATIO_LOG_LEVEL environment variable.
+ * Defaults to INFO (info, warn, and error messages).
+ * @returns {number} Numeric log level (0-2)
+ */
+export function getLogLevel() {
+  const envLevel = process.env.TESTOMATIO_LOG_LEVEL?.toUpperCase();
+  return LOG_LEVELS[envLevel] ?? LOG_LEVELS.INFO;
+}
+
+/**
+ * Check if a message should be logged based on its level.
+ * A message is logged if its level is <= the current log level,
+ * or if TESTOMATIO_DEBUG is set (for debugging with the debug package).
+ * @param {number} messageLevel - Message level (LOG_LEVELS value)
+ * @returns {boolean} True if the message should be logged
+ */
+export function shouldLog(messageLevel) {
+  return messageLevel <= getLogLevel() || !!process.env.TESTOMATIO_DEBUG;
+}
+
+/**
+ * Log an info message with [TESTOMATIO] prefix.
+ * Only logs when TESTOMATIO_LOG_LEVEL is INFO.
+ * @param {...any} args - Arguments to log
+ */
+export function info(...args) {
+  if (shouldLog(LOG_LEVELS.INFO)) {
+    console.log(APP_PREFIX, ...args);
+  }
+}
+
+/**
+ * Log a warning message with [TESTOMATIO] prefix.
+ * Only logs when TESTOMATIO_LOG_LEVEL is WARN or INFO.
+ * @param {...any} args - Arguments to log
+ */
+export function warn(...args) {
+  if (shouldLog(LOG_LEVELS.WARN)) {
+    console.warn(APP_PREFIX, ...args);
+  }
+}
+
+/**
+ * Log an error message with [TESTOMATIO] prefix.
+ * Logs for all TESTOMATIO_LOG_LEVEL values.
+ * @param {...any} args - Arguments to log
+ */
+export function error(...args) {
+  if (shouldLog(LOG_LEVELS.ERROR)) {
+    console.error(APP_PREFIX, ...args);
+  }
+}
+
+/**
+ * Logging utility for Testomat.io reporter.
+ * All messages are prefixed with [TESTOMATIO] and respect TESTOMATIO_LOG_LEVEL.
+ * @example
+ * import { log } from './utils/log.js';
+ * log.info('Test started');
+ * log.warn('This is a warning');
+ * log.error('Something went wrong');
+ */
+export const log = {
+  info,
+  warn,
+  error,
+  getLogLevel,
+  shouldLog,
+  LOG_LEVELS,
+};

package/src/utils/pipe_utils.js

@@ -1,4 +1,4 @@
-import { APP_PREFIX } from '../constants.js';
+import { log } from './log.js';
 
 /**
  * Set S3 credentials from the provided artifacts object.
@@ -7,7 +7,7 @@ import { APP_PREFIX } from '../constants.js';
 function setS3Credentials(artifacts) {
   if (!Object.keys(artifacts).length) return;
 
-  console.log(APP_PREFIX, 'S3 credentials obtained from Testomat.io...');
+  log.info( 'S3 credentials obtained from Testomat.io...');
 
   if (artifacts.ACCESS_KEY_ID) process.env.S3_ACCESS_KEY_ID = artifacts.ACCESS_KEY_ID;
   if (artifacts.SECRET_ACCESS_KEY) process.env.S3_SECRET_ACCESS_KEY = artifacts.SECRET_ACCESS_KEY;
@@ -28,7 +28,7 @@ function setS3Credentials(artifacts) {
 function generateFilterRequestParams(params) {
   // Defensive check: ensure params is an object
   if (!params || typeof params !== 'object') {
-    console.error(APP_PREFIX, `Invalid parameters provided. Expected an object, got: ${typeof params}`);
+    log.error( `Invalid parameters provided. Expected an object, got: ${typeof params}`);
     return;
   }
 
@@ -39,7 +39,7 @@ function generateFilterRequestParams(params) {
   }
 
   if (!id) {
-    console.error(APP_PREFIX, `Please make sure your settings "${type.toUpperCase()}"= "${id}" is correct!`);
+    log.error( `Please make sure your settings "${type.toUpperCase()}"= "${id}" is correct!`);
     return;
   }
 
@@ -99,7 +99,7 @@ function updateFilterType(type) {
   ];
 
   if (!filterTypes.includes(typeLowerCase)) {
-    console.log(APP_PREFIX, `❗❗❗ Invalid filter: "${type}" start settings! Available option list: ${filterTypes}`);
+    log.error( `❗ Invalid filter: "${type}" start settings! Available option list: ${filterTypes}`);
     return;
   }
 

package/src/utils/utils.js

@@ -92,6 +92,19 @@ const isValidUrl = s => {
   }
 };
 
+/**
+ * Checks whether a value is an HTTP(S) URL.
+ *
+ * Used for artifact handling: if a step artifact is already a remote URL,
+ * it should not be uploaded again as a local file path.
+ *
+ * @param {*} value - Artifact value to validate
+ * @returns {boolean} true when value starts with http:// or https://
+ */
+const isHttpUrl = value => {
+  return /^https?:\/\//i.test(String(value || ''));
+};
+
 const fileMatchRegex = /file:(\/*)([A-Za-z]:[\\/].*?|\/.*?)\.(png|avi|webm|jpg|html|txt)/gi;
 
 const fetchFilesFromStackTrace = (stack = '', checkExists = true) => {
@@ -705,6 +718,7 @@ export {
   getGitCommitSha,
   getTestomatIdFromTestTitle,
   humanize,
+  isHttpUrl,
   isValidUrl,
   parseSuite,
   readLatestRunId,

package/src/xmlReader.js

@@ -21,6 +21,7 @@ import { pipesFactory } from './pipe/index.js';
 import adapterFactory from './junit-adapter/index.js';
 import { config } from './config.js';
 import { S3Uploader } from './uploader.js';
+import { log } from './utils/log.js';
 
 // @ts-ignore this line will be removed in compiled code, because __dirname is defined in commonjs
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -86,7 +87,7 @@ class XmlReader {
     // @ts-ignore
     const packageJsonPath = path.resolve(__dirname, '..', 'package.json');
     this.version = JSON.parse(fs.readFileSync(packageJsonPath).toString()).version;
-    console.log(APP_PREFIX, `Testomatio Reporter v${this.version}`);
+    log.info(`Testomatio Reporter v${this.version}`);
   }
 
   connectAdapter() {
@@ -508,7 +509,7 @@ class XmlReader {
 
       const runId = this.runId || this.store.runId || Date.now().toString();
       test.artifacts = await Promise.all(files.map(f => this.uploader.uploadFileByPath(f, [runId, path.basename(f)])));
-      console.log(APP_PREFIX, `🗄️ Uploaded ${pc.bold(`${files.length} artifacts`)} for test ${test.title}`);
+      log.info(`🗄️ Uploaded ${pc.bold(`${files.length} artifacts`)} for test ${test.title}`);
     }
   }
 
@@ -626,9 +627,9 @@ class XmlReader {
     }
 
     if (totalChunks > 1) {
-      console.log(APP_PREFIX, `✅ Successfully uploaded ${uploadedTests} tests in ${totalChunks} chunks`);
+      log.info(`✅ Successfully uploaded ${uploadedTests} tests in ${totalChunks} chunks`);
     } else {
-      console.log(APP_PREFIX, `✅ Successfully uploaded ${uploadedTests} tests`);
+      log.info(`✅ Successfully uploaded ${uploadedTests} tests`);
     }
 
     const finishData = {

package/types/types.d.ts

@@ -317,6 +317,9 @@ interface Step {
   duration: number;
   steps?: Step[];
   error?: any;
+  status?: string;
+  log?: string;
+  artifacts?: string[];
 }
 
 declare global {