@testomatio/reporter 2.0.1-beta.4 → 2.0.1-beta.5-timestamp

package/src/adapter/codecept.js

@@ -1,373 +0,0 @@
-import createDebugMessages from 'debug';
-import pc from 'picocolors';
-import TestomatClient from '../client.js';
-import { STATUS, APP_PREFIX, TESTOMAT_TMP_STORAGE_DIR } from '../constants.js';
-import { getTestomatIdFromTestTitle, fileSystem } from '../utils/utils.js';
-import { services } from '../services/index.js';
-import codeceptjs from 'codeceptjs';
-
-const debug = createDebugMessages('@testomatio/reporter:adapter:codeceptjs');
-// @ts-ignore
-if (!global.codeceptjs) {
-  // @ts-ignore
-  global.codeceptjs = codeceptjs;
-}
-
-// @ts-ignore
-const { event, recorder, codecept } = global.codeceptjs;
-
-let currentMetaStep = [];
-let error;
-let stepShift = 0;
-
-// const output = new Output({
-//   filterFn: stack => !stack.includes('codeceptjs/lib/output'), // output from codeceptjs
-// });
-
-let stepStart = new Date();
-
-const MAJOR_VERSION = parseInt(codecept.version().match(/\d/)[0], 10);
-
-const DATA_REGEXP = /[|\s]+?(\{".*\}|\[.*\])/;
-
-if (MAJOR_VERSION < 3) {
-  console.log('🔴 This reporter works with CodeceptJS 3+, please update your tests');
-}
-
-function CodeceptReporter(config) {
-  let failedTests = [];
-  let videos = [];
-  let traces = [];
-  const reportTestPromises = [];
-
-  const testTimeMap = {};
-  const { apiKey } = config;
-
-  const getDuration = test => {
-    if (!test.uid) return 0;
-    if (testTimeMap[test.uid]) {
-      return Date.now() - testTimeMap[test.uid];
-    }
-
-    return 0;
-  };
-
-  const client = new TestomatClient({ apiKey });
-
-  recorder.startUnlessRunning();
-
-  // Listening to events
-  event.dispatcher.on(event.all.before, () => {
-    // clear tmp dir
-    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
-
-    // recorder.add('Creating new run', () => );
-    client.createRun();
-    videos = [];
-    traces = [];
-
-    if (!global.testomatioDataStore) global.testomatioDataStore = {};
-  });
-
-  let hookSteps = [];
-  let suiteHookRunning = false;
-
-  event.dispatcher.on(event.suite.before, suite => {
-    suiteHookRunning = true;
-    hookSteps = [];
-    global.testomatioDataStore.steps = [];
-
-    services.setContext(suite.fullTitle());
-  });
-
-  event.dispatcher.on(event.suite.after, () => {
-    services.setContext(null);
-  });
-
-  event.dispatcher.on(event.hook.started, () => {
-    // global.testomatioDataStore.steps = [];
-  });
-
-  event.dispatcher.on(event.hook.passed, () => {
-    if (suiteHookRunning) {
-      hookSteps.push(...global.testomatioDataStore.steps);
-      services.setContext(null);
-    }
-  });
-
-  event.dispatcher.on(event.hook.failed, () => {
-    if (suiteHookRunning) {
-      hookSteps.push(...global.testomatioDataStore.steps);
-      services.setContext(null);
-    }
-  });
-
-  event.dispatcher.on(event.test.before, test => {
-    suiteHookRunning = false;
-    global.testomatioDataStore.steps = [];
-
-    recorder.add(() => {
-      currentMetaStep = [];
-      // output.reset();
-      // output.start();
-      stepShift = 0;
-    });
-
-    if (!global.testomatioDataStore) global.testomatioDataStore = {};
-    // reset steps
-    global.testomatioDataStore.steps = [];
-
-    services.setContext(test.fullTitle());
-  });
-
-  event.dispatcher.on(event.test.started, test => {
-    services.setContext(test.fullTitle());
-
-    testTimeMap[test.id] = Date.now();
-    if (!test.uid) return;
-    testTimeMap[test.uid] = Date.now();
-  });
-
-  event.dispatcher.on(event.all.result, async () => {
-    debug('waiting for all tests to be reported');
-    // all tests were reported and we can upload videos
-    await Promise.all(reportTestPromises);
-
-    await uploadAttachments(client, videos, '🎞️ Uploading', 'video');
-    await uploadAttachments(client, traces, '📁 Uploading', 'trace');
-
-    const status = failedTests.length === 0 ? STATUS.PASSED : STATUS.FAILED;
-    // @ts-ignore
-    client.updateRunStatus(status);
-  });
-
-  event.dispatcher.on(event.test.passed, test => {
-    const { uid, tags, title } = test;
-    if (uid && failedTests.includes(uid)) {
-      failedTests = failedTests.filter(failed => uid !== failed);
-    }
-    const testObj = getTestAndMessage(title);
-
-    const logs = getTestLogs(test);
-    const manuallyAttachedArtifacts = services.artifacts.get(test.fullTitle());
-    const keyValues = services.keyValues.get(test.fullTitle());
-    services.setContext(null);
-
-    client.addTestRun(STATUS.PASSED, {
-      ...stripExampleFromTitle(title),
-      rid: uid,
-      suite_title: test.parent && test.parent.title,
-      message: testObj.message,
-      time: getDuration(test),
-      steps: global.testomatioDataStore.steps.join('\n') || null,
-      test_id: getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`),
-      logs,
-      manuallyAttachedArtifacts,
-      meta: keyValues,
-    });
-    // output.stop();
-  });
-
-  event.dispatcher.on(event.test.failed, (test, err) => {
-    error = err;
-  });
-
-  event.dispatcher.on(event.hook.failed, (suite, err) => {
-    error = err;
-
-    if (!suite) return;
-    if (!suite.tests) return;
-    for (const test of suite.tests) {
-      const { uid, tags, title } = test;
-      failedTests.push(uid || title);
-      const testId = getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`);
-
-      client.addTestRun(STATUS.FAILED, {
-        rid: uid,
-        ...stripExampleFromTitle(title),
-        suite_title: suite.title,
-        test_id: testId,
-        error,
-        time: 0,
-      });
-    }
-    // output.stop();
-  });
-
-  event.dispatcher.on(event.test.after, test => {
-    if (test.state && test.state !== STATUS.FAILED) return;
-    if (test.err) error = test.err;
-    const { uid, tags, title, artifacts } = test;
-    failedTests.push(uid || title);
-    const testObj = getTestAndMessage(title);
-
-    const files = [];
-    if (artifacts.screenshot) files.push({ path: artifacts.screenshot, type: 'image/png' });
-    // todo: video must be uploaded later....
-
-    const logs = getTestLogs(test);
-    const manuallyAttachedArtifacts = services.artifacts.get(test.fullTitle());
-    const keyValues = services.keyValues.get(test.fullTitle());
-    services.setContext(null);
-
-    client.addTestRun(STATUS.FAILED, {
-      ...stripExampleFromTitle(title),
-      rid: uid,
-      test_id: getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`),
-      suite_title: test.parent && test.parent.title,
-      error,
-      message: testObj.message,
-      time: getDuration(test),
-      files,
-      steps: global.testomatioDataStore?.steps?.join('\n') || null,
-      logs,
-      manuallyAttachedArtifacts,
-      meta: keyValues,
-    });
-
-    debug('artifacts', artifacts);
-
-    for (const aid in artifacts) {
-      if (aid.startsWith('video')) videos.push({ rid: uid, title, path: artifacts[aid], type: 'video/webm' });
-      if (aid.startsWith('trace')) traces.push({ rid: uid, title, path: artifacts[aid], type: 'application/zip' });
-    }
-
-    // output.stop();
-  });
-
-  event.dispatcher.on(event.test.skipped, test => {
-    const { uid, tags, title } = test;
-    if (failedTests.includes(uid || title)) return;
-
-    const testObj = getTestAndMessage(title);
-    client.addTestRun(STATUS.SKIPPED, {
-      rid: uid,
-      ...stripExampleFromTitle(title),
-      test_id: getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`),
-      suite_title: test.parent && test.parent.title,
-      message: testObj.message,
-      time: getDuration(test),
-    });
-    // output.stop();
-  });
-
-  event.dispatcher.on(event.step.started, step => {
-    stepShift = 0;
-    step.started = true;
-    stepStart = new Date();
-  });
-
-  event.dispatcher.on(event.step.finished, step => {
-    if (!step.started) return;
-    let processingStep = step;
-    const metaSteps = [];
-    while (processingStep.metaStep) {
-      metaSteps.unshift(processingStep.metaStep);
-      processingStep = processingStep.metaStep;
-    }
-    const shift = metaSteps.length;
-
-    for (let i = 0; i < Math.max(currentMetaStep.length, metaSteps.length); i++) {
-      if (currentMetaStep[i] !== metaSteps[i]) {
-        stepShift = 2 * i;
-        if (!metaSteps[i]) continue;
-        if (metaSteps[i].isBDD()) {
-          // output.push(repeat(stepShift) + pc.bold(metaSteps[i].toString()) + metaSteps[i].comment);
-          global.testomatioDataStore?.steps?.push(
-            repeat(stepShift) + pc.bold(metaSteps[i].toString()) + metaSteps[i].comment,
-          );
-        } else {
-          // output.push(repeat(stepShift) + pc.green.bold(metaSteps[i].toString()));
-          global.testomatioDataStore?.steps?.push(repeat(stepShift) + pc.green(pc.bold(metaSteps[i].toString())));
-        }
-      }
-    }
-    currentMetaStep = metaSteps;
-    stepShift = 2 * shift;
-
-    const durationMs = +new Date() - +stepStart;
-    let duration = '';
-    if (durationMs) {
-      duration = repeat(1) + pc.gray(`(${durationMs}ms)`);
-    }
-
-    if (step.status === STATUS.FAILED) {
-      // output.push(repeat(stepShift) + pc.red(step.toString()) + duration);
-      global.testomatioDataStore?.steps?.push(repeat(stepShift) + pc.red(step.toString()) + duration);
-    } else {
-      // output.push(repeat(stepShift) + step.toString() + duration);
-      global.testomatioDataStore?.steps?.push(repeat(stepShift) + step.toString() + duration);
-    }
-  });
-
-  event.dispatcher.on(event.step.comment, step => {
-    // output.push(pc.cyan.bold(step.toString()));
-    global.testomatioDataStore?.steps?.push(pc.cyan(pc.bold(step.toString())));
-  });
-}
-
-async function uploadAttachments(client, attachments, messagePrefix, attachmentType) {
-  if (!attachments?.length) return;
-
-  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;
-    const file = { path, type, title };
-
-    // we are storing file if upload is disabled
-    if (!client.uploader.isEnabled) return client.uploader.storeUploadedFile(path, client.runId, rid, false);
-
-    return client.addTestRun(undefined, {
-      ...stripExampleFromTitle(title),
-      rid,
-      files: [file],
-    });
-  });
-
-  await Promise.all(promises);
-}
-
-function getTestAndMessage(title) {
-  const testObj = { message: '' };
-  const testArr = title.split(/\s(\|\s\{.*?\})/);
-  testObj.title = testArr[0];
-
-  return testObj;
-}
-
-function stripExampleFromTitle(title) {
-  const res = title.match(DATA_REGEXP);
-  if (!res) return { title, example: null };
-
-  const example = JSON.parse(res[1]);
-  title = title.replace(DATA_REGEXP, '').trim();
-
-  return { title, example };
-}
-
-function repeat(num) {
-  return ''.padStart(num, ' ');
-}
-
-// TODO: think about moving to some common utils
-function getTestLogs(test) {
-  const suiteLogsArr = services.logger.getLogs(test.parent.fullTitle());
-  const suiteLogs = suiteLogsArr ? suiteLogsArr.join('\n').trim() : '';
-  const testLogsArr = services.logger.getLogs(test.fullTitle());
-  const testLogs = testLogsArr ? testLogsArr.join('\n').trim() : '';
-
-  let logs = '';
-  if (suiteLogs) {
-    logs += `${pc.bold('\t--- BeforeSuite ---')}\n${suiteLogs}`;
-  }
-  if (testLogs) {
-    logs += `\n${pc.bold('\t--- Test ---')}\n${testLogs}`;
-  }
-  return logs;
-}
-
-export { CodeceptReporter };
-export default CodeceptReporter;

package/src/adapter/cucumber/current.js

@@ -1,228 +0,0 @@
-import { Formatter, formatterHelpers } from '@cucumber/cucumber';
-
-import pc from 'picocolors';
-import fs from 'fs';
-import { STATUS, TESTOMAT_TMP_STORAGE_DIR } from '../../constants.js';
-import TestomatClient from '../../client.js';
-import { getTestomatIdFromTestTitle, fileSystem } from '../../utils/utils.js';
-import { config } from '../../config.js';
-import { services } from '../../services/index.js';
-
-const { GherkinDocumentParser, PickleParser } = formatterHelpers;
-const { getGherkinScenarioLocationMap, getGherkinStepMap } = GherkinDocumentParser;
-const { getPickleStepMap } = PickleParser;
-
-function getTestId(scenario) {
-  if (scenario) {
-    for (const tag of scenario.tags) {
-      const testId = getTestomatIdFromTestTitle(tag.name);
-      if (testId) return testId;
-    }
-  }
-
-  return null;
-}
-
-class CucumberReporter extends Formatter {
-  constructor(options) {
-    super(options);
-    options.eventBroadcaster.on('envelope', this.parseEnvelope.bind(this));
-    this.failures = [];
-    this.cases = [];
-
-    this.client = new TestomatClient({ apiKey: options.apiKey || config.TESTOMATIO });
-    this.client.createRun();
-    this.status = STATUS.PASSED;
-  }
-
-  parseEnvelope(envelope) {
-    if (envelope.testRunStarted) {
-      fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
-    }
-    if (envelope.testCaseStarted && this.client) {
-      this.onTestCaseStarted(envelope.testCaseStarted);
-    }
-    if (envelope.testCaseFinished) this.onTestCaseFinished(envelope.testCaseFinished);
-    if (envelope.testRunFinished) this.onTestRunFinished(envelope);
-  }
-
-  onTestCaseStarted(testCaseStarted) {
-    const testCaseAttempt = this.eventDataCollector.getTestCaseAttempt(testCaseStarted.id);
-    if (!global.testomatioDataStore) global.testomatioDataStore = {};
-
-    const testTitle = testCaseAttempt.pickle.name + testCaseAttempt.pickle.uri;
-    services.setContext(testTitle);
-  }
-
-  onTestCaseFinished(testCaseFinished) {
-    const testCaseAttempt = this.eventDataCollector.getTestCaseAttempt(testCaseFinished.testCaseStartedId);
-
-    let example;
-
-    let status = STATUS.PASSED;
-    let color = 'green';
-    let message;
-
-    this.cases.push(testCaseAttempt);
-
-    if (testCaseAttempt.worstTestStepResult) {
-      if (testCaseAttempt.worstTestStepResult.status === 'SKIPPED') {
-        status = STATUS.SKIPPED;
-      }
-      // if (testCaseAttempt.worstTestStepResult.status === 'UNDEFINED') {
-      //   status = STATUS.SKIPPED;
-      //   message = 'Undefined steps. Implement missing steps and rerun this scenario';
-      // }
-      if (testCaseAttempt.worstTestStepResult.status === 'FAILED') {
-        message = testCaseAttempt?.worstTestStepResult?.message;
-        status = STATUS.FAILED;
-      }
-      color = getStatusColor(testCaseAttempt.worstTestStepResult.status);
-      if (status !== STATUS.PASSED) this.failures.push(testCaseAttempt);
-    }
-
-    if (testCaseAttempt.pickle.astNodeIds.length > 1) {
-      example = getExample(testCaseAttempt);
-      // @ts-ignore
-      testCaseAttempt.example = example;
-    }
-
-    const scenario = testCaseAttempt.pickle.name;
-    // this may broke something (it is supposed to work, but I am sure it did not)
-    // const testId = testCaseAttempt.pickle.id;
-    const testId = getTestId(testCaseAttempt.pickle);
-
-    let exampleString = '';
-    if (example) exampleString = ` ${example.join(' | ')}`;
-    let cliMessage = `${pc.bold(scenario)}${exampleString}: ${pc[color](pc.bold(status.toUpperCase()))} `;
-
-    if (message) cliMessage += pc.gray(message.split('\n')[0]);
-    console.log(cliMessage);
-
-    if (status !== STATUS.PASSED && status !== STATUS.SKIPPED) {
-      this.status = STATUS.FAILED;
-    }
-
-    const time = Object.values(testCaseAttempt.stepResults)
-      .map(t => t.duration)
-      .reduce((sum, duration) => sum + duration.seconds * 1000 + duration.nanos / 1000000, 0);
-
-    if (!this.client) return;
-
-    const testTitle = testCaseAttempt.pickle.name + testCaseAttempt.pickle.uri;
-    const logs = services.logger.getLogs(testTitle).join('\n');
-    const artifacts = services.artifacts.get(testTitle);
-    const keyValues = services.keyValues.get(testTitle);
-
-    this.client.addTestRun(status, {
-      // error: testCaseAttempt.worstTestStepResult.message,
-      message,
-      steps: getSteps(testCaseAttempt)
-        .map(s => s.toString())
-        .join('\n')
-        .trim(),
-      example: { ...example },
-      logs,
-      manuallyAttachedArtifacts: artifacts,
-      meta: keyValues,
-      title: scenario,
-      test_id: testId,
-      time,
-    });
-
-    services.setContext(null);
-  }
-
-  onTestRunFinished(envelope) {
-    if (this.failures.length > 0) {
-      console.log(pc.bold('\nSUMMARY:\n\n'));
-
-      this.failures.forEach((tc, i) => {
-        let message = `  ${i + 1}) ${tc.pickle.name}\n`;
-
-        const steps = getSteps(tc);
-
-        steps.forEach(s => {
-          message += `     ${s.toString()}\n`;
-        });
-
-        console.log(message);
-        if (tc?.worstTestStepResult?.message) {
-          console.log(pc.red(tc?.worstTestStepResult?.message));
-        }
-        console.log();
-      });
-    }
-
-    const { testRunFinished } = envelope;
-
-    const bgColor = testRunFinished.success ? 'bgGreen' : 'bgRed';
-    const prefixSummary = `${pc.bold(testRunFinished.success ? ' SUCCESS ' : ' FALIURE ')}`;
-    console.log();
-    console.log(pc[bgColor](` ${prefixSummary} | Total Scenarios: ${pc.bold(this.cases.length)} `));
-
-    if (!this.client) return;
-
-    // @ts-ignore
-    this.client.updateRunStatus(testRunFinished.success ? STATUS.PASSED : STATUS.FAILED);
-  }
-}
-
-function getSteps(tc) {
-  const stepIds = Object.keys(tc.stepResults);
-  const pickleSteps = getPickleStepMap(tc.pickle);
-  return stepIds
-    .map(stepId => {
-      const ts = tc.testCase.testSteps.find(t => t.id === stepId);
-      if (!ts) return;
-      if (!ts.pickleStepId) return;
-      const result = tc.stepResults[stepId];
-      const pickleStep = pickleSteps[ts.pickleStepId];
-      const sourceStepId = pickleStep.astNodeIds[0];
-      const step = {
-        text: pickleStep.text,
-        duration: result.duration,
-        status: result.status,
-      };
-      const color = getStatusColor(result.status);
-      if (sourceStepId && getGherkinStepMap(tc.gherkinDocument)[sourceStepId]) {
-        step.keyword = getGherkinStepMap(tc.gherkinDocument)[sourceStepId].keyword;
-      }
-      step.toString = function toString() {
-        const duration = step.duration.seconds * 1000 + step.duration.nanos / 1000000;
-        const durationString = ` ${pc.gray(`(${Number(duration).toFixed(2)}ms)`)}`;
-        const stepString = `${pc.bold(this.keyword)}${this.text}`.trim();
-        if (color === 'red') return pc.red(stepString) + durationString;
-        if (color === 'yellow') return pc.yellow(stepString) + durationString;
-        return stepString + durationString;
-      };
-      return step;
-    })
-    .filter(s => !!s);
-}
-
-function getStatusColor(status) {
-  if (status === 'UNDEFINED') return 'yellow';
-  if (status === 'SKIPPED') return 'yellow';
-  if (status === 'FAILED') return 'red';
-  return 'green';
-}
-
-function getExample(testCaseAttempt) {
-  const nodesMap = getGherkinScenarioLocationMap(testCaseAttempt.gherkinDocument);
-  const exampleNodeId = testCaseAttempt.pickle.astNodeIds[1];
-  if (!nodesMap[exampleNodeId]) return;
-  const featureDoc = fs.readFileSync(testCaseAttempt.gherkinDocument.uri).toString();
-  const { line } = nodesMap[exampleNodeId];
-  const example = featureDoc.split('\n')[line - 1];
-  if (example) {
-    return example
-      .trim()
-      .split('|')
-      .filter(r => !!r)
-      .map(r => r.trim());
-  }
-}
-
-export { CucumberReporter };
-export default CucumberReporter;