@testomatio/reporter 0.8.2-beta.1 → 1.0.0-beta.1

package/Changelog.md

@@ -1,3 +1,9 @@
+# 1.0.0
+
+<!-- pending release updates -->
+
+* Added `TESTOMATIO_SHARED_RUN` option to use a shared run for parallel executions
+
 # 0.7.6
 
 * Updated to use AWS S3 3.0 SDK for uploading

package/README.md

@@ -440,6 +440,17 @@ Give a title to your reports by passing it as environment variable to `TESTOMATI
 TESTOMATIO={API_KEY} TESTOMATIO_TITLE="title for the report" <actual run command>
 ```
 
+### Reporting Parallel Executionto To Same Run
+
+Provide a shared unique title to all runs that will be running in parallel, and add `TESTOMATIO_SHARED_RUN` environment var. So all reports will be sent to this run.
+
+```bash
+TESTOMATIO={API_KEY} TESTOMATIO_TITLE="report for commit ${GIT_COMMIT}" TESTOMATIO_SHARED_RUN=1 <actual run command>
+```
+
+We recommend using a commit hash as a title to create a new Run. In this case we ensure that run title is unique and will be the same for all parallel jobs running exactly for this commit.
+
+
 ### Adding Report to RunGroup
 
 Create/Add run to group by providing `TESTOMATIO_RUNGROUP_TITLE`:

package/lib/fileUploader.js

@@ -22,6 +22,11 @@ const keys = [
 
 let config;
 
+function resetConfig() {
+  config = undefined;
+  isEnabled = undefined;
+}
+
 function getConfig() {
   if (config) return config;
   config = keys.reduce((acc, key) => {
@@ -32,8 +37,8 @@ function getConfig() {
 }
 
 function getMaskedConfig() {
-  const config = getConfig();
-  return Object.fromEntries(Object.entries(config).map(([key, value]) => [key, key === 'S3_SECRET_ACCESS_KEY' || key === 'S3_ACCESS_KEY_ID' ? '***' : value]));
+  return Object.fromEntries(Object.entries(getConfig())
+    .map(([key, value]) => [key, key === 'S3_SECRET_ACCESS_KEY' || key === 'S3_ACCESS_KEY_ID' ? '***' : value]));
 }
 
 let isEnabled;
@@ -111,6 +116,7 @@ const fileData = fs.readFileSync(filePath);
     Bucket: S3_BUCKET,
     Key,
     Body: fileData,
+    ContentType,
     ACL,
   };
 
@@ -126,7 +132,7 @@ const fileData = fs.readFileSync(filePath);
     return out.singleUploadResult.Location;
   } catch (e) {
     console.log(e);
-    console.log(APP_PREFIX, chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`), getMaskedConfig());
+    console.log(APP_PREFIX, chalk.red(`Failed uploading '${Key}'. Please check S3 credentials`), getMaskedConfig());
 
     console.log(APP_PREFIX, `To ${chalk.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
     if (!TESTOMATIO_PRIVATE_ARTIFACTS) {
@@ -215,4 +221,5 @@ module.exports = {
   uploadFileByPath: memoize(uploadFileByPath),
   uploadFileAsBuffer: memoize(uploadFileAsBuffer),
   isArtifactsEnabled: memoize(isArtifactsEnabled),
+  resetConfig,
 };

package/lib/pipe/csv.js

@@ -18,11 +18,11 @@ class CsvPipe {
   constructor(params, store) {
     this.store = store || {};
     this.title = params.title || process.env.TESTOMATIO_TITLE;
-    this.isEnabled = true;
     this.results = [];
 
     this.outputDir = 'export';
     this.csvFilename = process.env.TESTOMATIO_CSV_FILENAME;
+    this.isEnabled = !!this.csvFilename
     this.isCsvSave = false;
 
     if (this.csvFilename !== undefined && this.csvFilename.split('.').length > 0) {

package/lib/pipe/github.js

@@ -79,7 +79,9 @@ class GitHubPipe {
 | Summary | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji(
       'passed',
     )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
-| Duration | 🕐  **${humanizeDuration(parseFloat(this.tests.reduce((a, t) => a + (t.run_time || 0), 0)))}** |
+| Duration | 🕐  **${humanizeDuration(parseInt(this.tests.reduce((a, t) => a + (t.run_time || 0), 0), 10), {
+      maxDecimalPoints: 0,
+    })}** |
 `;
     if (this.store.runUrl) {
       summary += `| Testomat.io Report | 📊 [Run #${this.store.runId}](${this.store.runUrl})  | `;
@@ -154,7 +156,6 @@ class GitHubPipe {
         .join('\n');
       body += '\n</details>';
     }
-    
 
     await deletePreviousReport(this.octokit, owner, repo, this.issue, this.hiddenCommentData);
 

package/lib/pipe/gitlab.js

@@ -81,7 +81,9 @@ class GitLabPipe {
   | Summary | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji(
       'passed',
     )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
-  | Duration | 🕐  **${humanizeDuration(parseFloat(this.tests.reduce((a, t) => a + (t.run_time || 0), 0)))}** |
+  | Duration | 🕐  **${humanizeDuration(parseInt(this.tests.reduce((a, t) => a + (t.run_time || 0), 0), 10), {
+    maxDecimalPoints: 0,
+  })}** |
   `;
 
     if (this.ENV.CI_JOB_NAME && this.ENV.CI_JOB_ID) {

package/lib/pipe/testomatio.js

@@ -4,6 +4,7 @@ const axios = require('axios');
 const JsonCycle = require('json-cycle');
 const { APP_PREFIX, STATUS } = require('../constants');
 const { isValidUrl } = require('../util');
+const { resetConfig } = require('../fileUploader');
 
 const { TESTOMATIO_RUN } = process.env;
 if (TESTOMATIO_RUN) {
@@ -28,6 +29,7 @@ class TestomatioPipe {
     debug('Testomatio Pipe: Enabled');
     this.store = store || {};
     this.title = params.title || process.env.TESTOMATIO_TITLE;
+    this.sharedRun = !!process.env.TESTOMATIO_SHARED_RUN;
     this.groupTitle = params.groupTitle || process.env.TESTOMATIO_RUNGROUP_TITLE;
     this.env = process.env.TESTOMATIO_ENV;
     this.axios = axios.create();
@@ -55,11 +57,14 @@ class TestomatioPipe {
         group_title: this.groupTitle,
         env: this.env,
         title: this.title,
+        shared_run: this.sharedRun,
       }).filter(([, value]) => !!value)
     );
 
     if (this.runId) {
-      return this.axios.put(`${this.url.trim()}/api/reporter/${this.runId}`, runParams);
+      const resp = await this.axios.put(`${this.url.trim()}/api/reporter/${this.runId}`, runParams);
+      if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
+      return;
     }
 
     try {
@@ -69,6 +74,7 @@ class TestomatioPipe {
       });
       this.runId = resp.data.uid;
       this.runUrl = `${this.url}/${resp.data.url.split('/').splice(3).join('/')}`;
+      if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
       this.store.runUrl = this.runUrl;
       this.store.runId = this.runId;
       console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId);
@@ -162,3 +168,16 @@ class TestomatioPipe {
 }
 
 module.exports = TestomatioPipe;
+
+function setS3Credentials(artifacts) {
+  if (!Object.keys(artifacts).length) return;
+
+  console.log(APP_PREFIX, 'Setting S3 credentials obtained from Testomat.io...');
+
+  if (artifacts.ACCESS_KEY_ID) process.env.S3_ACCESS_KEY_ID = artifacts.ACCESS_KEY_ID; 
+  if (artifacts.SECRET_ACCESS_KEY) process.env.S3_SECRET_ACCESS_KEY = artifacts.SECRET_ACCESS_KEY; 
+  if (artifacts.REGION) process.env.S3_REGION = artifacts.REGION; 
+  if (artifacts.BUCKET) process.env.S3_BUCKET = artifacts.BUCKET; 
+  if (artifacts.ENDPOINT) process.env.S3_ENDPOINT = artifacts.ENDPOINT; 
+  resetConfig();
+}

package/lib/xmlReader.js

@@ -144,8 +144,9 @@ class XmlReader {
     if (!Array.isArray(result)) result = [result].filter(d => !!d);
 
     const results = result.map(td => ({ 
-      id: td.executionId, 
-      run_time: parseFloat(td.duration),
+      id: td.executionId,
+      // seconds are used in junit reports, but ms are used by testomatio
+      run_time: parseFloat(td.duration) * 1000,
       status: td.outcome, 
       stack: td.Output.StdOut,
       files: td?.ResultFiles?.ResultFile?.map(rf => rf.path)
@@ -278,7 +279,7 @@ class XmlReader {
   async uploadArtifacts() {
     for (const test of this.tests.filter(t => !!t.stack)) {
       let files = [];
-      if (test.files.length) files = test.files.map(f => path.join(process.cwd(), f))
+      if (test.files?.length) files = test.files.map(f => path.join(process.cwd(), f))
       files = [...files, ...fetchFilesFromStackTrace(test.stack)];
       debug('Uploading files', files)
       test.artifacts = await Promise.all(files.map(f => upload.uploadFileByPath(f, this.runId)));
@@ -361,7 +362,8 @@ function reduceTestCases(prev, item) {
       stack,
       message,
       line: testCaseItem.lineno,
-      run_time: parseFloat(testCaseItem.time || testCaseItem.duration),
+      // seconds are used in junit reports, but ms are used by testomatio
+      run_time: parseFloat(testCaseItem.time || testCaseItem.duration) * 1000,
       status,
       title: testCaseItem.name,
       suite_title: reduceOptions.preferClassname ? testCaseItem.classname : (item.name || testCaseItem.classname),

package/package.json

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