@testomatio/reporter 1.6.0-beta-2-artifacts → 2.0.0-beta-esm

package/lib/bin/cli.js

@@ -1,216 +0,0 @@
-#!/usr/bin/env node
-const { program } = require('commander');
-const spawn = require('cross-spawn');
-const chalk = require('chalk');
-const glob = require('glob');
-const debug = require('debug')('@testomatio/reporter:cli');
-const TestomatClient = require('../client');
-const XmlReader = require('../xmlReader');
-const { APP_PREFIX, STATUS } = require('../constants');
-const { version } = require('../../package.json');
-const config = require('../config');
-
-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) => {
-    const opts = thisCommand.opts();
-    if (opts.envFile) {
-      require('dotenv').config({ path: opts.envFile });
-    } else {
-      require('dotenv').config();
-    }
-  });
-
-program
-  .command('start')
-  .description('Start a new run and return its ID')
-  .action(async () => {
-    console.log('Starting a new Run on Testomat.io...');
-    const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config.TESTOMATIO;
-    const client = new TestomatClient({ apiKey });
-
-    client.createRun().then(() => {
-      console.log(process.env.runId);
-      process.exit(0);
-    });
-  });
-
-program
-  .command('finish')
-  .description('Finish Run by its ID')
-  .action(async () => {
-    if (!process.env.TESTOMATIO_RUN) {
-      console.log('TESTOMATIO_RUN environment variable must be set.');
-      return process.exit(1);
-    }
-
-    console.log('Finishing Run on Testomat.io...');
-    const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config.TESTOMATIO;
-    const client = new TestomatClient({ apiKey });
-
-    client.updateRunStatus(STATUS.FINISHED).then(() => {
-      console.log(chalk.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
-      process.exit(0);
-    });
-  });
-
-program
-  .command('run')
-  .description('Run tests with the specified command')
-  .argument('<command>', 'Test runner command')
-  .option('--filter <filter>', 'Additional execution filter')
-  .action(async (command, opts) => {
-    const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config.TESTOMATIO;
-    const title = process.env.TESTOMATIO_TITLE;
-
-    if (!command || !command.split) {
-      console.log(APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
-      return process.exit(255);
-    }
-
-    const client = new TestomatClient({ apiKey, title, parallel: true });
-
-    if (opts.filter) {
-      const [pipe, ...optsArray] = opts.filter.split(':');
-      const pipeOptions = optsArray.join(':');
-
-      try {
-        const tests = await client.prepareRun({ pipe, pipeOptions });
-        if (tests && tests.length > 0) {
-          command += ` --grep (${tests.join('|')})`;
-        }
-      } catch (err) {
-        console.log(APP_PREFIX, err);
-      }
-    }
-
-    console.log(APP_PREFIX, `🚀 Running`, chalk.green(command));
-
-    const runTests = () => {
-      const testCmds = command.split(' ');
-      const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
-
-      cmd.on('close', code => {
-        const emoji = code === 0 ? '🟢' : '🔴';
-        console.log(APP_PREFIX, emoji, `Runner exited with ${chalk.bold(code)}`);
-        if (apiKey) {
-          const status = code === 0 ? 'passed' : 'failed';
-          client.updateRunStatus(status, true);
-        }
-        process.exit(code);
-      });
-    };
-
-    if (apiKey) {
-      client.createRun().then(runTests);
-    } else {
-      runTests();
-    }
-  });
-
-program
-  .command('xml')
-  .description('Parse XML reports and upload to Testomat.io')
-  .argument('<pattern>', 'XML file pattern')
-  .option('-d, --dir <dir>', 'Project directory')
-  .option('--java-tests [java-path]', 'Load Java tests from path, by default: src/test/java')
-  .option('--lang <lang>', 'Language used (python, ruby, java)')
-  .option('--timelimit <time>', 'default time limit in seconds to kill a stuck process')
-  .action(async (pattern, opts) => {
-    if (!pattern.endsWith('.xml')) {
-      pattern += '.xml';
-    }
-    let { javaTests, lang } = opts;
-    if (javaTests === true) javaTests = 'src/test/java';
-    lang = lang?.toLowerCase();
-    const runReader = new XmlReader({ javaTests, lang });
-    const files = glob.sync(pattern, { cwd: opts.dir || process.cwd() });
-    if (!files.length) {
-      console.log(APP_PREFIX, `Report can't be created. No XML files found 😥`);
-      process.exit(1);
-    }
-
-    for (const file of files) {
-      console.log(APP_PREFIX, `Parsed ${file}`);
-      runReader.parse(file);
-    }
-
-    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);
-    }
-
-    try {
-      await runReader.createRun();
-      await runReader.uploadData();
-    } catch (err) {
-      console.log(APP_PREFIX, 'Error updating status, skipping...', err);
-    }
-
-    if (timeoutTimer) clearTimeout(timeoutTimer);
-  });
-
-program
-  .command('upload-artifacts')
-  .description('Upload artifacts to Testomat.io')
-  .option('--force', 'Re-upload artifacts even if they were uploaded before')
-  .action(async (opts) => {
-    const apiKey = config.TESTOMATIO;
-
-    process.env.TESTOMATIO_DISABLE_ARTIFACTS = '';
-
-    const client = new TestomatClient({
-      apiKey,
-      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;
-    }, {});
-
-    await client.createRun();
-    client.uploader.checkEnabled();
-    client.uploader.disbleLogStorage();
-
-    for (const rid in testrunsByRid) {
-      const files = testrunsByRid[rid];
-      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');
-    }
-  });
-
-program.parse(process.argv);
-
-if (!process.argv.slice(2).length) {
-  program.outputHelp();
-}

package/lib/bin/uploadArtifacts.js

@@ -1,86 +0,0 @@
-#!/usr/bin/env node
-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');
-
-console.log(chalk.cyan.bold(` 🤩 Testomat.io Reporter v${version}`));
-
-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 {
-      // try to load from env file
-      require('dotenv').config(); // eslint-disable-line
-    }
-
-    const apiKey = config.TESTOMATIO;
-
-    process.env.TESTOMATIO_DISABLE_ARTIFACTS = '';
-    // process.env.TESTOMATIO_ARTIFACTS_SIZE = null;
-
-    const client = new TestomatClient({
-      apiKey,
-      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;
-    }, {});
-
-    let numArtifacts = 0;
-
-    // we need to obtain S3 credentials
-    await client.createRun();
-
-    client.uploader.checkEnabled();
-    client.uploader.disbleLogStorage();
-
-    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');
-    }
-  });
-
-if (process.argv.length <= 1) {
-  program.outputHelp();
-}
-
-program.parse(process.argv);

package/lib/uploader.js

@@ -1,312 +0,0 @@
-const debug = require('debug')('@testomatio/reporter:uploader');
-const { S3 } = require('@aws-sdk/client-s3');
-const { Upload } = require('@aws-sdk/lib-storage');
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-const promiseRetry = require('promise-retry');
-const chalk = require('chalk');
-const { APP_PREFIX } = require('./constants');
-
-class S3Uploader {
-  constructor() {
-    this.isEnabled = undefined;
-    this.storeEnabled = true;
-    this.config = undefined;
-
-    // counters
-    this.skippedUpload = 0;
-    this.failedUpload = 0;
-    this.totalUploaded = 0;
-
-    this.succesfulUploads = {};
-
-    this.configKeys = [
-      'S3_ENDPOINT',
-      'S3_REGION',
-      'S3_BUCKET',
-      'S3_ACCESS_KEY_ID',
-      'S3_SECRET_ACCESS_KEY',
-      'S3_SESSION_TOKEN',
-      'S3_FORCE_PATH_STYLE',
-      'TESTOMATIO_DISABLE_ARTIFACTS',
-      'TESTOMATIO_PRIVATE_ARTIFACTS',
-      'TESTOMATIO_ARTIFACTS_SIZE'
-    ];
-  }
-
-  resetConfig() {
-    this.config = undefined;
-    this.isEnabled = undefined;
-  }
-
-  getConfig() {
-    if (this.config) return this.config;
-    this.config = this.configKeys.reduce((acc, key) => {
-      acc[key] = process.env[key];
-      return acc;
-    }, {});
-    return this.config;
-  }
-
-  getMaskedConfig() {
-    return Object.fromEntries(
-      Object.entries(this.getConfig()).map(([key, value]) => [
-        key,
-        key === 'S3_SECRET_ACCESS_KEY' || key === 'S3_ACCESS_KEY_ID' ? '***' : value,
-      ]),
-    );
-  }
-
-  checkEnabled() {
-    if (this.isEnabled !== undefined) return this.isEnabled;
-
-    const { S3_BUCKET, TESTOMATIO_DISABLE_ARTIFACTS } = this.getConfig();
-    if (!S3_BUCKET) debug(`Upload is disabled because S3_BUCKET is not set`);
-    this.isEnabled = !!(S3_BUCKET && !TESTOMATIO_DISABLE_ARTIFACTS);
-
-    if (this.isEnabled) debug('S3 uploader is enabled');
-    debug(this.getMaskedConfig());
-
-    return this.isEnabled;
-  }
-
-  enableLogStorage() {
-    this.storeEnabled = true;
-  }
-
-  disbleLogStorage() {
-    this.storeEnabled = false;
-  }
-
-  async uploadToS3(Body, Key) {
-    const { S3_BUCKET, TESTOMATIO_PRIVATE_ARTIFACTS } = this.getConfig();
-    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());
-      return;
-    }
-
-    debug('Uploading to S3:', Key);
-
-    const s3 = new S3(this.getS3Config());
-
-    try {
-      const upload = new Upload({
-        client: s3,
-        params: {
-          Bucket: S3_BUCKET,
-          Key,
-          Body,
-          ACL,
-        },
-      });
-
-      const link = await this.getS3LocationLink(upload);
-      this.totalUploaded++;
-      this.succesfulUploads[Key] = link;
-      return link;
-    } catch (e) {
-      this.failedUpload++;
-      debug('S3 uploading error:', e);
-      console.log(APP_PREFIX, "Upload failed:", e.message, this.getMaskedConfig());
-    }
-  }
-
-  readUploadedFiles(runId = null) {
-    const tempFilePath = this.#getUploadFilePath(runId);
-
-    debug('Reading file', tempFilePath);
-
-    if (!fs.existsSync(tempFilePath)) {
-      debug('File not found:', tempFilePath);
-      return [];
-    }
-
-    const stats = fs.statSync(tempFilePath);
-    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.');
-      return [];
-    }
-
-    const data = fs.readFileSync(tempFilePath, 'utf8');
-    const lines = data.split('\n').filter(Boolean);
-    return lines.map(line => JSON.parse(line));
-  }
-
-  #getUploadFilePath(runId = null, forceCreate = false) {
-    if (!runId && !forceCreate) {
-      return path.join(os.tmpdir(), 'testomatio.run.latest.jsonl');
-    }
-
-    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;
-  }
-
-  storeUploadedFile(filePath, runId, rid, uploaded = false) {
-    if (!this.storeEnabled) return;
-
-    if (!filePath || !runId || !rid ) return;
-
-    const tempFilePath = this.#getUploadFilePath(runId);
-
-    const data = { rid, file: filePath, uploaded };
-    const jsonLine = JSON.stringify(data) + '\n';
-
-    fs.appendFileSync(tempFilePath, jsonLine);
-  }
-
-  getskippedUpload() {
-    return this.skippedUpload;
-  }
-
-  async uploadFileByPath(filePath, pathInS3) {
-    const [runId, rid] = pathInS3;
-
-    if (!this.isEnabled) {
-      this.storeUploadedFile(filePath, runId, rid, false);
-      this.skippedUpload++;
-      return;
-    }
-
-    const {
-      S3_BUCKET,
-      TESTOMATIO_ARTIFACTS_SIZE,
-    } = 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;
-    }
-
-    const fileSize = fs.statSync(filePath).size;
-    const fileSizeInMb = fileSize / (1024 * 1024);
-
-    if (TESTOMATIO_ARTIFACTS_SIZE && fileSizeInMb > parseInt(TESTOMATIO_ARTIFACTS_SIZE)) {
-      this.skippedUpload++;
-      console.error(chalk.yellow(`Artifacts file ${filePath} exceeds the maximum allowed size. Skipping...`));
-      return;
-    }
-    debug('File:', filePath, 'exists, size:', fileSizeInMb.toFixed(2), 'MB');
-
-    const fileStream = fs.createReadStream(filePath);
-    const Key = pathInS3.join('/');
-
-    const link = await this.uploadToS3(fileStream, Key);
-
-    this.storeUploadedFile(filePath, runId, rid, !!link);
-
-    return link;
-  }
-
-  async uploadFileAsBuffer(buffer, pathInS3) {
-    if (!this.isEnabled) return;
-
-    let Key = pathInS3.join('/');
-    const ext = this.#getFileExtBase64(buffer);
-
-    if (ext) {
-      Key = `${Key}.${ext}`;
-    }
-
-    return this.uploadToS3(buffer, Key);
-  }
-
-  async checkFileExists(filePath, attempts = 5, intervalMs = 500) {
-    return promiseRetry(
-      async (retry, number) => {
-        try {
-          fs.accessSync(filePath);
-          return true;
-        } catch (err) {
-          if (number === attempts) {
-            return false;
-          }
-          debug(`File not found, retrying (attempt ${number}/${attempts})`);
-          await new Promise((resolve) => setTimeout(resolve, intervalMs));
-          retry(err);
-        }
-      },
-      {
-        retries: attempts,
-        minTimeout: intervalMs,
-        maxTimeout: intervalMs,
-      }
-    );
-  }
-
-  async getS3LocationLink(out) {
-    const response = await out.done();
-
-    let s3Location = response?.Location;
-
-    if (!s3Location) {
-      s3Location = out?.singleUploadResult?.Location;
-      debug('Uploaded singleUploadResult.Location', s3Location);
-
-      if (!s3Location) {
-        throw new Error("Problems getting the S3 artifact's link. Please check S3 permissions!");
-      }
-    }
-
-    return s3Location;
-  }
-
-  #getFileExtBase64(str) {
-    const type = str.charAt(0);
-
-    return (
-      {
-        '/': 'jpg',
-        i: 'png',
-        R: 'gif',
-        U: 'webp',
-      }[type] || ''
-    );
-  }
-
-  getS3Config() {
-    const { S3_REGION, S3_SESSION_TOKEN, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_FORCE_PATH_STYLE, S3_ENDPOINT } =
-      this.getConfig();
-
-    const cfg = {
-      region: S3_REGION,
-      credentials: {
-        accessKeyId: S3_ACCESS_KEY_ID,
-        secretAccessKey: S3_SECRET_ACCESS_KEY,
-        s3ForcePathStyle: S3_FORCE_PATH_STYLE,
-      },
-    };
-
-    if (S3_SESSION_TOKEN) {
-      cfg.credentials.sessionToken = S3_SESSION_TOKEN;
-    }
-
-    if (S3_ENDPOINT) {
-      cfg.endpoint = S3_ENDPOINT;
-    }
-
-    return cfg;
-  }
-}
-
-module.exports = S3Uploader;