@testomatio/reporter 1.2.0 → 1.2.1-beta.codecept-id

package/lib/utils/pipe_utils.js

@@ -6,17 +6,17 @@ const { APP_PREFIX } = require('../constants');
  * @param {Object} artifacts - The artifacts object containing S3 credentials.
  */
 function setS3Credentials(artifacts) {
-    if (!Object.keys(artifacts).length) return;
+  if (!Object.keys(artifacts).length) return;
 
-    console.log(APP_PREFIX, 'S3 were credentials obtained from Testomat.io...');
+  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.presign) process.env.TESTOMATIO_PRIVATE_ARTIFACTS = '1';
-    resetConfig();
+  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.presign) process.env.TESTOMATIO_PRIVATE_ARTIFACTS = '1';
+  resetConfig();
 }
 /**
  * Generates mode request parameters based on the input params.
@@ -27,25 +27,25 @@ function setS3Credentials(artifacts) {
  * @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"
-    }
+  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',
+  };
 }
 
 /**
@@ -55,13 +55,13 @@ function generateFilterRequestParams(params) {
  *                   The object has properties "type" and "id".
  */
 function parseFilterParams(opts) {
-    const [type, id] = opts.split("=");
-    const validType = updateFilterType(type);
+  const [type, id] = opts.split('=');
+  const validType = updateFilterType(type);
 
-    return {
-        type: validType,
-        id
-    };
+  return {
+    type: validType,
+    id,
+  };
 }
 
 /**
@@ -71,33 +71,26 @@ function parseFilterParams(opts) {
  *                            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
+  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;
 }
 
 /**
@@ -106,10 +99,10 @@ function updateFilterType(type) {
  * @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 '';
+  if (status === 'passed') return '🟢';
+  if (status === 'failed') return '🔴';
+  if (status === 'skipped') return '🟡';
+  return '';
 }
 
 /**
@@ -118,18 +111,18 @@ function statusEmoji(status) {
  * @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;
+  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
-};
+  updateFilterType,
+  parseFilterParams,
+  generateFilterRequestParams,
+  setS3Credentials,
+  statusEmoji,
+  fullName,
+};

package/lib/utils/utils.js

@@ -13,7 +13,7 @@ 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];
@@ -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,21 +55,20 @@ const isValidUrl = s => {
   }
 };
 
-const fileMatchRegex = /file:(\/\/?[^:\s]+?\.(png|avi|webm|jpg|html|txt))/ig;
+const fileMatchRegex = /file:(\/\/?[^:\s]+?\.(png|avi|webm|jpg|html|txt))/gi;
 
 const fetchFilesFromStackTrace = (stack = '') => {
-
   const files = Array.from(stack.matchAll(fileMatchRegex))
-  .map(f => f[1].trim())
-  .map(f => f.startsWith('//') ? f.substring(1) : f )
-  
+    .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 isFile = fs.existsSync(f);
+    if (!isFile) debug('File %s could not be found and uploaded as artifact', f);
+    return isFile;
+  });
 };
 
 const fetchSourceCodeFromStackTrace = (stack = '') => {
@@ -109,25 +108,30 @@ const fetchSourceCodeFromStackTrace = (stack = '') => {
 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('// ');
-    }
-  });
+  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://'));
+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 = {}) => {
   if (!opts.title && !opts.line) return '';
@@ -141,7 +145,7 @@ const fetchSourceCode = (contents, opts = {}) => {
   // remove special chars from title
   if (!lineIndex && opts.title) {
     const title = opts.title.replace(/[([@].*/g, '');
-    
+
     if (opts.lang === 'java') {
       lineIndex = lines.findIndex(l => l.includes(`test${title}`));
       if (lineIndex === -1) lineIndex = lines.findIndex(l => l.includes(`@DisplayName("${title}`));
@@ -235,14 +239,11 @@ const fileSystem = {
   },
 };
 
-
 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!`);
-}
+  return n === 1 ? console.log(app, `✅ We found one test!`) : console.log(app, `✅ We found ${n} tests!`);
+};
 
 const humanize = text => {
   text = decamelize(text);
@@ -333,4 +334,4 @@ module.exports = {
   removeColorCodes,
   foundedTestLog,
   testRunnerHelper,
-};
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.2.0",
+  "version": "1.2.1-beta.codecept-id",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -41,9 +41,11 @@
   ],
   "scripts": {
     "clear-exportdir": "rm -rf export/",
-    "pretty": "prettier --write .",
+    "pretty": "prettier --check .",
+    "pretty:fix": "prettier --write .",
     "lint": "eslint lib",
     "lint:fix": "eslint lib --fix",
+    "format": "npm run lint:fix && npm run pretty:fix",
     "test": "mocha tests/**",
     "init": "cd ./tests/adapter/examples/cucumber && npm i",
     "test:adapter": "mocha './tests/adapter/index.test.js'",