@testomatio/reporter 2.7.0 → 2.7.2-beta.1

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 {