@testomatio/reporter 0.8.0-beta.9 → 0.8.1

package/lib/fileUploader.js

@@ -1,4 +1,6 @@
-const AWS = require('aws-sdk');
+const debug = require('debug')('@testomatio/reporter:file-uploader');
+const { S3 } = require('@aws-sdk/client-s3');
+const { Upload } = require('@aws-sdk/lib-storage');
 const fs = require('fs');
 const path = require('path');
 const chalk = require('chalk');
@@ -6,18 +8,38 @@ const { randomUUID } = require('crypto');
 const memoize = require('lodash.memoize');
 const { APP_PREFIX } = require('./constants');
 
-const {
-  S3_ENDPOINT,
-  S3_REGION,
-  S3_BUCKET,
-  S3_ACCESS_KEY_ID,
-  S3_SECRET_ACCESS_KEY,
-  TESTOMATIO_DISABLE_ARTIFACTS,
-  TESTOMATIO_PRIVATE_ARTIFACTS,
-  S3_FORCE_PATH_STYLE,
-} = process.env;
-
-const isArtifactsEnabled = S3_BUCKET && !TESTOMATIO_DISABLE_ARTIFACTS;
+const keys = [
+  'S3_ENDPOINT',
+  'S3_REGION',
+  'S3_BUCKET',
+  'S3_ACCESS_KEY_ID',
+  'S3_SECRET_ACCESS_KEY',
+  'TESTOMATIO_DISABLE_ARTIFACTS',
+  'TESTOMATIO_PRIVATE_ARTIFACTS',
+  'S3_FORCE_PATH_STYLE',
+];
+
+let config;
+
+function getConfig() {
+  if (config) return config;
+  config = keys.reduce((acc, key) => {
+    acc[key] = process.env[key];
+    return acc;
+  }, {});
+  debug('Config', config);
+  return config;
+}
+
+let isEnabled;
+
+const isArtifactsEnabled = () => {
+  if (isEnabled !== undefined) return isEnabled;
+  const { S3_BUCKET, TESTOMATIO_DISABLE_ARTIFACTS } = getConfig();
+  isEnabled = !!(S3_BUCKET && !TESTOMATIO_DISABLE_ARTIFACTS);
+  debug(`Upload is ${isEnabled ? 'enabled' : 'disabled'}`);
+  return isEnabled;
+};
 
 const _getFileExtBase64 = str => {
   const type = str.charAt(0);
@@ -32,6 +54,25 @@ const _getFileExtBase64 = str => {
   );
 };
 
+const _getS3Config = () => {
+  const { S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_FORCE_PATH_STYLE, S3_ENDPOINT } = getConfig();
+
+  const cfg = {
+    region: S3_REGION,
+    credentials: {
+      accessKeyId: S3_ACCESS_KEY_ID,
+      secretAccessKey: S3_SECRET_ACCESS_KEY,
+      s3ForcePathStyle: S3_FORCE_PATH_STYLE,
+    }
+  };
+
+  if (S3_ENDPOINT) {
+    cfg.endpoint = S3_ENDPOINT;
+  }
+
+  return cfg;
+}
+
 const uploadUsingS3 = async (filePath, runId) => {
   let ContentType;
   let Key;
@@ -42,40 +83,39 @@ const uploadUsingS3 = async (filePath, runId) => {
     Key = filePath.name;
   }
 
-  const config = {
-    region: S3_REGION,
-    accessKeyId: S3_ACCESS_KEY_ID,
-    secretAccessKey: S3_SECRET_ACCESS_KEY,
-    s3ForcePathStyle: S3_FORCE_PATH_STYLE,
-  };
-
-  if (S3_ENDPOINT) {
-    config.endpoint = new AWS.Endpoint(S3_ENDPOINT);
-  }
-
-  const s3 = new AWS.S3(config);
   if (!fs.existsSync(filePath)) {
     console.error(chalk.yellow(`Artifacts file ${filePath} does not exist. Skipping...`));
     return;
   }
+
+  const {
+    S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_ENDPOINT, TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET
+  } = getConfig();
   
   const file = fs.readFileSync(filePath);
 
   Key = `${runId}/${randomUUID()}-${Key || path.basename(filePath)}`;
   const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
 
+  const s3 = new S3(_getS3Config());
+
   try {
-    const out = await s3
-      .upload({
+    const out = new Upload({
+      client: s3,
+
+      params: {
         Bucket: S3_BUCKET,
         Key,
         Body: file,
         ContentType,
         ACL,
-      })
-      .promise();
+      }
+    });
 
-    return out.Location;
+    await out.done();
+    debug('Uploaded', out.singleUploadResult.Location)
+
+    return out.singleUploadResult.Location;
   } catch (e) {
     console.log(APP_PREFIX, chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`), {
       accessKeyId: S3_ACCESS_KEY_ID,
@@ -100,35 +140,32 @@ const uploadUsingS3 = async (filePath, runId) => {
 };
 
 const uploadUsingS3AsBuffer = async (buffer, fileName, runId) => {
-  const config = {
-    region: S3_REGION,
-    accessKeyId: S3_ACCESS_KEY_ID,
-    secretAccessKey: S3_SECRET_ACCESS_KEY,
-    s3ForcePathStyle: S3_FORCE_PATH_STYLE,
-  };
-
-  if (S3_ENDPOINT) {
-    config.endpoint = new AWS.Endpoint(S3_ENDPOINT);
-  }
 
-  const s3 = new AWS.S3(config);
+  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}`;
 
+  const s3 = new S3(_getS3Config());
+
   try {
-    const out = await s3
-      .upload({
+    const out = new Upload({
+      client: s3,
+
+      params: {
         Bucket: S3_BUCKET,
         Key,
         Body: buffer,
         ACL,
-      })
-      .promise();
+      }
+    });
+    await out.done();
 
-    return out.Location;
+    return out.singleUploadResult.Location;
   } catch (e) {
     console.log(APP_PREFIX, chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`), {
       accessKeyId: S3_ACCESS_KEY_ID,
@@ -154,7 +191,7 @@ const uploadUsingS3AsBuffer = async (buffer, fileName, runId) => {
 
 const uploadFileByPath = async (filePath, runId) => {
   try {
-    if (isArtifactsEnabled) {
+    if (isArtifactsEnabled()) {
       return uploadUsingS3(filePath, runId);
     }
   } catch (e) {
@@ -164,7 +201,7 @@ const uploadFileByPath = async (filePath, runId) => {
 
 const uploadFileAsBuffer = async (buffer, fileName, runId) => {
   try {
-    if (isArtifactsEnabled) {
+    if (isArtifactsEnabled()) {
       return uploadUsingS3AsBuffer(buffer, fileName, runId);
     }
   } catch (e) {
@@ -175,5 +212,5 @@ const uploadFileAsBuffer = async (buffer, fileName, runId) => {
 module.exports = {
   uploadFileByPath: memoize(uploadFileByPath),
   uploadFileAsBuffer: memoize(uploadFileAsBuffer),
-  isArtifactsEnabled,
+  isArtifactsEnabled: memoize(isArtifactsEnabled),
 };

package/lib/junit-adapter/csharp.js

@@ -14,5 +14,4 @@ class CSharpAdapter extends Adapter {
   }
 }
 
-
 module.exports = CSharpAdapter;

package/lib/junit-adapter/index.js

@@ -5,8 +5,7 @@ const PythonAdapter = require('./python');
 const RubyAdapter = require('./ruby');
 const CSharpAdapter = require('./csharp');
 
-
-module.exports = function (lang, opts) {
+function AdapterFactory(lang, opts) {
   if (!lang) return new Adapter(opts);
 
   if (lang === 'java') {
@@ -25,3 +24,5 @@ module.exports = function (lang, opts) {
     return new CSharpAdapter(opts);
   }
 }
+
+module.exports = AdapterFactory;

package/lib/pipe/csv.js

@@ -0,0 +1,133 @@
+const debug = require('debug')('@testomatio/reporter:pipe:csv');
+const path = require('path');
+const fs = require('fs');
+const csvWriter = require('csv-writer');
+const chalk = require('chalk');
+const merge = require('lodash.merge');
+const { isSameTest, getCurrentDateTime } = require('../util');
+const { CSV_HEADERS } = require('../constants');
+
+/**
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
+ * @class CsvPipe
+ * @implements {Pipe}
+ */
+class CsvPipe {
+
+  constructor(params, store) {
+    this.store = store || {};
+    this.title = params.title || process.env.TESTOMATIO_TITLE;
+    this.isEnabled = true;
+    this.results = [];
+
+    this.outputDir = 'export';
+    this.csvFilename = process.env.TESTOMATIO_CSV_FILENAME;
+    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`,
+        );
+      }
+    }
+  }
+
+  async createRun() {
+    // empty
+  }
+
+  updateRun() {}
+
+  /**
+   * Create a folder that will contain the exported files
+   */
+  checkExportDir() {
+    if (!fs.existsSync(this.outputDir)) {
+      return fs.mkdirSync(this.outputDir);
+    }
+  }
+
+  /**
+   * Save data to the csv file.
+   * @param {Object} data - data that will be added to the CSV file.
+   * Example: [{suite_title: "Suite #1", test: "Test-case-1", message: "Test msg"}]
+   * @param {Object} headers - csv file headers. Example: [{ id: 'suite_title', title: 'Suite_title' }]
+   */
+  async saveToCsv(data, headers) {
+    debug('Data', data);
+    // First, we check whether the export directory exists: if yes - OK, no - create it.
+    this.checkExportDir();
+
+    if (!this.outputFile) {
+      console.log(this, 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
+    try {
+      await writer.writeRecords(data);
+      console.log(this, chalk.green(`Recording completed! You can check the result in file = ${this.outputFile}`));
+    } catch (e) {
+      console.log('Unknown error: ', e);
+    }
+  }
+
+  /**
+   * Add test data to the result array for saving. As a result of this function, we get a result object to save.
+   * @param {Object} test - object which includes each test entry.
+   */
+  addTest(test) {
+    if (!this.isEnabled) return;
+
+    const index = this.results.findIndex(t => isSameTest(t, test));
+    // update if they were already added
+    if (index >= 0) {
+      this.results[index] = merge(this.results[index], test);
+      return;
+    }
+
+    const { suite_title, title, status, message, stack } = test;
+
+    this.results.push({
+      suite_title,
+      title,
+      status,
+      message,
+      stack,
+    });
+  }
+
+  /**
+   * @param {{ tests?: TestData[] }} runParams
+   * @returns {Promise<void>}
+   */
+  async finishRun(runParams) {
+    if (!this.isEnabled) return;
+
+    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);
+    }
+  }
+
+  toString() {
+    return 'csv exporter';
+  }
+}
+
+module.exports = CsvPipe;

package/lib/pipe/github.js

@@ -1,65 +1,68 @@
+const debug = require('debug')('@testomatio/reporter:pipe:github');
+const path = require('path');
 const chalk = require('chalk');
-const { Octokit } = require("@octokit/rest");
+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 merge = require('lodash.merge');
-
 
+/**
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
+ * @class GitHubPipe
+ * @implements {Pipe}
+ */
 class GitHubPipe {
-
-  isEnabled = false;
-
   constructor(params, store = {}) {
+    this.isEnabled = false;
     this.store = store;
-    this.tests = []
+    this.tests = [];
     this.token = params.GH_PAT || process.env.GH_PAT;
-    this.ref = process.env.GITHUB_REF
-    this.repo = process.env.GITHUB_REPOSITORY
+    this.ref = process.env.GITHUB_REF;
+    this.repo = process.env.GITHUB_REPOSITORY;
+    this.hiddenCommentData = `<!--- testomat.io report ${process.env.GITHUB_WORKFLOW || ''} -->`;
 
-    if (process.env.DEBUG) {
-      console.log(APP_PREFIX, 'GitHub Pipe: ', this.token ? 'TOKEN' : '*no token*', this.ref, this.repo);  
-    }
+    debug('GitHub Pipe: ', this.token ? 'TOKEN' : '*no token*', 'Ref:', this.ref, 'Repo:', this.repo);
 
     if (!this.token || !this.ref || !this.repo) return;
     this.isEnabled = true;
     const matchedIssue = this.ref.match(/refs\/pull\/(\d+)\/merge/);
     if (!matchedIssue) return;
-    this.issue = matchedIssue[1]    
+    this.issue = parseInt(matchedIssue[1], 10);
+
     this.start = new Date();
 
-    if (process.env.DEBUG) {
-      console.log(APP_PREFIX, 'GitHub Pipe: Enabled');  
-    }
+    debug('GitHub Pipe: Enabled');
   }
-  
-  async createRun() {}
 
-  updateRun() {}
+  async createRun() {}
 
   addTest(test) {
+    debug('Adding test:', test);
     if (!this.isEnabled) return;
 
-    const index = this.tests.findIndex(t => isSameTest(t, test))    
+    const index = this.tests.findIndex(t => isSameTest(t, test));
     // update if they were already added
     if (index >= 0) {
       this.tests[index] = merge(this.tests[index], test);
       return;
     }
 
-    this.tests.push(test)
+    this.tests.push(test);
   }
 
   async finishRun(runParams) {
     if (!this.isEnabled) return;
+    if (!this.issue) return;
 
     if (runParams.tests) runParams.tests.forEach(t => this.addTest(t));
-    
 
     this.octokit = new Octokit({
       auth: this.token,
     });
 
-    const [owner, repo] = this.repo.split('/');
+    const [owner, repo] = (this.repo || '').split('/');
     if (!(owner || repo)) return;
 
     // ... create a comment on GitHub
@@ -67,15 +70,17 @@ class GitHubPipe {
     const failedCount = this.tests.filter(t => t.status === 'failed').length;
     const skippedCount = this.tests.filter(t => t.status === 'skipped').length;
 
-    let summary = `
-### Run Report
+    let summary = `${this.hiddenCommentData}
 
-|  | ${statusEmoji(runParams.status)} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
+| [![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)} |
 | --- | --- |        
 | Tests | ✔️  **${this.tests.length}** tests run  |
-| Summary | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji('passed')} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
-| Duration | 🕐  **${parseFloat(this.tests.reduce((a, t) => a + (t.run_time || 0), 0)).toFixed(2)}**ms |
-`
+| Summary | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji(
+      'passed',
+    )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
+| Duration | 🕐  **${humanizeDuration(parseFloat(this.tests.reduce((a, t) => a + (t.run_time || 0), 0)))}** |
+`;
     if (this.store.runUrl) {
       summary += `| Testomat.io Report | 📊 [Run #${this.store.runId}](${this.store.runUrl})  | `;
     }
@@ -92,71 +97,89 @@ class GitHubPipe {
       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 += `| Build Log | ✒️  ${process.env.GITHUB_SERVER_URL || 'https://github.com'}/${
+        this.repo
+      }/actions/runs/${process.env.GITHUB_RUN_ID} | `;
     }
 
+    const failures = this.tests
+      .filter(t => t.status === 'failed')
+      .slice(0, 20)
+      .map(t => {
+        let text = `#### ${statusEmoji('failed')} ${fullName(t)} `;
+        text += '\n\n';
+        if (t.message)
+          text += `> ${t.message
+            .replace(/[^\x20-\x7E]/g, '')
+            .replace(ansiRegExp(), '')
+            .trim()}\n`;
+        if (t.stack) text += `\`\`\`diff\n${t.stack.replace(ansiRegExp(), '').trim()}\n\`\`\`\n`;
+
+        if (t.artifacts && t.artifacts.length && !process.env.TESTOMATIO_PRIVATE_ARTIFACTS) {
+          t.artifacts
+            .filter(f => !!f)
+            .filter(f => f.endsWith('.png'))
+            .forEach(f => {
+              if (f.endsWith('.png')) {
+                text += `![](${f})\n`;
+                return text;
+              }
+              text += `[📄 ${path.basename(f)}](${f})\n`;
+              return text;
+            });
+        }
+
+        text += '\n---\n';
+
+        return text;
+      });
 
-    const failures = this.tests.filter(t => t.status === 'failed').slice(0, 20).map(t => {
-      let text = `#### ${statusEmoji('failed')} ${fullName(t)} `;
-      text += "\n\n"
-      if (t.message) text += "> " + t.message.replace(/[^\x20-\x7E]/g, '').replace(ansiRegExp(), '').trim() + "\n"
-      if (t.stack) text += "```diff\n" + t.stack.replace(ansiRegExp(), '').trim() + "\n```\n";
-      
-      if (t.artifacts && t.artifacts.length && !process.env.TESTOMATIO_PRIVATE_ARTIFACTS) {
-        t.artifacts.filter(f => f.endsWith('.png')).forEach(f => {
-          if (f.endsWith('.png')) return text+= `![](${f})\n`    
-        });
-      }
-
-      text += "\n---\n"
-
-      return text;
-    })
-    
     let body = summary;
 
     if (failures.length) {
-      body += `\n<details>\n<summary><h3>🟥 Failures (${failures.length})</h4></summary>\n${failures.join('\n')} \n</details>\n`;
-    }
-
-    if (failures.length > 20) {
-      body += "\n> Notice\n> Only first 20 failures shown*"
+      body += `\n<details>\n<summary><h3>🟥 Failures (${failures.length})</h4></summary>\n\n${failures.join('\n')}\n`;
+      if (failures.length > 20) {
+        body += '\n> Notice\n> Only first 20 failures shown*';
+      }
+      body += '\n\n</details>';
     }
 
     if (this.tests.length > 0) {
-      body += "\n### 🐢 Slowest Tests\n\n"
-      body += this.tests.sort((a, b) => b?.run_time - a?.run_time).slice(0, 5).map(t => {
-        return `* ${fullName(t)} (${parseFloat(t.run_time).toFixed(2)}ms)`
-      }).join('\n')
+      body += '\n<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n';
+      body += this.tests
+        // eslint-disable-next-line no-unsafe-optional-chaining
+        .sort((a, b) => b?.run_time - a?.run_time)
+        .slice(0, 5)
+        .map(t => `* ${fullName(t)} (${humanizeDuration(parseFloat(t.run_time))})`)
+        .join('\n');
+      body += '\n</details>';
     }
+    
 
+    await deletePreviousReport(this.octokit, owner, repo, this.issue, this.hiddenCommentData);
+
+    // add report as comment
     try {
+      debug('Adding comment\n', body);
       const resp = await this.octokit.rest.issues.createComment({
         owner,
         repo,
         issue_number: this.issue,
         body,
       });
-  
+
       const url = resp.data?.html_url;
+      debug('Comment URL:', url);
       this.store.githubUrl = url;
-  
-      console.log(
-        APP_PREFIX,
-        chalk.yellow('GitHub'),
-        `Report created: ${chalk.magenta(url)}`,
-      );
+
+      console.log(APP_PREFIX, chalk.yellow('GitHub'), `Report created: ${chalk.magenta(url)}`);
     } catch (err) {
-      console.log(
-        APP_PREFIX,
-        chalk.yellow('GitHub'),
-        `Couldn't create GitHub report ${err}`,
-      );
+      console.log(APP_PREFIX, chalk.yellow('GitHub'), `Couldn't create GitHub report ${err}`);
     }
   }
 
   toString() {
-    return 'GitHub Reporter'
+    return 'GitHub Reporter';
   }
 }
 
@@ -164,15 +187,56 @@ function statusEmoji(status) {
   if (status === 'passed') return '🟢';
   if (status === 'failed') return '🔴';
   if (status === 'skipped') return '🟡';
-  return ''
+  return '';
 }
 
 function fullName(t) {
   let line = '';
-  if (t.suite_title) line = `${t.suite_title}: `; 
-  line += `**${t.title}**`  
+  if (t.suite_title) line = `${t.suite_title}: `;
+  line += `**${t.title}**`;
   if (t.example) line += ` \`[${Object.values(t.example)}]\``;
   return line;
 }
 
-module.exports = GitHubPipe;
+async function deletePreviousReport(octokit, owner, repo, issue, hiddenCommentData) {
+  if (process.env.GITHUB_KEEP_OUTDATED_REPORTS) return;
+
+  // get comments
+  let comments = [];
+  try {
+    const response = await octokit.rest.issues.listComments({
+      owner,
+      repo,
+      issue_number: issue,
+    });
+    comments = response.data;
+  } catch (e) {
+    console.error('Error while attempt to retrieve comments on GitHub Pull Request:\n', e);
+  }
+
+  if (!comments.length) return;
+
+  for (const comment of comments) {
+    // if comment was left by the same workflow
+    if (comment.body.includes(hiddenCommentData)) {
+      try {
+        // delete previous comment
+        await octokit.rest.issues.deleteComment({
+          owner,
+          repo,
+          issue_number: issue,
+          comment_id: comment.id,
+        });
+      } catch (e) {
+        console.warn(`Can't delete previously added comment with testomat.io report. Ignore.`);
+      }
+
+      // pass next env var if need to clear all previous reports;
+      // only the last one is removed by default
+      if (!process.env.GITHUB_REMOVE_ALL_OUTDATED_REPORTS) break;
+      // TODO: in case of many reports should implement pagination
+    }
+  }
+}
+
+module.exports = GitHubPipe;