@testomatio/reporter 2.0.0-beta-esm → 2.0.0-beta.1-xml

package/src/bin/reportXml.js

@@ -1,14 +1,19 @@
 #!/usr/bin/env node
-import program from 'commander';
+import { Command } from 'commander';
 import pc from 'picocolors';
-import glob from 'glob';
+import { glob } from 'glob';
 import createDebugMessages from 'debug';
 import { APP_PREFIX } from '../constants.js';
 import XmlReader from '../xmlReader.js';
-import { version } from '../../package.json';
+import { getPackageVersion } from '../utils/utils.js';
+import dotenv from 'dotenv';
+import path from 'path';
+
+const version = getPackageVersion();
 
 const debug = createDebugMessages('@testomatio/reporter:xml-cli');
 console.log(pc.cyan(pc.bold(` 🤩 Testomat.io XML Reporter v${version}`)));
+const program = new Command();
 
 program
   .arguments('<pattern>')
@@ -25,10 +30,10 @@ program
     if (opts.envFile) {
       console.log(APP_PREFIX, 'Loading env file:', opts.envFile);
       debug('Loading env file: %s', opts.envFile);
-      require('dotenv').config({ path: opts.envFile }); // eslint-disable-line
+      dotenv.config({ path: opts.envFile });
     }
-    if (javaTests === true) javaTests = 'src/test/java';
     lang = lang?.toLowerCase();
+    if (javaTests === true || (lang === 'java' && !javaTests)) javaTests = 'src/test/java';
     const runReader = new XmlReader({ javaTests, lang });
     const files = glob.sync(pattern, { cwd: opts.dir || process.cwd() });
     if (!files.length) {
@@ -44,10 +49,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/src/bin/startTest.js

@@ -1,13 +1,16 @@
 #!/usr/bin/env node
 import { spawn } from 'cross-spawn';
-import program from 'commander';
+import { Command } from 'commander';
 import pc from 'picocolors';
 import TestomatClient from '../client.js';
 import { APP_PREFIX, STATUS } from '../constants.js';
-import { version } from '../../package.json';
-import {config} from '../config.js';
+import { getPackageVersion } from '../utils/utils.js';
+import { config } from '../config.js';
+import dotenv from 'dotenv';
 
+const version = getPackageVersion();
 console.log(pc.cyan(pc.bold(` 🤩 Testomat.io Reporter v${version}`)));
+const program = new Command();
 
 program
   .option('-c, --command <cmd>', 'Test runner command')
@@ -19,7 +22,7 @@ program
     const { launch, finish, filter } = opts;
     let { command } = opts;
 
-    if (opts.envFile) require('dotenv').config(opts.envFile); // eslint-disable-line
+    if (opts.envFile) dotenv.config({ path: opts.envFile });
 
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config.TESTOMATIO;
     const title = process.env.TESTOMATIO_TITLE;
@@ -36,6 +39,8 @@ program
     }
 
     if (finish) {
+      // TODO: add error in case of TESTOMATIO environment variable is not set
+      // because command is fine in console, but actually (on testomat.io) run is not finished
       if (!process.env.TESTOMATIO_RUN) {
         console.log('TESTOMATIO_RUN environment variable must be set.');
         return process.exit(1);

package/src/bin/uploadArtifacts.js

@@ -0,0 +1,91 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import pc from 'picocolors';
+import createDebugMessages from 'debug';
+import TestomatClient from '../client.js';
+import { APP_PREFIX } from '../constants.js';
+import { getPackageVersion } from '../utils/utils.js';
+import { config } from '../config.js';
+import { readLatestRunId } from '../utils/utils.js';
+import dotenv from 'dotenv';
+
+const debug = createDebugMessages('@testomatio/reporter:upload-cli');
+const version = getPackageVersion();
+console.log(pc.cyan(pc.bold(` 🤩 Testomat.io Reporter v${version}`)));
+const program = new Command();
+
+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) {
+      dotenv.config({ path: opts.envFile });
+    } else {
+      dotenv.config();
+    }
+
+    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,
+    });
+    let testruns = client.uploader.readUploadedFiles(process.env.TESTOMATIO_RUN);
+
+    const numTotalArtifacts = testruns.length;
+
+    debug('Found testruns:', testruns);
+
+    if (!opts.force) testruns = testruns.filter(tr => !tr.uploaded);
+
+    if (!testruns.length) {
+      console.log(APP_PREFIX, 'Total artifacts:', numTotalArtifacts);
+      if (numTotalArtifacts) {
+        console.log(APP_PREFIX, 'No new artifacts to upload');
+        console.log(APP_PREFIX, 'To re-upload artifacts run this command with --force flag');
+      }
+      process.exit(0);
+    }
+
+    const testrunsByRid = testruns.reduce((acc, { rid, file }) => {
+      if (!acc[rid]) {
+        acc[rid] = [];
+      }
+      if (!acc[rid].includes(file)) acc[rid].push(file);
+      return acc;
+    }, {});
+
+    // we need to obtain S3 credentials
+    await client.createRun();
+
+    client.uploader.checkEnabled();
+    client.uploader.disableLogStorage();
+
+    for (const rid in testrunsByRid) {
+      const files = testrunsByRid[rid];
+      await client.addTestRun(undefined, {
+        rid,
+        files,
+      });
+    }
+
+    console.log(APP_PREFIX, client.uploader.successfulUploads.length, 'artifacts uploaded');
+    if (client.uploader.failedUploads.length) {
+      console.log(APP_PREFIX, client.uploader.failedUploads.length, 'artifacts failed to upload');
+    }
+  });
+
+if (process.argv.length <= 1) {
+  program.outputHelp();
+}
+
+program.parse(process.argv);

package/src/client.js

@@ -4,24 +4,26 @@ import { minimatch } from 'minimatch';
 import fs from 'fs';
 import pc from 'picocolors';
 import { randomUUID } from 'crypto';
-import {upload} from './fileUploader.js';
 import { APP_PREFIX, STATUS } from './constants.js';
 import { pipesFactory } from './pipe/index.js';
 import { glob } from 'glob';
-import path, { sep} from 'path';
+import path, { sep } from 'path';
 import { fileURLToPath } from 'node:url';
+import { S3Uploader } from './uploader.js';
+import { formatStep, storeRunId } from './utils/utils.js';
+import { filesize as prettyBytes } from 'filesize';
 
 const debug = createDebugMessages('@testomatio/reporter:client');
 
 // removed __dirname usage, because:
 // 1. replaced with ESM syntax (import.meta.url), but it throws an error on tsc compilation;
-// 2. got error "__dirname already defined" in compiles js code (cjs dir) 
+// 2. got error "__dirname already defined" in compiles js code (cjs dir)
 
 let listOfTestFilesToExcludeFromReport = null;
 
 /**
- * @typedef {import('../types').TestData} TestData
- * @typedef {import('../types').PipeResult} PipeResult
+ * @typedef {import('../types/types.js').TestData} TestData
+ * @typedef {import('../types/types.js').PipeResult} PipeResult
  */
 
 class Client {
@@ -29,12 +31,11 @@ class Client {
    * Create a Testomat client instance
    * @returns
    */
-  // eslint-disable-next-line 
   constructor(params = {}) {
-    this.uuid = randomUUID();
+    this.paramsForPipesFactory = params;
+    this.pipeStore = {};
+    this.runId = randomUUID(); // will be replaced by real run id
     this.queue = Promise.resolve();
-    this.totalUploaded = 0;
-    this.failedToUpload = 0;
 
     // @ts-ignore this line will be removed in compiled code, because __dirname is defined in commonjs
     const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -47,6 +48,7 @@ class Client {
     }
     this.executionList = Promise.resolve();
 
+    this.uploader = new S3Uploader();
   }
 
   /**
@@ -66,8 +68,7 @@ class Client {
    * or resolves to undefined if no valid results are found or if all pipes are disabled.
    */
   async prepareRun(params) {
-    const store = {};
-    this.pipes = await pipesFactory(params, store);
+    this.pipes = await pipesFactory(params || this.paramsForPipesFactory || {}, this.pipeStore);
     const { pipe, pipeOptions } = params;
     // all pipes disabled, skipping
     if (!this.pipes.some(p => p.isEnabled)) {
@@ -77,7 +78,7 @@ class Client {
     try {
       const filterPipe = this.pipes.find(p => p.constructor.name.toLowerCase() === `${pipe.toLowerCase()}pipe`);
 
-      if (!filterPipe.isEnabled) {
+      if (!filterPipe?.isEnabled) {
         // TODO:for the future for the another pipes
         console.warn(
           APP_PREFIX,
@@ -110,7 +111,8 @@ class Client {
    * @returns {Promise<any>} - resolves to Run id which should be used to update / add test
    */
   async createRun(params) {
-    if (!this.pipes || !this.pipes.length) this.pipes = await pipesFactory(params || {}, {});
+    if (!this.pipes || !this.pipes.length)
+      this.pipes = await pipesFactory(params || this.paramsForPipesFactory || {}, this.pipeStore);
     debug('Creating run...');
     // all pipes disabled, skipping
     if (!this.pipes?.filter(p => p.isEnabled).length) return Promise.resolve();
@@ -118,6 +120,12 @@ class Client {
     this.queue = this.queue
       .then(() => Promise.all(this.pipes.map(p => p.createRun())))
       .catch(err => console.log(APP_PREFIX, err))
+      .then(() => {
+        const runId = this.pipeStore?.runId;
+        if (runId) this.runId = runId;
+        storeRunId(this.runId);
+      })
+      .then(() => this.uploader.checkEnabled())
       .then(() => undefined); // fixes return type
     // debug('Run', this.queue);
     return this.queue;
@@ -165,9 +173,45 @@ class Client {
       suite_id,
       test_id,
       manuallyAttachedArtifacts,
-      meta,
     } = testData;
-    let { message = '' } = testData;
+    let { message = '', meta = {} } = testData;
+
+    // stringify meta values and limit keys and values length to 255
+    meta = Object.entries(meta)
+      .filter(([, value]) => value !== null && value !== undefined)
+      .map(([key, value]) => {
+        try {
+          if (typeof value === 'object') {
+            value = JSON.stringify(value);
+          } else if (typeof value !== 'string') {
+            try {
+              value = value.toString();
+            } catch (err) {
+              console.warn(APP_PREFIX, `Can't convert meta value to string`, err);
+            }
+          }
+
+          if (value?.length > 255) {
+            value = value.substring(0, 255);
+            debug(APP_PREFIX, `Meta info value "${value}" is too long, trimmed to 255 characters`);
+          }
+
+          if (key?.length > 255) {
+            const newKey = key.substring(0, 255);
+            debug(APP_PREFIX, `Meta info key "${key}" is too long, trimmed to 255 characters`);
+            return [newKey, value];
+          }
+
+          return [key, value];
+        } catch (err) {
+          debug(APP_PREFIX, `Error while processing meta info key ${key}`, err);
+          return [null, null];
+        }
+      })
+      .reduce((acc, [key, value]) => {
+        if (key) acc[key] = value;
+        return acc;
+      }, {});
 
     let errorFormatted = '';
     if (error) {
@@ -183,24 +227,24 @@ class Client {
 
     const uploadedFiles = [];
 
-    for (const f of files) {
-      uploadedFiles.push(upload.uploadFileByPath(f, this.uuid));
+    for (let f of files) {
+      if (!f) continue; // f === null
+      if (typeof f === 'object') {
+        if (!f.path) continue;
+
+        f = f.path;
+      }
+
+      uploadedFiles.push(this.uploader.uploadFileByPath(f, [this.runId, rid, path.basename(f)]));
     }
 
     for (const [idx, buffer] of filesBuffers.entries()) {
       const fileName = `${idx + 1}-${title.replace(/\s+/g, '-')}`;
-      uploadedFiles.push(upload.uploadFileAsBuffer(buffer, fileName, this.uuid));
+      uploadedFiles.push(this.uploader.uploadFileAsBuffer(buffer, [this.runId, rid, fileName]));
     }
 
     const artifacts = (await Promise.all(uploadedFiles)).filter(n => !!n);
 
-    if (artifacts.length < uploadedFiles.length) {
-      const failedUploading = uploadedFiles.length - artifacts.length;
-      this.failedToUpload += failedUploading;
-    }
-
-    this.totalUploaded += artifacts.length;
-
     const data = {
       rid,
       files,
@@ -258,27 +302,81 @@ class Client {
     this.queue = this.queue
       .then(() => Promise.all(this.pipes.map(p => p.finishRun(runParams))))
       .then(() => {
-        debug('TOTAL artifacts', this.totalUploaded);
-        if (this.totalUploaded && !upload.isArtifactsEnabled())
-          debug(`${this.totalUploaded} artifacts are not uploaded, because artifacts uploading is not enabled`);
+        if (!this.uploader.isEnabled) return;
+
+        const filesizeStrMaxLength = 7;
+
+        if (this.uploader.successfulUploads.length) {
+          debug('\n', APP_PREFIX, `🗄️ ${this.uploader.successfulUploads.length} artifacts uploaded to S3 bucket`);
+          const uploadedArtifacts = this.uploader.successfulUploads.map(file => ({
+            relativePath: file.path.replace(process.cwd(), ''),
+            link: file.link,
+            sizePretty: prettyBytes(file.size, { round: 0 }).toString(),
+          }));
+
+          uploadedArtifacts.forEach(upload => {
+            debug(
+              `🟢Uploaded artifact`,
+              `${upload.relativePath},`,
+              'size:',
+              `${upload.sizePretty},`,
+              'link:',
+              `${upload.link}`,
+            );
+          });
+        }
 
-        if (this.totalUploaded && upload.isArtifactsEnabled()) {
+        if (this.uploader.failedUploads.length) {
           console.log(
             APP_PREFIX,
-            `🗄️ ${this.totalUploaded} artifacts ${
-              process.env.TESTOMATIO_PRIVATE_ARTIFACTS ? 'privately' : pc.bold('publicly')
-            } uploaded to S3 bucket`,
+            `🗄️ ${this.uploader.failedUploads.length} artifacts 🔴${pc.bold('failed')} to upload`,
           );
+          const failedUploads = this.uploader.failedUploads.map(file => ({
+            relativePath: file.path.replace(process.cwd(), ''),
+            sizePretty: prettyBytes(file.size, { round: 0 }).toString(),
+          }));
 
-          if (this.failedToUpload > 0) {
+          const pathPadding = Math.max(...failedUploads.map(upload => upload.relativePath.length)) + 1;
+
+          failedUploads.forEach(upload => {
             console.log(
-              APP_PREFIX,
-              pc.yellow(
-                `Some artifacts were not uploaded. ${this.failedToUpload} artifacts could not be uploaded.
-                Run tests with DEBUG="@testomatio/reporter:file-uploader" to see details"`,
-              ),
+              `  ${pc.gray('|')} 🔴 ${upload.relativePath.padEnd(pathPadding)} ${pc.gray(
+                `| ${upload.sizePretty.padStart(filesizeStrMaxLength)} |`,
+              )}`,
             );
-          }
+          });
+        }
+
+        if (this.uploader.skippedUploads.length) {
+          console.log(
+            '\n',
+            APP_PREFIX,
+            `🗄️ ${pc.bold(this.uploader.skippedUploads.length)} artifacts uploading 🟡${pc.bold('skipped')}`,
+          );
+          const skippedUploads = this.uploader.skippedUploads.map(file => ({
+            relativePath: file.path.replace(process.cwd(), ''),
+            sizePretty: file.size === null ? 'unknown' : prettyBytes(file.size, { round: 0 }).toString(),
+          }));
+          const pathPadding = Math.max(...skippedUploads.map(upload => upload.relativePath.length)) + 1;
+          skippedUploads.forEach(upload => {
+            console.log(
+              `  ${pc.gray('|')} 🟡 ${upload.relativePath.padEnd(pathPadding)} ${pc.gray(
+                `| ${upload.sizePretty.padStart(filesizeStrMaxLength)} |`,
+              )}`,
+            );
+          });
+        }
+
+        if (this.uploader.skippedUploads.length || this.uploader.failedUploads.length) {
+          const command = `TESTOMATIO=<your_api_key> TESTOMATIO_RUN=${
+            this.runId
+          } npx @testomatio/reporter upload-artifacts`;
+          const numberOfNotUploadedArtifacts = this.uploader.skippedUploads.length + this.uploader.failedUploads.length;
+          console.log(
+            APP_PREFIX,
+            `${numberOfNotUploadedArtifacts} artifacts were not uploaded.
+            Run "${pc.magenta(command)}" with valid S3 credentials to upload skipped & failed artifacts`,
+          );
         }
       })
       .catch(err => console.log(APP_PREFIX, err));
@@ -365,24 +463,6 @@ function isNotInternalFrame(frame) {
   );
 }
 
-function formatStep(step, shift = 0) {
-  const prefix = ' '.repeat(shift);
-
-  const lines = [];
-
-  if (step.error) {
-    lines.push(`${prefix}${pc.red(step.title)} ${pc.gray(`${step.duration}ms`)}`);
-  } else {
-    lines.push(`${prefix}${step.title} ${pc.gray(`${step.duration}ms`)}`);
-  }
-
-  for (const child of step.steps || []) {
-    lines.push(...formatStep(child, shift + 2));
-  }
-
-  return lines;
-}
-
 /**
  *
  * @param {TestData} testData

package/src/config.js

@@ -6,10 +6,10 @@ const debug = createDebugMessages('@testomatio/reporter:config');
 /* for possibility to use multiple env files (reading different paths)
 const envFileVars = dotenv.config({ path: '.env' }).parsed; */
 
-if (process.env.TESTOMATIO_API_KEY) {
+if (process.env.TESTOMATIO_API_KEY && !process.env.TESTOMATIO) {
   process.env.TESTOMATIO = process.env.TESTOMATIO_API_KEY;
 }
-if (process.env.TESTOMATIO_TOKEN) {
+if (process.env.TESTOMATIO_TOKEN && !process.env.TESTOMATIO) {
   process.env.TESTOMATIO = process.env.TESTOMATIO_TOKEN;
 }
 

package/src/constants.js

@@ -3,7 +3,11 @@ import os from 'os';
 import path from 'path';
 
 const APP_PREFIX = pc.gray('[TESTOMATIO]');
-const AXIOS_TIMEOUT = 20 * 1000; // sum = 20sec
+const TESTOMATIO_REQUEST_TIMEOUT = parseInt(process.env.TESTOMATIO_REQUEST_TIMEOUT, 10);
+if (TESTOMATIO_REQUEST_TIMEOUT) {
+  console.log(`${APP_PREFIX} Request timeout is set to ${TESTOMATIO_REQUEST_TIMEOUT / 1000}s`);
+}
+const AXIOS_TIMEOUT = TESTOMATIO_REQUEST_TIMEOUT || 20 * 1000;
 
 const TESTOMAT_TMP_STORAGE_DIR = path.join(os.tmpdir(), 'testomatio_tmp');
 

package/src/data-storage.js

@@ -52,7 +52,7 @@ class DataStorage {
 
     context = context || this.context || testRunnerHelper.getNameOfCurrentlyRunningTest();
     if (!context) {
-      debug(`No context provided for "${dataType}" data:`, data);
+      // debug(`No context provided for "${dataType}" data:`, data);
       return;
     }
     const contextHash = stringToMD5Hash(context);
@@ -101,7 +101,7 @@ class DataStorage {
     if (testDataFromFile.length) {
       return testDataFromFile;
     }
-    debug(`No "${dataType}" data for context "${contextHash}" in both file and global variable`);
+    // debug(`No "${dataType}" data for context "${contextHash}" in both file and global variable`);
 
     // in case no data found for context
     return null;

package/src/junit-adapter/csharp.js

@@ -1,3 +1,4 @@
+import path from 'path';
 import Adapter from './adapter.js';
 
 class CSharpAdapter extends Adapter {
@@ -7,10 +8,21 @@ class CSharpAdapter extends Adapter {
     if (example) t.example = { ...example[1].split(',') };
     const suite = t.suite_title.split('.');
     t.suite_title = suite.pop();
-    t.file = suite.join('/');
+    t.file = namespaceToFileName(t.file);
     t.title = title.trim();
     return t;
   }
+
+  getFilePath(t) {
+    const fileName = namespaceToFileName(t.file);
+    return fileName;
+  }
 }
 
 export default CSharpAdapter;
+
+function namespaceToFileName(fileName) {
+  const fileParts = fileName.split('.');
+  fileParts[fileParts.length - 1] = fileParts[fileParts.length - 1]?.replace(/\$.*/, '');
+  return `${fileParts.join(path.sep)}.cs`;
+}

package/src/pipe/bitbucket.js

@@ -15,8 +15,8 @@ const debug = createDebugMessages('@testomatio/reporter:pipe:bitbucket');
 
 /**
  * @class BitbucketPipe
- * @typedef {import('../../types').Pipe} Pipe
- * @typedef {import('../../types').TestData} TestData
+ * @typedef {import('../../types/types.js').Pipe} Pipe
+ * @typedef {import('../../types/types.js').TestData} TestData
  */
 export class BitbucketPipe {
   constructor(params, store = {}) {

package/src/pipe/csv.js

@@ -1,7 +1,7 @@
 import createDebugMessages from 'debug';
 import path from 'path';
 import fs from 'fs';
-import {createObjectCsvWriter} from 'csv-writer';
+import { createObjectCsvWriter } from 'csv-writer';
 import pc from 'picocolors';
 import merge from 'lodash.merge';
 import { isSameTest, getCurrentDateTime, ansiRegExp } from '../utils/utils.js';
@@ -9,8 +9,8 @@ import { CSV_HEADERS } from '../constants.js';
 
 const debug = createDebugMessages('@testomatio/reporter:pipe:csv');
 /**
- * @typedef {import('../../types').Pipe} Pipe
- * @typedef {import('../../types').TestData} TestData
+ * @typedef {import('../../types/types.js').Pipe} Pipe
+ * @typedef {import('../../types/types.js').TestData} TestData
  * @class CsvPipe
  * @implements {Pipe}
  */