@testomatio/reporter 0.4.4 → 0.5.0-beta.2

package/lib/adapter/mocha.js

@@ -1,27 +1,30 @@
-const mocha = require("mocha");
-const TestomatClient = require("../client");
-const TRConstants = require("../constants");
-const { parseTest } = require("../util");
+const Mocha = require('mocha');
+const TestomatClient = require('../client');
+const TRConstants = require('../constants');
+const { parseTest } = require('../util');
+
+const { EVENT_RUN_BEGIN, EVENT_RUN_END, EVENT_TEST_FAIL, EVENT_TEST_PASS } = Mocha.Runner.constants;
 
 function MochaReporter(runner, opts) {
-  mocha.reporters.Base.call(this, runner);
+  Mocha.reporters.Base.call(this, runner);
   let passes = 0;
   let failures = 0;
 
   const { apiKey } = opts.reporterOptions;
+
   if (!apiKey) {
-    console.log("TESTOMATIO key is empty, ignoring reports");
+    console.log('TESTOMATIO key is empty, ignoring reports');
     return;
   }
   const client = new TestomatClient({ apiKey });
 
-  runner.on("start", () => {
+  runner.on(EVENT_RUN_BEGIN, () => {
     client.createRun();
   });
 
-  runner.on("pass", (test) => {
+  runner.on(EVENT_TEST_PASS, test => {
     passes += 1;
-    console.log("pass: %s", test.fullTitle());
+    console.log('pass: %s', test.fullTitle());
     const testId = parseTest(test.title);
     client.addTestRun(testId, TRConstants.PASSED, {
       title: test.title,
@@ -29,9 +32,9 @@ function MochaReporter(runner, opts) {
     });
   });
 
-  runner.on("fail", (test, err) => {
+  runner.on(EVENT_TEST_FAIL, (test, err) => {
     failures += 1;
-    console.log("fail: %s -- error: %s", test.fullTitle(), err.message);
+    console.log('fail: %s -- error: %s', test.fullTitle(), err.message);
     const testId = parseTest(test.title);
     client.addTestRun(testId, TRConstants.FAILED, {
       error: err,
@@ -40,14 +43,14 @@ function MochaReporter(runner, opts) {
     });
   });
 
-  runner.on("end", () => {
-    console.log("end: %d/%d", passes, passes + failures);
+  runner.on(EVENT_RUN_END, () => {
+    console.log('end: %d/%d', passes, passes + failures);
     const status = failures === 0 ? TRConstants.PASSED : TRConstants.FAILED;
     client.updateRunStatus(status);
   });
 }
 
 // To have this reporter "extend" a built-in reporter uncomment the following line:
-mocha.utils.inherits(MochaReporter, mocha.reporters.Spec);
+Mocha.utils.inherits(MochaReporter, Mocha.reporters.Spec);
 
 module.exports = MochaReporter;

package/lib/adapter/playwright.js

@@ -1,14 +1,14 @@
-const chalk = require("chalk");
+const chalk = require('chalk');
 const crypto = require('crypto');
 const os = require('os');
 const path = require('path');
 const fs = require('fs');
 const Status = require('../constants');
-const TestomatioClient = require("../client");
+const TestomatioClient = require('../client');
+const upload = require('../fileUploader');
 const { parseTest } = require('../util');
 
 class TestomatioReporter {
-
   constructor(config = {}) {
     const { apiKey } = config;
 
@@ -21,7 +21,7 @@ class TestomatioReporter {
     this.videos = [];
   }
 
-  onBegin(config, suite) {
+  onBegin(_config, suite) {
     if (!this.client) return;
     this.suite = suite;
     this.client.createRun();
@@ -37,7 +37,7 @@ class TestomatioReporter {
 
     const suite_title = test.parent ? test.parent.title : null;
 
-    let steps = [];
+    const steps = [];
     for (const step of result.steps) {
       appendStep(step, steps);
     }
@@ -75,18 +75,20 @@ class TestomatioReporter {
   async onEnd(result) {
     if (!this.client) return;
 
-    if (this.videos.length) {
+    if (this.videos.length && upload.isEnabled()) {
       console.log(Status.APP_PREFIX, `🎞️  Uploading ${this.videos.length} videos...`);
 
-      let promises = [];
+      const promises = [];
       for (const video of this.videos) {
         const { testId, title, attachment, suite_title } = video;
-        const file = ({ path: attachment.path, title, type: attachment.contentType });
-        promises.push(this.client.addTestRun(testId, undefined, {
-          title,
-          suite_title,
-          files: [file],
-        }));
+        const file = { path: attachment.path, title, type: attachment.contentType };
+        promises.push(
+          this.client.addTestRun(testId, undefined, {
+            title,
+            suite_title,
+            files: [file],
+          }),
+        );
       }
       await Promise.all(promises);
     }
@@ -96,25 +98,24 @@ class TestomatioReporter {
 }
 
 function checkStatus(status) {
-  if (status === "skipped") {
-    return Status.SKIPPED;
-  }
-  if (status === "timedOut") {
-    return Status.FAILED;
-  }
-  if (status === 'passed') {
-    return Status.PASSED;
-  }
-  return Status.FAILED;
+  return (
+    {
+      skipped: Status.SKIPPED,
+      timedOut: Status.FAILED,
+      passed: Status.PASSED,
+    }[status] || Status.FAILED
+  );
 }
 
 function appendStep(step, steps = [], shift = 0) {
   const prefix = ' '.repeat(shift);
+
   if (step.error) {
-    steps.push(`${prefix}${chalk.red(step.title)} ${chalk.gray(`${step.duration}ms`)}`)
+    steps.push(`${prefix}${chalk.red(step.title)} ${chalk.gray(`${step.duration}ms`)}`);
   } else {
-    steps.push(`${prefix}${step.title} ${chalk.gray(`${step.duration}ms`)}`)
+    steps.push(`${prefix}${step.title} ${chalk.gray(`${step.duration}ms`)}`);
   }
+
   for (const child of step.steps || []) {
     appendStep(child, steps, shift + 2);
   }

package/lib/adapter/webdriver.js

@@ -1,6 +1,6 @@
-const WDIOReporter = require("@wdio/reporter").default;
-const TestomatClient = require("../client");
-const { parseTest } = require("../util");
+const WDIOReporter = require('@wdio/reporter').default;
+const TestomatClient = require('../client');
+const { parseTest } = require('../util');
 
 class WebdriverReporter extends WDIOReporter {
   constructor(options) {

package/lib/bin/startTest.js

@@ -1,86 +1,82 @@
 #!/usr/bin/env node
-const { spawn } = require("child_process");
-const program = require("commander");
-const chalk = require("chalk");
-const TestomatClient = require("../client");
-const { APP_PREFIX, FINISHED } = require("../constants");
+const { spawn } = require('child_process');
+const program = require('commander');
+const chalk = require('chalk');
+const TestomatClient = require('../client');
+const { APP_PREFIX, FINISHED } = require('../constants');
 
-const apiKey = process.env["INPUT_TESTOMATIO-KEY"] || process.env.TESTOMATIO;
+const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || process.env.TESTOMATIO;
 const title = process.env.TESTOMATIO_TITLE;
 
 program
-  .option("-c, --command <cmd>", "Test runner command")
+  .option('-c, --command <cmd>', 'Test runner command')
   .option('--launch', 'Start a new run and return its ID')
   .option('--finish', 'Finish Run by its ID')
-  .action((opts) => {
-  const { command, launch, finish } = opts;
-
-  if (launch) {
-    console.log('Starting a new Run on Testomat.io...');
-    const client = new TestomatClient({ apiKey });
-
-    client.createRun().then(() => {
-      console.log(process.env.runId);
-      process.exit(0);
-    })
-    return;
-  }
-
-  if (finish) {
-    if (!process.env.TESTOMATIO_RUN) {
-      console.log('TESTOMATIO_RUN environment variable must be set.');
-      return process.exit(1);
+  .action(opts => {
+    const { command, launch, finish } = opts;
+
+    if (launch) {
+      console.log('Starting a new Run on Testomat.io...');
+      const client = new TestomatClient({ apiKey });
+
+      client.createRun().then(() => {
+        console.log(process.env.runId);
+        process.exit(0);
+      });
+      return;
     }
 
-    console.log('Finishing Run on Testomat.io...');
+    if (finish) {
+      if (!process.env.TESTOMATIO_RUN) {
+        console.log('TESTOMATIO_RUN environment variable must be set.');
+        return process.exit(1);
+      }
 
-    const client = new TestomatClient({ apiKey });
+      console.log('Finishing Run on Testomat.io...');
 
-    client.updateRunStatus(FINISHED, true).then(() => {
-      console.log(chalk.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
-      process.exit(0);
-    });
-    return;
-  }
+      const client = new TestomatClient({ apiKey });
 
-  let exitCode = 0;
+      client.updateRunStatus(FINISHED, true).then(() => {
+        console.log(chalk.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
+        process.exit(0);
+      });
+      return;
+    }
 
-  const testCmds = command.split(" ");
-  console.log(APP_PREFIX, `🚀 Running`, chalk.green(command));
+    let exitCode = 0;
 
-  if (!apiKey) {
-    const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: "inherit" });
+    const testCmds = command.split(' ');
+    console.log(APP_PREFIX, `🚀 Running`, chalk.green(command));
 
-    cmd.on("close", (code) => {
-      console.log(
-        APP_PREFIX,
-        "⚠️ ",
-        `Runner exited with ${chalk.bold(code)}, report is ignored`
-      );
+    if (!apiKey) {
+      const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
 
-      if (code > exitCode) exitCode = code;
-      process.exitCode = exitCode;
-    });
+      cmd.on('close', code => {
+        console.log(APP_PREFIX, '⚠️ ', `Runner exited with ${chalk.bold(code)}, report is ignored`);
+
+        if (code > exitCode) exitCode = code;
+        process.exitCode = exitCode;
+      });
 
-    return;
-  }
+      return;
+    }
 
-  const client = new TestomatClient({ apiKey, title, parallel: true });
+    const client = new TestomatClient({ apiKey, title, parallel: true });
 
-  client.createRun().then(() => {
-    const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: "inherit" });
+    client.createRun().then(() => {
+      const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
 
-    cmd.on("close", (code) => {
-      const emoji = code === 0 ? "🟢" : "🔴";
-      console.log(APP_PREFIX, emoji, `Runner exited with ${chalk.bold(code)}`);
-      const status = code === 0 ? "passed" : "failed";
-      client.updateRunStatus(status, true);
+      cmd.on('close', code => {
+        const emoji = code === 0 ? '🟢' : '🔴';
+        console.log(APP_PREFIX, emoji, `Runner exited with ${chalk.bold(code)}`);
+        const status = code === 0 ? 'passed' : 'failed';
+        client.updateRunStatus(status, true);
 
-      if (code > exitCode) exitCode = code;
-      process.exitCode = exitCode;
+        if (code > exitCode) exitCode = code;
+        process.exitCode = exitCode;
+      });
     });
   });
-});
 
 if (process.argv.length <= 2) {
   program.outputHelp();

package/lib/client.js

@@ -1,16 +1,15 @@
-const axios = require("axios");
-const JsonCycle = require("json-cycle");
-const { URL } = require("url");
-const createCallsiteRecord = require("callsite-record");
-const { sep, join } = require("path");
-const fs = require("fs");
-const chalk = require("chalk");
-const { isPrivate, uploadFile } = require("./fileUploader");
-const { PASSED, FAILED, FINISHED, APP_PREFIX } = require("./constants");
-
-const TESTOMAT_URL = process.env.TESTOMATIO_URL || "https://app.testomat.io";
-const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN } =
-  process.env;
+const axios = require('axios');
+const JsonCycle = require('json-cycle');
+const createCallsiteRecord = require('callsite-record');
+const { sep, join } = require('path');
+const fs = require('fs');
+const chalk = require('chalk');
+const upload = require('./fileUploader');
+const { isValidUrl } = require('./util');
+const { PASSED, FAILED, FINISHED, APP_PREFIX } = require('./constants');
+
+const TESTOMAT_URL = process.env.TESTOMATIO_URL || 'https://app.testomat.io';
+const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN } = process.env;
 
 if (TESTOMATIO_RUN) {
   process.env.runId = TESTOMATIO_RUN;
@@ -54,44 +53,28 @@ class TestomatClient {
     if (!isValidUrl(TESTOMAT_URL.trim())) {
       console.log(
         APP_PREFIX,
-        chalk.red(
-          `Error creating report on Testomat.io, report url '${TESTOMAT_URL}' is invalid`
-        )
+        chalk.red(`Error creating report on Testomat.io, report url '${TESTOMAT_URL}' is invalid`),
       );
       return;
     }
 
     if (runId) {
       this.runId = runId;
-      this.queue = this.queue.then(() =>
-        axios.put(`${TESTOMAT_URL.trim()}/api/reporter/${runId}`, runParams)
-      );
+      this.queue = this.queue.then(() => axios.put(`${TESTOMAT_URL.trim()}/api/reporter/${runId}`, runParams));
       return Promise.resolve(runId);
     }
 
     this.queue = this.queue
-      .then(() =>
-        this.axios
-          .post(`${TESTOMAT_URL.trim()}/api/reporter`, runParams)
-          .then((resp) => {
-            this.runId = resp.data.uid;
-            this.runUrl = `${TESTOMAT_URL}/${resp.data.url
-              .split("/")
-              .splice(3)
-              .join("/")}`;
-            console.log(
-              APP_PREFIX,
-              "📊 Report created. Report ID:",
-              this.runId,
-              chalk.gray(`v${this.version}`)
-            );
-            process.env.runId = this.runId;
-          })
-      )
+      .then(() => this.axios.post(`${TESTOMAT_URL.trim()}/api/reporter`, runParams).then(resp => {
+        this.runId = resp.data.uid;
+        this.runUrl = `${TESTOMAT_URL}/${resp.data.url.split('/').splice(3).join('/')}`;
+        console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId, chalk.gray(`v${this.version}`));
+        process.env.runId = this.runId;
+      }))
       .catch(() => {
         console.log(
           APP_PREFIX,
-          "Error creating report Testomat.io, please check if your API key is valid. Skipping report"
+          'Error creating report Testomat.io, please check if your API key is valid. Skipping report',
         );
       });
 
@@ -104,10 +87,9 @@ class TestomatClient {
    * @returns {Promise}
    */
   async addTestRun(testId, status, testData = {}) {
-    let {
-      message = "",
-      error = "",
-      time = "",
+    const {
+      error = '',
+      time = '',
       example = null,
       files = [],
       steps,
@@ -116,15 +98,17 @@ class TestomatClient {
       suite_id,
       test_id,
     } = testData;
+    let { message = '' } = testData;
 
     const uploadedFiles = [];
 
     if (testId) testData.test_id = testId;
 
-    let stack = "";
+    let stack = '';
 
     if (error) {
       stack = this.formatError(error);
+      message = error.message;
     }
     if (steps) {
       stack = this.formatSteps(stack, steps);
@@ -137,7 +121,7 @@ class TestomatClient {
       }
 
       for (const file of files) {
-        uploadedFiles.push(uploadFile(file, this.runId));
+        uploadedFiles.push(upload.uploadFile(file, this.runId));
       }
     }
 
@@ -147,7 +131,7 @@ class TestomatClient {
 
         global.testomatioArtifacts = [];
 
-        this.totalUploaded += uploadedFiles.filter((n) => n).length;
+        this.totalUploaded += uploadedFiles.filter(n => n).length;
 
         const json = JsonCycle.stringify({
           api_key: this.apiKey,
@@ -164,42 +148,29 @@ class TestomatClient {
           run_time: time,
           artifacts: await Promise.all(uploadedFiles),
         });
-        return this.axios.post(
-          `${TESTOMAT_URL}/api/reporter/${this.runId}/testrun`,
-          json,
-          {
-            maxContentLength: Infinity,
-            maxBodyLength: Infinity,
-            headers: {
-              // Overwrite Axios's automatically set Content-Type
-              "Content-Type": "application/json",
-            },
-          }
-        );
+        return this.axios.post(`${TESTOMAT_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) => {
+      .catch(err => {
         if (err.response) {
           if (err.response.status >= 400) {
-            const data = err.response.data || { message: "" };
+            const data = err.response.data || { message: '' };
             console.log(
               APP_PREFIX,
               chalk.blue(title),
-              `Report couldn't be processed: (${err.response.status}) ${data.message}`
+              `Report couldn't be processed: (${err.response.status}) ${data.message}`,
             );
             return;
           }
-          console.log(
-            APP_PREFIX,
-            chalk.blue(title),
-            `Report couldn't be processed: ${err.response.data.message}`
-          );
+          console.log(APP_PREFIX, chalk.blue(title), `Report couldn't be processed: ${err.response.data.message}`);
         } else {
-          console.log(
-            APP_PREFIX,
-            chalk.blue(title),
-            "Report couldn't be processed",
-            err
-          );
+          console.log(APP_PREFIX, chalk.blue(title), "Report couldn't be processed", err);
         }
       });
 
@@ -216,43 +187,37 @@ class TestomatClient {
       .then(async () => {
         if (this.runId) {
           let statusEvent;
-          if (status === FINISHED) statusEvent = "finish";
-          if (status === PASSED) statusEvent = "pass";
-          if (status === FAILED) statusEvent = "fail";
-          if (isParallel) statusEvent += "_parallel";
+          if (status === FINISHED) statusEvent = 'finish';
+          if (status === PASSED) statusEvent = 'pass';
+          if (status === FAILED) statusEvent = 'fail';
+          if (isParallel) statusEvent += '_parallel';
           await this.axios.put(`${TESTOMAT_URL}/api/reporter/${this.runId}`, {
             api_key: this.apiKey,
             status_event: statusEvent,
             status,
           });
           if (this.runUrl) {
-            console.log(
-              APP_PREFIX,
-              "📊 Report Saved. Report URL:",
-              chalk.magenta(this.runUrl)
-            );
+            console.log(APP_PREFIX, '📊 Report Saved. Report URL:', chalk.magenta(this.runUrl));
           }
 
-          if (this.totalUploaded > 0) {
+          if (upload.isEnabled() && this.totalUploaded > 0) {
             console.log(
               APP_PREFIX,
               `🗄️  Total ${this.totalUploaded} artifacts ${
-                isPrivate ? "privately" : chalk.bold("publicly")
-              } uploaded to S3 bucket  `
+                upload.isPrivate ? 'privately' : chalk.bold('publicly')
+              } uploaded to S3 bucket  `,
             );
           }
         }
       })
-      .catch((err) => {
-        console.log(APP_PREFIX, "Error updating status, skipping...", err);
+      .catch(err => {
+        console.log(APP_PREFIX, 'Error updating status, skipping...', err);
       });
     return this.queue;
   }
 
   formatSteps(stack, steps) {
-    return stack
-      ? `${steps}\n\n${chalk.bold.red("################[ Failure ]################")}\n${stack}`
-      : steps;
+    return stack ? `${steps}\n\n${chalk.bold.red('################[ Failure ]################')}\n${stack}` : steps;
   }
 
   formatError(error, message) {
@@ -263,28 +228,21 @@ class TestomatClient {
 
     // diffs for mocha, cypress, codeceptjs style
     if (error.actual && error.expected) {
-      stack += `\n\n${chalk.bold.green("+ expected")} ${chalk.bold.red(
-        "- actual"
-      )}`;
-      stack += `\n${chalk.red(
-        `- ${error.actual.toString().split("\n").join("\n- ")}`
-      )}`;
-      stack += `\n${chalk.green(
-        `+ ${error.expected.toString().split("\n").join("\n+ ")}`
-      )}`;
-      stack += "\n\n";
+      stack += `\n\n${chalk.bold.green('+ expected')} ${chalk.bold.red('- actual')}`;
+      stack += `\n${chalk.red(`- ${error.actual.toString().split('\n').join('\n- ')}`)}`;
+      stack += `\n${chalk.green(`+ ${error.expected.toString().split('\n').join('\n+ ')}`)}`;
+      stack += '\n\n';
     }
 
     try {
       const record = createCallsiteRecord({
         forError: error,
       });
-      if (record) {
+      if (record && !record.filename.startsWith('http')) {
         stack += record.renderSync({
-          stackFilter: (frame) =>
-            frame.getFileName().indexOf(sep) > -1 &&
-            frame.getFileName().indexOf("node_modules") < 0 &&
-            frame.getFileName().indexOf("internal") < 0,
+          stackFilter: frame => frame.getFileName().indexOf(sep) > -1 &&
+            frame.getFileName().indexOf('node_modules') < 0 &&
+            frame.getFileName().indexOf('internal') < 0,
         });
       }
       return stack;
@@ -295,12 +253,3 @@ class TestomatClient {
 }
 
 module.exports = TestomatClient;
-
-function isValidUrl(s) {
-  try {
-    new URL(s); // eslint-disable-line
-    return true;
-  } catch (err) {
-    return false;
-  }
-}

package/lib/constants.js

@@ -1,11 +1,11 @@
-const chalk = require("chalk");
+const chalk = require('chalk');
 
-const APP_PREFIX = chalk.gray("[TESTOMATIO]");
+const APP_PREFIX = chalk.gray('[TESTOMATIO]');
 
 module.exports = Object.freeze({
-  PASSED: "passed",
-  FAILED: "failed",
-  SKIPPED: "skipped",
-  FINISHED: "finished",
+  PASSED: 'passed',
+  FAILED: 'failed',
+  SKIPPED: 'skipped',
+  FINISHED: 'finished',
   APP_PREFIX,
 });