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

package/lib/adapter/mocha.js

@@ -1,154 +1,125 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 // eslint-disable-next-line global-require, import/no-extraneous-dependencies
-const Mocha = require('mocha');
-const chalk = require('chalk');
-const TestomatClient = require('../client');
-const { STATUS, TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
-const { getTestomatIdFromTestTitle, fileSystem } = require('../utils/utils');
-const config = require('../config');
-const { services } = require('../services');
-
-const {
-  EVENT_RUN_BEGIN,
-  EVENT_RUN_END,
-  EVENT_TEST_FAIL,
-  EVENT_TEST_PASS,
-  EVENT_TEST_PENDING,
-  EVENT_SUITE_BEGIN,
-  EVENT_SUITE_END,
-  EVENT_TEST_BEGIN,
-  EVENT_TEST_END,
-} = Mocha.Runner.constants;
-
+const mocha_1 = __importDefault(require("mocha"));
+const client_js_1 = __importDefault(require("../client.js"));
+const constants_js_1 = require("../constants.js");
+const utils_js_1 = require("../utils/utils.js");
+const config_js_1 = require("../config.js");
+const index_js_1 = require("../services/index.js");
+const picocolors_1 = __importDefault(require("picocolors"));
+const { EVENT_RUN_BEGIN, EVENT_RUN_END, EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING, EVENT_SUITE_BEGIN, EVENT_SUITE_END, EVENT_TEST_BEGIN, EVENT_TEST_END, } = mocha_1.default.Runner.constants;
 function MochaReporter(runner, opts) {
-  Mocha.reporters.Base.call(this, runner);
-  let passes = 0;
-  let failures = 0;
-  let skipped = 0;
-  // let artifactStore;
-
-  const apiKey = opts?.reporterOptions?.apiKey || config.TESTOMATIO;
-
-  const client = new TestomatClient({ apiKey });
-
-  runner.on(EVENT_RUN_BEGIN, () => {
-    client.createRun();
-
-    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
-  });
-
-  runner.on(EVENT_SUITE_BEGIN, async suite => {
-    services.setContext(suite.fullTitle());
-  });
-
-  runner.on(EVENT_SUITE_END, async () => {
-    services.setContext(null);
-  });
-
-  runner.on(EVENT_TEST_BEGIN, async test => {
-    services.setContext(test.fullTitle());
-  });
-
-  runner.on(EVENT_TEST_END, async () => {
-    services.setContext(null);
-  });
-
-  runner.on(EVENT_TEST_PASS, async test => {
-    passes += 1;
-
-    console.log(chalk.bold.green('✔'), test.fullTitle());
-    const testId = getTestomatIdFromTestTitle(test.title);
-
-    const logs = getTestLogs(test);
-    const artifacts = services.artifacts.get(test.fullTitle());
-    const keyValues = services.keyValues.get(test.fullTitle());
-
-    client.addTestRun(STATUS.PASSED, {
-      test_id: testId,
-      suite_title: getSuiteTitle(test),
-      title: getTestName(test),
-      code: test.body.toString(),
-      file: getFile(test),
-      time: test.duration,
-      logs,
-      manuallyAttachedArtifacts: artifacts,
-      meta: keyValues,
+    mocha_1.default.reporters.Base.call(this, runner);
+    let passes = 0;
+    let failures = 0;
+    let skipped = 0;
+    // let artifactStore;
+    const apiKey = opts?.reporterOptions?.apiKey || config_js_1.config.TESTOMATIO;
+    const client = new client_js_1.default({ apiKey });
+    runner.on(EVENT_RUN_BEGIN, () => {
+        client.createRun();
+        utils_js_1.fileSystem.clearDir(constants_js_1.TESTOMAT_TMP_STORAGE_DIR);
     });
-  });
-
-  runner.on(EVENT_TEST_PENDING, test => {
-    skipped += 1;
-    console.log('skip: %s', test.fullTitle());
-    const testId = getTestomatIdFromTestTitle(test.title);
-    client.addTestRun(STATUS.SKIPPED, {
-      title: getTestName(test),
-      suite_title: getSuiteTitle(test),
-      code: test.body.toString(),
-      file: getFile(test),
-      test_id: testId,
-      time: test.duration,
+    runner.on(EVENT_SUITE_BEGIN, async (suite) => {
+        index_js_1.services.setContext(suite.fullTitle());
     });
-  });
-
-  runner.on(EVENT_TEST_FAIL, async (test, err) => {
-    failures += 1;
-    console.log(chalk.bold.red('✖'), test.fullTitle(), chalk.gray(err.message));
-    const testId = getTestomatIdFromTestTitle(test.title);
-
-    const logs = getTestLogs(test);
-
-    client.addTestRun(STATUS.FAILED, {
-      error: err,
-      suite_title: getSuiteTitle(test),
-      file: getFile(test),
-      test_id: testId,
-      title: getTestName(test),
-      code: test.body.toString(),
-      time: test.duration,
-      logs,
+    runner.on(EVENT_SUITE_END, async () => {
+        index_js_1.services.setContext(null);
+    });
+    runner.on(EVENT_TEST_BEGIN, async (test) => {
+        index_js_1.services.setContext(test.fullTitle());
+    });
+    runner.on(EVENT_TEST_END, async () => {
+        index_js_1.services.setContext(null);
+    });
+    runner.on(EVENT_TEST_PASS, async (test) => {
+        passes += 1;
+        console.log(picocolors_1.default.bold(picocolors_1.default.green('✔')), test.fullTitle());
+        const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
+        const logs = getTestLogs(test);
+        const artifacts = index_js_1.services.artifacts.get(test.fullTitle());
+        const keyValues = index_js_1.services.keyValues.get(test.fullTitle());
+        client.addTestRun(constants_js_1.STATUS.PASSED, {
+            test_id: testId,
+            suite_title: getSuiteTitle(test),
+            title: getTestName(test),
+            code: test.body.toString(),
+            file: getFile(test),
+            time: test.duration,
+            logs,
+            manuallyAttachedArtifacts: artifacts,
+            meta: keyValues,
+        });
+    });
+    runner.on(EVENT_TEST_PENDING, test => {
+        skipped += 1;
+        console.log('skip: %s', test.fullTitle());
+        const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
+        client.addTestRun(constants_js_1.STATUS.SKIPPED, {
+            title: getTestName(test),
+            suite_title: getSuiteTitle(test),
+            code: test.body.toString(),
+            file: getFile(test),
+            test_id: testId,
+            time: test.duration,
+        });
+    });
+    runner.on(EVENT_TEST_FAIL, async (test, err) => {
+        failures += 1;
+        console.log(picocolors_1.default.bold(picocolors_1.default.red('✖')), test.fullTitle(), picocolors_1.default.gray(err.message));
+        const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
+        const logs = getTestLogs(test);
+        client.addTestRun(constants_js_1.STATUS.FAILED, {
+            error: err,
+            suite_title: getSuiteTitle(test),
+            file: getFile(test),
+            test_id: testId,
+            title: getTestName(test),
+            code: test.body.toString(),
+            time: test.duration,
+            logs,
+        });
+    });
+    runner.on(EVENT_RUN_END, () => {
+        const status = failures === 0 ? constants_js_1.STATUS.PASSED : constants_js_1.STATUS.FAILED;
+        console.log(picocolors_1.default.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
+        // @ts-ignore
+        client.updateRunStatus(status);
     });
-  });
-
-  runner.on(EVENT_RUN_END, () => {
-    const status = failures === 0 ? STATUS.PASSED : STATUS.FAILED;
-    console.log(chalk.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
-    client.updateRunStatus(status);
-  });
 }
-
 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 += `${chalk.bold('\t--- BeforeSuite ---')}\n${suiteLogs}`;
-  }
-  if (testLogs) {
-    logs += `\n${chalk.bold('\t--- Test ---')}\n${testLogs}`;
-  }
-  return logs;
+    const suiteLogsArr = index_js_1.services.logger.getLogs(test.parent.fullTitle());
+    const suiteLogs = suiteLogsArr ? suiteLogsArr.join('\n').trim() : '';
+    const testLogsArr = index_js_1.services.logger.getLogs(test.fullTitle());
+    const testLogs = testLogsArr ? testLogsArr.join('\n').trim() : '';
+    let logs = '';
+    if (suiteLogs) {
+        logs += `${picocolors_1.default.bold('\t--- BeforeSuite ---')}\n${suiteLogs}`;
+    }
+    if (testLogs) {
+        logs += `\n${picocolors_1.default.bold('\t--- Test ---')}\n${testLogs}`;
+    }
+    return logs;
 }
-
-// To have this reporter "extend" a built-in reporter uncomment the following line:
-Mocha.utils.inherits(MochaReporter, Mocha.reporters.Spec);
-
-module.exports = MochaReporter;
-
 function getSuiteTitle(test, pathArr = []) {
-  if (test.parent.parent) getSuiteTitle(test.parent, pathArr);
-
-  pathArr.push(test.parent.title);
-
-  return pathArr.filter(t => !!t)[0];
+    if (test.parent.parent)
+        getSuiteTitle(test.parent, pathArr);
+    pathArr.push(test.parent.title);
+    return pathArr.filter(t => !!t)[0];
 }
-
 function getFile(test) {
-  return test.parent.file?.replace(process.cwd(), '');
+    return test.parent.file?.replace(process.cwd(), '');
 }
-
 function getTestName(test) {
-  if (process.env.TESTOMATIO_CREATE === 'fulltitle') return test.fullTitle();
-  return test.title;
+    if (process.env.TESTOMATIO_CREATE === 'fulltitle')
+        return test.fullTitle();
+    return test.title;
 }
+// To have this reporter "extend" a built-in reporter uncomment the following line:
+// @ts-ignore
+mocha_1.default.utils.inherits(MochaReporter, mocha_1.default.reporters.Spec);
+module.exports = MochaReporter;

package/lib/adapter/playwright.js

@@ -1,226 +1,194 @@
-const chalk = require('chalk');
-const crypto = require('crypto');
-const os = require('os');
-const path = require('path');
-const { v4: uuidv4 } = require('uuid');
-const fs = require('fs');
-const { APP_PREFIX, STATUS: Status, TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
-const TestomatioClient = require('../client');
-const { getTestomatIdFromTestTitle, fileSystem } = require('../utils/utils');
-// const debug = require('debug')('@testomatio/reporter:adapter:playwright');
-const { services } = require('../services');
-const { dataStorage } = require('../data-storage');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initPlaywrightForStorage = initPlaywrightForStorage;
+const picocolors_1 = __importDefault(require("picocolors"));
+const crypto_1 = __importDefault(require("crypto"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const uuid_1 = require("uuid");
+const fs_1 = __importDefault(require("fs"));
+const constants_js_1 = require("../constants.js");
+const client_js_1 = __importDefault(require("../client.js"));
+const fileUploader_js_1 = require("../fileUploader.js");
+const utils_js_1 = require("../utils/utils.js");
+const index_js_1 = require("../services/index.js");
+const data_storage_js_1 = require("../data-storage.js");
 const reportTestPromises = [];
-
 class PlaywrightReporter {
-  constructor(config = {}) {
-    this.client = new TestomatioClient({ apiKey: config?.apiKey });
-
-    this.uploads = [];
-  }
-
-  onBegin(config, suite) {
-    // clean data storage
-    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
-    if (!this.client) return;
-    this.suite = suite;
-    this.config = config;
-    this.client.createRun();
-  }
-
-  onTestBegin(testInfo) {
-    const fullTestTitle = getTestContextName(testInfo);
-    dataStorage.setContext(fullTestTitle);
-  }
-
-  onTestEnd(test, result) {
-    if (!this.client) return;
-
-    const { title } = test;
-    const { error, duration } = result;
-    const suite_title = test.parent ? test.parent?.title : path.basename(test?.location?.file);
-
-    const steps = [];
-    for (const step of result.steps) {
-      const appendedStep = appendStep(step);
-      if (appendedStep) {
-        steps.push(appendedStep);
-      }
+    constructor(config = {}) {
+        this.client = new client_js_1.default({ apiKey: config?.apiKey });
+        this.uploads = [];
     }
-
-    const fullTestTitle = getTestContextName(test);
-    let logs = '';
-    if (result.stderr.length || result.stdout.length) {
-      logs = `\n\n${chalk.bold('Logs:')}\n${chalk.red(result.stderr.join(''))}\n${result.stdout.join('')}`;
+    onBegin(config, suite) {
+        // clean data storage
+        utils_js_1.fileSystem.clearDir(constants_js_1.TESTOMAT_TMP_STORAGE_DIR);
+        if (!this.client)
+            return;
+        this.suite = suite;
+        this.config = config;
+        this.client.createRun();
     }
-    const manuallyAttachedArtifacts = services.artifacts.get(fullTestTitle);
-    const keyValues = services.keyValues.get(fullTestTitle);
-    const rid = test.id || test.testId || uuidv4();
-
-    const reportTestPromise = this.client.addTestRun(checkStatus(result.status), {
-      rid,
-      error,
-      test_id: getTestomatIdFromTestTitle(`${title} ${test.tags?.join(' ')}`),
-      suite_title,
-      title,
-      steps: steps.length ? steps : undefined,
-      time: duration,
-      logs,
-      manuallyAttachedArtifacts,
-      meta: keyValues,
-      file: test.location?.file,
-    });
-
-    this.uploads.push({
-      rid,
-      title: test.title,
-      files: result.attachments.filter(a => a.body || a.path),
-      file: test.location?.file,
-    });
-    // remove empty uploads
-    this.uploads = this.uploads.filter(upload => upload.files.length);
-
-    reportTestPromises.push(reportTestPromise);
-  }
-
-  #getArtifactPath(artifact) {
-    if (artifact.path) {
-      if (path.isAbsolute(artifact.path)) return artifact.path;
-
-      return path.join(this.config.outputDir || this.config.projects[0].outputDir, artifact.path);
+    onTestBegin(testInfo) {
+        const fullTestTitle = getTestContextName(testInfo);
+        data_storage_js_1.dataStorage.setContext(fullTestTitle);
     }
-
-    if (artifact.body) {
-      const fileName = tmpFile();
-      fs.writeFileSync(fileName, artifact.body);
-      return fileName;
+    onTestEnd(test, result) {
+        // test.parent.project().__projectId
+        if (!this.client)
+            return;
+        const { title } = test;
+        const { error, duration } = result;
+        const suite_title = test.parent ? test.parent?.title : path_1.default.basename(test?.location?.file);
+        const steps = [];
+        for (const step of result.steps) {
+            const appendedStep = appendStep(step);
+            if (appendedStep) {
+                steps.push(appendedStep);
+            }
+        }
+        const fullTestTitle = getTestContextName(test);
+        let logs = '';
+        if (result.stderr.length || result.stdout.length) {
+            logs = `\n\n${picocolors_1.default.bold('Logs:')}\n${picocolors_1.default.red(result.stderr.join(''))}\n${result.stdout.join('')}`;
+        }
+        const manuallyAttachedArtifacts = index_js_1.services.artifacts.get(fullTestTitle);
+        const keyValues = index_js_1.services.keyValues.get(fullTestTitle);
+        const rid = test.id || test.testId || (0, uuid_1.v4)();
+        const reportTestPromise = this.client.addTestRun(checkStatus(result.status), {
+            rid,
+            error,
+            test_id: (0, utils_js_1.getTestomatIdFromTestTitle)(`${title} ${test.tags?.join(' ')}`),
+            suite_title,
+            title,
+            steps: steps.length ? steps : undefined,
+            time: duration,
+            logs,
+            manuallyAttachedArtifacts,
+            meta: keyValues,
+            file: test.location?.file,
+        });
+        this.uploads.push({
+            rid,
+            title: test.title,
+            files: result.attachments.filter(a => a.body || a.path),
+            file: test.location?.file,
+        });
+        // remove empty uploads
+        this.uploads = this.uploads.filter(anUpload => anUpload.files.length);
+        reportTestPromises.push(reportTestPromise);
     }
-
-    return null;
-  }
-
-  async onEnd(result) {
-    if (!this.client) return;
-
-    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 = [];
-
-    for (const upload of this.uploads) {
-      const { rid, file, title } = upload;
-
-      const files = upload.files.map(attachment => ({
-        path: this.#getArtifactPath(attachment),
-        title,
-        type: attachment.contentType,
-      }));
-
-      if (!this.client.uploader.isEnabled) {
-        files.forEach(f => this.client.uploader.storeUploadedFile(f, this.client.runId, rid, false));
-        continue;
-      }
-
-      promises.push(
-        this.client.addTestRun(undefined, {
-          rid,
-          title,
-          files,
-          file,
-        }),
-      );
+    #getArtifactPath(artifact) {
+        if (artifact.path) {
+            if (path_1.default.isAbsolute(artifact.path))
+                return artifact.path;
+            return path_1.default.join(this.config.outputDir || this.config.projects[0].outputDir, artifact.path);
+        }
+        if (artifact.body) {
+            const fileName = tmpFile();
+            fs_1.default.writeFileSync(fileName, artifact.body);
+            return fileName;
+        }
+        return null;
+    }
+    async onEnd(result) {
+        if (!this.client)
+            return;
+        await Promise.all(reportTestPromises);
+        if (this.uploads.length && fileUploader_js_1.upload.isArtifactsEnabled()) {
+            console.log(constants_js_1.APP_PREFIX, `🎞️  Uploading ${this.uploads.length} files...`);
+            const promises = [];
+            for (const anUpload of this.uploads) {
+                const { rid, file, title } = anUpload;
+                const files = anUpload.files.map(attachment => ({
+                    path: this.#getArtifactPath(attachment),
+                    title,
+                    type: attachment.contentType,
+                }));
+                promises.push(this.client.addTestRun(undefined, {
+                    rid,
+                    title,
+                    files,
+                    file,
+                }));
+            }
+            await Promise.all(promises);
+        }
+        await this.client.updateRunStatus(checkStatus(result.status));
     }
-    await Promise.all(promises);
-  
-
-    await this.client.updateRunStatus(checkStatus(result.status));
-  }
 }
-
 function checkStatus(status) {
-  return (
-    {
-      skipped: Status.SKIPPED,
-      timedOut: Status.FAILED,
-      passed: Status.PASSED,
-    }[status] || Status.FAILED
-  );
+    return ({
+        skipped: constants_js_1.STATUS.SKIPPED,
+        timedOut: constants_js_1.STATUS.FAILED,
+        passed: constants_js_1.STATUS.PASSED,
+    }[status] || constants_js_1.STATUS.FAILED);
 }
-
 function appendStep(step, shift = 0) {
-  // nesting too deep, ignore those steps
-  if (shift >= 10) return;
-
-  let newCategory = step.category;
-  switch (newCategory) {
-    case 'test.step':
-      newCategory = 'user';
-      break;
-    case 'hook':
-      newCategory = 'hook';
-      break;
-    case 'attach':
-      return null; // Skip steps with category 'attach'
-    default:
-      newCategory = 'framework';
-  }
-
-  const formattedSteps = [];
-  for (const child of step.steps || []) {
-    const appendedChild = appendStep(child, shift + 2);
-    if (appendedChild) {
-      formattedSteps.push(appendedChild);
+    // nesting too deep, ignore those steps
+    if (shift >= 10)
+        return;
+    let newCategory = step.category;
+    switch (newCategory) {
+        case 'test.step':
+            newCategory = 'user';
+            break;
+        case 'hook':
+            newCategory = 'hook';
+            break;
+        case 'attach':
+            return null; // Skip steps with category 'attach'
+        default:
+            newCategory = 'framework';
     }
-  }
-
-  const resultStep = {
-    category: newCategory,
-    title: step.title,
-    duration: step.duration,
-  };
-
-  if (formattedSteps.length) {
-    resultStep.steps = formattedSteps.filter(s => !!s);
-  }
-
-  if (step.error !== undefined) {
-    resultStep.error = step.error;
-  }
-
-  return resultStep;
+    const formattedSteps = [];
+    for (const child of step.steps || []) {
+        const appendedChild = appendStep(child, shift + 2);
+        if (appendedChild) {
+            formattedSteps.push(appendedChild);
+        }
+    }
+    const resultStep = {
+        category: newCategory,
+        title: step.title,
+        duration: step.duration,
+    };
+    if (formattedSteps.length) {
+        resultStep.steps = formattedSteps.filter(s => !!s);
+    }
+    if (step.error !== undefined) {
+        resultStep.error = step.error;
+    }
+    return resultStep;
 }
-
 function tmpFile(prefix = 'tmp.') {
-  const tmpdir = os.tmpdir();
-  return path.join(tmpdir, prefix + crypto.randomBytes(16).toString('hex'));
+    const tmpdir = os_1.default.tmpdir();
+    return path_1.default.join(tmpdir, prefix + crypto_1.default.randomBytes(16).toString('hex'));
 }
-
 /**
  * Returns filename + test title
  * @param {*} test - testInfo object from Playwright
  * @returns
  */
 function getTestContextName(test) {
-  return `${test._requireFile || ''}_${test.title}`;
+    return `${test._requireFile || ''}_${test.title}`;
 }
-
 function initPlaywrightForStorage() {
-  try {
-    // @ts-ignore-next-line
-    // eslint-disable-next-line import/no-unresolved
-    const { test } = require('@playwright/test');
-    // eslint-disable-next-line no-empty-pattern
-    test.beforeEach(async ({}, testInfo) => {
-      global.testomatioTestTitle = `${testInfo.file || ''}_${testInfo.title}`;
-    });
-  } catch (e) {
-    // ignore
-  }
+    try {
+        // @ts-ignore-next-line
+        // eslint-disable-next-line import/no-extraneous-dependencies
+        const { test } = require('@playwright/test');
+        // eslint-disable-next-line no-empty-pattern
+        test.beforeEach(async ({}, testInfo) => {
+            global.testomatioTestTitle = `${testInfo.file || ''}_${testInfo.title}`;
+        });
+    }
+    catch (e) {
+        // ignore
+    }
 }
-
 module.exports = PlaywrightReporter;
+
 module.exports.initPlaywrightForStorage = initPlaywrightForStorage;