@allurereport/plugin-awesome 3.0.0-beta.16 → 3.0.0-beta.17

package/README.md

@@ -47,11 +47,12 @@ 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`     |
+| 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` |

package/dist/converters.js

@@ -36,6 +36,7 @@ export const convertTestResult = (tr) => {
         breadcrumbs: [],
         retry: false,
         transition: tr.transition,
+        titlePath: tr.titlePath || [],
     };
 };
 export const convertTestStepResult = (tsr) => {

package/dist/generators.js

@@ -1,6 +1,5 @@
 import { compareBy, incrementStatistic, nullsLast, ordinal, } from "@allurereport/core-api";
-import { filterTree, } from "@allurereport/plugin-api";
-import { createTreeByLabels, sortTree, transformTree } from "@allurereport/plugin-api";
+import { createTreeByLabels, createTreeByTitlePath, filterTree, preciseTreeLabels, sortTree, transformTree, } from "@allurereport/plugin-api";
 import { createBaseUrlScript, createFontLinkTag, createReportDataScript, createScriptTag, createStylesLinkTag, getPieChartData, } from "@allurereport/web-commons";
 import Handlebars from "handlebars";
 import { readFile } from "node:fs/promises";
@@ -119,24 +118,55 @@ export const generateNav = async (writer, trs, filename = "nav.json") => {
 };
 export const generateTree = async (writer, treeFilename, labels, tests) => {
     const visibleTests = tests.filter((test) => !test.hidden);
-    const tree = createTreeByLabels(visibleTests, labels, ({ id, name, status, duration, flaky, transition, start, retry, retriesCount }) => ({
-        nodeId: id,
-        retry,
-        retriesCount,
-        name,
-        status,
-        start,
-        duration,
-        flaky,
-        transition,
-    }), undefined, (group, leaf) => {
-        incrementStatistic(group.statistic, leaf.status);
-    });
+    const tree = labels.length
+        ? buildTreeByLabels(visibleTests, labels)
+        : buildTreeByTitlePath(visibleTests);
     filterTree(tree, (leaf) => !leaf.hidden);
     sortTree(tree, nullsLast(compareBy("start", ordinal())));
     transformTree(tree, (leaf, idx) => ({ ...leaf, groupOrder: idx + 1 }));
     await writer.writeWidget(treeFilename, tree);
 };
+const buildTreeByLabels = (tests, labels) => {
+    return createTreeByLabels(tests, labels, leafFactory, undefined, (group, leaf) => incrementStatistic(group.statistic, leaf.status));
+};
+const buildTreeByTitlePath = (tests) => {
+    const testsWithTitlePath = [];
+    const testsWithoutTitlePath = [];
+    for (const test of tests) {
+        if (Array.isArray(test.titlePath) && test.titlePath.length > 0) {
+            testsWithTitlePath.push(test);
+        }
+        else {
+            testsWithoutTitlePath.push(test);
+        }
+    }
+    const treeByTitlePath = createTreeByTitlePath(testsWithTitlePath, leafFactory, undefined, (group, leaf) => incrementStatistic(group.statistic, leaf.status));
+    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 };
+    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 {
+        root: {
+            leaves: mergedRootLeaves,
+            groups: mergedRootGroups,
+        },
+        leavesById: mergedLeavesById,
+        groupsById: mergedGroupsById,
+    };
+};
+const leafFactory = ({ id, name, status, duration, flaky, start, transition, retry, retriesCount, }) => ({
+    nodeId: id,
+    name,
+    status,
+    duration,
+    flaky,
+    start,
+    retry,
+    retriesCount,
+    transition,
+});
 export const generateEnvironmentJson = async (writer, env) => {
     await writer.writeWidget("allure_environment.json", env);
 };
@@ -197,7 +227,7 @@ export const generateHistoryDataPoints = async (writer, store) => {
     return result;
 };
 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 = "", } = payload;
+    const { id, reportName = "Allure Report", reportLanguage = "en", singleFile, logo = "", theme = "light", groupBy, reportFiles, reportDataFiles, reportUuid, allureVersion, layout = "base", charts = [], defaultSection = "", ci, } = payload;
     const compile = Handlebars.compile(template);
     const manifest = await readTemplateManifest(payload.singleFile);
     const headTags = [];
@@ -241,23 +271,34 @@ export const generateStaticFiles = async (payload) => {
         reportLanguage,
         createdAt: now,
         reportUuid,
-        groupBy: groupBy?.length ? groupBy : ["parentSuite", "suite", "subSuite"],
+        groupBy: groupBy?.length ? groupBy : [],
         cacheKey: now.toString(),
+        ci,
         layout,
         allureVersion,
         sections,
         defaultSection,
     };
-    const html = compile({
-        headTags: headTags.join("\n"),
-        bodyTags: bodyTags.join("\n"),
-        reportFilesScript: createReportDataScript(reportDataFiles),
-        reportOptions: JSON.stringify(reportOptions),
-        analyticsEnable: true,
-        allureVersion,
-        reportUuid,
-        reportName,
-        singleFile: payload.singleFile,
-    });
-    await reportFiles.addFile("index.html", Buffer.from(html, "utf8"));
+    try {
+        const html = compile({
+            headTags: headTags.join("\n"),
+            bodyTags: bodyTags.join("\n"),
+            reportFilesScript: createReportDataScript(reportDataFiles),
+            reportOptions: JSON.stringify(reportOptions),
+            analyticsEnable: true,
+            allureVersion,
+            reportUuid,
+            reportName,
+            singleFile: payload.singleFile,
+        });
+        await reportFiles.addFile("index.html", Buffer.from(html, "utf8"));
+    }
+    catch (err) {
+        if (err instanceof RangeError) {
+            console.error("The report is too large to be generated in the single file mode!");
+            process.exit(1);
+            return;
+        }
+        throw err;
+    }
 };

package/dist/model.d.ts

@@ -1,4 +1,4 @@
-import type { EnvironmentsConfig, TestResult } from "@allurereport/core-api";
+import type { CiDescriptor, EnvironmentsConfig, TestResult } from "@allurereport/core-api";
 import type { ChartOptions } from "./charts.js";
 export type AwesomeOptions = {
     reportName?: string;
@@ -9,11 +9,7 @@ export type AwesomeOptions = {
     groupBy?: string[];
     layout?: "base" | "split";
     environments?: Record<string, EnvironmentsConfig>;
-    ci?: {
-        type: "github" | "jenkins";
-        url: string;
-        name: string;
-    };
+    ci?: CiDescriptor;
     filter?: (testResult: TestResult) => boolean;
     charts?: ChartOptions[];
     sections?: string[];

package/dist/plugin.d.ts

@@ -1,4 +1,4 @@
-import type { AllureStore, Plugin, PluginContext, PluginSummary } from "@allurereport/plugin-api";
+import { type AllureStore, type Plugin, type PluginContext, type PluginSummary } from "@allurereport/plugin-api";
 import type { AwesomePluginOptions } from "./model.js";
 export declare class AwesomePlugin implements Plugin {
     #private;

package/dist/plugin.js

@@ -11,6 +11,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
 };
 var _AwesomePlugin_writer, _AwesomePlugin_generate;
 import { getWorstStatus } from "@allurereport/core-api";
+import { convertToSummaryTestResult, } from "@allurereport/plugin-api";
 import { preciseTreeLabels } from "@allurereport/plugin-api";
 import { join } from "node:path";
 import { generateAllCharts } from "./charts.js";
@@ -29,7 +30,10 @@ export class AwesomePlugin {
             await generatePieChart(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store, this.options.filter);
             await generateAllCharts(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store, this.options, context);
             const convertedTrs = await generateTestResults(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store, this.options.filter);
-            const treeLabels = preciseTreeLabels(!groupBy.length ? ["parentSuite", "suite", "subSuite"] : groupBy, convertedTrs, ({ labels }) => labels.map(({ name }) => name));
+            const hasGroupBy = groupBy.length > 0;
+            const treeLabels = hasGroupBy
+                ? preciseTreeLabels(groupBy, convertedTrs, ({ labels }) => labels.map(({ name }) => name))
+                : [];
             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);
@@ -85,6 +89,9 @@ export class AwesomePlugin {
     }
     async info(context, store) {
         const allTrs = (await store.allTestResults()).filter((tr) => this.options.filter ? this.options.filter(tr) : true);
+        const newTrs = await store.allNewTestResults();
+        const retryTrs = allTrs.filter((tr) => !!tr?.retries?.length);
+        const flakyTrs = allTrs.filter((tr) => !!tr?.flaky);
         const duration = allTrs.reduce((acc, { duration: trDuration = 0 }) => acc + trDuration, 0);
         const worstStatus = getWorstStatus(allTrs.map(({ status }) => status));
         const createdAt = allTrs.reduce((acc, { stop }) => Math.max(acc, stop || 0), 0);
@@ -95,6 +102,9 @@ export class AwesomePlugin {
             duration,
             createdAt,
             plugin: "Awesome",
+            newTests: newTrs.map(convertToSummaryTestResult),
+            flakyTests: flakyTrs.map(convertToSummaryTestResult),
+            retryTests: retryTrs.map(convertToSummaryTestResult),
         };
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-awesome",
-  "version": "3.0.0-beta.16",
+  "version": "3.0.0-beta.17",
   "description": "Allure Awesome Plugin – brand new HTML report with modern design and new features",
   "keywords": [
     "allure",
@@ -30,10 +30,10 @@
     "test": "rimraf ./out && vitest run"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.0.0-beta.16",
-    "@allurereport/plugin-api": "3.0.0-beta.16",
-    "@allurereport/web-awesome": "3.0.0-beta.16",
-    "@allurereport/web-commons": "3.0.0-beta.16",
+    "@allurereport/core-api": "3.0.0-beta.17",
+    "@allurereport/plugin-api": "3.0.0-beta.17",
+    "@allurereport/web-awesome": "3.0.0-beta.17",
+    "@allurereport/web-commons": "3.0.0-beta.17",
     "d3-shape": "^3.2.0",
     "handlebars": "^4.7.8"
   },
@@ -45,7 +45,7 @@
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
     "@vitest/runner": "^2.1.9",
-    "allure-vitest": "^3.0.9",
+    "allure-vitest": "^3.3.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",