@allurereport/plugin-api 3.20.0 → 3.21.0

package/dist/config.d.ts

@@ -6,6 +6,7 @@ export interface Config {
     output?: string;
     open?: boolean;
     port?: string;
+    host?: string;
     hideLabels?: (string | RegExp)[];
     historyPath?: string;
     historyBaseUrl?: string;

package/dist/plugin.d.ts

@@ -28,6 +28,7 @@ export interface PluginContext {
     hideLabels?: (string | RegExp)[];
     reportFiles: ReportFiles;
     reportUrl?: string;
+    overviewHref?: string;
     realTime?: boolean;
     output: string;
     ci?: CiDescriptor;
@@ -56,6 +57,8 @@ export interface PluginSummary {
     retryTests?: string[];
     checks?: SummaryCheckResult[];
     createdAt?: number;
+    exitCode?: ExitCode;
+    globalErrorsCount?: number;
     filtered?: boolean;
     meta?: Record<string, any>;
 }

package/dist/report.d.ts

@@ -37,6 +37,7 @@ export type ReportOptions = {
     runSummaryByEnv?: Record<string, ReportRunSummary>;
     stepTreeExpansion?: StepTreeExpansion;
     defaultSortBy?: string;
+    overviewHref?: string;
 };
 export type ReportFixtureResult = Omit<TestFixtureResult, "testResultIds" | "start" | "stop" | "sourceMetadata" | "steps"> & {
     steps: ReportTestStepResult[];
@@ -67,6 +68,7 @@ export type ReportTestResult = Omit<TestResult, "runSelector" | "sourceMetadata"
     history: HistoryTestResult[];
     retries?: TestResult[];
     retriesCount?: number;
+    retriesStatusChange?: boolean;
     groupedLabels: Record<string, string[]>;
     attachments?: AttachmentTestStepResult[];
     breadcrumbs: ReportBreadcrumbItem[];
@@ -82,7 +84,7 @@ export type ReportTestResult = Omit<TestResult, "runSelector" | "sourceMetadata"
         severity: string;
     };
 };
-export type ReportTreeLeaf = Pick<ReportTestResult, "duration" | "name" | "start" | "status" | "groupOrder" | "flaky" | "transition" | "retry" | "retriesCount" | "resolution"> & {
+export type ReportTreeLeaf = Pick<ReportTestResult, "duration" | "name" | "start" | "status" | "groupOrder" | "flaky" | "transition" | "retry" | "retriesCount" | "retriesStatusChange" | "resolution"> & {
     nodeId: string;
     id?: string;
     transitionTooltip?: string;
@@ -91,6 +93,7 @@ export type ReportTreeLeaf = Pick<ReportTestResult, "duration" | "name" | "start
     categories?: string[];
     severity?: string;
     resolutionStatus?: ResolutionCategory | "none";
+    parameters?: string[];
 };
 export type ReportTreeGroup = WithChildren & DefaultTreeGroup & {
     nodeId: string;
@@ -104,6 +107,7 @@ export type ReportSearchDocument = {
     id: string;
     nodeId: string;
     name: string;
+    titlePath?: string;
     fullName?: string;
     retryHash?: string | null;
     labels?: string;
@@ -114,7 +118,7 @@ export type ReportSearchDocument = {
     statusMessage?: string;
     links?: string;
 };
-export type ReportResolutionTestResult = Pick<ReportTreeLeaf, "nodeId" | "id" | "name" | "status" | "duration" | "flaky" | "transition" | "retry" | "retriesCount" | "resolution" | "tooltips"> & {
+export type ReportResolutionTestResult = Pick<ReportTreeLeaf, "nodeId" | "id" | "name" | "status" | "duration" | "flaky" | "transition" | "retry" | "retriesCount" | "retriesStatusChange" | "resolution" | "tooltips"> & {
     groupOrder?: number;
 };
 export type ReportResolutionGroup = {

package/dist/store.d.ts

@@ -7,6 +7,7 @@ export interface TestResultRelatedData {
     attachmentsByTrId: Map<string, AttachmentLink[]>;
     fixturesByTrId: Map<string, TestFixtureResult[]>;
     historyByTrId: Map<string, HistoryTestResult[] | undefined>;
+    resolutionIssuesByTrId?: Map<string, ResolutionIssue | undefined>;
     retriesByTrId: Map<string, TestResult[]>;
 }
 export interface AllureStore {

package/dist/utils/summary.d.ts

@@ -1,6 +1,11 @@
-import { AllureCheckResult, type AllureHistory, type CiDescriptor, type TestResult } from "@allurereport/core-api";
-import type { PluginSummary, SummaryCheckResult, TestResultRegistry, TestResultSummary } from "../plugin.js";
+import { AllureCheckResult, type AllureHistory, type CiDescriptor, type TestResult, type TestStatus } from "@allurereport/core-api";
+import type { ExitCode, PluginSummary, SummaryCheckResult, TestResultRegistry, TestResultSummary } from "../plugin.js";
 import type { AllureStore } from "../store.js";
+export declare const resolveReportStatus: (params: {
+    globalErrorsCount: number;
+    exitCode?: ExitCode;
+    testStatuses: TestStatus[];
+}) => TestStatus;
 export declare const convertToTestResultSummary: (tr: TestResult) => TestResultSummary;
 export declare const createTestResultRegistry: (testResults: TestResult[]) => TestResultRegistry;
 export declare const convertToSummaryCheckResult: (check: AllureCheckResult) => SummaryCheckResult;

package/dist/utils/summary.js

@@ -1,4 +1,14 @@
 import { getWorstStatus, } from "@allurereport/core-api";
+export const resolveReportStatus = (params) => {
+    if (params.globalErrorsCount > 0) {
+        return "failed";
+    }
+    const code = params.exitCode?.actual ?? params.exitCode?.original;
+    if (code !== undefined && code !== 0) {
+        return "failed";
+    }
+    return getWorstStatus(params.testStatuses) ?? "passed";
+};
 export const convertToTestResultSummary = (tr) => ({
     id: tr.id,
     name: tr.name,
@@ -43,11 +53,17 @@ export const createPluginSummary = async (params) => {
     const retryTrs = allTrs.filter(({ retryHash }) => retryHash && retryHashesWithRetries.has(retryHash));
     const flakyTrs = allTrs.filter((tr) => !!tr?.flaky);
     const duration = calculateRunDuration(allTrs);
-    const worstStatus = getWorstStatus(allTrs.map(({ status }) => status));
+    const exitCode = await store.globalExitCode();
+    const globalErrors = await store.allGlobalErrors();
+    const status = resolveReportStatus({
+        globalErrorsCount: globalErrors.length,
+        exitCode,
+        testStatuses: allTrs.map(({ status: testStatus }) => testStatus),
+    });
     const createdAt = allTrs.reduce((acc, { stop }) => Math.max(acc, stop || 0), 0);
     return {
         stats: await store.testsStatistic(filter),
-        status: worstStatus ?? "passed",
+        status,
         newTests: newTrs.filter(({ id }) => currentIds.has(id)).map(({ id }) => id),
         flakyTests: flakyTrs.map(({ id }) => id),
         retryTests: retryTrs.map(({ id }) => id),
@@ -55,6 +71,8 @@ export const createPluginSummary = async (params) => {
         name,
         duration,
         createdAt,
+        ...(exitCode ? { exitCode } : {}),
+        ...(globalErrors.length > 0 ? { globalErrorsCount: globalErrors.length } : {}),
         ...(filter ? { filtered: true } : {}),
         plugin,
         meta,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-api",
-  "version": "3.20.0",
+  "version": "3.21.0",
   "description": "Allure Plugin API",
   "keywords": [
     "allure"
@@ -25,16 +25,19 @@
     "build": "run clean && tsc --project ./tsconfig.json",
     "clean": "rimraf ./dist",
     "test": "rimraf ./out && vitest run",
+    "test:unit": "yarn test",
     "lint": "oxlint --import-plugin src test features stories",
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.20.0",
+    "@allurereport/core-api": "3.21.0",
     "tar-stream": "3.1.7"
   },
   "devDependencies": {
+    "@allurereport/test-config": "3.21.0",
     "@types/node": "^20",
     "@types/tar-stream": "^3.1.4",
+    "@vitest/coverage-istanbul": "^4.1.0",
     "@vitest/runner": "^2",
     "@vitest/snapshot": "^5.0.1",
     "allure-js-commons": "^3",