@testomatio/reporter 1.4.1-beta-1 → 1.4.1

package/lib/fileUploader.js

@@ -11,7 +11,6 @@ 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');
 
@@ -21,6 +20,7 @@ const keys = [
   'S3_BUCKET',
   'S3_ACCESS_KEY_ID',
   'S3_SECRET_ACCESS_KEY',
+  'S3_SESSION_TOKEN',
   'TESTOMATIO_DISABLE_ARTIFACTS',
   'TESTOMATIO_PRIVATE_ARTIFACTS',
   'S3_FORCE_PATH_STYLE',
@@ -43,8 +43,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;
@@ -71,7 +75,8 @@ const _getFileExtBase64 = str => {
 };
 
 const _getS3Config = () => {
-  const { S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_FORCE_PATH_STYLE, S3_ENDPOINT } = getConfig();
+  const { S3_REGION, S3_SESSION_TOKEN, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_FORCE_PATH_STYLE, S3_ENDPOINT } =
+    getConfig();
 
   const cfg = {
     region: S3_REGION,
@@ -79,35 +84,35 @@ const _getS3Config = () => {
       accessKeyId: S3_ACCESS_KEY_ID,
       secretAccessKey: S3_SECRET_ACCESS_KEY,
       s3ForcePathStyle: S3_FORCE_PATH_STYLE,
-    }
+    },
   };
 
+  if (S3_SESSION_TOKEN) {
+    cfg.credentials.sessionToken = S3_SESSION_TOKEN;
+  }
+
   if (S3_ENDPOINT) {
     cfg.endpoint = S3_ENDPOINT;
   }
 
   return cfg;
-}
+};
 
 const uploadUsingS3 = async (filePath, runId) => {
   let ContentType;
   let Key;
-  let s3FileLocation;
 
   if (typeof filePath === 'object') {
-    ContentType = filePath.type;
-    filePath = filePath.path;
-    Key = filePath.name;
+    ContentType = filePath?.type;
+    filePath = filePath?.path;
+    Key = filePath?.name;
   }
 
-  const {
-    TESTOMATIO_PRIVATE_ARTIFACTS,
-    S3_BUCKET
-  } = getConfig();
+  const { TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET } = getConfig();
 
   try {
     debug('S3 config', getMaskedConfig());
-    debug('Try upload', filePath, 'to', S3_BUCKET);
+    debug('Started upload', filePath, 'to ', S3_BUCKET);
 
     // Verification that the file was actually created: 20 attempts of 0.5 second => 10sec
     const isFileExist = await checkFileExists(filePath, 20, 500);
@@ -117,7 +122,7 @@ const uploadUsingS3 = async (filePath, runId) => {
       return;
     }
 
-    debug('Yes, ', filePath, 'is exist.');
+    debug('File: ', filePath, ' exists');
 
     const fileData = await readFile(filePath);
 
@@ -128,7 +133,9 @@ const uploadUsingS3 = async (filePath, runId) => {
     if (!S3_BUCKET || !fileData) {
       console.log(
         APP_PREFIX,
-        chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`), getMaskedConfig());
+        chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`),
+        getMaskedConfig(),
+      );
       return;
     }
 
@@ -144,20 +151,16 @@ const uploadUsingS3 = async (filePath, runId) => {
 
     const out = new Upload({
       client: s3,
-      params
+      params,
     });
 
-    const result = await out.done();
+    const link = await getS3LocationLink(out);
 
-    s3FileLocation = result?.Location;
-    debug('Uploaded location', s3FileLocation);
+    debug(`Succesfully uploaded ${filePath} => ${S3_BUCKET}/${Key} | URL: ${link}`);
 
-    return s3FileLocation || console.log(
-      chalk.bold.red(`Problems getting the S3 artifact's link , contact the ${APP_PREFIX} team!`)
-    );
-  }
-  catch (e) {
-    console.log(e);
+    return link;
+  } catch (e) {
+    debug('S3 file uploading error: ', e);
 
     console.log(APP_PREFIX, `To ${chalk.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
 
@@ -174,11 +177,8 @@ const uploadUsingS3 = async (filePath, runId) => {
 };
 
 const uploadUsingS3AsBuffer = async (buffer, fileName, runId) => {
-  let s3BufferLocation;
-
-  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';
 
@@ -208,19 +208,12 @@ const uploadUsingS3AsBuffer = async (buffer, fileName, runId) => {
         Key,
         Body: buffer,
         ACL,
-      }
+      },
     });
-    const result = await out.done();
-
-    s3BufferLocation = result?.Location;
-    debug('Uploaded location', s3BufferLocation);
 
-    return s3BufferLocation || console.log(
-      chalk.bold.red(`Problems getting the S3 artifact's link , contact the ${APP_PREFIX} team!`)
-    );
-  }
-  catch (e) {
-    console.log(e);
+    return await getS3LocationLink(out);
+  } catch (e) {
+    debug('S3 buffer uploading error: ', e);
 
     console.log(APP_PREFIX, `To ${chalk.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
 
@@ -242,7 +235,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);
   }
 };
 
@@ -252,7 +247,9 @@ 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);
   }
 };
 
@@ -268,26 +265,42 @@ const checkFileExists = async (filePath, attempts = 5, intervalMs = 500) => {
 
   try {
     await promiseRetry(
-      { 
+      {
         retries: attempts,
-        minTimeout: intervalMs 
+        minTimeout: intervalMs,
       },
-      checkFile
+      checkFile,
     );
 
     return true;
   } catch (err) {
-    console.error(
-      chalk.yellow(`File ${filePath} was not found or did not have time to be generated...`)
-    );
+    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,14 +2,13 @@ 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 fileParts = t.suite_title.split('.');
 
     t.file = namespaceToFileName(t.suite_title);
     t.title = t.title.split('(')[0];
@@ -21,19 +20,21 @@ class JavaAdapter extends Adapter {
       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}`
+        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, '') });
+      paramMatches.forEach((match, index) => {
+        example[params[index]] = match.replace(/[[\]]/g, '');
+      });
       t.example = example;
     }
 
-    t.suite_title = fileParts[fileParts.length - 1].replace(/\$/g, ' | ')
+    t.suite_title = fileParts[fileParts.length - 1].replace(/\$/g, ' | ');
     return t;
   }
 
@@ -49,10 +50,9 @@ class JavaAdapter extends Adapter {
 }
 
 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('../utils/utils');
+const { isSameTest, getCurrentDateTime, ansiRegExp } = require('../utils/utils');
 const { CSV_HEADERS } = require('../constants');
 
 /**
@@ -14,35 +14,37 @@ const { CSV_HEADERS } = require('../constants');
  * @implements {Pipe}
  */
 class CsvPipe {
-
   constructor(params, store) {
     this.store = store || {};
     this.title = params.title || process.env.TESTOMATIO_TITLE;
     this.results = [];
 
     this.outputDir = 'export';
+    this.defaultReportName = 'report.csv';
     this.csvFilename = process.env.TESTOMATIO_CSV_FILENAME;
-    this.isEnabled = !!this.csvFilename
-    this.isCsvSave = false;
-
-    if (this.csvFilename !== undefined && this.csvFilename.split('.').length > 0) {
-      this.isCsvSave = true;
-
-      if (this.csvFilename.split('.')[0] === 'report') {
-        this.outputFile = path.resolve(process.cwd(), this.outputDir, 'report.csv');
-      } else {
-        this.outputFile = path.resolve(
-          process.cwd(),
-          this.outputDir,
-          `${getCurrentDateTime()}_${this.csvFilename.split('.')[0]}.csv`,
-        );
+    this.isEnabled = false;
+
+    if (this.csvFilename) {
+      const filenameParts = this.csvFilename.split('.');
+
+      if (filenameParts.length > 0) {
+        this.isEnabled = true;
+        const baseFilename = filenameParts[0];
+        const defaultOutputFile = path.resolve(process.cwd(), this.outputDir, this.defaultReportName);
+
+        const outputFile =
+          baseFilename === this.defaultReportName.split('.')[0] // = 'report'
+            ? defaultOutputFile
+            : path.resolve(process.cwd(), this.outputDir, `${getCurrentDateTime()}_${baseFilename}.csv`);
+
+        this.outputFile = outputFile;
       }
     }
   }
 
   // TODO: to using SET opts as argument => prepareRun(opts)
   async prepareRun() {}
-  
+
   async createRun() {
     // empty
   }
@@ -70,22 +72,22 @@ class CsvPipe {
     this.checkExportDir();
 
     if (!this.outputFile) {
-      console.log(this, chalk.yellow(`CSV file is not set, ignoring`));
+      console.log(chalk.yellow(`⚠️  CSV file is not set, ignoring`));
       return;
     }
 
-    console.log(this, chalk.yellow(`The test results will be added to the csv. It will take some time...`));
-    // Create csv writer object
-    const writer = csvWriter.createObjectCsvWriter({
-      path: this.outputFile,
-      header: headers,
-    });
-    // Save csv file based on the current data
+    console.log(chalk.yellow(`⏳ The test results will be added to the csv. It will take some time...`));
+
     try {
-      await writer.writeRecords(data);
-      console.log(this, chalk.green(`Recording completed! You can check the result in file = ${this.outputFile}`));
+      // Create csv writer object
+      const writer = csvWriter.createObjectCsvWriter({
+        path: this.outputFile,
+        header: headers,
+      });
+      // Save csv file based on the current data
+      return await writer.writeRecords(data);
     } catch (e) {
-      console.log('Unknown error: ', e);
+      console.log('Unknown csv error: ', e);
     }
   }
 
@@ -109,8 +111,8 @@ class CsvPipe {
       suite_title,
       title,
       status,
-      message,
-      stack,
+      message: message.replace(ansiRegExp(), ''),
+      stack: stack.replace(ansiRegExp(), ''),
     });
   }
 
@@ -123,8 +125,9 @@ class CsvPipe {
 
     if (runParams.tests) runParams.tests.forEach(t => this.addTest(t));
     // Save results based on the default headers
-    if (this.isCsvSave) {
-      this.saveToCsv(this.results, CSV_HEADERS);
+    if (this.isEnabled) {
+      await this.saveToCsv(this.results, CSV_HEADERS);
+      console.log(chalk.green(`🗃️  Recording completed! You can check the result in file = ${this.outputFile}`));
     }
   }
 

package/lib/pipe/github.js

@@ -4,7 +4,7 @@ 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 { APP_PREFIX, testomatLogoURL } = require('../constants');
 const { ansiRegExp, isSameTest } = require('../utils/utils');
 const { statusEmoji, fullName } = require('../utils/pipe_utils');
 
@@ -77,8 +77,9 @@ 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,)} ${`${process.env.GITHUB_JOB} ${runParams.status}`.toUpperCase()} |
+| [![Testomat.io Report](${testomatLogoURL})](https://testomat.io)  | ${statusEmoji(
+      runParams.status,
+    )} ${`${process.env.GITHUB_JOB} ${runParams.status}`.toUpperCase()} |
 | --- | --- |        
 | Tests | ✔️  **${this.tests.length}** tests run  |
 | Summary | ${failedCount ? `${statusEmoji('failed')} **${failedCount}** failed; ` : ''} ${statusEmoji(

package/lib/pipe/gitlab.js

@@ -4,7 +4,7 @@ const chalk = require('chalk');
 const humanizeDuration = require('humanize-duration');
 const merge = require('lodash.merge');
 const path = require('path');
-const { APP_PREFIX } = require('../constants');
+const { APP_PREFIX, testomatLogoURL } = require('../constants');
 const { ansiRegExp, isSameTest } = require('../utils/utils');
 const { statusEmoji, fullName } = require('../utils/pipe_utils');
 
@@ -23,7 +23,7 @@ class GitLabPipe {
     this.store = store;
     this.tests = [];
     // GitLab PAT looks like glpat-nKGdja3jsG4850sGksh7
-    this.token = params.GITLAB_PAT || this.ENV.GITLAB_PAT;
+    this.token = params.GITLAB_PAT || process.env.GITLAB_PAT || this.ENV.GITLAB_PAT;
     this.hiddenCommentData = `<!--- testomat.io report ${process.env.CI_JOB_NAME || ''} -->`;
 
     debug(
@@ -77,17 +77,24 @@ class GitLabPipe {
 
     // constructing the table
     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,
+  )} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
   | --- | --- |
   | Tests | ✔️  **${this.tests.length}** tests run  |
   | Summary | ${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,
-  })}** |
+    'passed',
+  )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
+  | Duration | 🕐  **${humanizeDuration(
+    parseInt(
+      this.tests.reduce((a, t) => a + (t.run_time || 0), 0),
+      10,
+    ),
+    {
+      maxDecimalPoints: 0,
+    },
+  )}** |
   `;
 
     if (this.ENV.CI_JOB_NAME && this.ENV.CI_JOB_ID) {