@testomatio/reporter 1.3.1-beta → 1.3.1-beta.1-exclude-skipped-tests

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, ansiRegExp } = require('../utils/utils');
 const { CSV_HEADERS } = require('../constants');
 
 /**
@@ -14,32 +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
   }
@@ -67,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);
     }
   }
 
@@ -106,8 +111,8 @@ class CsvPipe {
       suite_title,
       title,
       status,
-      message,
-      stack,
+      message: message.replace(ansiRegExp(), ''),
+      stack: stack.replace(ansiRegExp(), ''),
     });
   }
 
@@ -120,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,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;
 

package/lib/pipe/gitlab.js

@@ -4,8 +4,9 @@ const chalk = require('chalk');
 const humanizeDuration = require('humanize-duration');
 const merge = require('lodash.merge');
 const path = require('path');
-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');
 
 //! GITLAB_PAT environment variable is required for this functionality to work
 //! and your pipeline trigger should be merge_request
@@ -22,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(
@@ -46,6 +47,9 @@ class GitLabPipe {
     debug('GitLab Pipe: Enabled');
   }
 
+  // TODO: to using SET opts as argument => prepareRun(opts)
+  async prepareRun() {}
+
   async createRun() {}
 
   addTest(test) {
@@ -73,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) {
@@ -179,21 +190,6 @@ class GitLabPipe {
   updateRun() {}
 }
 
-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(axiosInstance, commentsRequestURL, hiddenCommentData, token) {
   if (process.env.GITLAB_KEEP_OUTDATED_REPORTS) return;