@allurereport/plugin-awesome 3.0.0-beta.22 → 3.0.0-beta.24

package/README.md

@@ -47,12 +47,13 @@ export default defineConfig({
 
 The plugin accepts the following options:
 
-| Option           | Description                                     | Type    | Default                 |
-|------------------|-------------------------------------------------|---------|-------------------------|
-| `reportName`     | Name of the report                              | `string` | `Allure Report`         |
-| `singleFile`     | Writes the report as a single `index.html` file | `boolean` | `false`                 |
-| `logo`           | Path to the logo image                          | `string` | `null`                  |
-| `theme`          | Default color theme of the report               | `light \| dark` | OS theme                |
-| `reportLanguage` | Default language of the report                  | `string` | OS language             |
-| `ci`             | CI data which will be rendered in the report    | `{ type: "github" \| "jenkins", url: string, name: string }` | `undefined`             |
-| `groupBy`        | By default, tests are grouped using the `titlePath` provided by the test framework.    | `string`| Grouping by `titlepath` |
+| Option         | Description                                                                                                                                                 | Type                                                         | Default                       |
+|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|-------------------------------|
+| `reportName`   | Name of the report                                                                                                                                          | `string`                                                     | `Allure Report`               |
+| `singleFile`   | Writes the report as a single `index.html` file                                                                                                             | `boolean`                                                    | `false`                       |
+| `logo`         | Path to the logo image                                                                                                                                      | `string`                                                     | `null`                        |
+| `theme`        | Default color theme of the report                                                                                                                           | `light \| dark \| auto`                                      | `auto` OS theme               |
+| `reportLanguage` | Default language of the report                                                                                                                              | `string`                                                     | OS language                   |
+| `ci`           | CI data which will be rendered in the report                                                                                                                | `{ type: "github" \| "jenkins", url: string, name: string }` | `undefined`                   |
+| `groupBy`      | Grouping tests by labels or combining labels. By default, tests are grouped using the `titlePath` provided by the test framework. | `string`                                                      | `[]`(Grouping by `titlepath`) |
+| `appendTitlePath`| Special marker for `groupBy`. Forces a final grouping by `titlePath` after all label-based groups.                                                          | `boolean`                                                    | `false`                       |

package/dist/generateTimeline.d.ts

@@ -0,0 +1,7 @@
+import type { AllureStore } from "@allurereport/plugin-api";
+import type { AwesomeOptions } from "./model.js";
+type Writer = {
+    writeWidget(fileName: string, data: any): Promise<void>;
+};
+export declare const generateTimeline: (writer: Writer, store: AllureStore, options: AwesomeOptions) => Promise<void>;
+export {};

package/dist/generateTimeline.js

@@ -0,0 +1,28 @@
+import { hasLabels } from "@allurereport/web-commons";
+const DEFAULT_MIN_DURATION = 1;
+const HOST_LABEL = "host";
+const THREAD_LABEL = "thread";
+export const generateTimeline = async (writer, store, options) => {
+    if (!options.timeline) {
+        return;
+    }
+    const testResults = await store.allTestResults();
+    const { minDuration = DEFAULT_MIN_DURATION } = options.timeline;
+    const result = [];
+    for (const test of testResults) {
+        const hasStart = Number.isInteger(test.start);
+        const hasStop = Number.isInteger(test.stop);
+        if (!hasStart || !hasStop) {
+            continue;
+        }
+        const duration = test.duration ?? test.stop - test.start;
+        if (duration < minDuration) {
+            continue;
+        }
+        if (!hasLabels(test, [HOST_LABEL, THREAD_LABEL])) {
+            continue;
+        }
+        result.push(test);
+    }
+    await writer.writeWidget("timeline.json", result);
+};

package/dist/generators.d.ts

@@ -8,7 +8,9 @@ export declare const generateTestResults: (writer: AwesomeDataWriter, store: All
 export declare const generateTestCases: (writer: AwesomeDataWriter, trs: AwesomeTestResult[]) => Promise<void>;
 export declare const generateTestEnvGroups: (writer: AwesomeDataWriter, groups: TestEnvGroup[]) => Promise<void>;
 export declare const generateNav: (writer: AwesomeDataWriter, trs: AwesomeTestResult[], filename?: string) => Promise<void>;
-export declare const generateTree: (writer: AwesomeDataWriter, treeFilename: string, labels: string[], tests: AwesomeTestResult[]) => Promise<void>;
+export declare const generateTree: (writer: AwesomeDataWriter, treeFilename: string, labels: string[], tests: AwesomeTestResult[], options?: {
+    appendTitlePath?: boolean;
+}) => Promise<void>;
 export declare const generateEnvironmentJson: (writer: AwesomeDataWriter, env: EnvironmentItem[]) => Promise<void>;
 export declare const generateEnvirontmentsList: (writer: AwesomeDataWriter, store: AllureStore) => Promise<void>;
 export declare const generateVariables: (writer: AwesomeDataWriter, store: AllureStore) => Promise<void>;

package/dist/generators.js

@@ -1,5 +1,5 @@
 import { compareBy, createBaseUrlScript, createFontLinkTag, createReportDataScript, createScriptTag, createStylesLinkTag, incrementStatistic, nullsLast, ordinal, } from "@allurereport/core-api";
-import { createTreeByLabels, createTreeByTitlePath, filterTree, preciseTreeLabels, sortTree, transformTree, } from "@allurereport/plugin-api";
+import { createTreeByLabels, createTreeByLabelsAndTitlePath, createTreeByTitlePath, filterTree, preciseTreeLabels, sortTree, transformTree, } from "@allurereport/plugin-api";
 import { generateCharts, getPieChartValues } from "@allurereport/web-commons";
 import Handlebars from "handlebars";
 import { randomUUID } from "node:crypto";
@@ -115,11 +115,19 @@ export const generateTestEnvGroups = async (writer, groups) => {
 export const generateNav = async (writer, trs, filename = "nav.json") => {
     await writer.writeWidget(filename, trs.filter(({ hidden }) => !hidden).map(({ id }) => id));
 };
-export const generateTree = async (writer, treeFilename, labels, tests) => {
+export const generateTree = async (writer, treeFilename, labels, tests, options) => {
     const visibleTests = tests.filter((test) => !test.hidden);
-    const tree = labels.length
-        ? buildTreeByLabels(visibleTests, labels)
-        : buildTreeByTitlePath(visibleTests);
+    const { appendTitlePath } = options || {};
+    let tree;
+    if (labels.length === 0) {
+        tree = buildTreeByTitlePath(visibleTests);
+    }
+    else if (appendTitlePath && labels.length) {
+        tree = buildTreeByLabelsAndTitlePathCombined(visibleTests, labels);
+    }
+    else {
+        tree = buildTreeByLabels(visibleTests, labels);
+    }
     filterTree(tree, (leaf) => !leaf.hidden);
     sortTree(tree, nullsLast(compareBy("start", ordinal())));
     transformTree(tree, (leaf, idx) => ({ ...leaf, groupOrder: idx + 1 }));
@@ -140,10 +148,33 @@ const buildTreeByTitlePath = (tests) => {
         }
     }
     const treeByTitlePath = createTreeByTitlePath(testsWithTitlePath, leafFactory, undefined, (group, leaf) => incrementStatistic(group.statistic, leaf.status));
+    if (!testsWithoutTitlePath.length) {
+        return treeByTitlePath;
+    }
     const defaultLabels = preciseTreeLabels(["parentSuite", "suite", "subSuite"], testsWithoutTitlePath, ({ labels }) => labels.map(({ name }) => name));
-    const treeByDefaultLabels = createTreeByLabels(testsWithoutTitlePath, defaultLabels, leafFactory, undefined, (group, leaf) => incrementStatistic(group.statistic, leaf.status));
-    const mergedLeavesById = { ...treeByTitlePath.leavesById, ...treeByDefaultLabels.leavesById };
-    const mergedGroupsById = { ...treeByTitlePath.groupsById, ...treeByDefaultLabels.groupsById };
+    let treeByDefaultLabels = null;
+    if (defaultLabels.length) {
+        treeByDefaultLabels = createTreeByLabelsAndTitlePath(testsWithoutTitlePath, defaultLabels, leafFactory, undefined, (group, leaf) => incrementStatistic(group.statistic, leaf.status));
+    }
+    else {
+        for (const test of testsWithoutTitlePath) {
+            const leaf = leafFactory(test);
+            treeByTitlePath.leavesById[leaf.nodeId] = leaf;
+            if (!treeByTitlePath.root.leaves) {
+                treeByTitlePath.root.leaves = [];
+            }
+            treeByTitlePath.root.leaves.push(leaf.nodeId);
+        }
+        return treeByTitlePath;
+    }
+    const mergedLeavesById = {
+        ...treeByTitlePath.leavesById,
+        ...treeByDefaultLabels.leavesById,
+    };
+    const mergedGroupsById = {
+        ...treeByTitlePath.groupsById,
+        ...treeByDefaultLabels.groupsById,
+    };
     const mergedRootLeaves = Array.from(new Set([...(treeByTitlePath.root.leaves ?? []), ...(treeByDefaultLabels.root.leaves ?? [])]));
     const mergedRootGroups = Array.from(new Set([...(treeByTitlePath.root.groups ?? []), ...(treeByDefaultLabels.root.groups ?? [])]));
     return {
@@ -155,6 +186,7 @@ const buildTreeByTitlePath = (tests) => {
         groupsById: mergedGroupsById,
     };
 };
+const buildTreeByLabelsAndTitlePathCombined = (tests, labels) => createTreeByLabelsAndTitlePath(tests, labels, leafFactory, undefined, (group, leaf) => incrementStatistic(group.statistic, leaf.status));
 const leafFactory = ({ id, name, status, duration, flaky, start, transition, retry, retriesCount, }) => ({
     nodeId: id,
     name,
@@ -242,7 +274,7 @@ export const generateQualityGateResults = async (writer, qualityGateResults = []
     await writer.writeWidget("quality-gate.json", qualityGateResults);
 };
 export const generateStaticFiles = async (payload) => {
-    const { id, reportName = "Allure Report", reportLanguage = "en", singleFile, logo = "", theme = "light", groupBy, reportFiles, reportDataFiles, reportUuid, allureVersion, layout = "base", charts = [], defaultSection = "", ci, } = payload;
+    const { id, reportName = "Allure Report", reportLanguage = "en", singleFile, logo = "", theme = "auto", groupBy, reportFiles, reportDataFiles, reportUuid, allureVersion, layout = "base", charts = [], timeline, defaultSection = "", ci, } = payload;
     const compile = Handlebars.compile(template);
     const manifest = await readTemplateManifest(payload.singleFile);
     const headTags = [];
@@ -251,6 +283,9 @@ export const generateStaticFiles = async (payload) => {
     if (charts.length) {
         sections.push("charts");
     }
+    if (timeline) {
+        sections.push("timeline");
+    }
     if (!payload.singleFile) {
         for (const key in manifest) {
             const fileName = manifest[key];

package/dist/model.d.ts

@@ -4,17 +4,21 @@ export type AwesomeOptions = {
     reportName?: string;
     singleFile?: boolean;
     logo?: string;
-    theme?: "light" | "dark";
-    reportLanguage?: "en" | "ru";
+    theme?: "light" | "dark" | "auto";
+    reportLanguage?: "en";
     groupBy?: string[];
     layout?: "base" | "split";
     environments?: Record<string, EnvironmentsConfig>;
     ci?: CiDescriptor;
     filter?: (testResult: TestResult) => boolean;
     charts?: ChartOptions[];
+    timeline?: {
+        minDuration?: number;
+    };
     sections?: string[];
     defaultSection?: string;
     publish?: boolean;
+    appendTitlePath?: boolean;
 };
 export type TemplateManifest = Record<string, string>;
 export type AwesomePluginOptions = AwesomeOptions;

package/dist/plugin.js

@@ -15,6 +15,7 @@ import { convertToSummaryTestResult, } from "@allurereport/plugin-api";
 import { preciseTreeLabels } from "@allurereport/plugin-api";
 import { join } from "node:path";
 import { filterEnv } from "./environments.js";
+import { generateTimeline } from "./generateTimeline.js";
 import { generateAllCharts, generateAttachmentsFiles, generateEnvironmentJson, generateEnvirontmentsList, generateGlobals, generateHistoryDataPoints, generateNav, generateQualityGateResults, generateStaticFiles, generateStatistic, generateTestCases, generateTestEnvGroups, generateTestResults, generateTree, generateVariables, } from "./generators.js";
 import { InMemoryReportDataWriter, ReportFileDataWriter } from "./writer.js";
 export class AwesomePlugin {
@@ -22,7 +23,7 @@ export class AwesomePlugin {
         this.options = options;
         _AwesomePlugin_writer.set(this, void 0);
         _AwesomePlugin_generate.set(this, async (context, store) => {
-            const { singleFile, groupBy = [], filter } = this.options ?? {};
+            const { singleFile, groupBy = [], filter, appendTitlePath } = this.options ?? {};
             const environmentItems = await store.metadataByKey("allure_environment");
             const reportEnvironments = await store.allEnvironments();
             const attachments = await store.allAttachments();
@@ -44,6 +45,7 @@ export class AwesomePlugin {
                 envs: environments,
             });
             await generateAllCharts(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store, this.options, context);
+            await generateTimeline(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store, this.options);
             const convertedTrs = await generateTestResults(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store, allTrs, this.options.filter);
             const hasGroupBy = groupBy.length > 0;
             const treeLabels = hasGroupBy
@@ -51,12 +53,14 @@ export class AwesomePlugin {
                 : [];
             await generateHistoryDataPoints(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store);
             await generateTestCases(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), convertedTrs);
-            await generateTree(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), "tree.json", treeLabels, convertedTrs);
+            await generateTree(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), "tree.json", treeLabels, convertedTrs, { appendTitlePath });
             await generateNav(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), convertedTrs, "nav.json");
             await generateTestEnvGroups(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), allTestEnvGroups);
             for (const reportEnvironment of reportEnvironments) {
                 const envConvertedTrs = convertedTrs.filter(({ environment }) => environment === reportEnvironment);
-                await generateTree(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), join(reportEnvironment, "tree.json"), treeLabels, envConvertedTrs);
+                await generateTree(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), join(reportEnvironment, "tree.json"), treeLabels, envConvertedTrs, {
+                    appendTitlePath,
+                });
                 await generateNav(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), envConvertedTrs, join(reportEnvironment, "nav.json"));
             }
             await generateEnvirontmentsList(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-awesome",
-  "version": "3.0.0-beta.22",
+  "version": "3.0.0-beta.24",
   "description": "Allure Awesome Plugin – brand new HTML report with modern design and new features",
   "keywords": [
     "allure",
@@ -30,11 +30,11 @@
     "test": "rimraf ./out && vitest run"
   },
   "dependencies": {
-    "@allurereport/charts-api": "3.0.0-beta.22",
-    "@allurereport/core-api": "3.0.0-beta.22",
-    "@allurereport/plugin-api": "3.0.0-beta.22",
-    "@allurereport/web-awesome": "3.0.0-beta.22",
-    "@allurereport/web-commons": "3.0.0-beta.22",
+    "@allurereport/charts-api": "3.0.0-beta.24",
+    "@allurereport/core-api": "3.0.0-beta.24",
+    "@allurereport/plugin-api": "3.0.0-beta.24",
+    "@allurereport/web-awesome": "3.0.0-beta.24",
+    "@allurereport/web-commons": "3.0.0-beta.24",
     "d3-shape": "^3.2.0",
     "handlebars": "^4.7.8"
   },