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

package/lib/fileUploader.js

@@ -3,10 +3,15 @@ const { S3 } = require('@aws-sdk/client-s3');
 const { Upload } = require('@aws-sdk/lib-storage');
 
 const fs = require('fs');
+const util = require('util');
 const path = require('path');
+const promiseRetry = require('promise-retry');
+
+const readFile = util.promisify(fs.readFile);
+const stat = util.promisify(fs.stat);
 const chalk = require('chalk');
 const { randomUUID } = require('crypto');
-const memoize = require('lodash.memoize');
+
 const { APP_PREFIX } = require('./constants');
 
 const keys = [
@@ -37,8 +42,12 @@ function getConfig() {
 }
 
 function getMaskedConfig() {
-  return Object.fromEntries(Object.entries(getConfig())
-    .map(([key, value]) => [key, key === 'S3_SECRET_ACCESS_KEY' || key === 'S3_ACCESS_KEY_ID' ? '***' : value]));
+  return Object.fromEntries(
+    Object.entries(getConfig()).map(([key, value]) => [
+      key,
+      key === 'S3_SECRET_ACCESS_KEY' || key === 'S3_ACCESS_KEY_ID' ? '***' : value,
+    ]),
+  );
 }
 
 let isEnabled;
@@ -73,7 +82,7 @@ const _getS3Config = () => {
       accessKeyId: S3_ACCESS_KEY_ID,
       secretAccessKey: S3_SECRET_ACCESS_KEY,
       s3ForcePathStyle: S3_FORCE_PATH_STYLE,
-    }
+    },
   };
 
   if (S3_ENDPOINT) {
@@ -81,7 +90,7 @@ const _getS3Config = () => {
   }
 
   return cfg;
-}
+};
 
 const uploadUsingS3 = async (filePath, runId) => {
   let ContentType;
@@ -93,48 +102,62 @@ const uploadUsingS3 = async (filePath, runId) => {
     Key = filePath.name;
   }
 
-  if (!fs.existsSync(filePath)) {
-    console.error(chalk.yellow(`Artifacts file ${filePath} does not exist. Skipping...`));
-    return;
-  }
+  const { TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET } = getConfig();
 
-  const {
-    TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET
-  } = getConfig();
+  try {
+    debug('S3 config', getMaskedConfig());
+    debug('Started upload', filePath, 'to ', S3_BUCKET);
 
-  debug('S3 config', getMaskedConfig());
-  debug('Uploading', filePath, 'to', S3_BUCKET);
-  
-const fileData = fs.readFileSync(filePath);
+    // Verification that the file was actually created: 20 attempts of 0.5 second => 10sec
+    const isFileExist = await checkFileExists(filePath, 20, 500);
 
-  Key = `${runId}/${randomUUID()}-${Key || path.basename(filePath)}`;
-  const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
+    if (!isFileExist) {
+      console.error(chalk.yellow(`Artifacts file ${filePath} does not exist. Skipping...`));
+      return;
+    }
 
-  const s3 = new S3(_getS3Config());
+    debug('File: ', filePath, ' exists');
 
-  const params = {
-    Bucket: S3_BUCKET,
-    Key,
-    Body: fileData,
-    ContentType,
-    ACL,
-  };
+    const fileData = await readFile(filePath);
+
+    Key = `${runId}/${randomUUID()}-${Key || path.basename(filePath)}`;
+
+    const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
+
+    if (!S3_BUCKET || !fileData) {
+      console.log(
+        APP_PREFIX,
+        chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`),
+        getMaskedConfig(),
+      );
+      return;
+    }
+
+    const s3 = new S3(_getS3Config());
+
+    const params = {
+      Bucket: S3_BUCKET,
+      Key,
+      Body: fileData,
+      ContentType,
+      ACL,
+    };
 
-  try {
     const out = new Upload({
       client: s3,
-      params
+      params,
     });
 
-    await out.done();
-    debug('Uploaded', out.singleUploadResult.Location)
+    const link = await getS3LocationLink(out);
 
-    return out.singleUploadResult.Location;
+    debug(`Succesfully uploaded ${filePath} => ${S3_BUCKET}/${Key} | URL: ${link}`);
+
+    return link;
   } catch (e) {
-    console.log(e);
-    console.log(APP_PREFIX, chalk.red(`Failed uploading '${Key}'. Please check S3 credentials`), getMaskedConfig());
+    debug('S3 file uploading error: ', e);
 
     console.log(APP_PREFIX, `To ${chalk.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
+
     if (!TESTOMATIO_PRIVATE_ARTIFACTS) {
       console.log(APP_PREFIX, `To enable ${chalk.bold('PRIVATE')} uploads set: TESTOMATIO_PRIVATE_ARTIFACTS=1`);
     } else {
@@ -144,20 +167,30 @@ const fileData = fs.readFileSync(filePath);
       );
     }
     console.log(APP_PREFIX, '---------------');
-  } 
+  }
 };
 
 const uploadUsingS3AsBuffer = async (buffer, fileName, runId) => {
-
-  const {
-    S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_ENDPOINT, TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET
-  } = getConfig();
+  const { S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_ENDPOINT, TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET } =
+    getConfig();
 
   const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
 
   const fileExtension = _getFileExtBase64(buffer.toString('base64'));
   const Key = `${runId}/${fileName}${fileExtension}`;
 
+  if (!S3_BUCKET || !buffer) {
+    console.log(APP_PREFIX, chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`), {
+      accessKeyId: S3_ACCESS_KEY_ID,
+      secretAccessKey: S3_SECRET_ACCESS_KEY ? '**** (hidden) ***' : '(empty)',
+      region: S3_REGION,
+      bucket: S3_BUCKET,
+      acl: ACL,
+      endpoint: S3_ENDPOINT,
+    });
+    return;
+  }
+
   const s3 = new S3(_getS3Config());
 
   try {
@@ -169,22 +202,15 @@ const uploadUsingS3AsBuffer = async (buffer, fileName, runId) => {
         Key,
         Body: buffer,
         ACL,
-      }
+      },
     });
-    await out.done();
 
-    return out.singleUploadResult.Location;
+    return await getS3LocationLink(out);
   } catch (e) {
-    console.log(APP_PREFIX, chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`), {
-      accessKeyId: S3_ACCESS_KEY_ID,
-      secretAccessKey: S3_SECRET_ACCESS_KEY ? '**** (hidden) ***' : '(empty)',
-      region: S3_REGION,
-      bucket: S3_BUCKET,
-      acl: ACL,
-      endpoint: S3_ENDPOINT,
-    });
+    debug('S3 buffer uploading error: ', e);
 
     console.log(APP_PREFIX, `To ${chalk.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
+
     if (!TESTOMATIO_PRIVATE_ARTIFACTS) {
       console.log(APP_PREFIX, `To enable ${chalk.bold('PRIVATE')} uploads set: TESTOMATIO_PRIVATE_ARTIFACTS=1`);
     } else {
@@ -203,7 +229,9 @@ const uploadFileByPath = async (filePath, runId) => {
       return uploadUsingS3(filePath, runId);
     }
   } catch (e) {
-    console.error(chalk.red('Error occurred while uploading artifacts'), e);
+    debug(e);
+
+    console.error(chalk.red('Error occurred while uploading artifacts! '), e);
   }
 };
 
@@ -213,13 +241,60 @@ const uploadFileAsBuffer = async (buffer, fileName, runId) => {
       return uploadUsingS3AsBuffer(buffer, fileName, runId);
     }
   } catch (e) {
-    console.error(chalk.red('Error occurred while uploading artifacts'), e);
+    debug(e);
+
+    console.error(chalk.red('Error occurred while uploading artifacts! '), e);
   }
 };
 
+const checkFileExists = async (filePath, attempts = 5, intervalMs = 500) => {
+  const checkFile = async () => {
+    const fileStats = await stat(filePath);
+    if (fileStats.isFile()) {
+      return true;
+    }
+
+    throw new Error('File not found');
+  };
+
+  try {
+    await promiseRetry(
+      {
+        retries: attempts,
+        minTimeout: intervalMs,
+      },
+      checkFile,
+    );
+
+    return true;
+  } catch (err) {
+    console.error(chalk.yellow(`File ${filePath} was not found or did not have time to be generated...`));
+
+    return false;
+  }
+};
+
+const getS3LocationLink = async out => {
+  const response = await out.done();
+
+  let s3Location = response?.Location;
+
+  if (!s3Location) {
+    // TODO: out: a fallback case  - remove after deeper testing
+    s3Location = out?.singleUploadResult?.Location;
+    debug('Uploaded singleUploadResult.Location', s3Location);
+
+    if (!s3Location) {
+      throw new Error("Problems getting the S3 artifact's link. Please check S3 permissions!");
+    }
+  }
+
+  return s3Location;
+};
+
 module.exports = {
-  uploadFileByPath: memoize(uploadFileByPath),
-  uploadFileAsBuffer: memoize(uploadFileAsBuffer),
+  uploadFileByPath,
+  uploadFileAsBuffer,
   isArtifactsEnabled,
   resetConfig,
 };

package/lib/junit-adapter/adapter.js

@@ -1,5 +1,4 @@
 class Adapter {
-
   constructor(opts) {
     this.opts = opts;
   }
@@ -19,7 +18,6 @@ class Adapter {
   formatMessage(t) {
     return t.message;
   }
-
 }
 
 module.exports = Adapter;

package/lib/junit-adapter/csharp.js

@@ -1,12 +1,11 @@
 const Adapter = require('./adapter');
 
 class CSharpAdapter extends Adapter {
-
   formatTest(t) {
     const title = t.title.replace(/\(.*?\)/, '').trim();
     const example = t.title.match(/\((.*?)\)/);
-    if (example) t.example = { ...example[1].split(',')};
-    const suite = t.suite_title.split('.')
+    if (example) t.example = { ...example[1].split(',') };
+    const suite = t.suite_title.split('.');
     t.suite_title = suite.pop();
     t.file = suite.join('/');
     t.title = title.trim();
@@ -14,4 +13,4 @@ class CSharpAdapter extends Adapter {
   }
 }
 
-module.exports = CSharpAdapter;
+module.exports = CSharpAdapter;

package/lib/junit-adapter/index.js

@@ -6,8 +6,6 @@ const RubyAdapter = require('./ruby');
 const CSharpAdapter = require('./csharp');
 
 function AdapterFactory(lang, opts) {
-  if (!lang) return new Adapter(opts);
-
   if (lang === 'java') {
     return new JavaAdapter(opts);
   }
@@ -23,6 +21,8 @@ function AdapterFactory(lang, opts) {
   if (lang === 'c#' || lang === 'csharp') {
     return new CSharpAdapter(opts);
   }
+
+  return new Adapter(opts);
 }
 
-module.exports = AdapterFactory;
+module.exports = AdapterFactory;

package/lib/junit-adapter/java.js

@@ -2,39 +2,57 @@ const path = require('path');
 const Adapter = require('./adapter');
 
 class JavaAdapter extends Adapter {
-
   getFilePath(t) {
-    const fileName = namespaceToFileName(t.suite_title)
+    const fileName = namespaceToFileName(t.suite_title);
     return this.opts.javaTests + path.sep + fileName;
   }
 
   formatTest(t) {
-    const fileParts = t.suite_title.split('.')
-    const example = t.title.match(/\[(.*)\]/)?.[1];
-    if (example) t.example = { "#": example }
+    const fileParts = t.suite_title.split('.');
 
     t.file = namespaceToFileName(t.suite_title);
     t.title = t.title.split('(')[0];
-    t.suite_title = fileParts[fileParts.length - 1].replace(/\$/g, ' | ')
+
+    // detect params
+    const paramMatches = t.title.match(/\[(.*?)\]/g);
+
+    if (paramMatches) {
+      const params = paramMatches.map((_match, index) => `param${index + 1}`);
+      if (params.length === 1) params[0] = 'param';
+      let paramIndex = 0;
+
+      t.title = t.title.replace(/: \[(.*?)\]/g, () => {
+        if (params.length < 2) return `\${param}`;
+        const paramName = params[paramIndex] || `param${paramIndex + 1}`;
+        paramIndex++;
+        return `\${${paramName}}`;
+      });
+      const example = {};
+      paramMatches.forEach((match, index) => {
+        example[params[index]] = match.replace(/[[\]]/g, '');
+      });
+      t.example = example;
+    }
+
+    t.suite_title = fileParts[fileParts.length - 1].replace(/\$/g, ' | ');
     return t;
   }
 
-  formatStack(t) {
-    const stack = super.formatStack(t);
+  // formatStack(t) {
+  //   const stack = super.formatStack(t);
 
-    const file = t.suite_title.split('.');
+  //   const file = t.suite_title.split('.');
 
-    const fileLine = `at .*${file[file.length - 1]}\.java:(\\d+)` // eslint-disable-line no-useless-escape
-    const regexp = new RegExp(fileLine,"g")
-    return stack.replace(regexp, `${this.opts.javaTests}${path.sep}${namespaceToFileName(t.suite_title)}:$1:`);
-  }
+  //   const fileLine = `at .*${file[file.length - 1]}\.java:(\\d+)` // eslint-disable-line no-useless-escape
+  //   const regexp = new RegExp(fileLine,"g")
+  //   return stack.replace(regexp, `${this.opts.javaTests}${path.sep}${namespaceToFileName(t.suite_title)}:$1:`);
+  // }
 }
 
 function namespaceToFileName(fileName) {
-    const fileParts = fileName.split('.')
-    fileParts[fileParts.length - 1] = fileParts[fileParts.length - 1]?.replace(/\$.*/, '')
-    return `${fileParts.join(path.sep)  }.java`;
-
+  const fileParts = fileName.split('.');
+  fileParts[fileParts.length - 1] = fileParts[fileParts.length - 1]?.replace(/\$.*/, '');
+  return `${fileParts.join(path.sep)}.java`;
 }
 
 module.exports = JavaAdapter;

package/lib/junit-adapter/javascript.js

@@ -3,12 +3,11 @@ const path = require('path');
 const Adapter = require('./adapter');
 
 class JavaScriptAdapter extends Adapter {
-
   formatStack(t) {
     let stack = super.formatStack(t);
 
     try {
-      const error = new Error(stack.split('\n')[0])
+      const error = new Error(stack.split('\n')[0]);
       error.stack = stack;
       const record = createCallsiteRecord({
         forError: error,

package/lib/junit-adapter/python.js

@@ -3,7 +3,6 @@ const fs = require('fs');
 const Adapter = require('./adapter');
 
 class PythonAdapter extends Adapter {
-
   getFilePath(t) {
     let fileName = namespaceToFileName(t.suite_title, { checkFile: true });
     if (!fileName) fileName = namespaceToFileName(t.suite_title, { checkFile: false });
@@ -11,34 +10,33 @@ class PythonAdapter extends Adapter {
   }
 
   formatTest(t) {
-    const fileParts = t.suite_title.split('.')
+    const fileParts = t.suite_title.split('.');
     const example = t.title.match(/\[(.*)\]/)?.[1];
-    if (example) t.example = { "#": example }
+    if (example) t.example = { '#': example };
 
     t.file = namespaceToFileName(t.suite_title);
     t.title = t.title.split('[')[0];
-    t.suite_title = fileParts[fileParts.length - 1].replace(/\$/g, ' | ')
+    t.suite_title = fileParts[fileParts.length - 1].replace(/\$/g, ' | ');
     return t;
   }
 
   formatMessage(t) {
     return t.message.split('
')[0];
   }
-
 }
 
 function namespaceToFileName(fileName, opts = {}) {
-    const fileParts = fileName.split('.')
+  const fileParts = fileName.split('.');
 
-    while (fileParts.length > 0) {
-      const file = `${fileParts.join(path.sep)  }.py`;
-      if (!opts.checkFile) return file;
-      if (fs.existsSync(`${fileParts.join(path.sep)  }.py`)) {
-        return file;
-      }
-      fileParts.pop();
+  while (fileParts.length > 0) {
+    const file = `${fileParts.join(path.sep)}.py`;
+    if (!opts.checkFile) return file;
+    if (fs.existsSync(`${fileParts.join(path.sep)}.py`)) {
+      return file;
     }
-    return null;
+    fileParts.pop();
+  }
+  return null;
 }
 
 module.exports = PythonAdapter;

package/lib/junit-adapter/ruby.js

@@ -1,10 +1,9 @@
 const Adapter = require('./adapter');
 
 class RubyAdapter extends Adapter {
-
   formatStack(t) {
     const stack = super.formatStack(t);
-    return stack.replace(/\[(.*?:.\d*)\]/g, '\n$1')
+    return stack.replace(/\[(.*?:.\d*)\]/g, '\n$1');
   }
 }
 

package/lib/pipe/csv.js

@@ -4,7 +4,7 @@ const fs = require('fs');
 const csvWriter = require('csv-writer');
 const chalk = require('chalk');
 const merge = require('lodash.merge');
-const { isSameTest, getCurrentDateTime } = require('../util');
+const { isSameTest, getCurrentDateTime } = require('../utils/utils');
 const { CSV_HEADERS } = require('../constants');
 
 /**
@@ -14,7 +14,6 @@ const { CSV_HEADERS } = require('../constants');
  * @implements {Pipe}
  */
 class CsvPipe {
-
   constructor(params, store) {
     this.store = store || {};
     this.title = params.title || process.env.TESTOMATIO_TITLE;
@@ -22,7 +21,7 @@ class CsvPipe {
 
     this.outputDir = 'export';
     this.csvFilename = process.env.TESTOMATIO_CSV_FILENAME;
-    this.isEnabled = !!this.csvFilename
+    this.isEnabled = !!this.csvFilename;
     this.isCsvSave = false;
 
     if (this.csvFilename !== undefined && this.csvFilename.split('.').length > 0) {
@@ -40,6 +39,9 @@ class CsvPipe {
     }
   }
 
+  // TODO: to using SET opts as argument => prepareRun(opts)
+  async prepareRun() {}
+
   async createRun() {
     // empty
   }

package/lib/pipe/github.js

@@ -4,8 +4,9 @@ const chalk = require('chalk');
 const humanizeDuration = require('humanize-duration');
 const merge = require('lodash.merge');
 const { Octokit } = require('@octokit/rest');
-const { APP_PREFIX } = require('../constants');
-const { ansiRegExp, isSameTest } = require('../util');
+const { APP_PREFIX, testomatLogoURL } = require('../constants');
+const { ansiRegExp, isSameTest } = require('../utils/utils');
+const { statusEmoji, fullName } = require('../utils/pipe_utils');
 
 /**
  * @typedef {import('../../types').Pipe} Pipe
@@ -21,7 +22,8 @@ class GitHubPipe {
     this.token = params.GH_PAT || process.env.GH_PAT;
     this.ref = process.env.GITHUB_REF;
     this.repo = process.env.GITHUB_REPOSITORY;
-    this.hiddenCommentData = `<!--- testomat.io report ${process.env.GITHUB_WORKFLOW || ''} -->`;
+    this.jobKey = `${process.env.GITHUB_WORKFLOW || ''} / ${process.env.GITHUB_JOB || ''}`;
+    this.hiddenCommentData = `<!--- testomat.io report ${this.jobKey} -->`;
 
     debug('GitHub Pipe: ', this.token ? 'TOKEN' : '*no token*', 'Ref:', this.ref, 'Repo:', this.repo);
 
@@ -36,6 +38,9 @@ class GitHubPipe {
     debug('GitHub Pipe: Enabled');
   }
 
+  // TODO: to using SET opts as argument => prepareRun(opts)
+  async prepareRun() {}
+
   async createRun() {}
 
   addTest(test) {
@@ -72,36 +77,34 @@ class GitHubPipe {
 
     let summary = `${this.hiddenCommentData}
 
-| [![Testomat.io Report](https://avatars.githubusercontent.com/u/59105116?s=36&v=4)](https://testomat.io)  | ${
-  statusEmoji(runParams.status,)} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
+| [![Testomat.io Report](${testomatLogoURL})](https://testomat.io)  | ${statusEmoji(
+      runParams.status,
+    )} ${`${process.env.GITHUB_JOB} ${runParams.status}`.toUpperCase()} |
 | --- | --- |        
 | Tests | ✔️  **${this.tests.length}** tests run  |
-| Summary | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji(
+| Summary | ${failedCount ? `${statusEmoji('failed')} **${failedCount}** failed; ` : ''} ${statusEmoji(
       'passed',
     )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
-| Duration | 🕐  **${humanizeDuration(parseInt(this.tests.reduce((a, t) => a + (t.run_time || 0), 0), 10), {
-      maxDecimalPoints: 0,
-    })}** |
-`;
+| Duration | 🕐  **${humanizeDuration(
+      parseInt(
+        this.tests.reduce((a, t) => a + (t.run_time || 0), 0),
+        10,
+      ),
+      {
+        maxDecimalPoints: 0,
+      },
+    )}** |`;
+
     if (this.store.runUrl) {
-      summary += `| Testomat.io Report | 📊 [Run #${this.store.runId}](${this.store.runUrl})  | `;
+      summary += `\n| Testomat.io Report | 📊 [Run #${this.store.runId}](${this.store.runUrl})  | `;
     }
     if (process.env.GITHUB_WORKFLOW) {
-      summary += `| Workflow | 🗂️  ${process.env.GITHUB_WORKFLOW} | `;
+      summary += `\n| Job | 🗂️  [${this.jobKey}](${process.env.GITHUB_SERVER_URL || 'https://github.com'}/${
+        this.repo
+      }/actions/runs/${process.env.GITHUB_RUN_ID}) | `;
     }
     if (process.env.RUNNER_OS) {
-      summary += `| Operating System | 🖥️ \`${process.env.RUNNER_OS}\` ${process.env.RUNNER_ARCH || ''} | `;
-    }
-    if (process.env.GITHUB_HEAD_REF) {
-      summary += `| Branch | 🌳  \`${process.env.GITHUB_HEAD_REF}\` | `;
-    }
-    if (process.env.GITHUB_RUN_ATTEMPT) {
-      summary += `| Run Attempt | 🌒  \`${process.env.GITHUB_RUN_ATTEMPT}\` | `;
-    }
-    if (process.env.GITHUB_RUN_ID) {
-      summary += `| Build Log | ✒️  ${process.env.GITHUB_SERVER_URL || 'https://github.com'}/${
-        this.repo
-      }/actions/runs/${process.env.GITHUB_RUN_ID} | `;
+      summary += `\n| Operating System | 🖥️ \`${process.env.RUNNER_OS}\` ${process.env.RUNNER_ARCH || ''} | `;
     }
 
     const failures = this.tests
@@ -184,21 +187,6 @@ class GitHubPipe {
   }
 }
 
-function statusEmoji(status) {
-  if (status === 'passed') return '🟢';
-  if (status === 'failed') return '🔴';
-  if (status === 'skipped') return '🟡';
-  return '';
-}
-
-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;
-}
-
 async function deletePreviousReport(octokit, owner, repo, issue, hiddenCommentData) {
   if (process.env.GH_KEEP_OUTDATED_REPORTS) return;