@testomatio/reporter 1.6.0-beta-2-artifacts → 1.6.0-beta-4-artifacts

package/lib/adapter/codecept.js

@@ -301,9 +301,11 @@ function CodeceptReporter(config) {
 }
 
 async function uploadAttachments(client, attachments, messagePrefix, attachmentType) {
-  if (!attachments?.length) return;  
+  if (!attachments?.length) return;
 
-  if (client.uploader.isEnabled) console.log(APP_PREFIX, `Attachments: ${messagePrefix} ${attachments.length} ${attachmentType} ...`);
+  if (client.uploader.isEnabled) {
+    console.log(APP_PREFIX, `Attachments: ${messagePrefix} ${attachments.length} ${attachmentType} ...`);
+  }
 
   const promises = attachments.map(async attachment => {
     const { rid, title, path, type } = attachment;

package/lib/adapter/playwright.js

@@ -106,7 +106,7 @@ class PlaywrightReporter {
     await Promise.all(reportTestPromises);
 
     if (!this.uploads.length) return;
-      
+
     if (this.client.uploader.isEnabled) console.log(APP_PREFIX, `🎞️  Uploading ${this.uploads.length} files...`);
 
     const promises = [];
@@ -135,7 +135,6 @@ class PlaywrightReporter {
       );
     }
     await Promise.all(promises);
-  
 
     await this.client.updateRunStatus(checkStatus(result.status));
   }

package/lib/bin/cli.js

@@ -9,13 +9,14 @@ const XmlReader = require('../xmlReader');
 const { APP_PREFIX, STATUS } = require('../constants');
 const { version } = require('../../package.json');
 const config = require('../config');
+const { readLatestRunId } = require('../utils/utils');
 
 console.log(chalk.cyan.bold(` 🤩 Testomat.io Reporter v${version}`));
 
 program
   .version(version)
   .option('--env-file <envfile>', 'Load environment variables from env file')
-  .hook('preAction', (thisCommand) => {
+  .hook('preAction', thisCommand => {
     const opts = thisCommand.opts();
     if (opts.envFile) {
       require('dotenv').config({ path: opts.envFile });
@@ -42,8 +43,10 @@ program
   .command('finish')
   .description('Finish Run by its ID')
   .action(async () => {
+    process.env.TESTOMATIO_RUN ||= readLatestRunId();
+
     if (!process.env.TESTOMATIO_RUN) {
-      console.log('TESTOMATIO_RUN environment variable must be set.');
+      console.log('TESTOMATIO_RUN environment variable must be set or restored from a previous run.');
       return process.exit(1);
     }
 
@@ -140,10 +143,15 @@ program
 
     let timeoutTimer;
     if (opts.timelimit) {
-      timeoutTimer = setTimeout(() => {
-        console.log(`⚠️  Reached timeout of ${opts.timelimit}s. Exiting... (Exit code is 0 to not fail the pipeline)`);
-        process.exit(0);
-      }, parseInt(opts.timelimit, 10) * 1000);
+      timeoutTimer = setTimeout(
+        () => {
+          console.log(
+            `⚠️  Reached timeout of ${opts.timelimit}s. Exiting... (Exit code is 0 to not fail the pipeline)`,
+          );
+          process.exit(0);
+        },
+        parseInt(opts.timelimit, 10) * 1000,
+      );
     }
 
     try {
@@ -160,13 +168,20 @@ program
   .command('upload-artifacts')
   .description('Upload artifacts to Testomat.io')
   .option('--force', 'Re-upload artifacts even if they were uploaded before')
-  .action(async (opts) => {
+  .action(async opts => {
     const apiKey = config.TESTOMATIO;
 
     process.env.TESTOMATIO_DISABLE_ARTIFACTS = '';
+    const runId = process.env.TESTOMATIO_RUN || process.env.runId || readLatestRunId();
+
+    if (!runId) {
+      console.log('TESTOMATIO_RUN environment variable must be set or restored from a previous run.');
+      return process.exit(1);
+    }
 
     const client = new TestomatClient({
       apiKey,
+      runId,
       isBatchEnabled: false,
     });
 
@@ -203,9 +218,9 @@ program
       await client.addTestRun(undefined, { rid, files });
     }
 
-    console.log(APP_PREFIX, client.uploader.totalUploaded, 'artifacts uploaded');
-    if (client.uploader.failedUpload) {
-      console.log(APP_PREFIX, client.uploader.failedUpload, 'artifacts failed to upload');
+    console.log(APP_PREFIX, client.uploader.totalUploadsCount, 'artifacts uploaded');
+    if (client.uploader.failedUploadsCount) {
+      console.log(APP_PREFIX, client.uploader.failedUploadsCount, 'artifacts failed to upload');
     }
   });
 

package/lib/bin/reportXml.js

@@ -44,10 +44,15 @@ program
 
     let timeoutTimer;
     if (opts.timelimit) {
-      timeoutTimer = setTimeout(() => {
-        console.log(`⚠️  Reached timeout of ${opts.timelimit}s. Exiting... (Exit code is 0 to not fail the pipeline)`);
-        process.exit(0);
-      }, parseInt(opts.timelimit, 10) * 1000);
+      timeoutTimer = setTimeout(
+        () => {
+          console.log(
+            `⚠️  Reached timeout of ${opts.timelimit}s. Exiting... (Exit code is 0 to not fail the pipeline)`,
+          );
+          process.exit(0);
+        },
+        parseInt(opts.timelimit, 10) * 1000,
+      );
     }
 
     try {

package/lib/bin/uploadArtifacts.js

@@ -1,11 +1,12 @@
 #!/usr/bin/env node
-const program = require('commander');
+const { program } = require('commander');
 const chalk = require('chalk');
 const debug = require('debug')('@testomatio/reporter:upload-cli');
 const TestomatClient = require('../client');
 const { APP_PREFIX } = require('../constants');
 const { version } = require('../../package.json');
 const config = require('../config');
+const { readLatestRunId } = require('../utils/utils');
 
 console.log(chalk.cyan.bold(` 🤩 Testomat.io Reporter v${version}`));
 
@@ -13,7 +14,6 @@ program
   .option('--env-file <envfile>', 'Load environment variables from env file')
   .option('--force', 'Re-upload artifacts even if they were uploaded before')
   .action(async opts => {
-
     if (opts.envFile) {
       require('dotenv').config(opts.envFile); // eslint-disable-line
     } else {
@@ -22,15 +22,19 @@ program
     }
 
     const apiKey = config.TESTOMATIO;
-
     process.env.TESTOMATIO_DISABLE_ARTIFACTS = '';
-    // process.env.TESTOMATIO_ARTIFACTS_SIZE = null;
+    const runId = process.env.TESTOMATIO_RUN || process.env.runId || readLatestRunId();
+
+    if (!runId) {
+      console.log('TESTOMATIO_RUN environment variable must be set or restored from a previous run.');
+      return process.exit(1);
+    }
 
     const client = new TestomatClient({
       apiKey,
+      runId,
       isBatchEnabled: false,
-     });
-
+    });
     let testruns = client.uploader.readUploadedFiles(process.env.TESTOMATIO_RUN);
 
     const numTotalArtifacts = testruns.length;
@@ -56,8 +60,6 @@ program
       return acc;
     }, {});
 
-    let numArtifacts = 0;
-
     // we need to obtain S3 credentials
     await client.createRun();
 
@@ -66,16 +68,15 @@ program
 
     for (const rid in testrunsByRid) {
       const files = testrunsByRid[rid];
-      numArtifacts += files.length;
       await client.addTestRun(undefined, {
         rid,
         files,
       });
     }
 
-  console.log(APP_PREFIX, client.uploader.totalUploaded, 'artifacts uploaded');
-    if (client.uploader.failedUpload) {
-      console.log(APP_PREFIX, client.uploader.failedUpload, 'artifacts failed to upload');
+    console.log(APP_PREFIX, client.uploader.totalUploadsCount, 'artifacts uploaded');
+    if (client.uploader.failedUploadsCount) {
+      console.log(APP_PREFIX, client.uploader.failedUploadsCount, 'artifacts failed to upload');
     }
   });
 

package/lib/client.js

@@ -10,6 +10,7 @@ const { APP_PREFIX, STATUS } = require('./constants');
 const pipesFactory = require('./pipe');
 const { glob } = require('glob');
 const path = require('path');
+const { storeRunId } = require('./utils/utils');
 
 let listOfTestFilesToExcludeFromReport = null;
 
@@ -107,6 +108,8 @@ class Client {
       .then(() => {
         const runId = this.pipeStore?.runId;
         if (runId) this.runId = runId;
+        storeRunId(this.runId);
+
         this.uploader.checkEnabled();
       })
       .then(() => undefined); // fixes return type
@@ -182,12 +185,7 @@ class Client {
         f = f.path;
       }
 
-      uploadedFiles.push(this.uploader.uploadFileByPath(f, [
-        this.runId,
-        rid,
-        path.basename(f)
-      ]));
-
+      uploadedFiles.push(this.uploader.uploadFileByPath(f, [this.runId, rid, path.basename(f)]));
     }
 
     for (const [idx, buffer] of filesBuffers.entries()) {
@@ -252,30 +250,37 @@ class Client {
     this.queue = this.queue
       .then(() => Promise.all(this.pipes.map(p => p.finishRun(runParams))))
       .then(() => {
-        debug('TOTAL artifacts', this.uploader.totalUploaded);        
-        debug(`${this.uploader.skippedUpload} artifacts skipped`);
+        debug('TOTAL artifacts', this.uploader.totalUploadsCount);
+        debug(`${this.uploader.skippedUploadsCount} artifacts skipped`);
 
-        if (this.uploader.totalUploaded && this.uploader.isEnabled) {
+        if (this.uploader.totalUploadsCount && this.uploader.isEnabled) {
           console.log(
             APP_PREFIX,
-            `🗄️ ${this.uploader.totalUploaded} artifacts ${
+            `🗄️ ${this.uploader.totalUploadsCount} artifacts ${
               process.env.TESTOMATIO_PRIVATE_ARTIFACTS ? 'privately' : chalk.bold('publicly')
             } uploaded to S3 bucket`,
-          );          
+          );
         }
 
-        if (this.uploader.failedUpload) {
-          console.log(APP_PREFIX, `${this.uploader.failedUpload} artifacts failed to upload`);
+        if (this.uploader.failedUploadsCount) {
+          console.log(
+            APP_PREFIX,
+            chalk.gray('[CLIENT]'),
+            `${this.uploader.failedUploadsCount} artifacts failed to upload`,
+          );
         }
 
-        if (this.uploader.isEnabled && this.uploader.skippedUpload) {
-          console.log(APP_PREFIX, `${chalk.bold(this.uploader.skippedUpload)} artifacts skipped to upload`);
+        if (this.uploader.isEnabled && this.uploader.skippedUploadsCount) {
+          console.log(APP_PREFIX, `${chalk.bold(this.uploader.skippedUploadsCount)} artifacts skipped to upload`);
         }
 
-        if (this.uploader.skippedUpload || this.uploader.failedUpload) {
-          console.log(APP_PREFIX, `Run "${chalk.magenta(`TESTOMATIO_RUN=${this.runId} npx upload-artifacts`)}" with valid S3 credentials to upload skipped & failed artifacts`);
+        if (this.uploader.skippedUploadsCount || this.uploader.failedUploadsCount) {
+          const command = `TESTOMATIO_RUN=${this.runId} npx @testomatio/reporter upload-artifacts`;
+          console.log(
+            APP_PREFIX,
+            `Run "${chalk.magenta(command)}" with valid S3 credentials to upload skipped & failed artifacts`,
+          );
         }
-
       })
       .catch(err => console.log(APP_PREFIX, err));
 

package/lib/pipe/gitlab.js

@@ -79,13 +79,13 @@ class GitLabPipe {
     let summary = `${this.hiddenCommentData}
     
   | [![Testomat.io Report](${testomatLogoURL})](https://testomat.io)  | ${statusEmoji(
-      runParams.status,
-    )} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
+    runParams.status,
+  )} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
   | --- | --- |
   | Tests | ✔️  **${this.tests.length}** tests run  |
   | Summary | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji(
-      'passed',
-    )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
+    'passed',
+  )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
   | Duration | 🕐  **${humanizeDuration(
     parseInt(
       this.tests.reduce((a, t) => a + (t.run_time || 0), 0),

package/lib/pipe/testomatio.js

@@ -214,7 +214,7 @@ class TestomatioPipe {
       this.store.runPublicUrl = this.runPublicUrl;
       this.store.runId = this.runId;
       console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId);
-      process.env.runId = this.runId;
+      process.env.runId = this.runId;      
       debug('Run created', this.runId);
     } catch (err) {
       console.error(

package/lib/uploader.js

@@ -15,9 +15,9 @@ class S3Uploader {
     this.config = undefined;
 
     // counters
-    this.skippedUpload = 0;
-    this.failedUpload = 0;
-    this.totalUploaded = 0;
+    this.skippedUploadsCount = 0;
+    this.failedUploadsCount = 0;
+    this.totalUploadsCount = 0;
 
     this.succesfulUploads = {};
 
@@ -31,7 +31,7 @@ class S3Uploader {
       'S3_FORCE_PATH_STYLE',
       'TESTOMATIO_DISABLE_ARTIFACTS',
       'TESTOMATIO_PRIVATE_ARTIFACTS',
-      'TESTOMATIO_ARTIFACTS_SIZE'
+      'TESTOMATIO_ARTIFACT_MAX_SIZE_MB',
     ];
   }
 
@@ -84,7 +84,11 @@ class S3Uploader {
     const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
 
     if (!S3_BUCKET || !Body) {
-      console.log(APP_PREFIX, chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`), this.getMaskedConfig());
+      console.log(
+        APP_PREFIX,
+        chalk.bold.red(`Failed uploading '${Key}'. Please check S3 credentials`),
+        this.getMaskedConfig(),
+      );
       return;
     }
 
@@ -104,17 +108,17 @@ class S3Uploader {
       });
 
       const link = await this.getS3LocationLink(upload);
-      this.totalUploaded++;
+      this.totalUploadsCount++;
       this.succesfulUploads[Key] = link;
       return link;
     } catch (e) {
-      this.failedUpload++;
+      this.failedUploadsCount++;
       debug('S3 uploading error:', e);
-      console.log(APP_PREFIX, "Upload failed:", e.message, this.getMaskedConfig());
+      console.log(APP_PREFIX, 'Upload failed:', e.message, this.getMaskedConfig());
     }
   }
 
-  readUploadedFiles(runId = null) {
+  readUploadedFiles(runId) {
     const tempFilePath = this.#getUploadFilePath(runId);
 
     debug('Reading file', tempFilePath);
@@ -125,10 +129,10 @@ class S3Uploader {
     }
 
     const stats = fs.statSync(tempFilePath);
-    const diff = (+new Date()) - (+stats.mtime);
+    const diff = +new Date() - +stats.mtime;
     const diffHours = diff / 1000 / 60 / 60;
     if (diffHours > 3) {
-      console.log(APP_PREFIX, 'Artifacts file is too old, can\'t process artifacts. Please re-run the tests.');
+      console.log(APP_PREFIX, "Artifacts file is too old, can't process artifacts. Please re-run the tests.");
       return [];
     }
 
@@ -137,22 +141,11 @@ class S3Uploader {
     return lines.map(line => JSON.parse(line));
   }
 
-  #getUploadFilePath(runId = null, forceCreate = false) {
-    if (!runId && !forceCreate) {
-      return path.join(os.tmpdir(), 'testomatio.run.latest.jsonl');
-    }
-
+  #getUploadFilePath(runId, forceCreate = false) {
     const tempFilePath = path.join(os.tmpdir(), `testomatio.run.${runId}.jsonl`);
     if (!fs.existsSync(tempFilePath) || forceCreate) {
       debug('Creating artifacts file:', tempFilePath);
       fs.writeFileSync(tempFilePath, '');
-      // make symlink to 'testomatio.run.latest.jsonl' file
-      const latestFilePath = path.join(os.tmpdir(), 'testomatio.run.latest.jsonl');
-      if (fs.existsSync(latestFilePath)) {
-        fs.unlinkSync(latestFilePath);
-      }
-      fs.symlinkSync(tempFilePath, latestFilePath);
-
     }
     return tempFilePath;
   }
@@ -160,40 +153,38 @@ class S3Uploader {
   storeUploadedFile(filePath, runId, rid, uploaded = false) {
     if (!this.storeEnabled) return;
 
-    if (!filePath || !runId || !rid ) return;
+    if (!filePath || !runId || !rid) return;
 
     const tempFilePath = this.#getUploadFilePath(runId);
 
     const data = { rid, file: filePath, uploaded };
-    const jsonLine = JSON.stringify(data) + '\n';
+    const jsonLine = `${JSON.stringify(data)}\n`;
 
     fs.appendFileSync(tempFilePath, jsonLine);
   }
 
   getskippedUpload() {
-    return this.skippedUpload;
+    return this.skippedUploadsCount;
   }
 
   async uploadFileByPath(filePath, pathInS3) {
     const [runId, rid] = pathInS3;
 
+    if (!filePath) return;
+
     if (!this.isEnabled) {
       this.storeUploadedFile(filePath, runId, rid, false);
-      this.skippedUpload++;
+      this.skippedUploadsCount++;
       return;
     }
 
-    const {
-      S3_BUCKET,
-      TESTOMATIO_ARTIFACTS_SIZE,
-    } = this.getConfig();
+    const { S3_BUCKET, TESTOMATIO_ARTIFACT_MAX_SIZE_MB } = this.getConfig();
 
     debug('Started upload', filePath, 'to', S3_BUCKET);
 
     const isFileExist = await this.checkFileExists(filePath, 20, 500);
 
     if (!isFileExist) {
-      this.failedUpload++;
       console.error(chalk.yellow(`Artifacts file ${filePath} does not exist. Skipping...`));
       return;
     }
@@ -201,8 +192,8 @@ class S3Uploader {
     const fileSize = fs.statSync(filePath).size;
     const fileSizeInMb = fileSize / (1024 * 1024);
 
-    if (TESTOMATIO_ARTIFACTS_SIZE && fileSizeInMb > parseInt(TESTOMATIO_ARTIFACTS_SIZE)) {
-      this.skippedUpload++;
+    if (TESTOMATIO_ARTIFACT_MAX_SIZE_MB && fileSizeInMb > parseInt(TESTOMATIO_ARTIFACT_MAX_SIZE_MB, 10)) {
+      this.skippedUploadsCount++;
       console.error(chalk.yellow(`Artifacts file ${filePath} exceeds the maximum allowed size. Skipping...`));
       return;
     }
@@ -242,7 +233,9 @@ class S3Uploader {
             return false;
           }
           debug(`File not found, retrying (attempt ${number}/${attempts})`);
-          await new Promise((resolve) => setTimeout(resolve, intervalMs));
+          await new Promise(resolve => {
+            setTimeout(resolve, intervalMs);
+          });
           retry(err);
         }
       },
@@ -250,7 +243,7 @@ class S3Uploader {
         retries: attempts,
         minTimeout: intervalMs,
         maxTimeout: intervalMs,
-      }
+      },
     );
   }
 

package/lib/utils/utils.js

@@ -3,6 +3,8 @@ const { sep, basename } = require('path');
 const chalk = require('chalk');
 const fs = require('fs');
 const isValid = require('is-valid-path');
+const path = require('path');
+const os = require('os');
 const debug = require('debug')('@testomatio/reporter:util');
 
 /**
@@ -318,7 +320,28 @@ const testRunnerHelper = {
   },
 };
 
+function storeRunId(runId) {
+  const filePath = path.join(os.tmpdir(), `testomatio.latest.run`);
+  fs.writeFileSync(filePath, runId);
+}
+
+function readLatestRunId() {
+  try {
+    const filePath = path.join(os.tmpdir(), `testomatio.latest.run`);
+    const stats = fs.statSync(filePath);
+    const diff = +new Date() - +stats.mtime;
+    const diffHours = diff / 1000 / 60 / 60;
+    if (diffHours > 1) return;
+
+    return fs.readFileSync(filePath)?.toString()?.trim();
+  } catch (e) {
+    return null;
+  }
+}
+
 module.exports = {
+  storeRunId,
+  readLatestRunId,
   isSameTest,
   fetchSourceCode,
   fetchSourceCodeFromStackTrace,

package/package.json

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