@testomatio/reporter 0.8.0-beta.1 → 0.8.0-beta.11

package/lib/adapter/codecept.js

@@ -35,11 +35,6 @@ function CodeceptReporter(config) {
   const testTimeMap = {};
   const { apiKey } = config;
 
-  if (!apiKey) {
-    console.log('TESTOMATIO key is empty, ignoring reports');
-    return;
-  }
-
   const getDuration = test => {
     if (testTimeMap[test.id]) {
       return Date.now() - testTimeMap[test.id];

package/lib/adapter/cucumber/current.js

@@ -18,13 +18,7 @@ class CucumberReporter extends Formatter {
     this.failures = [];
     this.cases = [];
 
-    const apiKey = process.env.TESTOMATIO;
-    if (!apiKey || apiKey === '') {
-      console.log(chalk.red('TESTOMATIO key is empty, ignoring reports'));
-      return;
-    }
-
-    this.client = new TestomatClient({ apiKey });
+    this.client = new TestomatClient();
     this.status = TRConstants.PASSED;
 
   }

package/lib/adapter/jasmine.js

@@ -5,14 +5,7 @@ const { PASSED, FAILED } = require('../constants');
 class JasmineReporter {
   constructor(options) {
     this.testTimeMap = {};
-    const { apiKey } = options;
-
-    if (!apiKey) {
-      console.log('TESTOMATIO key is empty, ignoring reports');
-      return;
-    }
-
-    this.client = new TestomatClient({ apiKey });
+    this.client = new TestomatClient({ apiKey: options?.apiKey });
     this.client.createRun();
   }
 

package/lib/adapter/jest.js

@@ -6,14 +6,8 @@ class JestReporter {
   constructor(globalConfig, options) {
     this._globalConfig = globalConfig;
     this._options = options;
-    const { apiKey } = options;
 
-    if (!apiKey) {
-      console.log('TESTOMATIO key is empty, ignoring reports');
-      return;
-    }
-
-    this.client = new TestomatClient({ apiKey });
+    this.client = new TestomatClient({ apiKey: options?.apiKey });
     this.client.createRun();
   }
 

package/lib/adapter/mocha.js

@@ -1,5 +1,6 @@
 // eslint-disable-next-line global-require, import/no-extraneous-dependencies
 const Mocha = require('mocha');
+const chalk = require('chalk');
 const TestomatClient = require('../client');
 const TRConstants = require('../constants');
 const { parseTest } = require('../util');
@@ -11,13 +12,7 @@ function MochaReporter(runner, opts) {
   let passes = 0;
   let failures = 0;
 
-  const { apiKey } = opts.reporterOptions;
-
-  if (!apiKey) {
-    console.log('TESTOMATIO key is empty, ignoring reports');
-    return;
-  }
-  const client = new TestomatClient({ apiKey });
+  const client = new TestomatClient({ apiKey: opts?.reporterOptions?.apiKey });
 
   runner.on(EVENT_RUN_BEGIN, () => {
     client.createRun();
@@ -25,7 +20,7 @@ function MochaReporter(runner, opts) {
 
   runner.on(EVENT_TEST_PASS, test => {
     passes += 1;
-    console.log('pass: %s', test.fullTitle());
+    console.log(chalk.bold.green('✔'), test.fullTitle());
     const testId = parseTest(test.title);
     client.addTestRun(testId, TRConstants.PASSED, {
       title: test.title,
@@ -35,7 +30,7 @@ function MochaReporter(runner, opts) {
 
   runner.on(EVENT_TEST_FAIL, (test, err) => {
     failures += 1;
-    console.log('fail: %s -- error: %s', test.fullTitle(), err.message);
+    console.log(chalk.bold.red('✖'), test.fullTitle(), chalk.gray(err.message));
     const testId = parseTest(test.title);
     client.addTestRun(testId, TRConstants.FAILED, {
       error: err,
@@ -45,8 +40,8 @@ function MochaReporter(runner, opts) {
   });
 
   runner.on(EVENT_RUN_END, () => {
-    console.log('end: %d/%d', passes, passes + failures);
     const status = failures === 0 ? TRConstants.PASSED : TRConstants.FAILED;
+    console.log(chalk.bold(status), `${passes} passed, ${failures} failed`);
     client.updateRunStatus(status);
   });
 }

package/lib/adapter/playwright.js

@@ -10,13 +10,7 @@ const { parseTest } = require('../util');
 
 class TestomatioReporter {
   constructor(config = {}) {
-    const { apiKey } = config;
-
-    if (!apiKey) {
-      console.log('API Key is not provided. Testomat.io report is disabled');
-    } else {
-      this.client = new TestomatioClient({ apiKey });
-    }
+    this.client = new TestomatioClient({ apiKey: config?.apiKey });
 
     this.videos = [];
   }

package/lib/adapter/webdriver.js

@@ -7,10 +7,7 @@ class WebdriverReporter extends WDIOReporter {
   constructor(options) {
     super(options);
 
-    const { apiKey } = options;
-    if (!apiKey) return;
-
-    this.client = new TestomatClient({ apiKey });
+    this.client = new TestomatClient({ apiKey: options?.apiKey });
     options = Object.assign(options, { stdout: true });
 
     this._addTestPromises = [];

package/lib/client.js

@@ -1,4 +1,3 @@
-const axios = require('axios');
 const createCallsiteRecord = require('callsite-record');
 const { sep, join } = require('path');
 const fs = require('fs');
@@ -6,6 +5,7 @@ const chalk = require('chalk');
 const upload = require('./fileUploader');
 const { PASSED, FAILED, FINISHED, APP_PREFIX } = require('./constants');
 const pipesFactory = require('./pipe');
+
 const { TESTOMATIO_ENV } = process.env;
 
 
@@ -15,17 +15,16 @@ class TestomatClient {
    *
    * @param {*} params
    */
-  constructor(params) {
-    this.apiKey = params.apiKey || process.env.TESTOMATIO;
+  constructor(params = {}) {
     this.title = params.title || process.env.TESTOMATIO_TITLE;
     this.env  = TESTOMATIO_ENV;
     this.parallel = params.parallel;
     const store = {}
     this.pipes = pipesFactory(params, store);
     this.queue = Promise.resolve();
-    this.axios = axios.create();
     this.totalUploaded = 0;
     this.version = JSON.parse(fs.readFileSync(join(__dirname, '..', 'package.json')).toString()).version;
+    console.log(APP_PREFIX, `Testomatio Reporter v${this.version}`);
   }
 
   /**
@@ -34,7 +33,9 @@ class TestomatClient {
    * @returns {Promise} - resolves to Run id which should be used to update / add test
    */
   createRun() {
-    const { runId } = process.env;
+    // all pipes disabled, skipping
+    if (!this.pipes.filter(p => p.isEnabled).length) return;
+
     const runParams = {
       title: this.title,
       parallel: this.parallel,
@@ -54,6 +55,9 @@ class TestomatClient {
    * @returns {Promise}
    */
   async addTestRun(testId, status, testData = {}) {
+    // all pipes disabled, skipping
+    if (!this.pipes.filter(p => p.isEnabled).length) return;
+
     const {
       error = '',
       time = '',
@@ -127,6 +131,9 @@ class TestomatClient {
    * @returns {Promise}
    */
   updateRunStatus(status, isParallel) {
+    // all pipes disabled, skipping
+    if (!this.pipes.filter(p => p.isEnabled).length) return;
+
     let statusEvent;
     if (status === FINISHED) statusEvent = 'finish';
     if (status === PASSED) statusEvent = 'pass';

package/lib/pipe/github.js

@@ -1,8 +1,9 @@
+const path = require('path');
 const chalk = require('chalk');
+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 {
@@ -14,11 +15,22 @@ class GitHubPipe {
     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.repo = process.env.GITHUB_REPOSITORY
+
+    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() {}
@@ -27,7 +39,7 @@ class GitHubPipe {
 
   addTest(test) {
     if (!this.isEnabled) return;
-    
+
     const index = this.tests.findIndex(t => isSameTest(t, test))    
     // update if they were already added
     if (index >= 0) {
@@ -92,8 +104,9 @@ class GitHubPipe {
       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 => {
+        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`    
         });
       }
 
@@ -105,19 +118,19 @@ class GitHubPipe {
     let body = summary;
 
     if (failures.length) {
-      body += `\n### 🟥 Failures (${failures.length})\n${failures.join('\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>\n";
     }
 
     if (this.tests.length > 0) {
-      body += "\n### 🐢 Slowest Tests\n\n"
-
+      body += "\n<details>\n<summary><h3>🐢 Slowest Tests</h3>\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>"
     }
 
     try {
@@ -144,6 +157,10 @@ class GitHubPipe {
       );
     }
   }
+
+  toString() {
+    return 'GitHub Reporter'
+  }
 }
 
 function statusEmoji(status) {

package/lib/pipe/index.js

@@ -1,5 +1,6 @@
 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');
@@ -36,10 +37,13 @@ module.exports = function(params, opts) {
   }
   
 
-  const defaultPipes = [
+  const pipes = [
     new TestomatioPipe(params, opts),
     new GitHubPipe(params, opts),    
+    ...extraPipes
   ];
 
-  return [...defaultPipes, ...extraPipes];
+  console.log(APP_PREFIX, chalk.cyan('Pipes:'), chalk.cyan(pipes.filter(p => p.isEnabled).map(p => p.toString()).join(', ') || "No pipes enabled"));
+
+  return pipes;
 }

package/lib/pipe/testomatio.js

@@ -15,9 +15,15 @@ class TestomatioPipe {
   constructor(params, store = {}) {    
     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*');  
+    }    
     if (!this.apiKey) {
       return;
     }
+    if (process.env.DEBUG) {
+      console.log(APP_PREFIX, 'Testomatio Pipe: Enabled');  
+    }    
     this.store = store;
     this.title = params.title || process.env.TESTOMATIO_TITLE;
     this.axios = axios.create();
@@ -26,7 +32,6 @@ class TestomatioPipe {
     this.runId = params.runId || process.env.runId;
     this.createNewTests = !!process.env.TESTOMATIO_CREATE;
 
-
     if (!isValidUrl(this.url.trim())) {
       this.isEnabled = false;
       console.log(
@@ -56,7 +61,7 @@ class TestomatioPipe {
       this.runUrl = `${this.url}/${resp.data.url.split('/').splice(3).join('/')}`;
       this.store.runUrl = this.runUrl;
       this.store.runId = this.runId;      
-      console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId, chalk.gray(`v${this.version}`));
+      console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId);
       process.env.runId = this.runId;
     } catch (err) {
       console.log(
@@ -122,7 +127,11 @@ class TestomatioPipe {
     } catch (err) {
       console.log(APP_PREFIX, 'Error updating status, skipping...', err);
     }
-  }  
+  }
+
+  toString() {
+    return 'Testomatio Reporter';
+  }
 }
 
 module.exports = TestomatioPipe;

package/lib/util.js

@@ -137,9 +137,7 @@ const fetchSourceCode = (contents, opts = {}) => {
   }
 }
 
-const isSameTest = (test, t) => {
-  return 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) => t.title == test.title && t.suite_title == test.suite_title && Object.values(t.example) == Object.values(test.example) && t.test_id == test.test_id
 
 module.exports = {
   parseTest,

package/lib/xmlReader.js

@@ -4,7 +4,7 @@ const fs = require("fs");
 
 // const util = require("util"); // you can see a result
 const { XMLParser } = require("fast-xml-parser");
-const { PASSED, FAILED, SKIPPED } = require('./constants');
+const { APP_PREFIX, PASSED, FAILED, SKIPPED } = require('./constants');
 const { fetchFilesFromStackTrace, fetchSourceCode, fetchSourceCodeFromStackTrace } = require('./util');
 const upload = require('./fileUploader');
 const pipesFactory = require('./pipe');
@@ -45,6 +45,9 @@ class XmlReader {
     this.stats = {}
     this.stats.language = opts.lang?.toLowerCase();
     this.filesToUpload = {}
+
+    this.version = JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json')).toString()).version;
+    console.log(APP_PREFIX, `Testomatio Reporter v${this.version}`);    
   }
 
   connectAdapter() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "0.8.0-beta.1",
+  "version": "0.8.0-beta.11",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "repository": "git@github.com:testomatio/reporter.git",
@@ -19,7 +19,8 @@
     "has-flag": "^5.0.1",
     "is-valid-path": "^0.1.1",
     "json-cycle": "^1.3.0",
-    "lodash.memoize": "^4.1.2"
+    "lodash.memoize": "^4.1.2",
+    "lodash.merge": "^4.6.2"
   },
   "files": [
     "bin",