@testomatio/reporter 0.4.3 → 0.5.0-beta.1

package/lib/fileUploader.js

@@ -1,10 +1,13 @@
-const AWS = require("aws-sdk");
-const fs = require("fs");
-const path = require("path");
-const chalk = require("chalk");
+const AWS = require('aws-sdk');
+const fs = require('fs');
+const path = require('path');
+const chalk = require('chalk');
+const { APP_PREFIX } = require('./constants');
 
 const isPrivate = process.env.TESTOMATIO_PRIVATE_ARTIFACTS;
 
+const isEnabled = () => process.env.S3_BUCKET && !process.env.TESTOMATIO_DISABLE_ARTIFACTS;
+
 const uploadUsingS3 = async (filePath, runId) => {
   const region = process.env.S3_REGION;
   const bucket = process.env.S3_BUCKET;
@@ -32,26 +35,50 @@ const uploadUsingS3 = async (filePath, runId) => {
   const file = fs.readFileSync(filePath);
 
   fileName = `${runId}/${fileName || path.basename(filePath)}`;
+  const acl = isPrivate ? 'private' : 'public-read';
+
+  try {
+    const out = await s3
+      .upload({
+        Bucket: bucket,
+        Key: fileName,
+        Body: file,
+        ContentType: contentType,
+        ACL: acl,
+      })
+      .promise();
+    return out.Location;
+  } catch (e) {
+    console.log(APP_PREFIX, chalk.bold.red(`Failed uploading '${fileName}'. Please check S3 credentials`), {
+      accessKeyId,
+      secretAccessKey: secretAccessKey ? '**** (hidden) ***' : '(empty)',
+      region,
+      bucket,
+      acl,
+      endpoint: process.env.S3_ENDPOINT,
+    });
 
-  const out = await s3
-    .upload({
-      Bucket: bucket,
-      Key: fileName,
-      Body: file,
-      ContentType: contentType,
-      ACL: isPrivate ? "private" : "public-read",
-    })
-    .promise();
-  return out.Location;
+    console.log(APP_PREFIX, `To ${chalk.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
+    if (!isPrivate) {
+      console.log(APP_PREFIX, `To enable ${chalk.bold('PRIVATE')} uploads set: TESTOMATIO_PRIVATE_ARTIFACTS=1`);
+    } else {
+      console.log(
+        APP_PREFIX,
+        `To enable ${chalk.bold('PUBLIC')} uploads remove TESTOMATIO_PRIVATE_ARTIFACTS env variable`,
+      );
+    }
+    console.log(APP_PREFIX, '---------------');
+    return null;
+  }
 };
 
 const uploadFile = async (filePath, runId) => {
   try {
-    if (process.env.S3_BUCKET) {
+    if (isEnabled()) {
       return uploadUsingS3(filePath, runId);
     }
   } catch (e) {
-    console.error(chalk.red("Error occurred while uploading artifacts"), e);
+    console.error(chalk.red('Error occurred while uploading artifacts'), e);
   }
   return null;
 };
@@ -59,4 +86,5 @@ const uploadFile = async (filePath, runId) => {
 module.exports = {
   uploadFile,
   isPrivate,
+  isEnabled,
 };

package/lib/output.js

@@ -1,8 +1,10 @@
-const util = require("util");
+const { format } = require('util');
 
 const consoleLog = console.log;
 const consoleError = console.error;
 
+const formatArgs = args => format.apply(format, Array.prototype.slice.call(args));
+
 class Output {
   constructor(opts = {}) {
     this.filterFn = opts.filterFn || (() => true);
@@ -17,7 +19,7 @@ class Output {
   start() {
     const { filterFn } = this;
     const self = this;
-    console.log = function (...args) {
+    console.log = (...args) => {
       const obj = {};
       Error.captureStackTrace(obj);
       const logString = formatArgs(args);
@@ -27,7 +29,7 @@ class Output {
       consoleLog(logString);
     };
 
-    console.error = function (...args) {
+    console.error = (...args) => {
       const obj = {};
       Error.captureStackTrace(obj);
       const logString = formatArgs(args);
@@ -43,7 +45,7 @@ class Output {
   }
 
   text() {
-    return this.log.join("\n");
+    return this.log.join('\n');
   }
 
   stop() {
@@ -53,7 +55,3 @@ class Output {
 }
 
 module.exports = Output;
-
-function formatArgs(args) {
-  return util.format.apply(util.format, Array.prototype.slice.call(args));
-}

package/lib/reporter.js

@@ -1,5 +1,5 @@
-const TestomatClient = require("./client");
-const TRConstants = require("./constants");
+const TestomatClient = require('./client');
+const TRConstants = require('./constants');
 
 module.exports = {
   TestomatClient,

package/lib/util.js

@@ -1,9 +1,11 @@
+const { URL } = require('url');
+
 /**
  * @param {String} testTitle - Test title
  *
  * @returns {String} testId
  */
-const parseTest = (testTitle) => {
+const parseTest = testTitle => {
   const captures = testTitle.match(/@T([\w\d]+)/);
   if (captures) {
     return captures[1];
@@ -14,14 +16,25 @@ const parseTest = (testTitle) => {
 
 const ansiRegExp = () => {
   const pattern = [
-    "[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)",
-    "(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))",
-  ].join("|");
+    '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
+    '(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))',
+  ].join('|');
+
+  return new RegExp(pattern, 'g');
+};
 
-  return new RegExp(pattern, "g");
+const isValidUrl = s => {
+  try {
+    // eslint-disable-next-line no-new
+    new URL(s);
+    return true;
+  } catch (err) {
+    return false;
+  }
 };
 
 module.exports = {
   parseTest,
   ansiRegExp,
+  isValidUrl,
 };

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@testomatio/reporter",
-  "version": "0.4.3",
+  "version": "0.5.0-beta.1",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "repository": "git@github.com:testomatio/reporter.git",
   "author": "Koushik Mohan <koushikmohan1996@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "aws-sdk": "^2.827.0",
-    "axios": "^0.21.1",
-    "callsite-record": "^4.1.3",
+    "aws-sdk": "^2.1064.0",
+    "axios": "^0.25.0",
+    "callsite-record": "^4.1.4",
     "chalk": "^4.1.0",
     "commander": "^4.1.1",
     "has-flag": "^5.0.1",
@@ -17,23 +17,35 @@
   },
   "scripts": {
     "pretty": "prettier --write .",
-    "lint": "eslint lib --fix"
+    "lint": "eslint lib",
+    "lint:fix": "eslint lib --fix",
+    "test": "npm run test:adapter",
+    "test:adapter": "mocha './tests/adapter/index.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",
+    "test:adapter:codecept:example": "codeceptjs run --config='./tests/adapter/examples/codecept/codecept.conf.js'"
   },
   "peerDependencies": {
+    "@wdio/reporter": "*",
     "codeceptjs": "*",
     "cucumber": "*",
-    "mocha": "*",
-    "@wdio/reporter": "*"
+    "mocha": "*"
   },
   "devDependencies": {
-    "@wdio/reporter": "^7.8.0",
-    "codeceptjs": "^3.0.4",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-plugin-import": "^2.22.1",
-    "jest": "^25.5.4",
-    "prettier": "2.3.2",
-    "puppeteer": "^2.1.1"
+    "@wdio/reporter": "^7.16.13",
+    "chai": "^4.3.6",
+    "codeceptjs": "^3.2.3",
+    "eslint": "^8.7.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.25.4",
+    "jasmine": "^3.10.0",
+    "jest": "^27.4.7",
+    "mocha": "^9.2.0",
+    "mock-http-server": "^1.4.5",
+    "prettier": "2.5.1",
+    "puppeteer": "^13.1.2"
   },
   "bin": {
     "start-test-run": "./lib/bin/startTest.js"

package/testcafe/index.js

@@ -1,19 +1,19 @@
-const TestomatClient = require("@testomatio/reporter/lib/client");
-const TRConstants = require("@testomatio/reporter/lib/constants");
-const util = require("@testomatio/reporter/lib/util");
+const TestomatClient = require('@testomatio/reporter/lib/client');
+const TRConstants = require('@testomatio/reporter/lib/constants');
+const util = require('@testomatio/reporter/lib/util');
 
-module.exports = function () {
+module.exports = () => {
   const apiKey = process.env.TESTOMATIO;
   let failed = false;
 
-  if (apiKey === "" || apiKey === undefined) {
-    throw new Error("Testomat.io API key cannot be empty");
+  if (apiKey === '' || apiKey === undefined) {
+    throw new Error('Testomat.io API key cannot be empty');
   }
   const client = new TestomatClient({ apiKey });
 
   return {
     reportTaskStart(startTime, userAgents) {
-      console.log("TestCafe started with: ", userAgents);
+      console.log('TestCafe started with: ', userAgents);
       client.createRun();
     },
 
@@ -23,7 +23,7 @@ module.exports = function () {
 
     reportTestDone(name, testRunInfo) {
       let status = TRConstants.PASSED;
-      let message = "";
+      let message = '';
 
       if (testRunInfo.skipped) {
         status = TRConstants.SKIPPED;
@@ -43,16 +43,13 @@ module.exports = function () {
     },
 
     renderErrors(errors) {
-      let errorMessage = "";
+      let errorMessage = '';
       errors.forEach((error, id) => {
-        errorMessage = `${errorMessage}${this.formatError(
-          error,
-          `${id + 1} `
-        )}\n`;
+        errorMessage = `${errorMessage}${this.formatError(error, `${id + 1} `)}\n`;
       });
 
       console.log(errorMessage);
-      return errorMessage.replace(util.ansiRegExp(), "");
+      return errorMessage.replace(util.ansiRegExp(), '');
     },
 
     reportTaskDone() {

package/tests/adapter/config/index.js

@@ -0,0 +1,10 @@
+const host = 'localhost';
+const port = 9000;
+
+module.exports = {
+  host,
+  port,
+  TESTOMATIO_URL: `http://${host}:${port}`,
+  TESTOMATIO: 'e84d71b06590', // example api key
+  RUN_ID: '0957aa26', // example run id
+};

package/tests/adapter/examples/codecept/codecept.conf.js

@@ -0,0 +1,33 @@
+exports.config = {
+  tests: './*_test.js',
+  output: './output',
+  helpers: {
+    Puppeteer: {
+      url: 'http://localhost',
+      show: false,
+    },
+  },
+  include: {
+    I: './steps_file.js',
+  },
+  bootstrap: null,
+  mocha: {},
+  name: 'codecept',
+  plugins: {
+    pauseOnFail: {},
+    retryFailedStep: {
+      enabled: true,
+    },
+    tryTo: {
+      enabled: true,
+    },
+    screenshotOnFail: {
+      enabled: true,
+    },
+    testomat: {
+      enabled: true,
+      require: '../../../../lib/adapter/codecept',
+      apiKey: 'lz8ea4948ud5',
+    },
+  },
+};

package/tests/adapter/examples/codecept/index_test.js

@@ -0,0 +1,11 @@
+/* eslint-disable no-undef */
+Feature('Suite 1 @S25e19ba9');
+
+Scenario('Test issue for suite 1 @Tca70c8c4', ({ I }) => {
+  I.amOnPage('https://github.com/login');
+  I.see('GitHub');
+  I.fillField('login', 'randomuser_kmk');
+  I.fillField('password', 'randomuser_kmk');
+  I.click('Sign in');
+  I.see('Repositories');
+});

package/tests/adapter/examples/codecept/jsconfig.json

@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "allowJs": true
+  }
+}

package/tests/adapter/examples/codecept/sample_test.js

@@ -0,0 +1,7 @@
+/* eslint-disable no-undef */
+Feature('Suite 2 @S2bf55e11');
+
+Scenario('Test for suite 2 @Tc2171bd2', ({ I }) => {
+  I.amOnPage('https://github.com/login');
+  I.see('GitHub');
+});

package/tests/adapter/examples/codecept/steps_file.js

@@ -0,0 +1,10 @@
+// in this file you can append custom step methods to 'I' object
+
+module.exports = function () {
+  return actor({
+
+    // Define custom steps here, use 'this' to access default methods of I.
+    // It is recommended to place a general 'login' function here.
+
+  });
+};

package/tests/adapter/examples/jasmine/index.test.js

@@ -0,0 +1,11 @@
+/* eslint-disable no-undef */
+
+describe('Suite 1', () => {
+  it('Test addition', () => {
+    expect(1 + 2).toBe(4);
+  });
+
+  it('Test some more addition', () => {
+    expect(1 + 2).toBe(3);
+  });
+});

package/tests/adapter/examples/jasmine/passReporterOpts.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+if [ $TESTOMATIO ]
+then
+   sed -i "s/new Report(.*)/new Report({ apiKey: '${TESTOMATIO}' })/" ./node_modules/jasmine/lib/loadConfig.js
+else
+   sed -i "s/new Report(.*)/new Report()/" ./node_modules/jasmine/lib/loadConfig.js
+fi

package/tests/adapter/examples/jest/index.test.js

@@ -0,0 +1,11 @@
+/* eslint-disable no-undef */
+
+describe('Suite 1', () => {
+  test('Test addition', () => {
+    expect(1 + 2).toBe(4);
+  });
+
+  test('Test some more addition', () => {
+    expect(1 + 2).toBe(3);
+  });
+});

package/tests/adapter/examples/jest/jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  reporters: ['default', ['<rootDir>/../../../../lib/adapter/jest.js', { apiKey: process.env.TESTOMATIO }]],
+  silent: true,
+};

package/tests/adapter/examples/mocha/index.test.js

@@ -0,0 +1,13 @@
+const assert = require('assert');
+
+describe('Sample mocha suite', () => {
+  it('Sample mocha test', () => {
+    assert.equal([1, 2, 3].indexOf(4), 0);
+  });
+});
+
+describe('Sample mocha suite 2', () => {
+  it('Sample mocha test 2', () => {
+    assert.equal(1, 1);
+  });
+});

package/tests/adapter/examples/mocha/mocha.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  reporter: './lib/adapter/mocha.js',
+  reporterOptions: process.env.TESTOMATIO ? `apiKey=${process.env.TESTOMATIO}` : '',
+};

package/tests/adapter/index.test.js

@@ -0,0 +1,136 @@
+const { assert } = require('chai');
+const { exec } = require('child_process');
+const ServerMock = require('mock-http-server');
+const JestReporter = require('../../lib/adapter/jest');
+const MochaReporter = require('../../lib/adapter/mocha');
+const JasmineReporter = require('../../lib/adapter/jasmine');
+const CodeceptReporter = require('../../lib/adapter/codecept');
+const { registerHandlers } = require('./utils');
+const { host, port, TESTOMATIO_URL, TESTOMATIO, RUN_ID } = require('./config');
+
+const params = [
+  {
+    adapterName: JestReporter.name,
+    positiveCmd: `TESTOMATIO_URL=${TESTOMATIO_URL} TESTOMATIO=${TESTOMATIO} npm run test:adapter:jest:example`,
+    negativeCmd: `TESTOMATIO_URL=${TESTOMATIO_URL} npm run test:adapter:jest:example`,
+  },
+  {
+    adapterName: MochaReporter.name,
+    positiveCmd: `TESTOMATIO_URL=${TESTOMATIO_URL} TESTOMATIO=${TESTOMATIO} npm run test:adapter:mocha:example`,
+    negativeCmd: `TESTOMATIO_URL=${TESTOMATIO_URL} npm run test:adapter:mocha:example`,
+  },
+  {
+    adapterName: JasmineReporter.name,
+    positiveCmd: `TESTOMATIO_URL=${TESTOMATIO_URL} TESTOMATIO=${TESTOMATIO} npm run test:adapter:jasmine:example`,
+    negativeCmd: `TESTOMATIO_URL=${TESTOMATIO_URL} npm run test:adapter:jasmine:example`,
+  },
+  {
+    adapterName: CodeceptReporter.name,
+    positiveCmd: `TESTOMATIO_URL=${TESTOMATIO_URL} TESTOMATIO=${TESTOMATIO} npm run test:adapter:jasmine:example`,
+    negativeCmd: `TESTOMATIO_URL=${TESTOMATIO_URL} npm run test:adapter:jasmine:example`,
+  },
+];
+
+describe('Adapters', () => {
+  const server = new ServerMock({ host, port });
+
+  before(done => {
+    server.start(() => {
+      console.log(`[mock-http-server]: Server started at ${TESTOMATIO_URL}`);
+
+      done();
+    });
+  });
+
+  after(done => {
+    server.stop(() => {
+      console.log('[mock-http-server]: Server stopped');
+
+      done();
+    });
+  });
+
+  for (const { adapterName, positiveCmd, negativeCmd } of params) {
+    describe(adapterName, () => {
+      describe('positive tests', () => {
+        before(function (done) {
+          this.timeout(5000);
+
+          registerHandlers(server, RUN_ID);
+
+          exec(positiveCmd, () => done());
+        });
+
+        after(() => {
+          server.reset();
+        });
+
+        it('POST :: /api/reporter :: should create a report if api_key has been provided', () => {
+          const [req] = server.requests({ method: 'POST', path: '/api/reporter' });
+
+          const expectedResult = { api_key: TESTOMATIO };
+
+          assert.isObject(req.body);
+          assert.deepEqual(req.body, expectedResult);
+        });
+
+        it('PUT :: /api/reporter/:runId :: should update run status', () => {
+          const [req] = server.requests({ method: 'PUT', path: `/api/reporter/${RUN_ID}` });
+
+          const expectedResult = { api_key: TESTOMATIO, status_event: 'fail', status: 'failed' };
+
+          assert.isObject(req.body);
+          assert.deepEqual(req.body, expectedResult);
+        });
+
+        it('POST :: /api/reporter/:runId/testrun :: should add a new test to run instance', () => {
+          const reqs = server.requests({ method: 'POST', path: `/api/reporter/${RUN_ID}/testrun` });
+
+          const expectedRequiredBodyKeys = [
+            'api_key',
+            'files',
+            // 'steps',
+            'status',
+            'stack',
+            'example',
+            'title',
+            'message',
+            'run_time',
+            'artifacts',
+          ];
+
+          for (const req of reqs) {
+            assert.isObject(req.body);
+            assert.includeMembers(Object.keys(req.body), expectedRequiredBodyKeys);
+
+            assert.strictEqual(req.body.api_key, TESTOMATIO);
+            assert.isString(req.body.status);
+            assert.isString(req.body.title);
+            assert.isNumber(req.body.run_time);
+          }
+        });
+      });
+
+      describe('negative tests', () => {
+        before(function (done) {
+          this.timeout(5000);
+
+          registerHandlers(server, RUN_ID);
+
+          exec(negativeCmd, () => done());
+        });
+
+        after(() => {
+          server.reset();
+        });
+
+        it('should ignore reporter if api_key has not been provided', () => {
+          const requests = server.requests();
+
+          assert.isArray(requests);
+          assert.isEmpty(requests);
+        });
+      });
+    });
+  }
+});

package/tests/adapter/utils/index.js

@@ -0,0 +1,40 @@
+const registerHandlers = (server, RUN_ID) => {
+  // client.createRun()
+  server.on({
+    method: 'POST',
+    path: '/api/reporter',
+    reply: {
+      status: 200,
+      headers: { 'content-type': 'application/json' },
+      body: JSON.stringify({
+        uid: RUN_ID,
+        url: `http://127.0.0.1:3000/projects/test-project/runs/${RUN_ID}/report`,
+      }),
+    },
+  });
+
+  // client.updateRunStatus()
+  server.on({
+    method: 'PUT',
+    path: `/api/reporter/${RUN_ID}`,
+    reply: {
+      status: 200,
+      headers: { 'content-type': 'application/json' },
+    },
+  });
+
+  // client.addTestRun()
+  server.on({
+    method: 'POST',
+    path: `/api/reporter/${RUN_ID}/testrun`,
+    reply: {
+      status: 400,
+      headers: { 'content-type': 'application/json' },
+      body: JSON.stringify({ message: 'Test could not be matched' }),
+    },
+  });
+};
+
+module.exports = {
+  registerHandlers,
+};

package/.prettierrc.json

@@ -1 +0,0 @@
-{}