@testomatio/reporter 0.8.0-beta.9 → 0.8.2-beta.1

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;

package/lib/pipe/gitlab.js

@@ -0,0 +1,229 @@
+const debug = require('debug')('@testomatio/reporter:pipe:gitlab');
+const { default: 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
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
+ */
+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 || ''} -->`;
+
+    debug(
+      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) {
+      debug(`CI pipeline should be run in Merge Request to have ability to add the report comment.`);
+      return;
+    }
+
+    if (!this.token) {
+      debug(`Hint: GitLab CI variables are unavailable for unprotected branches by default.`);
+      return;
+    }
+
+    this.isEnabled = true;
+
+    debug('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) {
+      // eslint-disable-next-line max-len
+      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(axios, commentsRequestURL, this.hiddenCommentData, this.token);
+
+    // add current report
+    debug(`Adding comment via url: ${commentsRequestURL}`);
+
+    try {
+      const addCommentResponse = await 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.error(
+        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.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.GITLAB_REMOVE_ALL_OUTDATED_REPORTS) break;
+      // TODO: in case of many reports should implement pagination
+    }
+  }
+}
+
+module.exports = GitLabPipe;

package/lib/pipe/index.js

@@ -1,48 +1,63 @@
 const fs = require('fs');
 const path = require('path');
+const chalk = require('chalk');
 const { APP_PREFIX } = require('../constants');
 const TestomatioPipe = require('./testomatio');
 const GitHubPipe = require('./github');
+const GitLabPipe = require('./gitlab');
+const CsvPipe = require('./csv');
 
-module.exports = function(params, opts) {
+function PipeFactory(params, opts) {
   const extraPipes = [];
 
   // Add extra pipes into package.json file:
   // "testomatio": {
-  //   "pipes": ["my-module-pipe", "./local/js/file/pipe"] 
+  //   "pipes": ["my-module-pipe", "./local/js/file/pipe"]
   // }
 
   const packageJsonFile = path.join(process.cwd(), 'package.json');
   if (fs.existsSync(packageJsonFile)) {
-    const package = fs.readFileSync(packageJsonFile);
-    const pipeDefs = package?.testomatio?.pipes || [];
-    
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonFile).toString());
+    const pipeDefs = packageJson?.testomatio?.pipes || [];
+
     for (const pipeDef of pipeDefs) {
-      let pipeClass;
+      let PipeClass;
       try {
-        pipeClass = require(pipeDef);
+        PipeClass = require(pipeDef);
       } catch (err) {
         console.log(APP_PREFIX, `Can't load module Testomatio pipe module from ${pipeDef}`);
         continue;
       }
 
       try {
-        extraPipes.push(new pipeClass(params, opts))
+        extraPipes.push(new PipeClass(params, opts));
       } catch (err) {
         console.log(APP_PREFIX, `Can't instantiate Testomatio for ${pipeDef}`, err);
         continue;
       }
     }
   }
-  
 
   const pipes = [
     new TestomatioPipe(params, opts),
-    new GitHubPipe(params, opts),    
-    ...extraPipes
+    new GitHubPipe(params, opts),
+    new GitLabPipe(params, opts),
+    new CsvPipe(params, opts),
+    ...extraPipes,
   ];
 
-  console.log(APP_PREFIX, pipes.filter(p => p.isEnabled).map(p => p.toString()).join(', ') || "No pipe reporters enabled");
+  console.log(
+    APP_PREFIX,
+    chalk.cyan('Pipes:'),
+    chalk.cyan(
+      pipes
+        .filter(p => p.isEnabled)
+        .map(p => p.toString())
+        .join(', ') || 'No pipes enabled',
+    ),
+  );
 
   return pipes;
 }
+
+module.exports = PipeFactory;