@testomatio/reporter 0.8.0-beta.15 → 0.8.0-beta.20

package/README.md

@@ -208,6 +208,24 @@ Run the following command from you project folder:
 TESTOMATIO={API_KEY} npx start-test-run -c 'npx wdio wdio.conf.js'
 ```
 
+## Pipes
+Pipes allow you to get report inside different systems (e.g. Pull request comment, database etc)
+For now next pipes available:
+
+### Github
+This pipe adds comment with run report to GitHub Pull Request.
+
+To use it:
+1. run your tests using github actions in Pull Request
+2. pass `GH_PAT` (GitHub Personal Access Token) as environment variable.
+
+### GitLab
+This pipe adds comment with run report to GitLab Merge Request.
+
+To use it:
+1. run your tests in Merge Request (pipeline trigger should be `merge_request`)
+2. pass `GITLAB_PAT` (GitLab Personal Access Token) as environment variable.
+
 ## JUnit Reports
 
 > **Notice** JUnit reports are supported since 0.6.0
@@ -408,6 +426,23 @@ Add environments to run by providing `TESTOMATIO_ENV` as comma seperated values:
 TESTOMATIO={API_KEY} TESTOMATIO_ENV="Windows, Chrome" <actual run command>
 ```
 
+### Save test results to .csv file
+Add an env to run by specifying the `TESTOMATIO_CSV_FILENAME` variable.
+
+1) using default report name:
+
+```bash
+TESTOMATIO={API_KEY} TESTOMATIO_CSV_FILENAME="report.csv" <actual run command>
+```
+
+2) using unique report name:
+
+```bash
+TESTOMATIO={API_KEY} TESTOMATIO_CSV_FILENAME="test.csv" <actual run command>
+```
+_It's create a new /export folder with csv files_
+
+
 ### Attaching Test Artifacts
 
 To save a test artifacts (screenshots and videos) of a failed test use S3 storage.

package/lib/constants.js

@@ -2,10 +2,19 @@ const chalk = require('chalk');
 
 const APP_PREFIX = chalk.gray('[TESTOMATIO]');
 
+const CSV_HEADERS = [
+  { id: 'suite_title', title: 'Suite_title' },
+  { id: 'title', title: 'Title' },
+  { id: 'status', title: 'Status' },
+  { id: 'message', title: 'Message' },
+  { id: 'stack', title: 'Stack' },
+];
+
 module.exports = Object.freeze({
   PASSED: 'passed',
   FAILED: 'failed',
   SKIPPED: 'skipped',
   FINISHED: 'finished',
   APP_PREFIX,
+  CSV_HEADERS
 });

package/lib/pipe/csv.js

@@ -0,0 +1,111 @@
+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() {}
+
+    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

@@ -122,11 +122,11 @@ class GitHubPipe {
       if (failures.length > 20) {
         body += "\n> Notice\n> Only first 20 failures shown*"
       }
-      body += "\n\n</details>\n";
+      body += "\n\n</details>";
     }
 
     if (this.tests.length > 0) {
-      body += "<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n"
+      body += "\n<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n"
       body += this.tests.sort((a, b) => b?.run_time - a?.run_time).slice(0, 5).map(t => {
         return `* ${fullName(t)} (${humanizeDuration(parseFloat(t.run_time))})`
       }).join('\n')

package/lib/pipe/gitlab.js

@@ -0,0 +1,192 @@
+const { ansiRegExp, isSameTest } = require('../util');
+const { APP_PREFIX } = require('../constants');
+const chalk = require('chalk');
+const got = require('got');
+const humanizeDuration = require('humanize-duration');
+const merge = require('lodash.merge');
+const path = require('path');
+
+//! GITLAB_PAT environment variable is required for this functionality to work and your pipeline trigger should be merge_request
+
+class GitLabPipe {
+  isEnabled = false;
+
+  constructor(params, store = {}) {
+    this.ENV = process.env;
+    this.store = store;
+    this.tests = [];
+    // GitLab PAT looks like glpat-nKGdja3jsG4850sGksh7
+    this.token = params.GITLAB_PAT || this.ENV.GITLAB_PAT;
+
+    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 = `
+
+  | [![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')) return (text += `![](${f})\n`);
+              return (text += `[📄 ${path.basename(f)}](${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\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
+        .sort((a, b) => b?.run_time - a?.run_time)
+        .slice(0, 5)
+        .map(t => {
+          return `* ${fullName(t)} (${humanizeDuration(parseFloat(t.run_time))})`;
+        })
+        .join('\n');
+      body += '\n</details>';
+    }
+
+    try {
+      const addCommentRequestURL = `https://gitlab.com/api/v4/projects/${this.ENV.CI_PROJECT_ID}/merge_requests/${this.ENV.CI_MERGE_REQUEST_IID}/notes?access_token=${this.token}`;
+      console.info(chalk.grey(`Adding comment via url: ${addCommentRequestURL}`));
+      const options = {
+        json: {
+          body,
+        },
+      };
+
+      const addCommentResponse = await got.post(addCommentRequestURL, options);
+      const commentID =  JSON.parse(addCommentResponse.body).id;
+      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}.
+      Reqest url: ${addCommentRequestURL}
+      Request data: ${JSON.stringify(options)}`,
+      );
+    }
+  }
+
+  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;
+}
+
+module.exports = GitLabPipe;

package/lib/pipe/index.js

@@ -4,6 +4,8 @@ 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) {
   const extraPipes = [];
@@ -39,7 +41,9 @@ module.exports = function(params, opts) {
 
   const pipes = [
     new TestomatioPipe(params, opts),
-    new GitHubPipe(params, opts),    
+    new GitHubPipe(params, opts),
+    new GitLabPipe(params, opts),
+    new CsvPipe(params, opts),
     ...extraPipes
   ];
 

package/lib/util.js

@@ -146,6 +146,13 @@ const isSameTest = (test, t) => {
     && 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();
+}
+
 module.exports = {
   parseTest,
   parseSuite,
@@ -155,4 +162,5 @@ module.exports = {
   fetchSourceCode,
   fetchSourceCodeFromStackTrace,
   fetchFilesFromStackTrace,
+  getCurrentDateTime
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "0.8.0-beta.15",
+  "version": "0.8.0-beta.20",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "repository": "git@github.com:testomatio/reporter.git",
@@ -16,12 +16,14 @@
     "dotenv": "^16.0.1",
     "fast-xml-parser": "^4.0.8",
     "glob": "^8.0.3",
+    "got": "^11.8.3",
     "has-flag": "^5.0.1",
     "humanize-duration": "^3.27.3",
     "is-valid-path": "^0.1.1",
     "json-cycle": "^1.3.0",
     "lodash.memoize": "^4.1.2",
-    "lodash.merge": "^4.6.2"
+    "lodash.merge": "^4.6.2",
+    "csv-writer": "^1.6.0"
   },
   "files": [
     "bin",
@@ -29,6 +31,7 @@
     "testcafe"
   ],
   "scripts": {
+    "clear-exportdir": "rm -rf export/",
     "pretty": "prettier --write .",
     "lint": "eslint lib",
     "lint:fix": "eslint lib --fix",
@@ -36,6 +39,7 @@
     "init": "cd ./tests/adapter/examples/cucumber && npm i",
     "test:unit": "mocha tests",
     "test:adapter": "mocha './tests/adapter/index.test.js'",
+    "test:pipes": "mocha './tests/pipes/*_test.js'",
     "test:adapter:jest:example": "jest './tests/adapter/examples/jest/index.test.js' --config='./tests/adapter/examples/jest/jest.config.js'",
     "test:adapter:mocha:example": "mocha './tests/adapter/examples/mocha/index.test.js' --config='./tests/adapter/examples/mocha/mocha.config.js'",
     "test:adapter:jasmine:example": "./tests/adapter/examples/jasmine/passReporterOpts.sh && jasmine './tests/adapter/examples/jasmine/index.test.js' --reporter=./../../../lib/adapter/jasmine.js",