@testomatio/reporter 2.3.8 → 2.3.9

package/src/pipe/testomatio.js

@@ -60,8 +60,8 @@ class TestomatioPipe {
       retryConfig: {
         retry: REPORTER_REQUEST_RETRIES.retriesPerRequest,
         retryDelay: REPORTER_REQUEST_RETRIES.retryTimeout,
-        httpMethodsToRetry: ['GET','PUT','HEAD','OPTIONS','DELETE','POST'],
-        shouldRetry: (error) => {
+        httpMethodsToRetry: ['GET', 'PUT', 'HEAD', 'OPTIONS', 'DELETE', 'POST'],
+        shouldRetry: error => {
           if (!error.response) return false;
           switch (error.response?.status) {
             case 400: // Bad request (probably wrong API key)
@@ -73,8 +73,8 @@ class TestomatioPipe {
               break;
           }
           return error.response?.status >= 401; // Retry on 401+ and 5xx
-        }
-      }
+        },
+      },
     });
 
     this.isEnabled = true;
@@ -104,7 +104,6 @@ class TestomatioPipe {
     // add test ID + run ID
     if (data.rid) data.rid = `${this.runId}-${data.rid}`;
 
-
     if (!process.env.TESTOMATIO_STACK_PASSED && data.status === STATUS.PASSED) {
       data.stack = null;
     }
@@ -120,7 +119,6 @@ class TestomatioPipe {
     return data;
   }
 
-
   /**
    * Asynchronously prepares and retrieves the Testomat.io test grepList based on the provided options.
    * @param {Object} opts - The options for preparing the test grepList.
@@ -216,7 +214,7 @@ class TestomatioPipe {
         method: 'PUT',
         url: `/api/reporter/${this.runId}`,
         data: runParams,
-        responseType: 'json'
+        responseType: 'json',
       });
       if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
       return;
@@ -229,7 +227,7 @@ class TestomatioPipe {
         url: '/api/reporter',
         data: runParams,
         maxContentLength: Infinity,
-        responseType: 'json'
+        responseType: 'json',
       });
 
       this.runId = resp.data.uid;
@@ -288,44 +286,44 @@ class TestomatioPipe {
 
     debug('Adding test', json);
 
-    return this.client.request({
-      method: 'POST',
-      url: `/api/reporter/${this.runId}/testrun`,
-      data: json,
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      maxContentLength: Infinity
-    }).catch(err => {
-      this.requestFailures++;
-      this.notReportedTestsCount++;
-      if (err.response) {
-        if (err.response.status >= 400) {
-          const responseData = err.response.data || { message: '' };
+    return this.client
+      .request({
+        method: 'POST',
+        url: `/api/reporter/${this.runId}/testrun`,
+        data: json,
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        maxContentLength: Infinity,
+      })
+      .catch(err => {
+        this.requestFailures++;
+        this.notReportedTestsCount++;
+        if (err.response) {
+          if (err.response.status >= 400) {
+            const responseData = err.response.data || { message: '' };
+            console.log(
+              APP_PREFIX,
+              pc.yellow(`Warning: ${responseData.message} (${err.response.status})`),
+              pc.gray(data?.title || ''),
+            );
+            if (err.response?.data?.message?.includes('could not be matched')) {
+              this.hasUnmatchedTests = true;
+            }
+            return;
+          }
           console.log(
             APP_PREFIX,
-            pc.yellow(`Warning: ${responseData.message} (${err.response.status})`),
-            pc.gray(data?.title || ''),
+            pc.yellow(`Warning: ${data?.title || ''} (${err.response?.status})`),
+            `Report couldn't be processed: ${err?.response?.data?.message}`,
           );
-          if (err.response?.data?.message?.includes('could not be matched')) {
-            this.hasUnmatchedTests = true;
-          }
-          return;
+          printCreateIssue(err);
+        } else {
+          console.log(APP_PREFIX, pc.blue(data?.title || ''), "Report couldn't be processed", err);
         }
-        console.log(
-          APP_PREFIX,
-          pc.yellow(`Warning: ${data?.title || ''} (${err.response?.status})`),
-          `Report couldn't be processed: ${err?.response?.data?.message}`,
-        );
-        printCreateIssue(err);
-      } else {
-        console.log(APP_PREFIX, pc.blue(data?.title || ''), "Report couldn't be processed", err);
-      }
-    });
+      });
   };
 
-
-
   /**
    * Uploads tests as a batch (multiple tests at once). Intended to be used with a setInterval
    */
@@ -350,43 +348,42 @@ class TestomatioPipe {
     const testsToSend = this.batch.tests.splice(0);
     debug('📨 Batch upload', testsToSend.length, 'tests');
 
-    return this.client.request({
-      method: 'POST',
-      url: `/api/reporter/${this.runId}/testrun`,
-      data: {
-        api_key: this.apiKey,
-        tests: testsToSend,
-        batch_index: this.batch.batchIndex
-      },
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      maxContentLength: Infinity
-    }).catch(err => {
-      this.requestFailures++;
-      this.notReportedTestsCount += testsToSend.length;
-      if (err.response) {
-        if (err.response.status >= 400) {
-          const responseData = err.response.data || { message: '' };
+    return this.client
+      .request({
+        method: 'POST',
+        url: `/api/reporter/${this.runId}/testrun`,
+        data: {
+          api_key: this.apiKey,
+          tests: testsToSend,
+          batch_index: this.batch.batchIndex,
+        },
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        maxContentLength: Infinity,
+      })
+      .catch(err => {
+        this.requestFailures++;
+        this.notReportedTestsCount += testsToSend.length;
+        if (err.response) {
+          if (err.response.status >= 400) {
+            const responseData = err.response.data || { message: '' };
+            console.log(APP_PREFIX, pc.yellow(`Warning: ${responseData.message} (${err.response.status})`));
+            if (err.response?.data?.message?.includes('could not be matched')) {
+              this.hasUnmatchedTests = true;
+            }
+            return;
+          }
           console.log(
             APP_PREFIX,
-            pc.yellow(`Warning: ${responseData.message} (${err.response.status})`),
+            pc.yellow(`Warning: (${err.response?.status})`),
+            `Report couldn't be processed: ${err?.response?.data?.message}`,
           );
-          if (err.response?.data?.message?.includes('could not be matched')) {
-            this.hasUnmatchedTests = true;
-          }
-          return;
+          printCreateIssue(err);
+        } else {
+          console.log(APP_PREFIX, "Report couldn't be processed", err);
         }
-        console.log(
-          APP_PREFIX,
-          pc.yellow(`Warning: (${err.response?.status})`),
-          `Report couldn't be processed: ${err?.response?.data?.message}`,
-        );
-        printCreateIssue(err);
-      } else {
-        console.log(APP_PREFIX, "Report couldn't be processed", err);
-      }
-    });
+      });
   };
 
   /**
@@ -409,9 +406,9 @@ class TestomatioPipe {
     else this.batch.tests.push(data);
 
     // if test is added after run which is already finished
-     if (!this.batch.intervalFunction) uploading = this.#batchUpload();
+    if (!this.batch.intervalFunction) uploading = this.#batchUpload();
 
-     // return promise to be able to wait for it
+    // return promise to be able to wait for it
     return uploading;
   }
 
@@ -460,7 +457,7 @@ class TestomatioPipe {
             status_event,
             detach: params.detach,
             tests: params.tests,
-          }
+          },
         });
 
         if (this.runUrl) {
@@ -526,9 +523,6 @@ function printCreateIssue(err) {
     console.log({ body: body?.replace(/"(tstmt_[^"]+)"/g, 'tstmt_*'), url, baseURL, method, time });
     console.log('```');
   });
-
 }
 
-
-
 export default TestomatioPipe;

package/src/reporter-functions.js

@@ -62,9 +62,8 @@ function setLabel(key, value = null) {
   if (Array.isArray(value)) {
     return value.forEach(label => setLabel(key, label));
   }
-  const labelObject = value !== null && value !== undefined && value !== ''
-    ? { label: `${key}:${value}` }
-    : { label: key };
+  const labelObject =
+    value !== null && value !== undefined && value !== '' ? { label: `${key}:${value}` } : { label: key };
   services.links.put([labelObject]);
 }
 

package/src/reporter.js

@@ -1,5 +1,5 @@
 import Client from './client.js';
-import * as TestomatioConstants   from './constants.js';
+import * as TestomatioConstants from './constants.js';
 import { services } from './services/index.js';
 import reporterFunctions from './reporter-functions.js';
 
@@ -39,5 +39,4 @@ export default {
 
   TestomatioClient: Client,
   STATUS,
-
 };

package/src/services/links.js

@@ -66,4 +66,4 @@ class LinkStorage {
   }
 }
 
-export const linkStorage = LinkStorage.getInstance();
+export const linkStorage = LinkStorage.getInstance();

package/src/utils/log-formatter.js

@@ -0,0 +1,113 @@
+import createCallsiteRecord from 'callsite-record';
+import { minimatch } from 'minimatch';
+import pc from 'picocolors';
+import { stripVTControlCharacters } from 'util';
+import { sep } from 'path';
+import { formatStep, truncate } from './utils.js';
+
+const stripColors = stripVTControlCharacters || (str => str?.replace(/\x1b\[[0-9;]*m/g, '') || '');
+
+/**
+ * Returns the formatted stack including the stack trace, steps, and logs.
+ * @param {Object} params - Parameters for formatting logs
+ * @param {string} params.error - Error message
+ * @param {Array|any} params.steps - Test steps (array or other types)
+ * @param {string} params.logs - Test logs
+ * @returns {string}
+ */
+export function formatLogs({ error, steps, logs }) {
+  error = error?.trim();
+  logs = logs
+    ?.trim()
+    .split('\n')
+    .map(l => truncate(l))
+    .join('\n');
+
+  if (Array.isArray(steps)) {
+    steps = steps
+      .map(step => formatStep(step))
+      .flat()
+      .join('\n');
+  } else {
+    steps = null;
+  }
+
+  let testLogs = '';
+  if (steps) testLogs += `${pc.bold(pc.blue('################[ Steps ]################'))}\n${steps}\n\n`;
+  if (logs) testLogs += `${pc.bold(pc.gray('################[ Logs ]################'))}\n${logs}\n\n`;
+  if (error) testLogs += `${pc.bold(pc.red('################[ Failure ]################'))}\n${error}`;
+  return testLogs;
+}
+
+/**
+ * Formats an error with stack trace and diff information
+ * @param {Error & {inspect?: () => string, operator?: string, diff?: string, actual?: any, expected?: any}} error
+ *   The error object to format
+ * @param {string} [message] - Optional error message override
+ * @returns {string}
+ */
+export function formatError(error, message) {
+  if (!message) message = error.message;
+  // @ts-ignore - inspect is a custom property added by some testing frameworks
+  if (error.inspect) message = error.inspect() || '';
+
+  let stack = '';
+  if (error.name) stack += `${pc.red(error.name)}`;
+  // @ts-ignore - operator is a custom property added by assertion libraries
+  if (error.operator) stack += ` (${pc.red(error.operator)})`;
+  // add new line if something was added to stack
+  if (stack) stack += ': ';
+
+  stack += `${message}\n`;
+
+  // @ts-ignore - diff is a custom property added by vitest
+  if (error.diff) {
+    // diff for vitest
+    stack += error.diff;
+    stack += '\n\n';
+  } else if (error.actual && error.expected && error.actual !== error.expected) {
+    // diffs for mocha, cypress, codeceptjs style
+    stack += `\n\n${pc.bold(pc.green('+ expected'))} ${pc.bold(pc.red('- actual'))}`;
+    stack += `\n${pc.green(`+ ${error.expected.toString().split('\n').join('\n+ ')}`)}`;
+    stack += `\n${pc.red(`- ${error.actual.toString().split('\n').join('\n- ')}`)}`;
+    stack += '\n\n';
+  }
+
+  const customFilter = process.env.TESTOMATIO_STACK_IGNORE;
+
+  try {
+    let hasFrame = false;
+    const record = createCallsiteRecord({
+      forError: error,
+      isCallsiteFrame: frame => {
+        if (customFilter && minimatch(frame.fileName, customFilter)) return false;
+        if (hasFrame) return false;
+        if (isNotInternalFrame(frame)) hasFrame = true;
+        return hasFrame;
+      },
+    });
+    // @ts-ignore
+    if (record && !record.filename.startsWith('http')) {
+      stack += record.renderSync({ stackFilter: isNotInternalFrame });
+    }
+    return stack;
+  } catch (e) {
+    console.log(e);
+  }
+}
+
+/**
+ * Checks if a stack frame is not an internal frame (node_modules or internal)
+ * @param {Object} frame - Stack frame object
+ * @returns {boolean}
+ */
+function isNotInternalFrame(frame) {
+  return (
+    frame.getFileName() &&
+    frame.getFileName().includes(sep) &&
+    !frame.getFileName().includes('node_modules') &&
+    !frame.getFileName().includes('internal')
+  );
+}
+
+export { stripColors };

package/src/xmlReader.js

@@ -274,9 +274,14 @@ class XmlReader {
   _parseTRXTestDefinition(td) {
     const title = td.name.replace(/\(.*?\)/, '').trim();
     const exampleMatch = td.name.match(/\((.*?)\)/);
-    const example = exampleMatch ? {
-      ...exampleMatch[1].split(',').map(p => p.trim()).filter(p => p !== '')
-    } : null;
+    const example = exampleMatch
+      ? {
+          ...exampleMatch[1]
+            .split(',')
+            .map(p => p.trim())
+            .filter(p => p !== ''),
+        }
+      : null;
 
     const suite = td.TestMethod.className.split(', ')[0].split('.');
     const suite_title = suite.pop();
@@ -600,7 +605,12 @@ function reduceTestCases(prev, item) {
 
       const exampleMatches = testCaseItem.name?.match(/\S\((.*?)\)/);
       if (exampleMatches) {
-        example = { ...exampleMatches[1].split(',').map(v => v.trim().replace(/[^\w\s-]/g, '')).filter(v => v !== '') };
+        example = {
+          ...exampleMatches[1]
+            .split(',')
+            .map(v => v.trim().replace(/[^\w\s-]/g, ''))
+            .filter(v => v !== ''),
+        };
         title = title.replace(/\(.*?\)/, '').trim();
       }