@testomatio/reporter 1.4.0-beta-csv-enable → 1.4.0

package/lib/adapter/codecept.js

@@ -142,7 +142,7 @@ function CodeceptReporter(config) {
     if (id && failedTests.includes(id)) {
       failedTests = failedTests.filter(failed => id !== failed);
     }
-    const testId = getTestomatIdFromTestTitle(`${title} ${tags.join(' ')}`);
+    const testId = getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`);
     const testObj = getTestAndMessage(title);
 
     const logs = getTestLogs(test);
@@ -176,7 +176,7 @@ function CodeceptReporter(config) {
     for (const test of suite.tests) {
       const { id, tags, title } = test;
       failedTests.push(id || title);
-      const testId = getTestomatIdFromTestTitle(`${title} ${tags.join(' ')}`);
+      const testId = getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`);
 
       client.addTestRun(STATUS.FAILED, {
         ...stripExampleFromTitle(title),
@@ -194,7 +194,7 @@ function CodeceptReporter(config) {
     if (test.err) error = test.err;
     const { id, tags, title, artifacts } = test;
     failedTests.push(id || title);
-    let testId = getTestomatIdFromTestTitle(`${title} ${tags.join(' ')}`);
+    let testId = getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`);
     const testObj = getTestAndMessage(title);
 
     const files = [];
@@ -240,7 +240,7 @@ function CodeceptReporter(config) {
     const { id, tags, title } = test;
     if (failedTests.includes(id || title)) return;
 
-    const testId = getTestomatIdFromTestTitle(`${title} ${tags.join(' ')}`);
+    const testId = getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`);
     const testObj = getTestAndMessage(title);
     client.addTestRun(STATUS.SKIPPED, {
       ...stripExampleFromTitle(title),

package/lib/adapter/webdriver.js

@@ -31,6 +31,18 @@ class WebdriverReporter extends WDIOReporter {
     this._addTestPromises.push(this.addTest(test));
   }
 
+  // wdio-cucumber does not trigger onTestEnd hook, thus, using this one
+  /**
+   *
+   * @param {} scerario
+   * @returns
+   */
+  onSuiteEnd(scerario) {
+    if (scerario.type === 'scenario') {
+      this._addTestPromises.push(this.addBddScenario(scerario));
+    }
+  }
+
   async addTest(test) {
     if (!this.client) return;
 
@@ -51,6 +63,39 @@ class WebdriverReporter extends WDIOReporter {
       filesBuffers: screenshotsBuffers,
     });
   }
+
+  /**
+   * @param {import('../../types').WebdriverIOScenario} scenario
+   */
+  addBddScenario(scenario) {
+    if (!this.client) return;
+
+    const { title, _duration: duration } = scenario;
+
+    const testId = getTestomatIdFromTestTitle(title || scenario.tags.map(tag => tag.name).join(' '));
+
+    let scenarioState = scenario.tests.every(test => test.state === 'passed') ? 'passed' : 'failed';
+    if (scenario.tests.every(test => test.state === 'skipped')) {
+      scenarioState = 'skipped';
+    }
+    const errors = scenario.tests
+      .filter(test => test.state === 'failed')
+      .map(test => test.error?.stack)
+      .filter(Boolean);
+    const error = errors.join('\n');
+
+    const tags = scenario.tags.map(tag => tag.name);
+
+    return this.client.addTestRun(scenarioState, {
+      error: error ? Error(error) : null,
+      title,
+      test_id: testId,
+      time: duration,
+      tags,
+      file: scenario.file,
+      // filesBuffers: screenshotsBuffers,
+    });
+  }
 }
 
 module.exports = WebdriverReporter;

package/lib/pipe/testomatio.js

@@ -23,6 +23,13 @@ if (process.env.TESTOMATIO_RUN) {
  */
 class TestomatioPipe {
   constructor(params, store) {
+    this.batch = {
+      isEnabled: params.isBatchEnabled ?? !process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ?? true,
+      intervalFunction: null, // will be created in createRun by setInterval function
+      intervalTime: 5000, // how often tests are sent
+      tests: [], // array of tests in batch
+      batchIndex: 0, // represents the current batch index (starts from 1 and increments by 1 for each batch)
+    };
     this.retriesTimestamps = [];
     this.reportingCanceledDueToReqFailures = false;
     this.notReportedTestsCount = 0;
@@ -126,11 +133,15 @@ class TestomatioPipe {
   }
 
   /**
+   * Creates a new run on Testomat.io
+   * @param {{isBatchEnabled?: boolean}} params
    * @returns Promise<void>
    */
-  async createRun() {
+  async createRun(params = {}) {
+    this.batch.isEnabled = params.isBatchEnabled ?? this.batch.isEnabled;
     debug('Creating run...');
     if (!this.isEnabled) return;
+    if (this.batch.isEnabled) this.batch.intervalFunction = setInterval(this.#batchUpload, this.batch.intervalTime);
 
     let buildUrl = process.env.BUILD_URL || process.env.CI_JOB_URL || process.env.CIRCLE_BUILD_URL;
 
@@ -233,7 +244,7 @@ class TestomatioPipe {
     return false;
   }
 
-  addTest(data) {
+  #uploadSingleTest = async data => {
     if (!this.isEnabled) return;
     if (!this.runId) return;
     if (this.#cancelTestReportingInCaseOfTooManyReqFailures(data)) return;
@@ -250,14 +261,7 @@ class TestomatioPipe {
     debug('Adding test', json);
 
     return this.axios
-      .post(`/api/reporter/${this.runId}/testrun`, json, {
-        maxContentLength: Infinity,
-        maxBodyLength: Infinity,
-        headers: {
-          // Overwrite Axios's automatically set Content-Type
-          'Content-Type': 'application/json',
-        },
-      })
+      .post(`/api/reporter/${this.runId}/testrun`, json, axiosAddTestrunRequestConfig)
       .catch(err => {
         if (err.response) {
           if (err.response.status >= 400) {
@@ -282,6 +286,67 @@ class TestomatioPipe {
           console.log(APP_PREFIX, chalk.blue(data?.title || ''), "Report couldn't be processed", err);
         }
       });
+    };
+    
+
+  /**
+   * Uploads tests as a batch (multiple tests at once). Intended to be used with a setInterval
+   */
+  #batchUpload = async () => {
+    this.batch.batchIndex++;
+    if (!this.batch.isEnabled) return;
+    if (!this.batch.tests.length) return;
+
+    // get tests from batch and clear batch
+    const testsToSend = this.batch.tests.splice(0);
+    debug('📨 Batch upload', testsToSend.length, 'tests');
+
+    return this.axios
+      .post(
+        `/api/reporter/${this.runId}/testrun`,
+        { api_key: this.apiKey, tests: testsToSend, batch_index: this.batch.batchIndex },
+        axiosAddTestrunRequestConfig,
+      )
+      .catch(err => {
+        if (err.response) {
+          if (err.response.status >= 400) {
+            const responseData = err.response.data || { message: '' };
+            console.log(
+              APP_PREFIX,
+              chalk.yellow(`Warning: ${responseData.message} (${err.response.status})`),
+              // chalk.grey(data?.title || ''),
+            );
+            if (err.response?.data?.message?.includes('could not be matched')) {
+              this.hasUnmatchedTests = true;
+            }
+            return;
+          }
+          console.log(
+            APP_PREFIX,
+            chalk.yellow(`Warning: (${err.response?.status})`),
+            `Report couldn't be processed: ${err?.response?.data?.message}`,
+          );
+          printCreateIssue(err);
+        } else {
+          console.log(APP_PREFIX, "Report couldn't be processed", err);
+        }
+      });
+  };
+
+  /**
+   * Adds a test to the batch uploader (or reports a single test if batch uploading is disabled)
+   */
+  addTest(data) {
+    if (!this.isEnabled) return;
+    if (!this.runId) return;
+    data.api_key = this.apiKey;
+    data.create = this.createNewTests;
+
+    if (!this.batch.isEnabled) this.#uploadSingleTest(data);
+    else this.batch.tests.push(data);
+
+    // if test is added after run already finished
+    if (!this.batch.intervalFunction) this.#batchUpload();
   }
 
   /**
@@ -289,6 +354,10 @@ class TestomatioPipe {
    * @returns
    */
   async finishRun(params) {
+    this.#batchUpload();
+    if (this.batch.intervalFunction) clearInterval(this.batch.intervalFunction);
+
+    debug('Finishing run...');
     if (!this.isEnabled) return;
     debug('Finishing run...');
 
@@ -387,4 +456,13 @@ function printCreateIssue(err) {
   });
 }
 
+const axiosAddTestrunRequestConfig = {
+  maxContentLength: Infinity,
+  maxBodyLength: Infinity,
+  headers: {
+    // Overwrite Axios's automatically set Content-Type
+    'Content-Type': 'application/json',
+  },
+};
+
 module.exports = TestomatioPipe;

package/lib/xmlReader.js

@@ -38,6 +38,8 @@ class XmlReader {
       title: TESTOMATIO_TITLE,
       env: TESTOMATIO_ENV,
       group_title: TESTOMATIO_RUNGROUP_TITLE,
+      // batch uploading is implemented for xml already
+      isBatchEnabled: false,
     };
     this.runId = opts.runId || TESTOMATIO_RUN;
     this.adapter = adapterFactory(opts.lang?.toLowerCase(), opts);
@@ -376,6 +378,7 @@ class XmlReader {
       title: this.requestParams.title,
       env: this.requestParams.env,
       group_title: this.requestParams.group_title,
+      isBatchEnabled: this.requestParams.isBatchEnabled,
     };
 
     debug('Run', runParams);
@@ -405,6 +408,10 @@ class XmlReader {
 
     return Promise.all(this.pipes.map(p => p.finishRun(dataString)));
   }
+
+  async _finishRun() {
+    return Promise.all(this.pipes.map(p => p.finishRun({ status: 'finished' })));
+  }
 }
 
 module.exports = XmlReader;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.4.0-beta-csv-enable",
+  "version": "1.4.0",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",