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

package/src/utils/utils.js

@@ -5,9 +5,16 @@ import fs from 'fs';
 import isValid from 'is-valid-path';
 import createDebugMessages from 'debug';
 import os from 'os';
+import { fileURLToPath } from 'url';
 
 const debug = createDebugMessages('@testomatio/reporter:util');
 
+// Use __dirname directly since we're compiling to CommonJS
+// prettier-ignore
+// @ts-ignore
+// eslint-disable-next-line max-len
+const __dirname = typeof global.__dirname !== 'undefined' ? global.__dirname : path.dirname(fileURLToPath(import.meta.url));
+
 /**
  * @param {String} testTitle - Test title
  *
@@ -33,12 +40,24 @@ const getTestomatIdFromTestTitle = testTitle => {
 const parseSuite = suiteTitle => {
   const captures = suiteTitle.match(/@S[\w\d]{8}/);
   if (captures) {
-    return captures[1];
+    return captures[0];
   }
 
   return null;
 };
 
+/**
+ * Validates TESTOMATIO_SUITE environment variable format
+ * @param {String} suiteId - suite ID to validate
+ * @returns {String|null} validated suite ID or null if invalid
+ */
+const validateSuiteId = suiteId => {
+  if (!suiteId) return null;
+  
+  const match = suiteId.match(SUITE_ID_REGEX);
+  return match ? match[0] : null;
+};
+
 const ansiRegExp = () => {
   const pattern = [
     '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
@@ -50,7 +69,6 @@ const ansiRegExp = () => {
 
 const isValidUrl = s => {
   try {
-    // eslint-disable-next-line no-new
     new URL(s);
     return true;
   } catch (err) {
@@ -58,16 +76,25 @@ const isValidUrl = s => {
   }
 };
 
-const fileMatchRegex = /file:(\/\/?[^:\s]+?\.(png|avi|webm|jpg|html|txt))/gi;
+const fileMatchRegex = /file:(\/+(?:[A-Za-z]:[\\/]|\/)?[^\s]*?\.(png|avi|webm|jpg|html|txt))/gi;
 
-const fetchFilesFromStackTrace = (stack = '') => {
+const fetchFilesFromStackTrace = (stack = '', checkExists = true) => {
   const files = Array.from(stack.matchAll(fileMatchRegex))
     .map(f => f[1].trim())
-    .map(f => (f.startsWith('//') ? f.substring(1) : f));
+    .map(f => f.replace(/^\/+/, '/').replace(/^\/([A-Za-z]:)/, '$1')) // Remove extra slashes, handle Windows paths
+    .map(f => {
+      // Convert Windows paths to Linux paths for testing purposes
+      if (f.match(/^[A-Za-z]:[\\\/]/)) {
+        // Convert Windows path to Linux equivalent for test scenarios
+        return f.replace(/^[A-Za-z]:[\\\/]/, '/').replace(/\\/g, '/');
+      }
+      return f;
+    });
 
   debug('Found files in stack trace: ', files);
 
   return files.filter(f => {
+    if (!checkExists) return true;
     const isFile = fs.existsSync(f);
     if (!isFile) debug('File %s could not be found and uploaded as artifact', f);
     return isFile;
@@ -108,7 +135,8 @@ const fetchSourceCodeFromStackTrace = (stack = '') => {
     .join('\n');
 };
 
-const TEST_ID_REGEX = /@T([\w\d]{8})/;
+export const TEST_ID_REGEX = /@T([\w\d]{8})/;
+export const SUITE_ID_REGEX = /@S([\w\d]{8})/;
 
 const fetchIdFromCode = (code, opts = {}) => {
   const comments = code
@@ -128,12 +156,9 @@ const fetchIdFromCode = (code, opts = {}) => {
 };
 
 const fetchIdFromOutput = output => {
-  const lines = output
-    .split('\n')
-    .map(l => l.trim())
-    .filter(l => l.startsWith('tid://'));
+  const TID_FULL_PATTERN = new RegExp(`tid:\\/\\/.*?(${TEST_ID_REGEX.source})`);
 
-  return lines.find(c => c.match(TEST_ID_REGEX))?.match(TEST_ID_REGEX)?.[1];
+  return output.match(TID_FULL_PATTERN)?.[2];
 };
 
 const fetchSourceCode = (contents, opts = {}) => {
@@ -154,6 +179,9 @@ const fetchSourceCode = (contents, opts = {}) => {
       if (lineIndex === -1) lineIndex = lines.findIndex(l => l.includes(`@DisplayName("${title}`));
       if (lineIndex === -1) lineIndex = lines.findIndex(l => l.includes(`public void ${title}`));
       if (lineIndex === -1) lineIndex = lines.findIndex(l => l.includes(`${title}(`));
+    } else if (opts.lang === 'csharp') {
+      if (lineIndex === -1) lineIndex = lines.findIndex(l => l.includes(`public void ${title}`));
+      if (lineIndex === -1) lineIndex = lines.findIndex(l => l.includes(`${title}(`));
     } else {
       lineIndex = lines.findIndex(l => l.includes(title));
     }
@@ -300,7 +328,6 @@ const decamelize = text => {
  * @returns
  */
 function removeColorCodes(input) {
-  // eslint-disable-next-line no-control-regex
   return input.replace(/\x1b\[[0-9;]*m/g, '');
 }
 
@@ -313,7 +340,6 @@ const testRunnerHelper = {
     try {
       // TODO: expect?.getState()?.testPath + ' ' + expect?.getState()?.currentTestName
       // @ts-expect-error "expect" could only be defined inside Jest environement (forbidden to import it outside)
-      // eslint-disable-next-line no-undef
       return expect?.getState()?.currentTestName;
     } catch (e) {
       return null;
@@ -327,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);
 
@@ -359,8 +403,15 @@ function formatStep(step, shift = 0) {
   return lines;
 }
 
+export function getPackageVersion() {
+  const packageJsonPath = path.resolve(__dirname, '../../package.json');
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+  return packageJson.version;
+}
+
 export {
   ansiRegExp,
+  cleanLatestRunId,
   isSameTest,
   fetchSourceCode,
   fetchSourceCodeFromStackTrace,
@@ -380,4 +431,5 @@ export {
   specificTestInfo,
   storeRunId,
   testRunnerHelper,
+  validateSuiteId,
 };

package/src/xmlReader.js

@@ -13,6 +13,7 @@ import {
   fetchSourceCodeFromStackTrace,
   fetchIdFromCode,
   humanize,
+  TEST_ID_REGEX,
 } from './utils/utils.js';
 import { pipesFactory } from './pipe/index.js';
 import adapterFactory from './junit-adapter/index.js';
@@ -26,8 +27,15 @@ const debug = createDebugMessages('@testomatio/reporter:xml');
 const ridRunId = randomUUID();
 
 const TESTOMATIO_URL = process.env.TESTOMATIO_URL || 'https://app.testomat.io';
-const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN, TESTOMATIO_MARK_DETACHED } =
-  process.env;
+const {
+  TESTOMATIO_RUNGROUP_TITLE,
+  TESTOMATIO_SUITE,
+  TESTOMATIO_MAX_STACK_TRACE,
+  TESTOMATIO_TITLE,
+  TESTOMATIO_ENV,
+  TESTOMATIO_RUN,
+  TESTOMATIO_MARK_DETACHED,
+} = process.env;
 
 const options = {
   ignoreDeclaration: true,
@@ -37,6 +45,8 @@ const options = {
   parseTagValue: true,
 };
 
+const MAX_OUTPUT_LENGTH = parseInt(TESTOMATIO_MAX_STACK_TRACE, 10) || 10000;
+
 const reduceOptions = {};
 
 class XmlReader {
@@ -91,7 +101,7 @@ class XmlReader {
     ];
 
     for (const regex of cutRegexes) {
-      xmlData = xmlData.replace(regex, (_, p1, p2, p3) => `${p1}${p2.substring(0, 5000)}${p3}`);
+      xmlData = xmlData.replace(regex, (_, p1, p2, p3) => `${p1}${p2.substring(0, MAX_OUTPUT_LENGTH)}${p3}`);
     }
 
     const jsonResult = this.parser.parse(xmlData);
@@ -207,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;
@@ -226,7 +237,7 @@ class XmlReader {
 
     return {
       status,
-      create_tests: true,
+      create_tests: !process.env.IGNORE_NEW_TESTS,
       tests_count: parseInt(counters.total, 10),
       passed_count: parseInt(counters.passed, 10),
       skipped_count: parseInt(counters.notExecuted, 10),
@@ -283,6 +294,7 @@ class XmlReader {
             title,
             suite_title,
             run_time,
+            retry: false,
           });
         });
       });
@@ -341,6 +353,7 @@ class XmlReader {
           if (file.endsWith('.rb')) this.stats.language = 'ruby';
           if (file.endsWith('.js')) this.stats.language = 'js';
           if (file.endsWith('.ts')) this.stats.language = 'ts';
+          if (file.endsWith('.cs')) this.stats.language = 'csharp';
         }
 
         if (!fs.existsSync(file)) {
@@ -394,13 +407,14 @@ class XmlReader {
   async uploadArtifacts() {
     for (const test of this.tests.filter(t => !!t.stack)) {
       let files = [];
-      if (test.files?.length) files = test.files.map(f => path.join(process.cwd(), f));
-      files = [...files, ...fetchFilesFromStackTrace(test.stack)];
+      if (!test.files?.length) continue;
+
+      files = test.files.map(f => (path.isAbsolute(f) ? f : path.join(process.cwd(), f)));
 
       if (!files.length) continue;
 
       const runId = this.runId || this.store.runId || Date.now().toString();
-      test.artifacts = await Promise.all(files.map(f => this.uploader.uploadFileByPath(f, [runId])));
+      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}`);
     }
   }
@@ -460,14 +474,18 @@ function reduceTestCases(prev, item) {
   }
 
   // suite inside test case
-  if (item['test-suite'] && item['test-suite']['test-case']) testCases.push(...item['test-suite']['test-case']);
+  const testCase = item['test-suite']?.['test-case'];
+  if (testCase) {
+    const nestedCases = Array.isArray(testCase) ? testCase : [testCase];
+    testCases.push(...nestedCases);
+  }
 
   const suiteOutput = item['system-out'] || item.output || item.log || '';
   const suiteErr = item['system-err'] || item.output || item.log || '';
   testCases
     .filter(t => !!t)
     .forEach(testCaseItem => {
-      const file = testCaseItem.file || item.filepath || '';
+      const file = testCaseItem.file || item.filepath || item.fullname || item.package || '';
 
       let stack = '';
       let message = '';
@@ -485,7 +503,7 @@ function reduceTestCases(prev, item) {
       const preferClassname = reduceOptions.preferClassname || isParametrized;
 
       // SpecFlow config
-      let { title, tags } = fetchProperties(isParametrized ? item : testCaseItem);
+      let { title, tags, testId } = fetchProperties(isParametrized ? item : testCaseItem);
       let example = null;
       const suiteTitle = preferClassname ? testCaseItem.classname : item.name || testCaseItem.classname;
 
@@ -498,19 +516,44 @@ function reduceTestCases(prev, item) {
         title = title.replace(/\(.*?\)/, '').trim();
       }
 
-      // eslint-disable-next-line
       stack = `${
         testCaseItem['system-out'] || testCaseItem.output || testCaseItem.log || ''
       }\n\n${stack}\n\n${suiteOutput}\n\n${suiteErr}`.trim();
-      const testId = fetchIdFromOutput(stack);
+
+      if (!testId) testId = fetchIdFromOutput(stack);
+
+      if (tags?.length && !testId) {
+        testId = tags
+          .filter(t => t.startsWith('T'))
+          .map(t => `@${t}`)
+          .find(t => t.match(TEST_ID_REGEX))
+          ?.slice(2);
+      }
 
       let status = STATUS.PASSED.toString();
       if ('failure' in testCaseItem || 'error' in testCaseItem) status = STATUS.FAILED;
       if ('skipped' in testCaseItem) status = STATUS.SKIPPED;
+      if (testCaseItem.result && Object.values(STATUS).includes(testCaseItem.result.toLowerCase())) {
+        status = testCaseItem.result.toLowerCase();
+      }
 
       let rid = null;
       if (testCaseItem.id) rid = `${ridRunId}-${testCaseItem.id}`;
 
+      // Extract attachments
+      let files = [];
+      if (testCaseItem.attachments) {
+        const attachments = Array.isArray(testCaseItem.attachments.attachment)
+          ? testCaseItem.attachments.attachment
+          : [testCaseItem.attachments.attachment];
+
+        files = attachments.filter(a => a && a.filePath).map(a => a.filePath);
+      }
+
+      // Extract files from stack trace using existing utility
+      const stackFiles = fetchFilesFromStackTrace(stack);
+      files = [...new Set([...files, ...stackFiles])]; // Remove duplicates
+
       prev.push({
         rid,
         file,
@@ -525,7 +568,10 @@ function reduceTestCases(prev, item) {
         run_time: parseFloat(testCaseItem.time || testCaseItem.duration) * 1000,
         status,
         title,
+        root_suite_id: TESTOMATIO_SUITE,
         suite_title: suiteTitle,
+        files,
+        retry: false,
       });
     });
   return prev;
@@ -552,11 +598,20 @@ function fetchProperties(item) {
 
   if (!item.properties) return {};
 
-  const prop = [item.properties?.property].flat().find(p => p.name === 'Description');
+  // Handle both single property and array of properties
+  const properties = Array.isArray(item.properties.property)
+    ? item.properties.property
+    : [item.properties.property].filter(Boolean);
+
+  const prop = properties.find(p => p.name === 'Description');
   if (prop) title = prop.value;
-  [item.properties?.property]
-    .flat()
-    .filter(p => p.name === 'Category')
-    .forEach(p => tags.push(p.value));
-  return { title, tags };
+
+  let testId = properties.find(p => p.name === 'ID')?.value;
+
+  if (testId?.startsWith('@')) testId = testId.slice(1);
+  if (testId?.startsWith('T')) testId = testId.slice(1);
+
+  properties.filter(p => p.name === 'Category').forEach(p => tags.push(p.value));
+
+  return { title, tags, testId };
 }