allure 3.1.0 → 3.3.1

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

@@ -3,5 +3,5 @@ export declare const generate: (params: {
     cwd: string;
     config: FullConfig;
     resultsDir: string;
-    stage?: string[];
+    dump?: string[];
 }) => Promise<void>;

package/dist/commands/commons/generate.js

@@ -5,21 +5,21 @@ import { exit } from "node:process";
 import { red } from "yoctocolors";
 import { logError } from "../../utils/logs.js";
 export const generate = async (params) => {
-    const stageDumpFiles = [];
+    const dumpFiles = [];
     const resultsDirectories = [];
-    if (params?.stage?.length) {
-        for (const stage of params.stage) {
-            const matchedFiles = await glob(stage, {
+    if (params?.dump?.length) {
+        for (const dump of params.dump) {
+            const matchedFiles = await glob(dump, {
                 nodir: true,
                 dot: true,
                 absolute: true,
                 windowsPathsNoEscape: true,
                 cwd: params.cwd,
             });
-            stageDumpFiles.push(...matchedFiles);
+            dumpFiles.push(...matchedFiles);
         }
     }
-    if (!!params?.resultsDir || stageDumpFiles.length === 0) {
+    if (!!params?.resultsDir || dumpFiles.length === 0) {
         const matchedDirs = (await glob(params.resultsDir, {
             mark: true,
             nodir: false,
@@ -30,14 +30,14 @@ export const generate = async (params) => {
         })).filter((p) => /(\/|\\)$/.test(p));
         resultsDirectories.push(...matchedDirs);
     }
-    if (resultsDirectories.length === 0 && stageDumpFiles.length === 0) {
+    if (resultsDirectories.length === 0 && dumpFiles.length === 0) {
         console.error(red(`No test results directories found matching pattern: ${params.resultsDir}`));
         exit(1);
         return;
     }
     try {
         const allureReport = new AllureReport(params.config);
-        await allureReport.restoreState(Array.from(stageDumpFiles));
+        await allureReport.restoreState(Array.from(dumpFiles));
         await allureReport.start();
         for (const dir of resultsDirectories) {
             await allureReport.readDirectory(dir);

package/dist/commands/generate.d.ts

@@ -7,7 +7,7 @@ export declare class GenerateCommand extends Command {
     output: string | undefined;
     cwd: string | undefined;
     reportName: string | undefined;
-    stage: string[] | undefined;
+    dump: string[] | undefined;
     open: boolean | undefined;
     port: string | undefined;
     historyLimit: string | undefined;

package/dist/commands/generate.js

@@ -22,8 +22,8 @@ export class GenerateCommand extends Command {
         this.reportName = Option.String("--report-name,--name", {
             description: "The report name (default: Allure Report)",
         });
-        this.stage = Option.Array("--stage", {
-            description: "Stages archives to restore state from (default: empty string)",
+        this.dump = Option.Array("--dump", {
+            description: "Dump archives to restore state from (default: empty string)",
         });
         this.open = Option.Boolean("--open", {
             description: "Open the report in the default browser after generation (default: false)",
@@ -45,7 +45,7 @@ export class GenerateCommand extends Command {
             historyLimit: this.historyLimit ? parseInt(this.historyLimit, 10) : undefined,
         });
         await generate({
-            stage: this.stage,
+            dump: this.dump,
             resultsDir: this.resultsDir ?? "./**/allure-results",
             cwd,
             config,
@@ -70,12 +70,12 @@ GenerateCommand.usage = Command.Usage({
             "Generate a report from the ./allure-results directory to the custom-report directory",
         ],
         [
-            "generate --stage=windows.zip --stage=macos.zip ./allure-results",
+            "generate --dump=windows.zip --dump=macos.zip ./allure-results",
             "Generate a report using data from windows.zip and macos.zip archives and using results from the ./allure-results directory",
         ],
         [
-            "generate --stage=allure-*.zip",
-            "Generate a report using data from any stage archive that matches the given pattern only (ignoring results directories)",
+            "generate --dump=allure-*.zip",
+            "Generate a report using data from any dump archive that matches the given pattern and results directory if it exists",
         ],
     ],
 });

package/dist/commands/qualityGate.d.ts

@@ -9,6 +9,7 @@ export declare class QualityGateCommand extends Command {
     minTestsCount: number | undefined;
     successRate: number | undefined;
     knownIssues: string | undefined;
+    environment: string | undefined;
     cwd: string | undefined;
     execute(): Promise<void>;
 }

package/dist/commands/qualityGate.js

@@ -34,6 +34,9 @@ export class QualityGateCommand extends Command {
         this.knownIssues = Option.String("--known-issues", {
             description: "Path to the known issues file. Updates the file and quarantines failed tests when specified",
         });
+        this.environment = Option.String("--environment,--env", {
+            description: "Force specific environment to all tests in the run. Given environment has higher priority than the one defined in the config file (default: empty string)",
+        });
         this.cwd = Option.String("--cwd", {
             description: "The working directory for the command to run (default: current working directory)",
         });
@@ -41,7 +44,7 @@ export class QualityGateCommand extends Command {
     async execute() {
         const cwd = await realpath(this.cwd ?? processCwd());
         const resultsDir = (this.resultsDir ?? "./**/allure-results").replace(/[\\/]$/, "");
-        const { maxFailures, minTestsCount, successRate, fastFail, knownIssues: knownIssuesPath } = this;
+        const { maxFailures, minTestsCount, successRate, fastFail, knownIssues: knownIssuesPath, environment } = this;
         const config = await readConfig(cwd, this.config, {
             knownIssuesPath,
         });
@@ -91,6 +94,7 @@ export class QualityGateCommand extends Command {
             const notHiddenTrs = trs.filter((tr) => !tr.hidden);
             const { results, fastFailed } = await allureReport.validate({
                 trs: notHiddenTrs,
+                environment,
                 knownIssues,
                 state,
             });
@@ -109,6 +113,7 @@ export class QualityGateCommand extends Command {
         const validationResults = await allureReport.validate({
             trs: allTrs,
             knownIssues,
+            environment,
         });
         if (validationResults.results.length === 0) {
             exit(0);

package/dist/commands/run.d.ts

@@ -18,7 +18,7 @@ export declare class RunCommand extends Command {
     rerun: string | undefined;
     silent: boolean | undefined;
     ignoreLogs: boolean | undefined;
-    stage: string | undefined;
+    dump: string | undefined;
     environment: string | undefined;
     historyLimit: string | undefined;
     commandToRun: string[];

package/dist/commands/run.js

@@ -7,6 +7,7 @@ import { KnownError } from "@allurereport/service";
 import { serve } from "@allurereport/static-server";
 import { Command, Option } from "clipanion";
 import * as console from "node:console";
+import { randomUUID } from "node:crypto";
 import { mkdtemp, realpath, rm, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
 import { join, resolve } from "node:path";
@@ -16,7 +17,7 @@ import { logTests, runProcess, terminationOf } from "../utils/index.js";
 import { logError } from "../utils/logs.js";
 import { stopProcessTree } from "../utils/process.js";
 const runTests = async (params) => {
-    const { allureReport, knownIssues, cwd, command, commandArgs, logs, environment, withQualityGate, silent } = params;
+    const { allureReport, knownIssues, cwd, command, commandArgs, logs, environmentVariables, environment, withQualityGate, silent, } = params;
     let testProcessStarted = false;
     const allureResultsWatchers = new Map();
     const processWatcher = delayedFileProcessingWatcher(async (path) => {
@@ -54,7 +55,7 @@ const runTests = async (params) => {
         command,
         commandArgs,
         cwd,
-        environment,
+        environmentVariables,
         logs,
     });
     const qualityGateState = new QualityGateState();
@@ -72,6 +73,7 @@ const runTests = async (params) => {
             const { results, fastFailed } = await allureReport.validate({
                 trs: filteredTrs,
                 state: qualityGateState,
+                environment,
                 knownIssues,
             });
             if (!fastFailed) {
@@ -158,10 +160,10 @@ export class RunCommand extends Command {
         this.ignoreLogs = Option.Boolean("--ignore-logs", {
             description: "Prevent logs attaching to the report (default: false)",
         });
-        this.stage = Option.String("--stage", {
-            description: "Runs tests in stage mode to collect results to a stage archive with the provided name (default: empty string)",
+        this.dump = Option.String("--dump", {
+            description: "Runs tests in dump mode to collect results to a dump archive with the provided name (default: empty string)",
         });
-        this.environment = Option.String("--environment", {
+        this.environment = Option.String("--environment,--env", {
             description: "Force specific environment to all tests in the run. Given environment has higher priority than the one defined in the config file (default: empty string)",
         });
         this.historyLimit = Option.String("--history-limit", {
@@ -215,7 +217,7 @@ export class RunCommand extends Command {
         const allureReport = new AllureReport({
             ...config,
             environment: this.environment,
-            stage: this.stage,
+            dump: this.dump,
             realTime: false,
             plugins: [
                 ...(config.plugins?.length
@@ -249,7 +251,8 @@ export class RunCommand extends Command {
                 cwd,
                 command,
                 commandArgs,
-                environment: {},
+                environment: this.environment,
+                environmentVariables: {},
                 withQualityGate,
             });
             for (let rerun = 0; rerun < maxRerun; rerun++) {
@@ -272,7 +275,8 @@ export class RunCommand extends Command {
                     cwd,
                     command,
                     commandArgs,
-                    environment: {
+                    environment: this.environment,
+                    environmentVariables: {
                         ALLURE_TESTPLAN_PATH: testPlanPath,
                         ALLURE_RERUN: `${rerun}`,
                     },
@@ -287,6 +291,7 @@ export class RunCommand extends Command {
                 const { results } = await allureReport.validate({
                     trs,
                     knownIssues,
+                    environment: this.environment,
                 });
                 qualityGateResults = results;
             }
@@ -318,14 +323,16 @@ export class RunCommand extends Command {
         }
         const processFailed = Math.abs(globalExitCode.actual ?? globalExitCode.original) !== 0;
         if (!this.ignoreLogs && testProcessResult?.stdout) {
-            const stdoutResultFile = new BufferResultFile(Buffer.from(testProcessResult.stdout, "utf8"), "stdout.txt");
+            const fileName = randomUUID();
+            const stdoutResultFile = new BufferResultFile(Buffer.from(testProcessResult.stdout, "utf8"), `${fileName}`);
             stdoutResultFile.contentType = "text/plain";
-            allureReport.realtimeDispatcher.sendGlobalAttachment(stdoutResultFile);
+            allureReport.realtimeDispatcher.sendGlobalAttachment(stdoutResultFile, "stdout.txt");
         }
         if (!this.ignoreLogs && testProcessResult?.stderr) {
-            const stderrResultFile = new BufferResultFile(Buffer.from(testProcessResult.stderr, "utf8"), "stderr.txt");
+            const fileName = randomUUID();
+            const stderrResultFile = new BufferResultFile(Buffer.from(testProcessResult.stderr, "utf8"), fileName);
             stderrResultFile.contentType = "text/plain";
-            allureReport.realtimeDispatcher.sendGlobalAttachment(stderrResultFile);
+            allureReport.realtimeDispatcher.sendGlobalAttachment(stderrResultFile, "stderr.txt");
             if (processFailed) {
                 allureReport.realtimeDispatcher.sendGlobalError({
                     message: "Test process has failed",
@@ -355,8 +362,8 @@ RunCommand.usage = Command.Usage({
         ["run -- npm run test", "Run npm run test and collect Allure results"],
         ["run --rerun 3 -- npm run test", "Run npm run test and rerun failed tests up to 3 times"],
         [
-            "run --stage=my-stage -- npm run test",
-            "Run npm run test and pack inner report state into my-stage.zip archive to restore the state in the next run",
+            "run --dump=my-dump -- npm run test",
+            "Run npm run test and pack inner report state into my-dump.zip archive to restore the state in the next run",
         ],
     ],
 });

package/dist/utils/process.d.ts

@@ -11,7 +11,7 @@ export declare const runProcess: (params: {
     command: string;
     commandArgs: string[];
     cwd: string | undefined;
-    environment?: Record<string, string>;
+    environmentVariables?: Record<string, string>;
     logs?: "pipe" | "inherit" | "ignore";
 }) => ChildProcess;
 export declare const terminationOf: (testProcess: ChildProcess) => Promise<number | null>;

package/dist/utils/process.js

@@ -5,10 +5,10 @@ import { platform } from "process";
 const IS_WIN = platform === "win32";
 const PS_OUTPUT_PATTERN = /(?<ppid>\d+)\s+(?<pid>\d+)\s+(?<comm>.*)/;
 export const runProcess = (params) => {
-    const { command, commandArgs, cwd, environment = {}, logs = "inherit" } = params;
+    const { command, commandArgs, cwd, environmentVariables = {}, logs = "inherit" } = params;
     const env = {
         ...process.env,
-        ...environment,
+        ...environmentVariables,
     };
     if (logs === "pipe") {
         Object.assign(env, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "allure",
-  "version": "3.1.0",
+  "version": "3.3.1",
   "description": "Allure Commandline Tool",
   "keywords": [
     "allure",
@@ -32,25 +32,25 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@allurereport/charts-api": "3.1.0",
-    "@allurereport/ci": "3.1.0",
-    "@allurereport/core": "3.1.0",
-    "@allurereport/core-api": "3.1.0",
-    "@allurereport/directory-watcher": "3.1.0",
-    "@allurereport/plugin-allure2": "3.1.0",
-    "@allurereport/plugin-api": "3.1.0",
-    "@allurereport/plugin-awesome": "3.1.0",
-    "@allurereport/plugin-classic": "3.1.0",
-    "@allurereport/plugin-csv": "3.1.0",
-    "@allurereport/plugin-dashboard": "3.1.0",
-    "@allurereport/plugin-jira": "3.1.0",
-    "@allurereport/plugin-log": "3.1.0",
-    "@allurereport/plugin-progress": "3.1.0",
-    "@allurereport/plugin-server-reload": "3.1.0",
-    "@allurereport/plugin-slack": "3.1.0",
-    "@allurereport/reader-api": "3.1.0",
-    "@allurereport/service": "3.1.0",
-    "@allurereport/static-server": "3.1.0",
+    "@allurereport/charts-api": "3.3.1",
+    "@allurereport/ci": "3.3.1",
+    "@allurereport/core": "3.3.1",
+    "@allurereport/core-api": "3.3.1",
+    "@allurereport/directory-watcher": "3.3.1",
+    "@allurereport/plugin-allure2": "3.3.1",
+    "@allurereport/plugin-api": "3.3.1",
+    "@allurereport/plugin-awesome": "3.3.1",
+    "@allurereport/plugin-classic": "3.3.1",
+    "@allurereport/plugin-csv": "3.3.1",
+    "@allurereport/plugin-dashboard": "3.3.1",
+    "@allurereport/plugin-jira": "3.3.1",
+    "@allurereport/plugin-log": "3.3.1",
+    "@allurereport/plugin-progress": "3.3.1",
+    "@allurereport/plugin-server-reload": "3.3.1",
+    "@allurereport/plugin-slack": "3.3.1",
+    "@allurereport/reader-api": "3.3.1",
+    "@allurereport/service": "3.3.1",
+    "@allurereport/static-server": "3.3.1",
     "adm-zip": "^0.5.16",
     "clipanion": "^4.0.0-rc.4",
     "glob": "^11.1.0",