@testomatio/reporter 0.8.0-beta.30 → 0.8.0-beta.32

package/lib/adapter/mocha.js

@@ -1,63 +1,98 @@
 // eslint-disable-next-line global-require, import/no-extraneous-dependencies
 const Mocha = require('mocha');
+const debug = require('debug')('@testomatio/reporter:adapter:mocha');
 const chalk = require('chalk');
 const TestomatClient = require('../client');
-const TRConstants = require('../constants');
-const { parseTest } = require('../util');
+const { STATUS } = require('../constants');
+const { parseTest, specificTestInfo } = require('../util');
+const ArtifactStorage = require('../ArtifactStorage');
 
 const { EVENT_RUN_BEGIN, EVENT_RUN_END, EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING } = Mocha.Runner.constants;
 
 function MochaReporter(runner, opts) {
   Mocha.reporters.Base.call(this, runner);
-  let passes = 0; let failures = 0; let skipped = 0; // eslint-disable-line no-unused-vars
+  let passes = 0; let failures = 0; let skipped = 0;
+  let artifactStore;
 
   const apiKey = opts?.reporterOptions?.apiKey || process.env.TESTOMATIO;
 
   if (!apiKey) {
-    console.log('TESTOMATIO key is empty, ignoring reports');
+    debug('TESTOMATIO key is empty, ignoring reports');
     return;
   }
   const client = new TestomatClient({ apiKey });
 
   runner.on(EVENT_RUN_BEGIN, () => {
     client.createRun();
+
+    const params = { 
+      toFile: true
+    };
+    
+    artifactStore = runner._workerReporter !== undefined
+      ? new ArtifactStorage(params)
+      : new ArtifactStorage();
   });
 
-  runner.on(EVENT_TEST_PASS, test => {
+  runner.on(EVENT_TEST_PASS, async(test) => {
     passes += 1;
     console.log(chalk.bold.green('✔'), test.fullTitle());
     const testId = parseTest(test.title);
-    client.addTestRun(testId, TRConstants.PASSED, {
-      title: test.title,
-      time: test.duration,
-    });
+
+    const specificTest =  specificTestInfo(test);
+    const content = await artifactStore.artifactByTestName(specificTest);
+
+    debug(`test=${specificTest} content = `, content);
+
+    client.addTestRun(
+      STATUS.PASSED, 
+      {
+        test_id: testId,
+        title: test.title,
+        time: test.duration,
+      },
+      content
+    );
   });
 
   runner.on(EVENT_TEST_PENDING, test => {
     skipped += 1;
     console.log('skip: %s', test.fullTitle());
     const testId = parseTest(test.title);
-    client.addTestRun(testId, TRConstants.SKIPPED, {
+    client.addTestRun(STATUS.SKIPPED, {
       title: test.title,
+      test_id: testId,
       time: test.duration,
     });
   });
 
-  runner.on(EVENT_TEST_FAIL, (test, err) => {
+  runner.on(EVENT_TEST_FAIL, async(test, err) => {
     failures += 1;
     console.log(chalk.bold.red('✖'), test.fullTitle(), chalk.gray(err.message));
     const testId = parseTest(test.title);
-    client.addTestRun(testId, TRConstants.FAILED, {
-      error: err,
-      title: test.title,
-      time: test.duration,
-    });
+
+    const specificTest =  specificTestInfo(test);
+    const content = await artifactStore.artifactByTestName(specificTest);
+
+    debug(`fail test=${specificTest} content = `, content);
+
+    client.addTestRun(
+      STATUS.FAILED, {
+        error: err,
+        test_id: testId,
+        title: test.title,
+        time: test.duration,
+      }, 
+      content
+    );
   });
 
   runner.on(EVENT_RUN_END, () => {
-    const status = failures === 0 ? TRConstants.PASSED : TRConstants.FAILED;
-    console.log(chalk.bold(status), `${passes} passed, ${failures} failed`);
+    const status = failures === 0 ? STATUS.PASSED : STATUS.FAILED;
+    console.log(chalk.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
     client.updateRunStatus(status);
+
+    artifactStore.cleanup();
   });
 }
 

package/lib/adapter/playwright.js

@@ -3,11 +3,12 @@ const crypto = require('crypto');
 const os = require('os');
 const path = require('path');
 const fs = require('fs');
-const Status = require('../constants');
+const { APP_PREFIX, STATUS: Status } = require('../constants');
 const TestomatioClient = require('../client');
 const upload = require('../fileUploader');
 const { parseTest } = require('../util');
 
+
 class TestomatioReporter {
   constructor(config = {}) {
     this.client = new TestomatioClient({ apiKey: config?.apiKey });
@@ -56,8 +57,9 @@ class TestomatioReporter {
       files.push({ path: fileName, type: attachment.contentType });
     }
 
-    this.client.addTestRun(testId, checkStatus(result.status), {
+    this.client.addTestRun(checkStatus(result.status), {
       error,
+      test_id: testId,
       suite_title,
       title,
       files,
@@ -70,14 +72,15 @@ class TestomatioReporter {
     if (!this.client) return;
 
     if (this.videos.length && upload.isArtifactsEnabled()) {
-      console.log(Status.APP_PREFIX, `🎞️  Uploading ${this.videos.length} videos...`);
+      console.log(APP_PREFIX, `🎞️  Uploading ${this.videos.length} videos...`);
 
       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, {
+          this.client.addTestRun(undefined, {
+            test_id: testId,
             title,
             suite_title,
             files: [file],

package/lib/adapter/webdriver.js

@@ -43,9 +43,10 @@ class WebdriverReporter extends WDIOReporter {
       .filter(el => el.endpoint === screenshotEndpoint && el.result && el.result.value)
       .map(el => Buffer.from(el.result.value, 'base64'));
 
-    await this.client.addTestRun(testId, state, {
+    await this.client.addTestRun(state, {
       error,
       title,
+      test_id: testId,
       time: duration,
       filesBuffers: screenshotsBuffers,
     });

package/lib/bin/reportXml.js

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
-
 const program = require("commander");
 const chalk = require("chalk");
 const glob = require('glob');

package/lib/bin/startTest.js

@@ -3,7 +3,7 @@ const { spawn } = require('child_process');
 const program = require('commander');
 const chalk = require('chalk');
 const TestomatClient = require('../client');
-const { APP_PREFIX, FINISHED } = require('../constants');
+const { APP_PREFIX, STATUS } = require('../constants');
 const { version } = require('../../package.json');
 
 console.log(chalk.cyan.bold(` 🤩 Testomat.io Reporter v${version}`));
@@ -42,7 +42,7 @@ program
 
       const client = new TestomatClient({ apiKey });
 
-      client.updateRunStatus(FINISHED, true).then(() => {
+      client.updateRunStatus(STATUS.FINISHED, true).then(() => {
         console.log(chalk.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
         process.exit(0);
       });

package/lib/client.js

@@ -1,26 +1,28 @@
+const debug = require('debug')('@testomatio/reporter:client');
 const createCallsiteRecord = require('callsite-record');
 const { sep, join } = require('path');
 const fs = require('fs');
 const chalk = require('chalk');
+const { randomUUID } = require('crypto');
 const upload = require('./fileUploader');
-const { PASSED, FAILED, FINISHED, APP_PREFIX } = require('./constants');
+const { APP_PREFIX } = require('./constants');
 const pipesFactory = require('./pipe');
 
-const { TESTOMATIO_ENV } = process.env;
+/**
+ * @typedef {import('../types').TestData} TestData
+ * @typedef {import('../types').RunStatus} RunStatus
+ */
 
-class TestomatClient {
+class Client {
   /**
    * Create a Testomat client instance
    *
    * @param {*} params
    */
   constructor(params = {}) {
-    this.title = params.title || process.env.TESTOMATIO_TITLE;
-    this.createNewTests = params.createNewTests ?? !!process.env.TESTOMATIO_CREATE;
-    this.proceed = process.env.TESTOMATIO_PROCEED;
-    this.env = TESTOMATIO_ENV;
     this.parallel = params.parallel;
     const store = {};
+    this.uuid = randomUUID();
     this.pipes = pipesFactory(params, store);
     this.queue = Promise.resolve();
     this.totalUploaded = 0;
@@ -31,11 +33,11 @@ class TestomatClient {
   /**
    * Used to create a new Test run
    *
-   * @returns {Promise} - resolves to Run id which should be used to update / add test
+   * @returns {Promise<void>} - resolves to Run id which should be used to update / add test
    */
   createRun() {
     // all pipes disabled, skipping
-    if (!this.pipes.filter(p => p.isEnabled).length) return;
+    if (!this.pipes.filter(p => p.isEnabled).length) return Promise.resolve();
 
     const runParams = {
       title: this.title,
@@ -47,27 +49,37 @@ class TestomatClient {
 
     this.queue = this.queue
       .then(() => Promise.all(this.pipes.map(p => p.createRun(runParams))))
-      .catch(err => console.log(APP_PREFIX, err));
-
+      .catch(err => console.log(APP_PREFIX, err))
+      .then(() => undefined); // fixes return type
+    debug('Run', this.queue);
     return this.queue;
   }
 
   /**
-   * Used to add a new test to Run instance
-   *
-   * @returns {Promise}
+   * Updates test status and its data
+   * 
+   * @param {string|undefined} status
+   * @param {TestData} [testData]
+   * @param {string[]} [storeArtifacts]
+   * @returns {Promise<void>}
    */
-  async addTestRun(testId, status, testData = {}) {
+  async addTestRun(status, testData, storeArtifacts = []) {
     // all pipes disabled, skipping
     if (!this.pipes.filter(p => p.isEnabled).length) return;
 
+    if (!testData) testData = {
+      title: 'Unknown test',
+      suite_title: 'Unknown suite',
+    }
+
     const {
-      error = '',
+      error = null,
       time = '',
       example = null,
       files = [],
       filesBuffers = [],
       steps,
+      code = null,
       title,
       suite_title,
       suite_id,
@@ -77,30 +89,34 @@ class TestomatClient {
 
     const uploadedFiles = [];
 
-    if (testId) testData.test_id = testId;
-
     let stack = '';
 
     if (error) {
-      stack = this.formatError(error);
-      message = error.message;
+      stack = this.formatError(error) || '';
+      message = error?.message;
     }
     if (steps) {
       stack = this.formatSteps(stack, steps);
     }
 
+    if (Array.isArray(storeArtifacts) && storeArtifacts.length) {
+      debug("CLIENT storeArtifact", storeArtifacts);
+      files.push(...storeArtifacts);
+    }
+
     if (Array.isArray(global.testomatioArtifacts)) {
+      debug("CLIENT global[testomatioArtifacts]", global.testomatioArtifacts);
       files.push(...global.testomatioArtifacts);
       global.testomatioArtifacts = [];
     }
 
     for (const file of files) {
-      uploadedFiles.push(upload.uploadFileByPath(file, this.runId));
+      uploadedFiles.push(upload.uploadFileByPath(file, this.uuid));
     }
 
     for (const [idx, buffer] of filesBuffers.entries()) {
       const fileName = `${idx + 1}-${title.replace(/\s+/g, '-')}`;
-      uploadedFiles.push(upload.uploadFileAsBuffer(buffer, fileName, this.runId));
+      uploadedFiles.push(upload.uploadFileAsBuffer(buffer, fileName, this.uuid));
     }
 
     const artifacts = await Promise.all(uploadedFiles);
@@ -115,6 +131,7 @@ class TestomatClient {
       status,
       stack,
       example,
+      code,
       title,
       suite_title,
       suite_id,
@@ -126,38 +143,40 @@ class TestomatClient {
 
     this.queue = this.queue
       .then(() => Promise.all(this.pipes.map(p => p.addTest(data))))
-      .catch(err => console.log(APP_PREFIX, err));
+      .catch(err => console.log(APP_PREFIX, err))
+      .then(() => undefined);
     return this.queue;
   }
 
   /**
-   * Update run status
    *
-   * @returns {Promise}
+   * Updates the status of the current test run and finishes the run.
+   * @param {RunStatus} status - The status of the current test run. Must be one of "passed", "failed", or "finished"
+   * @param {boolean} [isParallel] - Whether the current test run was executed in parallel with other tests.
+   * @returns {Promise<void>} - A Promise that resolves when finishes the run.
    */
-  updateRunStatus(status, isParallel) {
+  updateRunStatus(status, isParallel = false) {
     // all pipes disabled, skipping
-    if (!this.pipes.filter(p => p.isEnabled).length) return;
+    if (!this.pipes.filter(p => p.isEnabled).length) return Promise.resolve();
 
-    let statusEvent;
-    if (status === FINISHED) statusEvent = 'finish';
-    if (status === PASSED) statusEvent = 'pass';
-    if (status === FAILED) statusEvent = 'fail';
-    if (isParallel) statusEvent += '_parallel';
-    const runParams = { status, statusEvent };
+    const runParams = { status, parallel: isParallel };
 
     this.queue = this.queue
       .then(() => Promise.all(this.pipes.map(p => p.finishRun(runParams))))
+      .then(() => {
+        debug("TOTAL uploaded files", this.totalUploaded);
+        
+        if (upload.isArtifactsEnabled() && this.totalUploaded > 0) {
+          console.log(
+            APP_PREFIX,
+            `🗄️  Total ${this.totalUploaded} artifacts ${
+              process.env.TESTOMATIO_PRIVATE_ARTIFACTS ? 'privately' : chalk.bold('publicly')
+            } uploaded to S3 bucket  `,
+          );
+        }
+      })
       .catch(err => console.log(APP_PREFIX, err));
 
-    if (upload.isArtifactsEnabled() && this.totalUploaded > 0) {
-      console.log(
-        APP_PREFIX,
-        `🗄️  Total ${this.totalUploaded} artifacts ${
-          process.env.TESTOMATIO_PRIVATE_ARTIFACTS ? 'privately' : chalk.bold('publicly')
-        } uploaded to S3 bucket  `,
-      );
-    }
     return this.queue;
   }
 
@@ -198,4 +217,4 @@ class TestomatClient {
   }
 }
 
-module.exports = TestomatClient;
+module.exports = Client;

package/lib/constants.js

@@ -1,6 +1,7 @@
 const chalk = require('chalk');
 
 const APP_PREFIX = chalk.gray('[TESTOMATIO]');
+const TESTOMAT_ARTIFACT_SUFFIX = "testomatio_artifact_";
 
 const CSV_HEADERS = [
   { id: 'suite_title', title: 'Suite_title' },
@@ -10,11 +11,16 @@ const CSV_HEADERS = [
   { id: 'stack', title: 'Stack' },
 ];
 
-module.exports = Object.freeze({
+const STATUS = {
   PASSED: 'passed',
   FAILED: 'failed',
   SKIPPED: 'skipped',
   FINISHED: 'finished',
+};
+
+module.exports = {
   APP_PREFIX,
-  CSV_HEADERS
-});
+  TESTOMAT_ARTIFACT_SUFFIX,
+  CSV_HEADERS,
+  STATUS,
+}

package/lib/fileUploader.js

@@ -1,6 +1,6 @@
-const debug = require('debug')('@testomatio/reporter:upload');
+const debug = require('debug')('@testomatio/reporter:file-uploader');
 const { S3 } = require('@aws-sdk/client-s3');
-const { Upload } = require("@aws-sdk/lib-storage");
+const { Upload } = require('@aws-sdk/lib-storage');
 const fs = require('fs');
 const path = require('path');
 const chalk = require('chalk');
@@ -88,7 +88,9 @@ const uploadUsingS3 = async (filePath, runId) => {
     return;
   }
 
-  const {  S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_ENDPOINT, TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET } = getConfig();
+  const {
+    S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_ENDPOINT, TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET
+  } = getConfig();
   
   const file = fs.readFileSync(filePath);
 
@@ -139,7 +141,9 @@ const uploadUsingS3 = async (filePath, runId) => {
 
 const uploadUsingS3AsBuffer = async (buffer, fileName, runId) => {
 
-  const {  S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_ENDPOINT, TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET } = getConfig();
+  const {
+    S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_ENDPOINT, TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET
+  } = getConfig();
 
   const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
 

package/lib/junit-adapter/csharp.js

@@ -14,5 +14,4 @@ class CSharpAdapter extends Adapter {
   }
 }
 
-
 module.exports = CSharpAdapter;

package/lib/junit-adapter/index.js

@@ -5,8 +5,7 @@ const PythonAdapter = require('./python');
 const RubyAdapter = require('./ruby');
 const CSharpAdapter = require('./csharp');
 
-
-module.exports = function (lang, opts) {
+function AdapterFactory(lang, opts) {
   if (!lang) return new Adapter(opts);
 
   if (lang === 'java') {
@@ -25,3 +24,5 @@ module.exports = function (lang, opts) {
     return new CSharpAdapter(opts);
   }
 }
+
+module.exports = AdapterFactory;

package/lib/pipe/csv.js

@@ -1,3 +1,4 @@
+const debug = require('debug')('@testomatio/reporter:pipe:csv');
 const path = require('path');
 const fs = require('fs');
 const csvWriter = require('csv-writer');
@@ -6,9 +7,16 @@ const merge = require('lodash.merge');
 const { isSameTest, getCurrentDateTime } = require('../util');
 const { CSV_HEADERS } = require('../constants');
 
+/**
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
+ * @class CsvPipe
+ * @implements {Pipe}
+ */
 class CsvPipe {
-  constructor(params, store = {}) {
-    this.store = store;
+
+  constructor(params, store) {
+    this.store = store || {};
     this.title = params.title || process.env.TESTOMATIO_TITLE;
     this.isEnabled = true;
     this.results = [];
@@ -54,10 +62,16 @@ class CsvPipe {
    * @param {Object} headers - csv file headers. Example: [{ id: 'suite_title', title: 'Suite_title' }]
    */
   async saveToCsv(data, headers) {
+    debug('Data', data);
     // 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...`));
+    if (!this.outputFile) {
+      console.log(this, chalk.yellow(`CSV file is not set, ignoring`));
+      return;
+    }
+
+    console.log(this, 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,
@@ -66,7 +80,7 @@ class CsvPipe {
     // 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}`));
+      console.log(this, chalk.green(`Recording completed! You can check the result in file = ${this.outputFile}`));
     } catch (e) {
       console.log('Unknown error: ', e);
     }
@@ -98,8 +112,8 @@ class CsvPipe {
   }
 
   /**
-   * Save short tests data to the csv file.
-   * @param {Object} runParams - run params.
+   * @param {{ tests?: TestData[] }} runParams
+   * @returns {Promise<void>}
    */
   async finishRun(runParams) {
     if (!this.isEnabled) return;

package/lib/pipe/github.js

@@ -1,3 +1,4 @@
+const debug = require('debug')('@testomatio/reporter:pipe:github');
 const path = require('path');
 const chalk = require('chalk');
 const humanizeDuration = require('humanize-duration');
@@ -6,6 +7,12 @@ const { Octokit } = require('@octokit/rest');
 const { APP_PREFIX } = require('../constants');
 const { ansiRegExp, isSameTest } = require('../util');
 
+/**
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
+ * @class GitHubPipe
+ * @implements {Pipe}
+ */
 class GitHubPipe {
   constructor(params, store = {}) {
     this.isEnabled = false;
@@ -16,27 +23,23 @@ class GitHubPipe {
     this.repo = process.env.GITHUB_REPOSITORY;
     this.hiddenCommentData = `<!--- testomat.io report ${process.env.GITHUB_WORKFLOW || ''} -->`;
 
-    if (process.env.DEBUG) {
-      console.log(APP_PREFIX, 'GitHub Pipe: ', this.token ? 'TOKEN' : '*no token*', this.ref, this.repo);
-    }
+    debug('GitHub Pipe: ', this.token ? 'TOKEN' : '*no token*', 'Ref:', this.ref, 'Repo:', this.repo);
 
     if (!this.token || !this.ref || !this.repo) return;
     this.isEnabled = true;
     const matchedIssue = this.ref.match(/refs\/pull\/(\d+)\/merge/);
     if (!matchedIssue) return;
-    this.issue = matchedIssue[1];
+    this.issue = parseInt(matchedIssue[1], 10);
+
     this.start = new Date();
 
-    if (process.env.DEBUG) {
-      console.log(APP_PREFIX, 'GitHub Pipe: Enabled');
-    }
+    debug('GitHub Pipe: Enabled');
   }
 
   async createRun() {}
 
-  updateRun() {}
-
   addTest(test) {
+    debug('Adding test:', test);
     if (!this.isEnabled) return;
 
     const index = this.tests.findIndex(t => isSameTest(t, test));
@@ -51,6 +54,7 @@ class GitHubPipe {
 
   async finishRun(runParams) {
     if (!this.isEnabled) return;
+    if (!this.issue) return;
 
     if (runParams.tests) runParams.tests.forEach(t => this.addTest(t));
 
@@ -58,7 +62,7 @@ class GitHubPipe {
       auth: this.token,
     });
 
-    const [owner, repo] = this.repo.split('/');
+    const [owner, repo] = (this.repo || '').split('/');
     if (!(owner || repo)) return;
 
     // ... create a comment on GitHub
@@ -69,7 +73,7 @@ class GitHubPipe {
     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)} |
+  statusEmoji(runParams.status,)} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
 | --- | --- |        
 | Tests | ✔️  **${this.tests.length}** tests run  |
 | Summary | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji(
@@ -150,11 +154,13 @@ class GitHubPipe {
         .join('\n');
       body += '\n</details>';
     }
+    
 
     await deletePreviousReport(this.octokit, owner, repo, this.issue, this.hiddenCommentData);
 
     // add report as comment
     try {
+      debug('Adding comment\n', body);
       const resp = await this.octokit.rest.issues.createComment({
         owner,
         repo,
@@ -163,6 +169,7 @@ class GitHubPipe {
       });
 
       const url = resp.data?.html_url;
+      debug('Comment URL:', url);
       this.store.githubUrl = url;
 
       console.log(APP_PREFIX, chalk.yellow('GitHub'), `Report created: ${chalk.magenta(url)}`);
@@ -221,7 +228,7 @@ async function deletePreviousReport(octokit, owner, repo, issue, hiddenCommentDa
           comment_id: comment.id,
         });
       } catch (e) {
-        console.error(`Can't delete previously added comment with testomat.io report. Ignore.`);
+        console.warn(`Can't delete previously added comment with testomat.io report. Ignore.`);
       }
 
       // pass next env var if need to clear all previous reports;