@testomatio/reporter 2.0.1-beta.2 → 2.0.1-beta.3

package/lib/adapter/playwright.js

@@ -98,6 +98,10 @@ class PlaywrightReporter {
                 projectDependencies: project.dependencies?.length ? project.dependencies : null,
                 ...testMeta,
                 ...project.metadata, // metadata has any type (in playwright), but we will stringify it in client.js
+                ...test.annotations?.reduce((acc, annotation) => {
+                    acc[annotation.type] = annotation.description;
+                    return acc;
+                }, {}),
             },
             file: test.location?.file,
         });

package/lib/client.js

@@ -240,6 +240,9 @@ class Client {
             uploadedFiles.push(this.uploader.uploadFileAsBuffer(buffer, [this.runId, rid, fileName]));
         }
         const artifacts = (await Promise.all(uploadedFiles)).filter(n => !!n);
+        const workspaceDir = process.env.TESTOMATIO_WORKDIR || process.cwd();
+        const relativeFile = file ? path_1.default.relative(workspaceDir, file) : file;
+        const rootSuiteId = (0, utils_js_1.validateSuiteId)(process.env.TESTOMATIO_SUITE);
         const data = {
             rid,
             files,
@@ -247,7 +250,7 @@ class Client {
             status,
             stack: fullLogs,
             example,
-            file,
+            file: relativeFile,
             code,
             title,
             suite_title,
@@ -257,6 +260,7 @@ class Client {
             run_time: typeof time === 'number' ? time : parseFloat(time),
             artifacts,
             meta,
+            ...(rootSuiteId && { root_suite_id: rootSuiteId }),
         };
         // debug('Adding test run...', data);
         // @ts-ignore

package/lib/utils/utils.d.ts

@@ -1,5 +1,6 @@
 export function getPackageVersion(): any;
 export const TEST_ID_REGEX: RegExp;
+export const SUITE_ID_REGEX: RegExp;
 export function ansiRegExp(): RegExp;
 export function isSameTest(test: any, t: any): boolean;
 export function fetchSourceCode(contents: any, opts?: {}): string;
@@ -45,3 +46,9 @@ export function storeRunId(runId: any): void;
 export namespace testRunnerHelper {
     function getNameOfCurrentlyRunningTest(): any;
 }
+/**
+ * Validates TESTOMATIO_SUITE environment variable format
+ * @param {String} suiteId - suite ID to validate
+ * @returns {String|null} validated suite ID or null if invalid
+ */
+export function validateSuiteId(suiteId: string): string | null;

package/lib/utils/utils.js

@@ -36,7 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testRunnerHelper = exports.specificTestInfo = exports.parseSuite = exports.isValidUrl = exports.humanize = exports.getTestomatIdFromTestTitle = exports.getCurrentDateTime = exports.foundedTestLog = exports.fileSystem = exports.fetchFilesFromStackTrace = exports.fetchIdFromOutput = exports.fetchIdFromCode = exports.fetchSourceCodeFromStackTrace = exports.fetchSourceCode = exports.isSameTest = exports.ansiRegExp = exports.TEST_ID_REGEX = void 0;
+exports.validateSuiteId = exports.testRunnerHelper = exports.specificTestInfo = exports.parseSuite = exports.isValidUrl = exports.humanize = exports.getTestomatIdFromTestTitle = exports.getCurrentDateTime = exports.foundedTestLog = exports.fileSystem = exports.fetchFilesFromStackTrace = exports.fetchIdFromOutput = exports.fetchIdFromCode = exports.fetchSourceCodeFromStackTrace = exports.fetchSourceCode = exports.isSameTest = exports.ansiRegExp = exports.SUITE_ID_REGEX = exports.TEST_ID_REGEX = void 0;
 exports.getPackageVersion = getPackageVersion;
 exports.formatStep = formatStep;
 exports.readLatestRunId = readLatestRunId;
@@ -78,11 +78,23 @@ exports.getTestomatIdFromTestTitle = getTestomatIdFromTestTitle;
 const parseSuite = suiteTitle => {
     const captures = suiteTitle.match(/@S[\w\d]{8}/);
     if (captures) {
-        return captures[1];
+        return captures[0];
     }
     return null;
 };
 exports.parseSuite = parseSuite;
+/**
+ * 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(exports.SUITE_ID_REGEX);
+    return match ? match[0] : null;
+};
+exports.validateSuiteId = validateSuiteId;
 const ansiRegExp = () => {
     const pattern = [
         '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
@@ -157,6 +169,7 @@ const fetchSourceCodeFromStackTrace = (stack = '') => {
 };
 exports.fetchSourceCodeFromStackTrace = fetchSourceCodeFromStackTrace;
 exports.TEST_ID_REGEX = /@T([\w\d]{8})/;
+exports.SUITE_ID_REGEX = /@S([\w\d]{8})/;
 const fetchIdFromCode = (code, opts = {}) => {
     const comments = code
         .split('\n')
@@ -426,6 +439,8 @@ module.exports.getTestomatIdFromTestTitle = getTestomatIdFromTestTitle;
 
 module.exports.parseSuite = parseSuite;
 
+module.exports.validateSuiteId = validateSuiteId;
+
 module.exports.ansiRegExp = ansiRegExp;
 
 module.exports.isValidUrl = isValidUrl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.0.1-beta.2",
+  "version": "2.0.1-beta.3",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"
@@ -54,7 +54,9 @@
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
     "format": "npm run lint:fix && npm run pretty:fix",
-    "test": "mocha tests/**",
+    "test": "mocha tests/** --ignore tests/adapter/playwright.test.js --ignore tests/adapter/codecept.test.js",
+    "test:frameworks": "mocha tests/adapter/playwright.test.js tests/adapter/codecept.test.js",
+    "install-example-deps": "cd example/playwright && npm install && cd ../codecept && npm install",
     "init": "cd ./tests/adapter/examples/cucumber && npm i",
     "test:adapter": "node node_modules/mocha/bin/mocha './tests/adapter/index.test.js'",
     "test:pipes": "mocha './tests/pipes/*_test.js'",

package/src/adapter/playwright.js

@@ -102,6 +102,10 @@ class PlaywrightReporter {
         projectDependencies: project.dependencies?.length ? project.dependencies : null,
         ...testMeta,
         ...project.metadata, // metadata has any type (in playwright), but we will stringify it in client.js
+        ...test.annotations?.reduce((acc, annotation) => {
+          acc[annotation.type] = annotation.description;
+          return acc;
+        }, {}),
       },
       file: test.location?.file,
     });

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 } from './utils/utils.js';
+import { formatStep, storeRunId, validateSuiteId } from './utils/utils.js';
 import { filesize as prettyBytes } from 'filesize';
 
 const debug = createDebugMessages('@testomatio/reporter:client');
@@ -245,6 +245,10 @@ class Client {
 
     const artifacts = (await Promise.all(uploadedFiles)).filter(n => !!n);
 
+    const workspaceDir = process.env.TESTOMATIO_WORKDIR || process.cwd();
+    const relativeFile = file ? path.relative(workspaceDir, file) : file;
+    const rootSuiteId = validateSuiteId(process.env.TESTOMATIO_SUITE);
+
     const data = {
       rid,
       files,
@@ -252,7 +256,7 @@ class Client {
       status,
       stack: fullLogs,
       example,
-      file,
+      file: relativeFile,
       code,
       title,
       suite_title,
@@ -262,6 +266,7 @@ class Client {
       run_time: typeof time === 'number' ? time : parseFloat(time),
       artifacts,
       meta,
+      ...(rootSuiteId && { root_suite_id: rootSuiteId }),
     };
 
     // debug('Adding test run...', data);

package/src/utils/utils.js

@@ -40,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)',
@@ -124,6 +136,7 @@ const fetchSourceCodeFromStackTrace = (stack = '') => {
 };
 
 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
@@ -399,4 +412,5 @@ export {
   specificTestInfo,
   storeRunId,
   testRunnerHelper,
+  validateSuiteId,
 };