@testomatio/reporter 1.6.13 → 2.0.1-beta-esm

package/src/adapter/webdriver.js

@@ -0,0 +1,142 @@
+// eslint-disable-next-line
+import WDIOReporter, { RunnerStats } from '@wdio/reporter';
+import TestomatClient from '../client.js';
+import { getTestomatIdFromTestTitle, fileSystem } from '../utils/utils.js';
+import { services } from '../services/index.js';
+import { TESTOMAT_TMP_STORAGE_DIR } from '../constants.js';
+
+class WebdriverReporter extends WDIOReporter {
+  constructor(options) {
+    super(options);
+
+    this.client = new TestomatClient({ apiKey: options?.apiKey });
+    options = Object.assign(options, { stdout: true });
+
+    this._addTestPromises = [];
+
+    this._isSynchronising = false;
+    // NOTE: new functionality; may break everything
+    this.client.createRun();
+  }
+
+  get isSynchronised() {
+    return this._isSynchronising === false;
+  }
+
+  /**
+   *
+   * @param {RunnerStats} runData
+   */
+  async onRunnerEnd(runData) {
+    this._isSynchronising = true;
+
+    await Promise.all(this._addTestPromises);
+
+    this._isSynchronising = false;
+
+    // NOTE: new functionality; may break everything
+    // also this may require additional status mapping
+    await this.client.updateRunStatus(runData.failures ? 'failed' : 'passed');
+  }
+
+  onRunnerStart() {
+    // clear dir with artifacts/logs
+    //
+    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
+  }
+
+  onTestStart(test) {
+    services.setContext(test.fullTitle);
+  }
+
+  onTestEnd(test) {
+    test.suite = test.parent;
+    const logs = getTestLogs(test.fullTitle);
+    // TODO: FIX: artifacts for some reason leads to empty report on Testomat.io
+    // const artifacts = services.artifacts.get(test.fullTitle);
+    // const keyValues = services.keyValues.get(test.fullTitle);
+    test.logs = logs;
+    // test.artifacts = artifacts;
+    // test.meta = keyValues;
+
+    this._addTestPromises.push(this.addTest(test));
+  }
+
+  // wdio-cucumber does not trigger onTestEnd hook, thus, using this one
+  onSuiteEnd(scerario) {
+    if (scerario.type === 'scenario') {
+      this._addTestPromises.push(this.addBddScenario(scerario));
+    }
+  }
+
+  async addTest(test) {
+    if (!this.client) return;
+
+    const { title, _duration: duration, state, error, output } = test;
+
+    const testId = getTestomatIdFromTestTitle(title);
+
+    const screenshotEndpoint = '/session/:sessionId/screenshot';
+    const screenshotsBuffers = output
+      .filter(el => el.endpoint === screenshotEndpoint && el.result && el.result.value)
+      .map(el => Buffer.from(el.result.value, 'base64'));
+
+    await this.client.addTestRun(state, {
+      manuallyAttachedArtifacts: test.artifacts,
+      error,
+      logs: test.logs,
+      meta: test.meta,
+      title,
+      test_id: testId,
+      time: duration,
+      filesBuffers: screenshotsBuffers,
+    });
+  }
+
+  /**
+   * @param {import('../../types/types.js').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,
+    });
+  }
+}
+
+/**
+ *
+ * @param {*} fullTestTitle
+ * @returns string
+ */
+function getTestLogs(fullTestTitle) {
+  const logsArr = services.logger.getLogs(fullTestTitle);
+  // remove duplicates (for some reason, logs are duplicated several times)
+  const logs = logsArr ? Array.from(new Set(logsArr)).join('\n').trim() : '';
+  return logs;
+}
+
+export default WebdriverReporter;

package/src/bin/cli.js

@@ -0,0 +1,280 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import { spawn } from 'cross-spawn';
+import glob from 'glob';
+import createDebugMessages from 'debug';
+import TestomatClient from '../client.js';
+import XmlReader from '../xmlReader.js';
+import { APP_PREFIX, STATUS } from '../constants.js';
+import { version } from '../../package.json';
+import { config } from '../config.js';
+import { readLatestRunId } from '../utils/utils.js';
+import pc from 'picocolors';
+import { filesize as prettyBytes } from 'filesize';
+import dotenv from 'dotenv';
+
+const debug = createDebugMessages('@testomatio/reporter:xml-cli');
+console.log(pc.cyan(pc.bold(` 🤩 Testomat.io Reporter v${version}`)));
+const program = new Command();
+
+program
+  .version(version)
+  .option('--env-file <envfile>', 'Load environment variables from env file')
+  .hook('preAction', thisCommand => {
+    const opts = thisCommand.opts();
+    if (opts.envFile) {
+      dotenv.config({ path: opts.envFile });
+    } else {
+      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 () => {
+    process.env.TESTOMATIO_RUN ||= readLatestRunId();
+
+    if (!process.env.TESTOMATIO_RUN) {
+      console.log('TESTOMATIO_RUN environment variable must be set or restored from a previous run.');
+      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 });
+
+    // @ts-ignore
+    client.updateRunStatus(STATUS.FINISHED).then(() => {
+      console.log(pc.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`, pc.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 ${pc.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 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(runId);
+    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.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.successfulUploads.length) {
+      debug('\n', APP_PREFIX, `🗄️ ${client.uploader.successfulUploads.length} artifacts uploaded to S3 bucket`);
+      const uploadedArtifacts = client.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}`,
+        );
+      });
+    }
+
+    const filesizeStrMaxLength = 7;
+
+    if (client.uploader.failedUploads.length) {
+      console.log(
+        '\n',
+        APP_PREFIX,
+        '🗄️',
+        client.uploader.failedUploads.length,
+        `artifacts 🔴${pc.bold('failed')} to upload`,
+      );
+
+      const failedUploads = client.uploader.failedUploads.map(({ path, size }) => ({
+        relativePath: path.replace(process.cwd(), ''),
+        sizePretty: prettyBytes(size, { round: 0 }).toString(),
+      }));
+
+      const pathPadding = Math.max(...failedUploads.map(upload => upload.relativePath.length)) + 1;
+      failedUploads.forEach(upload => {
+        console.log(
+          `  ${pc.gray('|')} 🔴 ${upload.relativePath.padEnd(pathPadding)} ${pc.gray(
+            `| ${upload.sizePretty.padStart(filesizeStrMaxLength)} |`,
+          )}`,
+        );
+      });
+    }
+  });
+
+program.parse(process.argv);
+
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+}

package/src/bin/reportXml.js

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import pc from 'picocolors';
+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 dotenv from 'dotenv';
+
+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>')
+  .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')
+  .option('--env-file <envfile>', 'Load environment variables from env file')
+  .action(async (pattern, opts) => {
+    if (!pattern.endsWith('.xml')) {
+      pattern += '.xml';
+    }
+    let { javaTests, lang } = opts;
+    if (opts.envFile) {
+      console.log(APP_PREFIX, 'Loading env file:', opts.envFile);
+      debug('Loading env file: %s', opts.envFile);
+      dotenv.config({ path: opts.envFile });
+    }
+    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) {
+      console.log(APP_PREFIX, `Report can't be created. No XML files found 😥`);
+      process.exitCode = 1;
+      return;
+    }
+
+    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);
+  });
+
+if (process.argv.length < 3) {
+  program.outputHelp();
+}
+
+program.parse(process.argv);

package/src/bin/startTest.js

@@ -0,0 +1,123 @@
+#!/usr/bin/env node
+import { spawn } from 'cross-spawn';
+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 dotenv from 'dotenv';
+
+console.log(pc.cyan(pc.bold(` 🤩 Testomat.io Reporter v${version}`)));
+const program = new Command();
+
+program
+  .option('-c, --command <cmd>', 'Test runner command')
+  .option('--launch', 'Start a new run and return its ID')
+  .option('--finish', 'Finish Run by its ID')
+  .option('--env-file <envfile>', 'Load environment variables from env file')
+  .option('--filter <filter>', 'Additional execution filter')
+  .action(async opts => {
+    const { launch, finish, filter } = opts;
+    let { command } = opts;
+
+    if (opts.envFile) dotenv.config({ path: opts.envFile });
+
+    const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config.TESTOMATIO;
+    const title = process.env.TESTOMATIO_TITLE;
+
+    if (launch) {
+      console.log('Starting a new Run on Testomat.io...');
+      const client = new TestomatClient({ apiKey });
+
+      client.createRun().then(() => {
+        console.log(process.env.runId);
+        process.exit(0);
+      });
+      return;
+    }
+
+    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);
+      }
+
+      console.log('Finishing Run on Testomat.io...');
+
+      const client = new TestomatClient({ apiKey });
+
+      // @ts-ignore
+      client.updateRunStatus(STATUS.FINISHED).then(() => {
+        console.log(pc.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
+        process.exit(0);
+      });
+      return;
+    }
+
+    let exitCode = 0;
+
+    if (!command.split) {
+      process.exitCode = 255;
+      console.log(APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
+      return;
+    }
+
+    const client = new TestomatClient({ apiKey, title, parallel: true });
+
+    if (filter) {
+      const [pipe, ...optsArray] = filter.split(':');
+      const pipeOptions = optsArray.join(':');
+
+      try {
+        const tests = await client.prepareRun({ pipe, pipeOptions });
+
+        if (!tests || tests.length === 0) {
+          return;
+        }
+
+        const grep = ` --grep (${tests.join('|')})`;
+        command += grep;
+      } catch (err) {
+        console.log(APP_PREFIX, err);
+      }
+    }
+
+    const testCmds = command.split(' ');
+    console.log(APP_PREFIX, `🚀 Running`, pc.green(command));
+
+    if (!apiKey) {
+      const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
+
+      cmd.on('close', code => {
+        console.log(APP_PREFIX, '⚠️ ', `Runner exited with ${pc.bold(code)}, report is ignored`);
+
+        if (code > exitCode) exitCode = code;
+        process.exitCode = exitCode;
+      });
+
+      return;
+    }
+
+    client.createRun().then(() => {
+      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 ${pc.bold(code)}`);
+        const status = code === 0 ? 'passed' : 'failed';
+        client.updateRunStatus(status, true);
+
+        if (code > exitCode) exitCode = code;
+        process.exitCode = exitCode;
+      });
+    });
+  });
+
+if (process.argv.length <= 2) {
+  program.outputHelp();
+}
+
+program.parse(process.argv);

package/src/bin/uploadArtifacts.js

@@ -0,0 +1,90 @@
+#!/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 { version } from '../../package.json';
+import { config } from '../config.js';
+import { readLatestRunId } from '../utils/utils.js';
+import dotenv from 'dotenv';
+
+const debug = createDebugMessages('@testomatio/reporter:upload-cli');
+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);