@testomatio/reporter 2.7.3-beta.1-vitest → 2.7.3-beta.3.allure

package/README.md

@@ -69,6 +69,7 @@ yarn add @testomatio/reporter --dev
 | [TestCafe](./docs/frameworks.md#testcafe)       | [Detox](./docs/frameworks.md#detox)           | [Codeception](https://github.com/testomatio/php-reporter) |
 | [Newman (Postman)](./docs/frameworks.md#newman) | [JUnit](./docs/junit.md#junit)                | [NUnit](./docs/junit.md#nunit)                            |
 | [PyTest](./docs/junit.md#pytest)                | [PHPUnit](./docs/junit.md#phpunit)            | [Protractor](./docs/frameworks.md#protractor)             |
+| [Allure](./docs/allure.md)                      |                                               |                                                           |
 
 or **any [other via JUnit](./docs/junit.md)** report....
 
@@ -129,9 +130,10 @@ Bring this reporter on CI and never lose test results again!
   - [CSV](./docs/pipes/csv.md)
   - [HTML report](./docs/pipes/html.md)
   - [Bitbucket](./docs/pipes/bitbucket.md)
-- 🔗 [Linking Tests](./docs/linking-tests.md)
-- 📓 [JUnit](./docs/junit.md)
+- 📓 [JUnit Reports](./docs/junit.md)
 - 🗄️ [Artifacts](./docs/artifacts.md)
+- 🔬 [Allure Reports](./docs/allure.md)
+- 🔗 [Linking Tests](./docs/linking-tests.md)
 - 🔂 [Workflows](./docs/workflows.md)
 - 🖊️ [Logger](./docs/logger.md)
 - 🪲 [Debug File Format](./docs/debug-file-format.md)

package/lib/adapter/vitest.d.ts

@@ -18,22 +18,15 @@ export type TestData = import("../../types/types.js").TestData;
 export class VitestReporter {
     constructor(config?: {});
     client: TestomatioClient;
-    /** @type {(TestData & {status: string, _reportKey?: string | null})[]} tests */
+    /**
+     * @type {(TestData & {status: string})[]} tests
+     */
     tests: (TestData & {
         status: string;
-        _reportKey?: string | null;
     })[];
     _finalized: boolean;
     _finalizing: boolean;
-    _runStartedAtMs: number;
-    _runStartedAtMicros: number;
-    _reportedTestKeys: Set<any>;
-    _liveQueue: Promise<void>;
     onInit(): void;
-    /**
-     * Vitest 3/4 callback fired when test run starts.
-     */
-    onTestRunStart(): void;
     /**
      * @param {VitestTestFile[] | undefined} files // array with results;
      * @param {unknown[] | undefined} errors // errors does not contain errors from tests; probably its testrunner errors
@@ -46,18 +39,6 @@ export class VitestReporter {
      * @param {unknown[] | undefined} errors
      */
     onTestRunEnd(testModules: Array<unknown> | undefined, errors: unknown[] | undefined): Promise<void>;
-    /**
-     * Vitest 4 callback fired when single test case is finished.
-     *
-     * @param {unknown} testCase
-     */
-    onTestCaseResult(testCase: unknown): Promise<void>;
-    /**
-     * Vitest 3 fallback callback with task updates.
-     *
-     * @param {unknown[] | undefined} packs
-     */
-    onTaskUpdate(packs: unknown[] | undefined): Promise<void>;
     #private;
 }
 import { Client as TestomatioClient } from '../client.js';

package/lib/adapter/vitest.js

@@ -22,34 +22,19 @@ const debug = (0, debug_1.default)('@testomatio/reporter:adapter-jest');
 class VitestReporter {
     constructor(config = {}) {
         this.client = new client_js_1.Client({ apiKey: config?.apiKey });
-        /** @type {(TestData & {status: string, _reportKey?: string | null})[]} tests */
+        /**
+         * @type {(TestData & {status: string})[]} tests
+         */
         this.tests = [];
         this._finalized = false;
         this._finalizing = false;
-        this._runStartedAtMs = null;
-        this._runStartedAtMicros = null;
-        this._reportedTestKeys = new Set();
-        this._liveQueue = Promise.resolve();
     }
     // on run start
     onInit() {
-        const now = Date.now();
         this._finalized = false;
         this._finalizing = false;
-        this._runStartedAtMs = now;
-        this._runStartedAtMicros = now * 1000;
-        this._reportedTestKeys = new Set();
-        this._liveQueue = Promise.resolve();
         this.client.createRun();
     }
-    /**
-     * Vitest 3/4 callback fired when test run starts.
-     */
-    onTestRunStart() {
-        const now = Date.now();
-        this._runStartedAtMs = now;
-        this._runStartedAtMicros = now * 1000;
-    }
     /**
      * @param {VitestTestFile[] | undefined} files // array with results;
      * @param {unknown[] | undefined} errors // errors does not contain errors from tests; probably its testrunner errors
@@ -83,19 +68,12 @@ class VitestReporter {
             debug(this.tests.length, 'tests collected');
             // send tests to Testomat.io
             for (const test of this.tests) {
-                if (test._reportKey && this._reportedTestKeys.has(test._reportKey))
-                    continue;
-                if (test._reportKey)
-                    this._reportedTestKeys.add(test._reportKey);
                 await this.client.addTestRun(test.status, test);
             }
-            await this._liveQueue;
             console.log('finished');
             if (errors.length)
                 console.error('Vitest adapter errors:', errors);
-            const startedAtMs = this._runStartedAtMs || getEarliestTestStartMs(files) || Date.now();
-            const duration = Math.max(0, (Date.now() - startedAtMs) / 1000);
-            await this.client.updateRunStatus(getRunStatusFromResults(files), { duration });
+            await this.client.updateRunStatus(getRunStatusFromResults(files));
             this._finalized = true;
         }
         finally {
@@ -114,28 +92,6 @@ class VitestReporter {
             .filter(Boolean);
         await this.onFinished(files, errors);
     }
-    /**
-     * Vitest 4 callback fired when single test case is finished.
-     *
-     * @param {unknown} testCase
-     */
-    async onTestCaseResult(testCase) {
-        await this.#reportLive(testCase);
-    }
-    /**
-     * Vitest 3 fallback callback with task updates.
-     *
-     * @param {unknown[] | undefined} packs
-     */
-    async onTaskUpdate(packs) {
-        if (!Array.isArray(packs) || !packs.length)
-            return;
-        for (const pack of packs) {
-            const test = getTestFromTaskUpdatePack(pack);
-            if (test)
-                await this.#reportLive(test);
-        }
-    }
     /* non-used listeners
     onUserConsoleLog(log) {}
     onPathsCollected(paths) {} // paths array to files with tests
@@ -170,50 +126,25 @@ class VitestReporter {
     /**
      * Processes task and returns test data ready to be sent to Testomat.io
      *
-     * @param {any} test
+     * @param {VitestTest} test
      *
-     * @returns {TestData & {status: 'passed' | 'failed' | 'skipped', _reportKey?: string | null}}
+     * @returns {TestData & {status: 'passed' | 'failed' | 'skipped'}}
      */
     #getDataFromTest(test) {
-        const normalized = normalizeVitestTest(test);
-        const reportKey = getReportKey(test, normalized);
-        const startMicros = typeof normalized.startTime === 'number'
-            ? Math.floor(normalized.startTime * 1000)
-            : this._runStartedAtMicros || undefined;
         return {
-            _reportKey: reportKey,
-            error: normalized.error,
-            file: normalized.file,
-            logs: normalized.logs,
-            meta: normalized.meta,
+            error: test.result?.errors ? test.result.errors[0] : undefined,
+            file: test.file?.name || test.file?.filepath || '',
+            logs: test.logs ? transformLogsToString(test.logs) : '',
+            meta: test.meta,
             // @ts-ignore - STATUS values are string literals but type system sees them as string
-            status: getTestStatus(normalized.state, normalized.mode),
-            suite_title: normalized.suiteTitle,
-            test_id: (0, utils_js_1.getTestomatIdFromTestTitle)(normalized.name),
-            time: normalized.duration,
-            timestamp: startMicros,
-            title: normalized.name,
+            status: getTestStatus(test),
+            suite_title: test.suite?.name || test.file?.name || test.file?.filepath,
+            test_id: (0, utils_js_1.getTestomatIdFromTestTitle)(test.name),
+            time: test.result?.duration || 0,
+            title: test.name,
             // testomatio functions (artifacts, logs, steps, meta) are not supported
         };
     }
-    /**
-     * @param {unknown} testCase
-     */
-    async #reportLive(testCase) {
-        if (this._finalized || this._finalizing)
-            return;
-        const normalized = normalizeVitestTest(testCase);
-        if (!isLiveReportableState(normalized.state, normalized.mode))
-            return;
-        const data = this.#getDataFromTest(testCase);
-        if (!data._reportKey || this._reportedTestKeys.has(data._reportKey))
-            return;
-        this._reportedTestKeys.add(data._reportKey);
-        this._liveQueue = this._liveQueue
-            .then(() => this.client.addTestRun(data.status, data))
-            .catch(() => undefined);
-        await this._liveQueue;
-    }
 }
 exports.VitestReporter = VitestReporter;
 /**
@@ -228,15 +159,16 @@ function getRunStatusFromResults(files) {
      */
     let status = 'finished'; // default status (if no failed or passed tests)
     files.forEach(file => {
-        getTasks(file).forEach(taskOrSuite => {
-            if (isFailedState(taskOrSuite?.result?.state)) {
+        // search for failed tests
+        file.tasks.forEach(taskOrSuite => {
+            if (taskOrSuite.result?.state === 'fail') {
                 status = 'failed'; // set status to failed if any test failed
             }
         });
         // if there are no failed tests > search for passed tests
         if (status !== 'failed') {
-            getTasks(file).forEach(taskOrSuite => {
-                if (isPassedState(taskOrSuite?.result?.state)) {
+            file.tasks.forEach(taskOrSuite => {
+                if (taskOrSuite.result?.state === 'pass') {
                     status = 'passed'; // set status to passed if any test passed (and there are no failed tests)
                 }
             });
@@ -247,18 +179,17 @@ function getRunStatusFromResults(files) {
 /**
  * Returns test status in Testomat.io format
  *
- * @param {string | undefined} state
- * @param {string | undefined} mode
+ * @param {VitestTest} test
  * @returns 'passed' | 'failed' | 'skipped'
  */
-function getTestStatus(state, mode) {
-    if (isFailedState(state))
+function getTestStatus(test) {
+    if (test.result?.state === 'fail')
         return constants_js_1.STATUS.FAILED;
-    if (isPassedState(state))
+    if (test.result?.state === 'pass')
         return constants_js_1.STATUS.PASSED;
-    if (isSkippedState(state) || (!state && mode === 'skip'))
+    if (test.result?.state === 'skip' || (!test.result && test.mode === 'skip'))
         return constants_js_1.STATUS.SKIPPED;
-    console.error(picocolors_1.default.red('Unprocessed case for defining test status. Contact dev team. State:'), state);
+    console.error(picocolors_1.default.red('Unprocessed case for defining test status. Contact dev team. Test:'), test);
     return constants_js_1.STATUS.SKIPPED;
 }
 /**
@@ -290,165 +221,10 @@ function getTasks(node) {
         return node.tasks;
     if (Array.isArray(node.children))
         return node.children;
-    if (node.children && typeof node.children[Symbol.iterator] === 'function')
-        return Array.from(node.children);
     if (node.task)
         return [node.task];
     return [];
 }
-/**
- * @param {string | undefined} state
- * @returns {boolean}
- */
-function isFailedState(state) {
-    return state === 'fail' || state === 'failed';
-}
-/**
- * @param {string | undefined} state
- * @returns {boolean}
- */
-function isPassedState(state) {
-    return state === 'pass' || state === 'passed';
-}
-/**
- * @param {string | undefined} state
- * @returns {boolean}
- */
-function isSkippedState(state) {
-    return state === 'skip' || state === 'skipped' || state === 'todo';
-}
-/**
- * Accept only completed test states for live upload to avoid reporting
- * intermediate task updates as skipped.
- *
- * @param {string | undefined} state
- * @param {string | undefined} mode
- * @returns {boolean}
- */
-function isLiveReportableState(state, mode) {
-    if (isFailedState(state) || isPassedState(state) || isSkippedState(state))
-        return true;
-    if (!state && mode === 'skip')
-        return true;
-    return false;
-}
-/**
- * @param {VitestTestFile[] | undefined} files
- * @returns {number | null}
- */
-function getEarliestTestStartMs(files) {
-    let earliest = null;
-    const walk = node => {
-        if (!node)
-            return;
-        const startTime = node?.result?.startTime;
-        if (typeof startTime === 'number' && !Number.isNaN(startTime)) {
-            if (earliest == null || startTime < earliest)
-                earliest = startTime;
-        }
-        getTasks(node).forEach(walk);
-    };
-    (files || []).forEach(walk);
-    return earliest;
-}
-/**
- * @param {any} test
- * @returns {{
- *  name: string,
- *  state: string | undefined,
- *  mode: string | undefined,
- *  duration: number,
- *  startTime: number | undefined,
- *  error: any,
- *  file: string,
- *  suiteTitle: string,
- *  logs: string,
- *  meta: any
- * }}
- */
-function normalizeVitestTest(test) {
-    if (test && typeof test.result === 'function') {
-        const result = test.result();
-        const diagnostic = typeof test.diagnostic === 'function' ? test.diagnostic() : undefined;
-        const state = result?.state;
-        const duration = diagnostic?.duration || 0;
-        const startTime = diagnostic?.startTime;
-        const error = Array.isArray(result?.errors) ? result.errors[0] : undefined;
-        const file = test.module?.relativeModuleId ||
-            test.module?.moduleId ||
-            test.task?.file?.name ||
-            test.task?.file?.filepath ||
-            '';
-        const suiteTitle = (test.parent?.type === 'suite' ? test.parent?.name : null) ||
-            test.task?.suite?.name ||
-            test.task?.file?.name ||
-            file;
-        return {
-            name: test.name || test.task?.name || '',
-            state,
-            mode: test.options?.mode || test.task?.mode,
-            duration,
-            startTime,
-            error,
-            file,
-            suiteTitle,
-            logs: '',
-            meta: typeof test.meta === 'function' ? test.meta() : {},
-        };
-    }
-    return {
-        name: test?.name || '',
-        state: test?.result?.state,
-        mode: test?.mode,
-        duration: test?.result?.duration || 0,
-        startTime: test?.result?.startTime,
-        error: test?.result?.errors ? test.result.errors[0] : undefined,
-        file: test?.file?.name || test?.file?.filepath || '',
-        suiteTitle: test?.suite?.name || test?.file?.name || test?.file?.filepath || '',
-        logs: test?.logs ? transformLogsToString(test.logs) : '',
-        meta: test?.meta,
-    };
-}
-/**
- * @param {any} test
- * @param {{file: string, suiteTitle: string, name: string, startTime?: number}} normalized
- * @returns {string | null}
- */
-function getReportKey(test, normalized) {
-    if (test?.id)
-        return String(test.id);
-    if (test?.task?.id)
-        return String(test.task.id);
-    if (!normalized?.name)
-        return null;
-    const loc = test?.location || test?.task?.location;
-    const locationKey = loc ? `${loc.line || ''}:${loc.column || ''}` : '';
-    const startKey = typeof normalized.startTime === 'number' && !Number.isNaN(normalized.startTime) ? String(normalized.startTime) : '';
-    return `${normalized.file}::${normalized.suiteTitle}::${normalized.name}::${locationKey}::${startKey}`;
-}
-/**
- * Vitest can pass task updates as tuples. Try to extract a test-like object.
- *
- * @param {unknown} pack
- * @returns {any | null}
- */
-function getTestFromTaskUpdatePack(pack) {
-    if (!pack)
-        return null;
-    if (Array.isArray(pack)) {
-        if (pack[2]?.type === 'test')
-            return pack[2];
-        if (pack[1]?.type === 'test')
-            return pack[1];
-        if (pack[0]?.type === 'test')
-            return pack[0];
-        return null;
-    }
-    const objectPack = /** @type {any} */ (pack);
-    if (typeof objectPack === 'object' && objectPack?.type === 'test')
-        return objectPack;
-    return null;
-}
 module.exports = VitestReporter;
 
 module.exports.VitestReporter = VitestReporter;

package/lib/allureReader.d.ts

@@ -0,0 +1,65 @@
+export default AllureReader;
+declare class AllureReader {
+    constructor(opts?: {});
+    requestParams: {
+        apiKey: any;
+        url: any;
+        title: string;
+        env: string;
+        group_title: string;
+        isBatchEnabled: boolean;
+    };
+    runId: any;
+    opts: {};
+    withPackage: any;
+    store: {};
+    pipesPromise: Promise<any[]>;
+    _tests: any[];
+    stats: {};
+    suites: {};
+    uploader: S3Uploader;
+    version: any;
+    set tests(value: any[]);
+    get tests(): any[];
+    createRun(): Promise<any[]>;
+    pipes: any;
+    parse(resultsPattern: any): {};
+    parseContainerFiles(containerFiles: any): void;
+    processAllureResult(result: any, resultsDir: any): {
+        rid: any;
+        title: any;
+        status: any;
+        suite_title: any;
+        file: string;
+        run_time: number;
+        steps: any;
+        message: any;
+        stack: any;
+        meta: {};
+        links: {
+            label: string;
+        }[];
+        artifacts: any[];
+        create: boolean;
+        overwrite: boolean;
+    };
+    mapStatus(status: any): any;
+    extractSuiteTitle(result: any): any;
+    stripNamespace(suiteName: any): any;
+    extractFile(result: any): string;
+    getFileExtension(result: any): any;
+    extractMeta(result: any): {};
+    extractLinks(result: any): {
+        label: string;
+    }[];
+    convertSteps(steps: any, depth?: number): any;
+    calculateRunTime(item: any): number;
+    convertParameters(parameters: any): {};
+    combineRetryAttempts(attempts: any): any;
+    calculateStats(): {};
+    fetchSourceCode(): void;
+    getLanguage(): any;
+    uploadArtifacts(): Promise<void>;
+    uploadData(): Promise<any[]>;
+}
+import { S3Uploader } from './uploader.js';