@allurereport/core 3.0.0-beta.6 → 3.0.0-beta.8

package/dist/api.d.ts

@@ -1,5 +1,5 @@
 import type { HistoryDataPoint, KnownTestFailure } from "@allurereport/core-api";
-import type { Plugin, QualityGateConfig, ReportFiles } from "@allurereport/plugin-api";
+import type { DefaultLabelsConfig, Plugin, QualityGateConfig, ReportFiles } from "@allurereport/plugin-api";
 import type { ResultsReader } from "@allurereport/reader-api";
 export interface FullConfig {
     name: string;
@@ -13,6 +13,7 @@ export interface FullConfig {
     knownIssuesPath: string;
     known?: KnownTestFailure[];
     qualityGate?: QualityGateConfig;
+    defaultLabels?: DefaultLabelsConfig;
     realTime?: any;
 }
 export interface PluginInstance {

package/dist/config.d.ts

@@ -8,7 +8,11 @@ export interface ConfigOverride {
     historyPath?: string;
     knownIssuesPath?: string;
 }
-export declare const readConfig: (cwd?: string, configPath?: string, override?: ConfigOverride) => Promise<FullConfig>;
+export declare const validateConfig: (config: Config) => {
+    valid: boolean;
+    fields: string[];
+};
 export declare const loadConfig: (configPath: string) => Promise<Config>;
 export declare const resolveConfig: (config: Config, override?: ConfigOverride) => Promise<FullConfig>;
+export declare const readConfig: (cwd?: string, configPath?: string, override?: ConfigOverride) => Promise<FullConfig>;
 export declare const resolvePlugin: (path: string) => Promise<any>;

package/dist/config.js

@@ -38,22 +38,44 @@ export const findConfig = async (cwd, configPath) => {
         }
     }
 };
-export const readConfig = async (cwd = process.cwd(), configPath, override) => {
-    const cfg = await findConfig(cwd, configPath);
-    const config = cfg ? await loadConfig(cfg) : { ...defaultConfig };
-    return await resolveConfig(config, override);
+export const validateConfig = (config) => {
+    const supportedFields = [
+        "name",
+        "output",
+        "historyPath",
+        "knownIssuesPath",
+        "qualityGate",
+        "plugins",
+        "defaultLabels",
+    ];
+    const unsupportedFields = Object.keys(config).filter((key) => !supportedFields.includes(key));
+    return {
+        valid: unsupportedFields.length === 0,
+        fields: unsupportedFields,
+    };
 };
 export const loadConfig = async (configPath) => {
     return (await import(normalizeImportPath(configPath))).default;
 };
 export const resolveConfig = async (config, override = {}) => {
+    const validationResult = validateConfig(config);
+    if (!validationResult.valid) {
+        throw new Error(`The provided Allure config contains unsupported fields: ${validationResult.fields.join(", ")}`);
+    }
     const name = override.name ?? config.name ?? "Allure Report";
     const historyPath = resolve(override.historyPath ?? config.historyPath ?? "./.allure/history.jsonl");
     const knownIssuesPath = resolve(override.knownIssuesPath ?? config.knownIssuesPath ?? "./allure/known.json");
     const output = resolve(override.output ?? config.output ?? "./allure-report");
     const history = await readHistory(historyPath);
     const known = await readKnownIssues(knownIssuesPath);
-    const pluginInstances = await resolvePlugins(config.plugins ?? {});
+    const plugins = Object.keys(config?.plugins ?? {}).length === 0
+        ? {
+            awesome: {
+                options: {},
+            },
+        }
+        : config.plugins;
+    const pluginInstances = await resolvePlugins(plugins);
     return {
         name,
         reportFiles: new FileSystemReportFiles(output),
@@ -66,6 +88,11 @@ export const resolveConfig = async (config, override = {}) => {
         qualityGate: config.qualityGate,
     };
 };
+export const readConfig = async (cwd = process.cwd(), configPath, override) => {
+    const cfg = await findConfig(cwd, configPath);
+    const config = cfg ? await loadConfig(cfg) : { ...defaultConfig };
+    return await resolveConfig(config, override);
+};
 export const resolvePlugin = async (path) => {
     if (!path.startsWith("@allurereport/plugin-")) {
         try {

package/dist/history.js

@@ -4,7 +4,7 @@ import { isFileNotFoundError } from "./utils/misc.js";
 const createHistoryItems = (testResults) => {
     return testResults
         .filter((tr) => tr.historyId)
-        .map(({ id, name, fullName, historyId, status, message, trace, start, stop, duration }) => {
+        .map(({ id, name, fullName, historyId, status, error: { message, trace } = {}, start, stop, duration }) => {
         return {
             id,
             name,

package/dist/report.js

@@ -159,7 +159,7 @@ export class AllureReport {
         this.validate = async () => {
             await __classPrivateFieldGet(this, _AllureReport_qualityGate, "f").validate(__classPrivateFieldGet(this, _AllureReport_store, "f"));
         };
-        const { name, readers = [allure1, allure2, cucumberjson, junitXml, attachments], plugins = [], history, known, reportFiles, qualityGate, realTime, appendHistory, historyPath, } = opts;
+        const { name, readers = [allure1, allure2, cucumberjson, junitXml, attachments], plugins = [], history, known, reportFiles, qualityGate, realTime, appendHistory, historyPath, defaultLabels = {}, } = opts;
         __classPrivateFieldSet(this, _AllureReport_reportUuid, randomUUID(), "f");
         __classPrivateFieldSet(this, _AllureReport_reportName, name, "f");
         __classPrivateFieldSet(this, _AllureReport_eventEmitter, new EventEmitter(), "f");
@@ -167,7 +167,12 @@ export class AllureReport {
         __classPrivateFieldSet(this, _AllureReport_realTime, realTime, "f");
         __classPrivateFieldSet(this, _AllureReport_appendHistory, appendHistory ?? true, "f");
         __classPrivateFieldSet(this, _AllureReport_historyPath, historyPath, "f");
-        __classPrivateFieldSet(this, _AllureReport_store, new DefaultAllureStore(history, known, __classPrivateFieldGet(this, _AllureReport_eventEmitter, "f")), "f");
+        __classPrivateFieldSet(this, _AllureReport_store, new DefaultAllureStore({
+            history,
+            known,
+            eventEmitter: __classPrivateFieldGet(this, _AllureReport_eventEmitter, "f"),
+            defaultLabels,
+        }), "f");
         __classPrivateFieldSet(this, _AllureReport_readers, [...readers], "f");
         __classPrivateFieldSet(this, _AllureReport_plugins, [...plugins], "f");
         __classPrivateFieldSet(this, _AllureReport_reportFiles, reportFiles, "f");

package/dist/store/convert.js

@@ -1,5 +1,4 @@
-import { notNull } from "@allurereport/core-api";
-import { findByLabelName } from "@allurereport/core-api";
+import { findByLabelName, notNull } from "@allurereport/core-api";
 import { md5 } from "@allurereport/plugin-api";
 import { extension, lookupContentType } from "@allurereport/reader-api";
 import MarkdownIt from "markdown-it";
@@ -14,8 +13,10 @@ export const testFixtureResultRawToState = (stateData, raw, context) => {
         type: raw.type,
         name,
         status: raw.status ?? defaultStatus,
-        message: raw.message,
-        trace: raw.trace,
+        error: {
+            message: raw.message,
+            trace: raw.trace,
+        },
         ...processTimings(raw),
         steps: convertSteps(stateData, raw.steps),
         sourceMetadata: {
@@ -38,8 +39,10 @@ export const testResultRawToState = (stateData, raw, context) => {
         fullName: raw.fullName,
         historyId: calculateHistoryId(testCase, parameters),
         status: raw.status ?? defaultStatus,
-        message: raw.message,
-        trace: raw.trace,
+        error: {
+            message: raw.message,
+            trace: raw.trace,
+        },
         ...processTimings(raw),
         description: raw.description,
         descriptionHtml: raw.descriptionHtml ?? markdownToHtml(raw.description),

package/dist/store/store.d.ts

@@ -1,5 +1,5 @@
 import type { AttachmentLink, HistoryDataPoint, HistoryTestResult, KnownTestFailure, Statistic, TestCase, TestFixtureResult, TestResult } from "@allurereport/core-api";
-import type { AllureStore, ResultFile } from "@allurereport/plugin-api";
+import type { AllureStore, DefaultLabelsConfig, ResultFile } from "@allurereport/plugin-api";
 import type { RawFixtureResult, RawMetadata, RawTestResult, ReaderContext, ResultsVisitor } from "@allurereport/reader-api";
 import type { EventEmitter } from "node:events";
 import type { AllureStoreEvents } from "../utils/event.js";
@@ -12,7 +12,12 @@ export declare class DefaultAllureStore implements AllureStore, ResultsVisitor {
     readonly indexAttachmentByFixture: Map<string, AttachmentLink[]>;
     readonly indexFixturesByTestResult: Map<string, TestFixtureResult[]>;
     readonly indexKnownByHistoryId: Map<string, KnownTestFailure[]>;
-    constructor(history?: HistoryDataPoint[], known?: KnownTestFailure[], eventEmitter?: EventEmitter<AllureStoreEvents>);
+    constructor(params?: {
+        history?: HistoryDataPoint[];
+        known?: KnownTestFailure[];
+        eventEmitter?: EventEmitter<AllureStoreEvents>;
+        defaultLabels?: DefaultLabelsConfig;
+    });
     visitTestResult(raw: RawTestResult, context: ReaderContext): Promise<void>;
     visitTestFixtureResult(result: RawFixtureResult, context: ReaderContext): Promise<void>;
     visitAttachmentFile(resultFile: ResultFile, context: ReaderContext): Promise<void>;

package/dist/store/store.js

@@ -9,7 +9,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _DefaultAllureStore_testResults, _DefaultAllureStore_attachments, _DefaultAllureStore_attachmentContents, _DefaultAllureStore_testCases, _DefaultAllureStore_metadata, _DefaultAllureStore_history, _DefaultAllureStore_known, _DefaultAllureStore_fixtures, _DefaultAllureStore_eventEmitter;
+var _DefaultAllureStore_testResults, _DefaultAllureStore_attachments, _DefaultAllureStore_attachmentContents, _DefaultAllureStore_testCases, _DefaultAllureStore_metadata, _DefaultAllureStore_history, _DefaultAllureStore_known, _DefaultAllureStore_fixtures, _DefaultAllureStore_defaultLabels, _DefaultAllureStore_eventEmitter;
 import { compareBy, nullsLast, ordinal, reverse } from "@allurereport/core-api";
 import { md5 } from "@allurereport/plugin-api";
 import { testFixtureResultRawToState, testResultRawToState } from "./convert.js";
@@ -23,7 +23,7 @@ const index = (indexMap, key, ...items) => {
     }
 };
 export class DefaultAllureStore {
-    constructor(history = [], known = [], eventEmitter) {
+    constructor(params) {
         _DefaultAllureStore_testResults.set(this, void 0);
         _DefaultAllureStore_attachments.set(this, void 0);
         _DefaultAllureStore_attachmentContents.set(this, void 0);
@@ -32,6 +32,7 @@ export class DefaultAllureStore {
         _DefaultAllureStore_history.set(this, void 0);
         _DefaultAllureStore_known.set(this, void 0);
         _DefaultAllureStore_fixtures.set(this, void 0);
+        _DefaultAllureStore_defaultLabels.set(this, {});
         _DefaultAllureStore_eventEmitter.set(this, void 0);
         this.indexTestResultByTestCase = new Map();
         this.indexLatestTestResultByHistoryId = new Map();
@@ -40,6 +41,7 @@ export class DefaultAllureStore {
         this.indexAttachmentByFixture = new Map();
         this.indexFixturesByTestResult = new Map();
         this.indexKnownByHistoryId = new Map();
+        const { history = [], known = [], eventEmitter, defaultLabels } = params ?? {};
         __classPrivateFieldSet(this, _DefaultAllureStore_testResults, new Map(), "f");
         __classPrivateFieldSet(this, _DefaultAllureStore_attachments, new Map(), "f");
         __classPrivateFieldSet(this, _DefaultAllureStore_attachmentContents, new Map(), "f");
@@ -50,6 +52,7 @@ export class DefaultAllureStore {
         __classPrivateFieldSet(this, _DefaultAllureStore_known, [...known], "f");
         __classPrivateFieldGet(this, _DefaultAllureStore_known, "f").forEach((ktf) => index(this.indexKnownByHistoryId, ktf.historyId, ktf));
         __classPrivateFieldSet(this, _DefaultAllureStore_eventEmitter, eventEmitter, "f");
+        __classPrivateFieldSet(this, _DefaultAllureStore_defaultLabels, defaultLabels ?? {}, "f");
     }
     async visitTestResult(raw, context) {
         const attachmentLinks = [];
@@ -58,6 +61,20 @@ export class DefaultAllureStore {
             attachments: __classPrivateFieldGet(this, _DefaultAllureStore_attachments, "f"),
             visitAttachmentLink: (link) => attachmentLinks.push(link),
         }, raw, context);
+        const defaultLabelsNames = Object.keys(__classPrivateFieldGet(this, _DefaultAllureStore_defaultLabels, "f"));
+        if (defaultLabelsNames.length) {
+            defaultLabelsNames.forEach((labelName) => {
+                if (!testResult.labels.find((label) => label.name === labelName)) {
+                    const defaultLabelValue = __classPrivateFieldGet(this, _DefaultAllureStore_defaultLabels, "f")[labelName];
+                    [].concat(defaultLabelValue).forEach((labelValue) => {
+                        testResult.labels.push({
+                            name: labelName,
+                            value: labelValue,
+                        });
+                    });
+                }
+            });
+        }
         __classPrivateFieldGet(this, _DefaultAllureStore_testResults, "f").set(testResult.id, testResult);
         if (testResult.historyId) {
             const maybeOther = this.indexLatestTestResultByHistoryId.get(testResult.historyId);
@@ -234,4 +251,4 @@ export class DefaultAllureStore {
         }, { total: all.length });
     }
 }
-_DefaultAllureStore_testResults = new WeakMap(), _DefaultAllureStore_attachments = new WeakMap(), _DefaultAllureStore_attachmentContents = new WeakMap(), _DefaultAllureStore_testCases = new WeakMap(), _DefaultAllureStore_metadata = new WeakMap(), _DefaultAllureStore_history = new WeakMap(), _DefaultAllureStore_known = new WeakMap(), _DefaultAllureStore_fixtures = new WeakMap(), _DefaultAllureStore_eventEmitter = new WeakMap();
+_DefaultAllureStore_testResults = new WeakMap(), _DefaultAllureStore_attachments = new WeakMap(), _DefaultAllureStore_attachmentContents = new WeakMap(), _DefaultAllureStore_testCases = new WeakMap(), _DefaultAllureStore_metadata = new WeakMap(), _DefaultAllureStore_history = new WeakMap(), _DefaultAllureStore_known = new WeakMap(), _DefaultAllureStore_fixtures = new WeakMap(), _DefaultAllureStore_defaultLabels = new WeakMap(), _DefaultAllureStore_eventEmitter = new WeakMap();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/core",
-  "version": "3.0.0-beta.6",
+  "version": "3.0.0-beta.8",
   "description": "Collection of generic Allure utilities used across the entire project",
   "keywords": [
     "allure"
@@ -25,17 +25,17 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.0.0-beta.6",
-    "@allurereport/plugin-api": "3.0.0-beta.6",
-    "@allurereport/plugin-awesome": "3.0.0-beta.6",
-    "@allurereport/plugin-classic": "3.0.0-beta.6",
-    "@allurereport/plugin-csv": "3.0.0-beta.6",
-    "@allurereport/plugin-log": "3.0.0-beta.6",
-    "@allurereport/plugin-progress": "3.0.0-beta.6",
-    "@allurereport/plugin-slack": "3.0.0-beta.6",
-    "@allurereport/plugin-testplan": "3.0.0-beta.6",
-    "@allurereport/reader": "3.0.0-beta.6",
-    "@allurereport/reader-api": "3.0.0-beta.6",
+    "@allurereport/core-api": "3.0.0-beta.8",
+    "@allurereport/plugin-api": "3.0.0-beta.8",
+    "@allurereport/plugin-awesome": "3.0.0-beta.8",
+    "@allurereport/plugin-classic": "3.0.0-beta.8",
+    "@allurereport/plugin-csv": "3.0.0-beta.8",
+    "@allurereport/plugin-log": "3.0.0-beta.8",
+    "@allurereport/plugin-progress": "3.0.0-beta.8",
+    "@allurereport/plugin-slack": "3.0.0-beta.8",
+    "@allurereport/plugin-testplan": "3.0.0-beta.8",
+    "@allurereport/reader": "3.0.0-beta.8",
+    "@allurereport/reader-api": "3.0.0-beta.8",
     "markdown-it": "^14.1.0"
   },
   "devDependencies": {
@@ -47,8 +47,8 @@
     "@typescript-eslint/parser": "^8.0.0",
     "@vitest/runner": "^2.1.8",
     "@vitest/snapshot": "^2.1.8",
-    "allure-js-commons": "^3.0.7",
-    "allure-vitest": "^3.0.7",
+    "allure-js-commons": "^3.0.9",
+    "allure-vitest": "^3.0.9",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",