@testomatio/reporter 1.3.6-beta → 1.4.0-beta-wdio-bdd

package/lib/utils/pipe_utils.js

@@ -0,0 +1,129 @@
+const { resetConfig } = require('../fileUploader');
+const { APP_PREFIX } = require('../constants');
+
+/**
+ * Set S3 credentials from the provided artifacts object.
+ * @param {Object} artifacts - The artifacts object containing S3 credentials.
+ */
+function setS3Credentials(artifacts) {
+  if (!Object.keys(artifacts).length) return;
+
+  console.log(APP_PREFIX, 'S3 were 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;
+  if (artifacts.REGION) process.env.S3_REGION = artifacts.REGION;
+  if (artifacts.BUCKET) process.env.S3_BUCKET = artifacts.BUCKET;
+  if (artifacts.ENDPOINT) process.env.S3_ENDPOINT = artifacts.ENDPOINT;
+  if (artifacts.SESSION_TOKEN) process.env.S3_SESSION_TOKEN = artifacts.SESSION_TOKEN;
+  if (artifacts.presign) process.env.TESTOMATIO_PRIVATE_ARTIFACTS = '1';
+  resetConfig();
+}
+/**
+ * Generates mode request parameters based on the input params.
+ * @param {Object} params - The input parameters for the request.
+ * @param {string} params.type - The type of the request (e.g., "tag").
+ * @param {string} params.id - The ID associated with the request.
+ * @param {string} params.apiKey - The API key for authentication.
+ * @returns {Object|null} - An object containing the generated request parameters, or null if the type is invalid.
+ */
+function generateFilterRequestParams(params) {
+  const { type, id, apiKey } = params;
+
+  if (!type) {
+    return;
+  }
+
+  if (!id) {
+    console.error(APP_PREFIX, `Please make sure your settings "${type.toUpperCase()}"= "${id}" is correct!`);
+    return;
+  }
+
+  return {
+    params: {
+      type,
+      id: encodeURIComponent(id),
+      api_key: apiKey,
+    },
+    responseType: 'json',
+  };
+}
+
+/**
+ * Parse filter parameters from a string in the format "type=id".
+ * @param {string} opts - The input string containing the filter parameters.
+ * @returns {Object} An object containing the parsed filter parameters.
+ *                   The object has properties "type" and "id".
+ */
+function parseFilterParams(opts) {
+  const [type, id] = opts.split('=');
+  const validType = updateFilterType(type);
+
+  return {
+    type: validType,
+    id,
+  };
+}
+
+/**
+ * Update and validate the filter type.
+ * @param {string} type - The original filter type.
+ * @returns {string|undefined} The updated and validated filter type.
+ *                            Returns undefined if the type is not valid.
+ */
+function updateFilterType(type) {
+  const typeLowerCase = type.toLowerCase();
+
+  const filterTypes = ['tag-name', 'plan-id', 'label', 'jira-ticket'];
+
+  const filterApi = [
+    'tag',
+    'plan',
+    'label',
+    'jira',
+    // "ims-issue", //TODO: WIP
+  ];
+
+  if (!filterTypes.includes(typeLowerCase)) {
+    console.log(APP_PREFIX, `❗❗❗ Invalid "filter=${type}" start settings! Available option list: ${filterTypes}`);
+    return;
+  }
+
+  const index = filterTypes.indexOf(typeLowerCase);
+
+  return index !== -1 ? filterApi[index] : undefined;
+}
+
+/**
+ * Return an emoji based on the provided status.
+ * @param {string} status - The status value ('passed', 'failed', or 'skipped').
+ * @returns {string} - An emoji corresponding to the provided status.
+ */
+function statusEmoji(status) {
+  if (status === 'passed') return '🟢';
+  if (status === 'failed') return '🔴';
+  if (status === 'skipped') return '🟡';
+  return '';
+}
+
+/**
+ * Generate a full name string based on the provided test object.
+ * @param {object} t - The test object.
+ * @returns {string} - A formatted full name string for the test object.
+ */
+function fullName(t) {
+  let line = '';
+  if (t.suite_title) line = `${t.suite_title}: `;
+  line += `**${t.title}**`;
+  if (t.example) line += ` \`[${Object.values(t.example)}]\``;
+  return line;
+}
+
+module.exports = {
+  updateFilterType,
+  parseFilterParams,
+  generateFilterRequestParams,
+  setS3Credentials,
+  statusEmoji,
+  fullName,
+};

package/lib/{util.js → utils/utils.js}

@@ -12,11 +12,11 @@ const debug = require('debug')('@testomatio/reporter:util');
  */
 const parseTest = testTitle => {
   if (!testTitle) return null;
-  
-  const captures = testTitle.match(/@T([\w\d]+)/);
-  
+
+  const captures = testTitle.match(/@T[\w\d]{8}/);
+
   if (captures) {
-    return captures[1];
+    return captures[0];
   }
 
   return null;
@@ -28,7 +28,7 @@ const parseTest = testTitle => {
  * @returns {String|null} suiteId
  */
 const parseSuite = suiteTitle => {
-  const captures = suiteTitle.match(/@S([\w\d]+)/);
+  const captures = suiteTitle.match(/@S[\w\d]{8}/);
   if (captures) {
     return captures[1];
   }
@@ -55,11 +55,20 @@ const isValidUrl = s => {
   }
 };
 
+const fileMatchRegex = /file:(\/\/?[^:\s]+?\.(png|avi|webm|jpg|html|txt))/gi;
+
 const fetchFilesFromStackTrace = (stack = '') => {
-  const files = stack.matchAll(/file:?\/(\/.*?\.(png|avi|webm|jpg|html|txt))/g);
-  return Array.from(files)
-    .map(f => f[1])
-    .filter(f => fs.existsSync(f));
+  const files = Array.from(stack.matchAll(fileMatchRegex))
+    .map(f => f[1].trim())
+    .map(f => (f.startsWith('//') ? f.substring(1) : f));
+
+  debug('Found files in stack trace: ', files);
+
+  return files.filter(f => {
+    const isFile = fs.existsSync(f);
+    if (!isFile) debug('File %s could not be found and uploaded as artifact', f);
+    return isFile;
+  });
 };
 
 const fetchSourceCodeFromStackTrace = (stack = '') => {
@@ -87,11 +96,41 @@ const fetchSourceCodeFromStackTrace = (stack = '') => {
 
   if (!source) return '';
 
-  return source.split('\n')
+  return source
+    .split('\n')
     .map((l, i) => {
       if (i === prepend) return `${line} > ${chalk.bold(l)}`;
-      return `${line - prepend + i} | ${l}`
-    }).join('\n');
+      return `${line - prepend + i} | ${l}`;
+    })
+    .join('\n');
+};
+
+const TEST_ID_REGEX = /@T([\w\d]{8})/;
+
+const fetchIdFromCode = (code, opts = {}) => {
+  const comments = code
+    .split('\n')
+    .map(l => l.trim())
+    .filter(l => {
+      switch (opts.lang) {
+        case 'ruby':
+        case 'python':
+          return l.startsWith('# ');
+        default:
+          return l.startsWith('// ');
+      }
+    });
+
+  return comments.find(c => c.match(TEST_ID_REGEX))?.match(TEST_ID_REGEX)?.[1];
+};
+
+const fetchIdFromOutput = output => {
+  const lines = output
+    .split('\n')
+    .map(l => l.trim())
+    .filter(l => l.startsWith('tid://'));
+
+  return lines.find(c => c.match(TEST_ID_REGEX))?.match(TEST_ID_REGEX)?.[1];
 };
 
 const fetchSourceCode = (contents, opts = {}) => {
@@ -106,7 +145,15 @@ const fetchSourceCode = (contents, opts = {}) => {
   // remove special chars from title
   if (!lineIndex && opts.title) {
     const title = opts.title.replace(/[([@].*/g, '');
-    lineIndex = lines.findIndex(l => l.includes(title));
+
+    if (opts.lang === 'java') {
+      lineIndex = lines.findIndex(l => l.includes(`test${title}`));
+      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 {
+      lineIndex = lines.findIndex(l => l.includes(title));
+    }
   }
 
   if (opts.prepend) {
@@ -115,7 +162,7 @@ const fetchSourceCode = (contents, opts = {}) => {
 
   if (lineIndex) {
     const result = [];
-    for (let i = lineIndex; i < (lineIndex + limit); i++) {
+    for (let i = lineIndex; i < lineIndex + limit; i++) {
       if (lines[i] === undefined) continue;
 
       if (i > lineIndex + 2 && !opts.prepend) {
@@ -189,13 +236,92 @@ const fileSystem = {
     } else {
       debug(`Trying to delete ${dirPath} but it doesn't exist`);
     }
-  }
+  },
+};
+
+const foundedTestLog = (app, tests) => {
+  const n = tests.length;
+
+  return n === 1 ? console.log(app, `✅ We found one test!`) : console.log(app, `✅ We found ${n} tests!`);
+};
+
+const humanize = text => {
+  text = decamelize(text);
+  return text
+    .replace(/_./g, match => ` ${match.charAt(1).toUpperCase()}`)
+    .trim()
+    .replace(/^(.)|\s(.)/g, $1 => $1.toUpperCase())
+    .trim()
+    .replace(/\sA\s/g, ' a ') // replace a|the
+    .replace(/\sThe\s/g, ' the ') // replace a|the
+    .replace(/^Test\s/, '')
+    .replace(/^Should\s/, '');
+};
+
+/**
+ * From https://github.com/sindresorhus/decamelize/blob/main/index.js
+ * @param {*} text
+ * @returns
+ */
+const decamelize = text => {
+  const separator = '_';
+  const replacement = `$1${separator}$2`;
+
+  // Split lowercase sequences followed by uppercase character.
+  // `dataForUSACounties` → `data_For_USACounties`
+  // `myURLstring → `my_URLstring`
+  let decamelized = text.replace(/([\p{Lowercase_Letter}\d])(\p{Uppercase_Letter})/gu, replacement);
+
+  // Lowercase all single uppercase characters. As we
+  // want to preserve uppercase sequences, we cannot
+  // simply lowercase the separated string at the end.
+  // `data_For_USACounties` → `data_for_USACounties`
+  decamelized = decamelized.replace(
+    /((?<![\p{Uppercase_Letter}\d])[\p{Uppercase_Letter}\d](?![\p{Uppercase_Letter}\d]))/gu,
+    $0 => $0.toLowerCase(),
+  );
+
+  // Remaining uppercase sequences will be separated from lowercase sequences.
+  // `data_For_USACounties` → `data_for_USA_counties`
+  return decamelized.replace(
+    /(\p{Uppercase_Letter}+)(\p{Uppercase_Letter}\p{Lowercase_Letter}+)/gu,
+    (_, $1, $2) => $1 + separator + $2.toLowerCase(),
+  );
+};
+
+/**
+ * Used to remove color codes
+ * @param {*} input
+ * @returns
+ */
+function removeColorCodes(input) {
+  // eslint-disable-next-line no-control-regex
+  return input.replace(/\x1b\[[0-9;]*m/g, '');
+}
+
+const testRunnerHelper = {
+  // for Jest
+  getNameOfCurrentlyRunningTest: () => {
+    if (global.testomatioTestTitle) return global.testomatioTestTitle;
+
+    if (!process.env.JEST_WORKER_ID) return null;
+    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;
+    }
+  },
 };
 
 module.exports = {
   isSameTest,
   fetchSourceCode,
   fetchSourceCodeFromStackTrace,
+  fetchIdFromCode,
+  fetchIdFromOutput,
   fetchFilesFromStackTrace,
   fileSystem,
   getCurrentDateTime,
@@ -204,4 +330,8 @@ module.exports = {
   ansiRegExp,
   parseTest,
   parseSuite,
+  humanize,
+  removeColorCodes,
+  foundedTestLog,
+  testRunnerHelper,
 };