@testomatio/reporter 0.8.0-beta.3 → 0.8.0-beta.30

package/lib/pipe/csv.js

@@ -0,0 +1,119 @@
+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');
+
+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) {
+    // First, we check whether the export directory exists: if yes - OK, no - create it.
+    this.checkExportDir();
+
+    console.log(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(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,
+    });
+  }
+
+  /**
+   * Save short tests data to the csv file.
+   * @param {Object} runParams - run params.
+   */
+  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,26 +1,37 @@
+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');
-
 
 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_ACTION_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);
+    }
+
     if (!this.token || !this.ref || !this.repo) return;
     this.isEnabled = true;
-    this.issue = this.ref.match(/refs\/pull\/(\d+)\/merge/)[1]    
+    const matchedIssue = this.ref.match(/refs\/pull\/(\d+)\/merge/);
+    if (!matchedIssue) return;
+    this.issue = matchedIssue[1];
     this.start = new Date();
+
+    if (process.env.DEBUG) {
+      console.log(APP_PREFIX, 'GitHub Pipe: Enabled');
+    }
   }
-  
+
   async createRun() {}
 
   updateRun() {}
@@ -28,21 +39,20 @@ class GitHubPipe {
   addTest(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 (runParams.tests) runParams.tests.forEach(t => this.addTest(t));
-    
 
     this.octokit = new Octokit({
       auth: this.token,
@@ -56,15 +66,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})  | `;
     }
@@ -81,44 +93,67 @@ 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 += `<details>\n<summary>### 🟥 Failures (${failures.length})</summary>\n${failures.join('\n')} </details>`;
-    }
-
-    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 {
       const resp = await this.octokit.rest.issues.createComment({
         owner,
@@ -126,38 +161,75 @@ class GitHubPipe {
         issue_number: this.issue,
         body,
       });
-  
+
       const url = resp.data?.html_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';
+  }
 }
 
 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.error(`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;

package/lib/pipe/gitlab.js

@@ -0,0 +1,229 @@
+const axios = require('axios');
+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');
+
+//! GITLAB_PAT environment variable is required for this functionality to work
+//! and your pipeline trigger should be merge_request
+
+class GitLabPipe {
+  constructor(params, store = {}) {
+    this.isEnabled = false;
+    this.ENV = process.env;
+    this.store = store;
+    this.tests = [];
+    // GitLab PAT looks like glpat-nKGdja3jsG4850sGksh7
+    this.token = params.GITLAB_PAT || this.ENV.GITLAB_PAT;
+    this.hiddenCommentData = `<!--- testomat.io report ${process.env.CI_JOB_NAME || ''} -->`;
+    this.axios = axios.create();
+
+    if (this.ENV.DEBUG) {
+      console.log(
+        APP_PREFIX,
+        chalk.yellow('GitLab Pipe:'),
+        this.token ? 'TOKEN passed' : '*no token*',
+        `Project id: ${this.ENV.CI_PROJECT_ID}, MR id: ${this.ENV.CI_MERGE_REQUEST_IID}`,
+      );
+    }
+
+    if (!this.ENV.CI_PROJECT_ID || !this.ENV.CI_MERGE_REQUEST_IID) {
+      // console.warn(`CI pipeline should be run in Merge Request to have ability to add the report comment.`);
+      return;
+    }
+
+    if (!this.token) {
+      console.warn(chalk.grey(`Hint: GitLab CI variables are unavailable for unprotected branches by default.`));
+      return;
+    }
+
+    this.isEnabled = true;
+
+    if (this.ENV.DEBUG) {
+      console.log(APP_PREFIX, chalk.yellow('GitLab Pipe: Enabled'));
+    }
+  }
+
+  async createRun() {}
+
+  addTest(test) {
+    if (!this.isEnabled) return;
+
+    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);
+  }
+
+  async finishRun(runParams) {
+    if (!this.isEnabled) return;
+
+    if (runParams.tests) runParams.tests.forEach(t => this.addTest(t));
+
+    // ... create a comment on GitLab
+    const passedCount = this.tests.filter(t => t.status === 'passed').length;
+    const failedCount = this.tests.filter(t => t.status === 'failed').length;
+    const skippedCount = this.tests.filter(t => t.status === 'skipped').length;
+
+    // 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)} |
+  | --- | --- |
+  | Tests | ✔️  **${this.tests.length}** tests run  |
+  | 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.ENV.CI_JOB_NAME && this.ENV.CI_JOB_ID) {
+      summary += `| Job | 👷 [${this.ENV.CI_JOB_ID}](${this.ENV.CI_JOB_URL})<br>Name: **${
+        this.ENV.CI_JOB_NAME}**<br>Stage: **${this.ENV.CI_JOB_STAGE}** | `;
+    }
+
+    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 && !this.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;
+      });
+
+    let body = summary;
+
+    if (failures.length) {
+      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<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>';
+    }
+
+    // eslint-disable-next-line max-len
+    const commentsRequestURL = `https://gitlab.com/api/v4/projects/${this.ENV.CI_PROJECT_ID}/merge_requests/${this.ENV.CI_MERGE_REQUEST_IID}/notes`;
+
+    // delete previous report
+    await deletePreviousReport(this.axios, commentsRequestURL, this.hiddenCommentData, this.token);
+
+    // add current report
+    console.info(chalk.grey(`Adding comment via url: ${commentsRequestURL}`));
+    try {
+      const addCommentResponse = await this.axios.post(`${commentsRequestURL}?access_token=${this.token}`, { body });
+
+      const commentID = addCommentResponse.data.id;
+      // eslint-disable-next-line max-len
+      const commentURL = `${this.ENV.CI_PROJECT_URL}/-/merge_requests/${this.ENV.CI_MERGE_REQUEST_IID}#note_${commentID}`;
+
+      console.log(APP_PREFIX, chalk.yellow('GitLab'), `Report created: ${chalk.magenta(commentURL)}`);
+    } catch (err) {
+      console.log(
+        APP_PREFIX,
+        chalk.yellow('GitLab'),
+        `Couldn't create GitLab report\n${err}.
+      Request url: ${commentsRequestURL}
+      Request data: ${body}`,
+      );
+    }
+  }
+
+  toString() {
+    return 'GitLab Reporter';
+  }
+
+  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;
+
+  // get comments
+  let comments = [];
+
+  try {
+    const response = await axiosInstance.get(`${commentsRequestURL}?access_token=${token}`);
+    comments = response.data;
+  } catch (e) {
+    console.error('Error while attempt to retrieve comments on GitLab Merge 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
+        const deleteCommentURL = `${commentsRequestURL}/${comment.id}?access_token=${token}`;
+        await axiosInstance.delete(deleteCommentURL);
+      } catch (e) {
+        console.error(`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.GITLAB_REMOVE_ALL_OUTDATED_REPORTS) break;
+      // TODO: in case of many reports should implement pagination
+    }
+  }
+}
+
+module.exports = GitLabPipe;