allure 3.14.2 → 3.15.0

package/README.md

@@ -165,7 +165,7 @@ npx allure --version
 
 ## Configuration
 
-Allure 3 uses an `allurerc.mjs` or `allurerc.js` configuration file to manage report settings, including the report name, output directory, and plugin options.
+Allure 3 uses an `allurerc.ts`, `allurerc.mts`, `allurerc.cts`, `allurerc.mjs`, or `allurerc.js` configuration file to manage report settings, including the report name, output directory, and plugin options.
 
 > [!TIP]
 > We recommend using the **Awesome** plugin for the best experience.  
@@ -193,6 +193,21 @@ export default defineConfig({
 
 In this example, the generated report is named *Allure Report Example* and saved to the `./out/allure-report` directory. The **Awesome** plugin is enabled with options to produce a single-file HTML report in English.
 
+### TypeScript Configuration File
+
+TypeScript configuration files are loaded directly by the Allure CLI, so you don't need to precompile them or install `tsx` or `ts-node`.
+
+```ts
+import type { AllureConfig } from "allure";
+
+export default {
+  name: "Allure Report Example",
+  output: "./out/allure-report",
+} satisfies AllureConfig;
+```
+
+For editor type checking, make sure the `allure` package is available to your project, for example as a local dev dependency. If you run Allure only as a global CLI, you can still use a TypeScript config without importing from `allure`.
+
 ### Configuration Options
 
 The configuration file allows you to fine-tune report generation. Key options include:
@@ -217,11 +232,11 @@ For example, setting `"reportLanguage": "fr"` will render the report interface i
 
 ### Declarative configuration format
 
-You can also use `allurerc.json` or `allurerc.yaml` files as a declarative way to configure Allure 3.
+You can also use `allurerc.json`, `allurerc.yaml`, or `allurerc.yml` files as a declarative way to configure Allure 3.
 
 > [!WARNING]  
 > Declarative formats don't support advanced features such as tests filtering or environments.
-> If you need these features, please consider using the `allurerc.mjs` or `allurerc.js` files.
+> If you need these features, please consider using the `allurerc.ts`, `allurerc.mts`, `allurerc.cts`, `allurerc.mjs`, or `allurerc.js` files.
 
 ## Official CI/CD Integrations
 

package/dist/commands/allure2.js

@@ -34,7 +34,7 @@ export class Allure2Command extends Command {
             description: "The path to history file",
         });
         this.knownIssues = Option.String("--known-issues", {
-            description: "Path to the known issues file. Updates the file and quarantines failed tests when specified",
+            description: "Path to known issues file",
         });
     }
     async execute() {

package/dist/commands/awesome.js

@@ -40,7 +40,7 @@ export class AwesomeCommand extends Command {
             description: "The path to history file",
         });
         this.knownIssues = Option.String("--known-issues", {
-            description: "Path to the known issues file. Updates the file and quarantines failed tests when specified",
+            description: "Path to known issues file",
         });
         this.groupBy = Option.String("--group-by,-g", {
             description: "Group test results by labels. The labels should be separated by commas",

package/dist/commands/classic.js

@@ -34,7 +34,7 @@ export class ClassicCommand extends Command {
             description: "The path to history file",
         });
         this.knownIssues = Option.String("--known-issues", {
-            description: "Path to the known issues file. Updates the file and quarantines failed tests when specified",
+            description: "Path to known issues file",
         });
     }
     async execute() {

package/dist/commands/commons/run.d.ts

@@ -6,6 +6,7 @@ export type TestProcessResult = {
     stdout: string;
     stderr: string;
     qualityGateResults: QualityGateValidationResult[];
+    fastFailed: boolean;
 };
 export type RunLogsMode = "pipe" | "inherit" | "ignore";
 export declare const executeNestedAllureCommand: (params: {

package/dist/commands/commons/run.js

@@ -7,6 +7,7 @@ import process from "node:process";
 import { QualityGateState, stringifyQualityGateResults } from "@allurereport/core";
 import { createTestPlan } from "@allurereport/core-api";
 import { allureResultsDirectoriesWatcher, delayedFileProcessingWatcher, newFilesInDirectoryWatcher, } from "@allurereport/directory-watcher";
+import { formatProcessLogAttachmentName } from "@allurereport/plugin-agent";
 import { BufferResultFile, PathResultFile } from "@allurereport/reader-api";
 import { KnownError } from "@allurereport/service";
 import { red } from "yoctocolors";
@@ -68,10 +69,14 @@ export const runTests = async (params) => {
     const qualityGateState = new QualityGateState();
     let qualityGateUnsub;
     let qualityGateResults = [];
+    let fastFailTriggered = false;
     let testProcessStdout = "";
     let testProcessStderr = "";
     if (withQualityGate) {
         qualityGateUnsub = allureReport.realtimeSubscriber.onTestResults(async (testResults) => {
+            if (fastFailTriggered) {
+                return;
+            }
             const trs = await Promise.all(testResults.map((tr) => allureReport.store.testResultById(tr)));
             const filteredTrs = trs.filter((tr) => tr !== undefined);
             if (!filteredTrs.length) {
@@ -86,8 +91,10 @@ export const runTests = async (params) => {
             if (!fastFailed) {
                 return;
             }
-            allureReport.realtimeDispatcher.sendQualityGateResults(results);
+            qualityGateUnsub?.();
+            fastFailTriggered = true;
             qualityGateResults = results;
+            qualityGateUnsub = undefined;
             try {
                 await stopProcessTree(testProcess.pid);
             }
@@ -137,6 +144,7 @@ export const runTests = async (params) => {
         stdout: testProcessStdout,
         stderr: testProcessStderr,
         qualityGateResults,
+        fastFailed: fastFailTriggered,
     };
 };
 export const executeAllureRun = async (params) => {
@@ -162,8 +170,13 @@ export const executeAllureRun = async (params) => {
             withQualityGate,
             logProcessExit,
         });
-        for (let rerun = 0; rerun < maxRerun; rerun++) {
-            const failed = await allureReport.store.failedTestResults();
+        const allFailuresAfterInitialRun = await allureReport.store.failedTestResults();
+        const blockingFailuresAfterInitialRun = await allureReport.store.blockingFailedTestResults();
+        if (allFailuresAfterInitialRun.length > 0 && blockingFailuresAfterInitialRun.length === 0 && testProcessResult) {
+            globalExitCode.actual = 0;
+        }
+        for (let rerun = 0; rerun < maxRerun && testProcessResult && !testProcessResult.fastFailed; rerun++) {
+            const failed = await allureReport.store.blockingFailedTestResults();
             if (failed.length === 0) {
                 console.log("no failed tests is detected.");
                 break;
@@ -194,6 +207,11 @@ export const executeAllureRun = async (params) => {
             await rm(tmpDir, { recursive: true });
             logTests(await allureReport.store.allTestResults());
         }
+        const allFailuresAfterReruns = await allureReport.store.failedTestResults();
+        const blockingFailuresAfterReruns = await allureReport.store.blockingFailedTestResults();
+        if (allFailuresAfterReruns.length > 0 && blockingFailuresAfterReruns.length === 0 && testProcessResult) {
+            globalExitCode.actual = 0;
+        }
         const trs = await allureReport.store.allTestResults({ includeRetries: false });
         qualityGateResults = testProcessResult?.qualityGateResults ?? [];
         if (withQualityGate && !qualityGateResults.length) {
@@ -235,13 +253,13 @@ export const executeAllureRun = async (params) => {
         const fileName = randomUUID();
         const stdoutResultFile = new BufferResultFile(Buffer.from(testProcessResult.stdout, "utf8"), `${fileName}`);
         stdoutResultFile.contentType = "text/plain";
-        allureReport.realtimeDispatcher.sendGlobalAttachment(stdoutResultFile, "stdout.txt");
+        allureReport.realtimeDispatcher.sendGlobalAttachment(stdoutResultFile, formatProcessLogAttachmentName([command, ...commandArgs].join(" "), "stdout"));
     }
     if (!ignoreLogs && testProcessResult?.stderr) {
         const fileName = randomUUID();
         const stderrResultFile = new BufferResultFile(Buffer.from(testProcessResult.stderr, "utf8"), fileName);
         stderrResultFile.contentType = "text/plain";
-        allureReport.realtimeDispatcher.sendGlobalAttachment(stderrResultFile, "stderr.txt");
+        allureReport.realtimeDispatcher.sendGlobalAttachment(stderrResultFile, formatProcessLogAttachmentName([command, ...commandArgs].join(" "), "stderr"));
         if (processFailed) {
             allureReport.realtimeDispatcher.sendGlobalError({
                 message: "Test process has failed",

package/dist/commands/csv.js

@@ -29,7 +29,7 @@ export class CsvCommand extends Command {
             description: "The csv separator",
         });
         this.knownIssues = Option.String("--known-issues", {
-            description: "Path to the known issues file. Updates the file and quarantines failed tests when specified",
+            description: "Path to known issues file",
         });
     }
     async execute() {

package/dist/commands/generate.d.ts

@@ -12,5 +12,6 @@ export declare class GenerateCommand extends Command {
     port: string | undefined;
     historyLimit: string | undefined;
     hideLabels: string[] | undefined;
+    knownIssues: string | undefined;
     execute(): Promise<void>;
 }

package/dist/commands/generate.js

@@ -38,6 +38,9 @@ export class GenerateCommand extends Command {
         this.hideLabels = Option.Array("--hide-labels", {
             description: "Hide labels by exact name in generated reports. Repeat the option for multiple labels",
         });
+        this.knownIssues = Option.String("--known-issues", {
+            description: "Path to known issues file",
+        });
     }
     async execute() {
         const cwd = this.cwd ?? processCwd();
@@ -48,7 +51,8 @@ export class GenerateCommand extends Command {
             open: this.open,
             port: this.port,
             hideLabels,
-            historyLimit: this.historyLimit ? parseInt(this.historyLimit, 10) : undefined,
+            historyLimit: this.historyLimit !== undefined ? parseInt(this.historyLimit, 10) : undefined,
+            knownIssuesPath: this.knownIssues,
         });
         await generate({
             dump: this.dump,

package/dist/commands/index.d.ts

@@ -7,7 +7,6 @@ export * from "./awesome.js";
 export * from "./csv.js";
 export * from "./check.js";
 export * from "./history.js";
-export * from "./knownIssue.js";
 export * from "./run.js";
 export * from "./slack.js";
 export * from "./testplan.js";

package/dist/commands/index.js

@@ -7,7 +7,6 @@ export * from "./awesome.js";
 export * from "./csv.js";
 export * from "./check.js";
 export * from "./history.js";
-export * from "./knownIssue.js";
 export * from "./run.js";
 export * from "./slack.js";
 export * from "./testplan.js";

package/dist/commands/qualityGate.js

@@ -32,7 +32,7 @@ export class QualityGateCommand extends Command {
             validator: typanion.isNumber(),
         });
         this.knownIssues = Option.String("--known-issues", {
-            description: "Path to the known issues file. Updates the file and quarantines failed tests when specified",
+            description: "Path to known issues file",
         });
         this.environment = environmentOption();
         this.environmentName = environmentNameOption();
@@ -47,9 +47,9 @@ export class QualityGateCommand extends Command {
         };
         normalizeCommandEnvironmentOptions(environmentOptions);
         const cwd = await realpath(this.cwd ?? processCwd());
-        const { maxFailures, minTestsCount, successRate, fastFail, knownIssues: knownIssuesPath } = this;
+        const { maxFailures, minTestsCount, successRate, fastFail } = this;
         const config = await readConfig(cwd, this.config, {
-            knownIssuesPath,
+            knownIssuesPath: this.knownIssues,
         });
         const resolvedEnvironment = resolveCommandEnvironment(config, environmentOptions);
         const rules = {};

package/dist/commands/run.d.ts

@@ -16,6 +16,7 @@ export declare class RunCommand extends Command {
     environmentName: string | undefined;
     historyLimit: string | undefined;
     hideLabels: string[] | undefined;
+    knownIssues: string | undefined;
     commandToRun: string[];
     get logs(): "pipe" | "inherit" | "ignore";
     execute(): Promise<void>;

package/dist/commands/run.js

@@ -49,6 +49,9 @@ export class RunCommand extends Command {
         this.hideLabels = Option.Array("--hide-labels", {
             description: "Hide labels by exact name in generated reports. Repeat the option for multiple labels",
         });
+        this.knownIssues = Option.String("--known-issues", {
+            description: "Path to known issues file",
+        });
         this.commandToRun = Option.Rest();
     }
     get logs() {
@@ -94,7 +97,8 @@ export class RunCommand extends Command {
             open: this.open,
             port: this.port,
             hideLabels,
-            historyLimit: this.historyLimit ? parseInt(this.historyLimit, 10) : undefined,
+            historyLimit: this.historyLimit !== undefined ? parseInt(this.historyLimit, 10) : undefined,
+            knownIssuesPath: this.knownIssues,
         });
         const resolvedEnvironment = resolveCommandEnvironment(config, environmentOptions);
         const withRerun = maxRerun > 0;

package/dist/commands/watch.d.ts

@@ -9,5 +9,6 @@ export declare class WatchCommand extends Command {
     reportName: string | undefined;
     open: boolean | undefined;
     port: string | undefined;
+    preserve: boolean | undefined;
     execute(): Promise<void>;
 }

package/dist/commands/watch.js

@@ -37,6 +37,9 @@ export class WatchCommand extends Command {
         this.port = Option.String("--port", {
             description: "The port to serve the reports on (default: random port)",
         });
+        this.preserve = Option.Boolean("--preserve", {
+            description: "Don't clear terminal output on the data refresh",
+        });
     }
     async execute() {
         const cwd = await realpath(this.cwd ?? process.cwd());
@@ -93,7 +96,7 @@ export class WatchCommand extends Command {
                     id: "watch log",
                     enabled: true,
                     options: {},
-                    plugin: new ProgressPlugin(),
+                    plugin: new ProgressPlugin({ preserve: this.preserve }),
                 },
                 {
                     id: "server reload",

package/dist/index.js

@@ -1,7 +1,7 @@
 import { readFileSync } from "node:fs";
 import process, { argv } from "node:process";
 import { Builtins, Cli } from "clipanion";
-import { AgentCommand, AGENT_TASK_MAP_HELP, AgentCapabilitiesCommand, AgentInspectCommand, AgentLatestCommand, AgentQueryCommand, AgentSelectCommand, AgentStateDirCommand, Allure2Command, AwesomeCommand, CheckCommand, ClassicCommand, CsvCommand, DashboardCommand, GenerateCommand, HistoryCommand, JiraClearCommand, KnownIssueCommand, LogCommand, OpenCommand, QualityGateCommand, ResultsPackCommand, ResultsUnpackCommand, RunCommand, SlackCommand, TestPlanCommand, WatchCommand, isAgentTaskMapHelpRequest, } from "./commands/index.js";
+import { AgentCommand, AGENT_TASK_MAP_HELP, AgentCapabilitiesCommand, AgentInspectCommand, AgentLatestCommand, AgentQueryCommand, AgentSelectCommand, AgentStateDirCommand, Allure2Command, AwesomeCommand, CheckCommand, ClassicCommand, CsvCommand, DashboardCommand, GenerateCommand, HistoryCommand, JiraClearCommand, LogCommand, OpenCommand, QualityGateCommand, ResultsPackCommand, ResultsUnpackCommand, RunCommand, SlackCommand, TestPlanCommand, WatchCommand, isAgentTaskMapHelpRequest, } from "./commands/index.js";
 const [node, app, ...args] = argv;
 const pkg = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
 const cli = new Cli({
@@ -25,7 +25,6 @@ cli.register(DashboardCommand);
 cli.register(GenerateCommand);
 cli.register(HistoryCommand);
 cli.register(JiraClearCommand);
-cli.register(KnownIssueCommand);
 cli.register(LogCommand);
 cli.register(OpenCommand);
 cli.register(QualityGateCommand);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "allure",
-  "version": "3.14.2",
+  "version": "3.15.0",
   "description": "Allure Commandline Tool",
   "keywords": [
     "allure",
@@ -32,33 +32,33 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/charts-api": "3.14.2",
-    "@allurereport/ci": "3.14.2",
-    "@allurereport/core": "3.14.2",
-    "@allurereport/core-api": "3.14.2",
-    "@allurereport/directory-watcher": "3.14.2",
-    "@allurereport/plugin-agent": "3.14.2",
-    "@allurereport/plugin-allure2": "3.14.2",
-    "@allurereport/plugin-api": "3.14.2",
-    "@allurereport/plugin-awesome": "3.14.2",
-    "@allurereport/plugin-classic": "3.14.2",
-    "@allurereport/plugin-csv": "3.14.2",
-    "@allurereport/plugin-dashboard": "3.14.2",
-    "@allurereport/plugin-jira": "3.14.2",
-    "@allurereport/plugin-log": "3.14.2",
-    "@allurereport/plugin-progress": "3.14.2",
-    "@allurereport/plugin-server-reload": "3.14.2",
-    "@allurereport/plugin-slack": "3.14.2",
-    "@allurereport/reader-api": "3.14.2",
-    "@allurereport/service": "3.14.2",
-    "@allurereport/static-server": "3.14.2",
-    "adm-zip": "^0.5.16",
+    "@allurereport/charts-api": "3.15.0",
+    "@allurereport/ci": "3.15.0",
+    "@allurereport/core": "3.15.0",
+    "@allurereport/core-api": "3.15.0",
+    "@allurereport/directory-watcher": "3.15.0",
+    "@allurereport/plugin-agent": "3.15.0",
+    "@allurereport/plugin-allure2": "3.15.0",
+    "@allurereport/plugin-api": "3.15.0",
+    "@allurereport/plugin-awesome": "3.15.0",
+    "@allurereport/plugin-classic": "3.15.0",
+    "@allurereport/plugin-csv": "3.15.0",
+    "@allurereport/plugin-dashboard": "3.15.0",
+    "@allurereport/plugin-jira": "3.15.0",
+    "@allurereport/plugin-log": "3.15.0",
+    "@allurereport/plugin-progress": "3.15.0",
+    "@allurereport/plugin-server-reload": "3.15.0",
+    "@allurereport/plugin-slack": "3.15.0",
+    "@allurereport/reader-api": "3.15.0",
+    "@allurereport/service": "3.15.0",
+    "@allurereport/static-server": "3.15.0",
+    "adm-zip": "^0.6.0",
     "clipanion": "^4.0.0-rc.4",
     "glob": "^13.0.6",
     "lodash.omit": "^4.18.0",
     "prompts": "^2.4.2",
     "typanion": "^3.14.0",
-    "yoctocolors": "^2.1.1"
+    "yoctocolors": "^2.1.2"
   },
   "devDependencies": {
     "@types/adm-zip": "^0",

package/dist/commands/knownIssue.d.ts

@@ -1,8 +0,0 @@
-import { Command } from "clipanion";
-export declare class KnownIssueCommand extends Command {
-    static paths: string[][];
-    static usage: import("clipanion").Usage;
-    resultsDir: string[];
-    output: string | undefined;
-    execute(): Promise<void>;
-}

package/dist/commands/knownIssue.js

@@ -1,59 +0,0 @@
-import * as console from "node:console";
-import { resolve } from "node:path";
-import process, { exit } from "node:process";
-import { AllureReport, resolveConfig, writeKnownIssues } from "@allurereport/core";
-import { Command, Option } from "clipanion";
-import { red } from "yoctocolors";
-import { findAllureResultDirectories } from "../utils/fileSystem.js";
-export class KnownIssueCommand extends Command {
-    constructor() {
-        super(...arguments);
-        this.resultsDir = Option.Rest({
-            name: "Patterns to match test results directories in the current working directory (default: ./**/allure-results)",
-        });
-        this.output = Option.String("--output,-o", {
-            description: "The output file name. Absolute paths are accepted as well",
-        });
-    }
-    async execute() {
-        const { resultDirectories, patterns } = await findAllureResultDirectories(process.cwd(), this.resultsDir);
-        if (!resultDirectories.length) {
-            console.error(red(`No test results directories found matching pattern: ${patterns}`));
-            exit(1);
-            return;
-        }
-        const outputPath = this.output ?? "known-issues.json";
-        const config = await resolveConfig({
-            plugins: {},
-        });
-        const allureReport = new AllureReport(config);
-        await allureReport.start();
-        for (const directory of resultDirectories) {
-            await allureReport.readDirectory(directory);
-        }
-        await allureReport.done();
-        const targetPath = resolve(outputPath);
-        await writeKnownIssues(allureReport.store, outputPath);
-        console.log(`writing known-issues.json to ${targetPath}`);
-    }
-}
-KnownIssueCommand.paths = [["known-issue"]];
-KnownIssueCommand.usage = Command.Usage({
-    description: "Generates a known issue list",
-    details: "This command generates a known issue list from the provided Allure Results directory.",
-    examples: [
-        ["known-issue ./allure-results", "Generate a known issue list from the ./allure-results directory"],
-        [
-            "known-issue ./allure-results --output custom-issues.json",
-            "Generate a known issue list from the ./allure-results directory to the custom-issues.json file",
-        ],
-        [
-            "known-issue ./packages/*/allure-results",
-            "Generate a known issue list from all Allure result directories matching the pattern",
-        ],
-        [
-            "known-issue ./packages/foo/allure-results ./packages/bar/allure-results",
-            "Generate a known issue list from two Allure result directories",
-        ],
-    ],
-});