@testomatio/reporter 0.8.0-beta.8 → 0.8.1

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;

package/lib/pipe/testomatio.js

@@ -1,100 +1,114 @@
+const debug = require('debug')('@testomatio/reporter:pipe:testomatio');
 const chalk = require('chalk');
 const axios = require('axios');
 const JsonCycle = require('json-cycle');
-const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_RUN } = process.env;
-const { APP_PREFIX } = require('../constants');
+const { APP_PREFIX, STATUS } = require('../constants');
 const { isValidUrl } = require('../util');
 
+const { TESTOMATIO_RUN } = process.env;
 if (TESTOMATIO_RUN) {
   process.env.runId = TESTOMATIO_RUN;
 }
 
+/**
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
+ * @class TestomatioPipe
+ * @implements {Pipe}
+ */
 class TestomatioPipe {
-  isEnabled = false;
-
-  constructor(params, store = {}) {    
+  constructor(params, store) {
+    this.isEnabled = false;
     this.url = params.testomatioUrl || process.env.TESTOMATIO_URL || 'https://app.testomat.io';
     this.apiKey = params.apiKey || process.env.TESTOMATIO;
-    if (process.env.DEBUG) {
-      console.log(APP_PREFIX, 'Testomatio Pipe: ', this.apiKey ? 'API KEY' : '*no api key*');  
-    }    
+    debug('Testomatio Pipe: ', this.apiKey ? 'API KEY' : '*no api key*');
     if (!this.apiKey) {
       return;
     }
-    if (process.env.DEBUG) {
-      console.log(APP_PREFIX, 'Testomatio Pipe: Enabled');  
-    }    
-    this.store = store;
+    debug('Testomatio Pipe: Enabled');
+    this.store = store || {};
     this.title = params.title || process.env.TESTOMATIO_TITLE;
+    this.groupTitle = params.groupTitle || process.env.TESTOMATIO_RUNGROUP_TITLE;
+    this.env = process.env.TESTOMATIO_ENV;
     this.axios = axios.create();
     this.isEnabled = true;
+    // do not finish this run (for parallel testing)
     this.proceed = process.env.TESTOMATIO_PROCEED;
     this.runId = params.runId || process.env.runId;
     this.createNewTests = !!process.env.TESTOMATIO_CREATE;
 
     if (!isValidUrl(this.url.trim())) {
       this.isEnabled = false;
-      console.log(
-        APP_PREFIX,
-        chalk.red(`Error creating report on Testomat.io, report url '${this.url}' is invalid`),
-      );
-      return;
+      console.error(APP_PREFIX, chalk.red(`Error creating report on Testomat.io, report url '${this.url}' is invalid`));
     }
   }
 
-  async createRun(runParams) {
+  /**
+   * @returns Promise<void>
+   */
+  async createRun() {
     if (!this.isEnabled) return;
 
-    runParams.api_key = this.apiKey.trim();
-    runParams.group_title = TESTOMATIO_RUNGROUP_TITLE;
-    
+    const runParams = Object.fromEntries(
+      Object.entries({
+        api_key: this.apiKey.trim(),
+        group_title: this.groupTitle,
+        env: this.env,
+        title: this.title,
+      }).filter(([, value]) => !!value)
+    );
+
     if (this.runId) {
-      return this.axios.put(`${this.url.trim()}/api/reporter/${this.runId}`, runParams)  
+      return this.axios.put(`${this.url.trim()}/api/reporter/${this.runId}`, runParams);
     }
-    
+
     try {
       const resp = await this.axios.post(`${this.url.trim()}/api/reporter`, runParams, {
         maxContentLength: Infinity,
         maxBodyLength: Infinity,
-      })
+      });
       this.runId = resp.data.uid;
       this.runUrl = `${this.url}/${resp.data.url.split('/').splice(3).join('/')}`;
       this.store.runUrl = this.runUrl;
-      this.store.runId = this.runId;      
+      this.store.runId = this.runId;
       console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId);
       process.env.runId = this.runId;
     } catch (err) {
-      console.log(
+      console.error(
         APP_PREFIX,
         'Error creating Testomat.io report, please check if your API key is valid. Skipping report',
       );
     }
   }
 
-  async addTest(data) {
+  /**
+   * 
+   * @param testData data 
+   * @returns 
+   */
+  addTest(data) {
     if (!this.isEnabled) return;
     if (!this.runId) return;
     data.api_key = this.apiKey;
     data.create = this.createNewTests;
     const json = JsonCycle.stringify(data);
 
-    try {
-      return await this.axios.post(`${this.url}/api/reporter/${this.runId}/testrun`, json, {
-        maxContentLength: Infinity,
-        maxBodyLength: Infinity,
-        headers: {
-          // Overwrite Axios's automatically set Content-Type
-          'Content-Type': 'application/json',
-        },
-      });
-    } catch (err) {
+    return this.axios.post(`${this.url}/api/reporter/${this.runId}/testrun`, json, {
+      maxContentLength: Infinity,
+      maxBodyLength: Infinity,
+      headers: {
+        // Overwrite Axios's automatically set Content-Type
+        'Content-Type': 'application/json',
+      },
+    })
+    .catch((err) => {
       if (err.response) {
         if (err.response.status >= 400) {
-          const data = err.response.data || { message: '' };
+          const responseData = err.response.data || { message: '' };
           console.log(
             APP_PREFIX,
             chalk.blue(this.title),
-            `Report couldn't be processed: (${err.response.status}) ${data.message}`,
+            `Report couldn't be processed: (${err.response.status}) ${responseData.message}`,
           );
           return;
         }
@@ -102,18 +116,31 @@ class TestomatioPipe {
       } else {
         console.log(APP_PREFIX, chalk.blue(this.title), "Report couldn't be processed", err);
       }
-    }
-
+    });
   }
 
+  /**
+   * @param {import('../../types').RunData} params 
+   * @returns 
+   */
   async finishRun(params) {
     if (!this.isEnabled) return;
+
+    const { status, parallel } = params;
+
+    let status_event;
+
+    if (status === STATUS.FINISHED) status_event = 'finish';
+    if (status === STATUS.PASSED) status_event = 'pass';
+    if (status === STATUS.FAILED) status_event = 'fail';
+    if (parallel) status_event += '_parallel';
+
     try {
       if (this.runId && !this.proceed) {
         await this.axios.put(`${this.url}/api/reporter/${this.runId}`, {
           api_key: this.apiKey,
-          status_event: params.statusEvent,
-          status: params.status,
+          status_event,
+          tests: params.tests,
         });
         if (this.runUrl) {
           console.log(APP_PREFIX, '📊 Report Saved. Report URL:', chalk.magenta(this.runUrl));
@@ -134,4 +161,4 @@ class TestomatioPipe {
   }
 }
 
-module.exports = TestomatioPipe;
+module.exports = TestomatioPipe;

package/lib/reporter.js

@@ -1,7 +1,9 @@
 const TestomatClient = require('./client');
 const TRConstants = require('./constants');
+const TRArtifacts = require('./ArtifactStorage');
 
 module.exports = {
   TestomatClient,
   TRConstants,
+  TRArtifacts
 };

package/lib/util.js

@@ -1,5 +1,5 @@
 const { URL } = require('url');
-const { sep } = require('path');
+const { sep, basename } = require('path');
 const chalk = require('chalk');
 const fs = require('fs');
 const isValid = require('is-valid-path');
@@ -7,7 +7,7 @@ const isValid = require('is-valid-path');
 /**
  * @param {String} testTitle - Test title
  *
- * @returns {String} testId
+ * @returns {String|null} testId
  */
 const parseTest = testTitle => {
   const captures = testTitle.match(/@T([\w\d]+)/);
@@ -21,7 +21,7 @@ const parseTest = testTitle => {
 /**
  * @param {String} suiteTitle - suite title
  *
- * @returns {String} suiteId
+ * @returns {String|null} suiteId
  */
 const parseSuite = suiteTitle => {
   const captures = suiteTitle.match(/@S([\w\d]+)/);
@@ -63,12 +63,12 @@ const fetchSourceCodeFromStackTrace = (stack = '') => {
     // .map(l => l.match(/\[(.*?)\]/)?.[1] || l) // minitest format
     // .map(l => l.split(':')[0])
     .map(l => l.trim())
-    .map(l => l.split(' ').find(p => p.includes(':')))
-    .filter(l => isValid(l.split(':')[0]))
+    .map(l => l.split(' ').find(p => p.includes(':')) || '')
+    .filter(l => isValid(l?.split(':')[0]))
 
     // // filter out 3rd party libs
-    .filter(l => !l.includes(`vendor${  sep}`))
-    .filter(l => !l.includes(`node_modules${  sep}`))
+    .filter(l => !l?.includes(`vendor${  sep}`))
+    .filter(l => !l?.includes(`node_modules${  sep}`))
     .filter(l => fs.existsSync(l.split(':')[0]))
     .filter(l => fs.lstatSync(l.split(':')[0]).isFile())
 
@@ -79,6 +79,8 @@ const fetchSourceCodeFromStackTrace = (stack = '') => {
   const prepend = 3;
   const source = fetchSourceCode(fs.readFileSync(file).toString(), { line, prepend, limit: 7 })
 
+  if (!source) return '';
+
   return source.split('\n')
     .map((l, i) => {
       if (i === prepend) return `${line} > ${chalk.bold(l)}`;
@@ -137,15 +139,46 @@ const fetchSourceCode = (contents, opts = {}) => {
   }
 }
 
-const isSameTest = (test, t) => t.title == test.title && t.suite_title == test.suite_title && Object.values(t.example) == Object.values(test.example) && t.test_id == test.test_id
+const isSameTest = (test, t) => (typeof t === 'object') 
+    && (typeof test === 'object') 
+    && t.title === test.title 
+    && t.suite_title === test.suite_title 
+    && Object.values(t.example || {}) === Object.values(test.example || {})
+    && t.test_id === test.test_id;
+
+const getCurrentDateTime = () => {
+  const today = new Date();
+  
+  return `${today.getFullYear()  }_${  today.getMonth() + 1  }_${  today.getDate()  }_${ 
+         today.getHours()  }_${  today.getMinutes()  }_${  today.getSeconds()}`;
+}
+
+/**
+ * @param {Object} test - Test adapter object
+ *
+ * @returns {String|null} testInfo as one string 
+ */
+const specificTestInfo = test => {
+  // TODO: afterEach has another context.... need to add specific handler, maybe...
+  if (test?.title && test?.file) {
+
+    return `${basename(test.file).split(".").join("#")
+              }#${ 
+              test.title.split(" ").join("#")}`;
+  }
+
+  return null;
+};
 
 module.exports = {
-  parseTest,
-  parseSuite,
-  ansiRegExp,
   isSameTest,
-  isValidUrl,
   fetchSourceCode,
   fetchSourceCodeFromStackTrace,
   fetchFilesFromStackTrace,
-};
+  getCurrentDateTime,
+  specificTestInfo,
+  isValidUrl,
+  ansiRegExp,
+  parseTest,
+  parseSuite 
+}