allure 3.0.1 → 3.2.0

package/dist/commands/csv.js

@@ -4,6 +4,7 @@ import { Command, Option } from "clipanion";
 import * as console from "node:console";
 import { existsSync } from "node:fs";
 import { realpath } from "node:fs/promises";
+import { isAbsolute, join } from "node:path";
 import process, { exit } from "node:process";
 import { red } from "yoctocolors";
 export class CsvCommand extends Command {
@@ -40,9 +41,9 @@ export class CsvCommand extends Command {
         const defaultCsvOptions = {
             separator: this.separator ?? ",",
             disableHeaders: this.disableHeaders ?? false,
+            fileName: this.output && isAbsolute(this.output) ? this.output : this.output ? join(cwd, this.output) : undefined,
         };
         const config = await readConfig(cwd, this.config, {
-            output: this.output ?? "allure.csv",
             knownIssuesPath: this.knownIssues,
         });
         config.plugins = [

package/dist/commands/generate.js

@@ -75,7 +75,7 @@ GenerateCommand.usage = Command.Usage({
         ],
         [
             "generate --stage=allure-*.zip",
-            "Generate a report using data from any stage archive that matches the given pattern only (ignoring results directories)",
+            "Generate a report using data from any stage 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.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) {
@@ -161,7 +163,7 @@ export class RunCommand extends Command {
         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.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", {
@@ -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",

package/dist/commands/watch.d.ts

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

package/dist/commands/watch.js

@@ -28,6 +28,9 @@ export class WatchCommand extends Command {
         this.reportName = Option.String("--report-name,--name", {
             description: "The report name (default: Allure Report)",
         });
+        this.open = Option.Boolean("--open", {
+            description: "Open the report in the default browser after generation (default: false)",
+        });
         this.port = Option.String("--port", {
             description: "The port to serve the reports on (default: random port)",
         });
@@ -46,6 +49,8 @@ export class WatchCommand extends Command {
         const config = await readConfig(this.cwd, this.config, {
             output: this.output,
             name: this.reportName,
+            open: this.open,
+            port: this.port,
         });
         try {
             await rm(config.output, { recursive: true });
@@ -71,7 +76,9 @@ export class WatchCommand extends Command {
                         {
                             id: "awesome",
                             enabled: true,
-                            options: {},
+                            options: {
+                                open: config.open,
+                            },
                             plugin: new Awesome({
                                 reportName: config.name,
                             }),
@@ -102,9 +109,6 @@ export class WatchCommand extends Command {
         if (pluginIdToOpen) {
             await server.open(join(server.url, pluginIdToOpen));
         }
-        else {
-            await server.open(server.url);
-        }
         console.info("Press Ctrl+C to exit");
         process.on("SIGINT", async () => {
             console.log("");

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.0.1",
+  "version": "3.2.0",
   "description": "Allure Commandline Tool",
   "keywords": [
     "allure",
@@ -32,25 +32,25 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@allurereport/charts-api": "3.0.1",
-    "@allurereport/ci": "3.0.1",
-    "@allurereport/core": "3.0.1",
-    "@allurereport/core-api": "3.0.1",
-    "@allurereport/directory-watcher": "3.0.1",
-    "@allurereport/plugin-allure2": "3.0.1",
-    "@allurereport/plugin-api": "3.0.1",
-    "@allurereport/plugin-awesome": "3.0.1",
-    "@allurereport/plugin-classic": "3.0.1",
-    "@allurereport/plugin-csv": "3.0.1",
-    "@allurereport/plugin-dashboard": "3.0.1",
-    "@allurereport/plugin-jira": "3.0.1",
-    "@allurereport/plugin-log": "3.0.1",
-    "@allurereport/plugin-progress": "3.0.1",
-    "@allurereport/plugin-server-reload": "3.0.1",
-    "@allurereport/plugin-slack": "3.0.1",
-    "@allurereport/reader-api": "3.0.1",
-    "@allurereport/service": "3.0.1",
-    "@allurereport/static-server": "3.0.1",
+    "@allurereport/charts-api": "3.2.0",
+    "@allurereport/ci": "3.2.0",
+    "@allurereport/core": "3.2.0",
+    "@allurereport/core-api": "3.2.0",
+    "@allurereport/directory-watcher": "3.2.0",
+    "@allurereport/plugin-allure2": "3.2.0",
+    "@allurereport/plugin-api": "3.2.0",
+    "@allurereport/plugin-awesome": "3.2.0",
+    "@allurereport/plugin-classic": "3.2.0",
+    "@allurereport/plugin-csv": "3.2.0",
+    "@allurereport/plugin-dashboard": "3.2.0",
+    "@allurereport/plugin-jira": "3.2.0",
+    "@allurereport/plugin-log": "3.2.0",
+    "@allurereport/plugin-progress": "3.2.0",
+    "@allurereport/plugin-server-reload": "3.2.0",
+    "@allurereport/plugin-slack": "3.2.0",
+    "@allurereport/reader-api": "3.2.0",
+    "@allurereport/service": "3.2.0",
+    "@allurereport/static-server": "3.2.0",
     "adm-zip": "^0.5.16",
     "clipanion": "^4.0.0-rc.4",
     "glob": "^11.1.0",