allure 3.7.0 → 3.8.1

package/README.md

@@ -94,7 +94,7 @@ To view a previously generated report locally, the `open` command serves it in y
 npx allure open <reportDir>
 ```
 
-If you’ve defined the output directory in your configuration file, specifying `<reportDir>` is optional. By default, Allure 3 looks for a directory named `allure-report`. To open the Awesome report directly, point to the nested directory:
+When `<reportDir>` is omitted, Allure 3 uses the configured output directory, falling back to `allure-report` when no output is configured. To open the Awesome report directly, point to the nested directory:
 
 ```bash
 npx allure open allure-report/awesome

package/dist/commands/check.d.ts

@@ -0,0 +1,15 @@
+import { Command } from "clipanion";
+export declare class CheckCommand extends Command {
+    static paths: string[][];
+    static usage: import("clipanion").Usage;
+    name: string;
+    status: string | undefined;
+    message: string | undefined;
+    tag: string[] | undefined;
+    config: string | undefined;
+    cwd: string | undefined;
+    output: string | undefined;
+    dump: string | undefined;
+    commandToRun: string[];
+    execute(): Promise<void>;
+}

package/dist/commands/check.js

@@ -0,0 +1,166 @@
+import { randomUUID } from "node:crypto";
+import { mkdir, realpath, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+import process, { exit } from "node:process";
+import { AllureReport, readConfig } from "@allurereport/core";
+import { Command, Option, UsageError } from "clipanion";
+import { runProcess, terminationOf } from "../utils/index.js";
+const checkStatuses = ["passed", "failed"];
+const parseCheckStatus = (status) => {
+    if (status === undefined) {
+        return undefined;
+    }
+    if (checkStatuses.includes(status)) {
+        return status;
+    }
+    throw new UsageError(`Invalid --status value ${JSON.stringify(status)}. Expected one of: passed, failed`);
+};
+const quoteCommandArg = (arg) => {
+    if (/^[A-Za-z0-9_/:=.,@%+-]+$/.test(arg)) {
+        return arg;
+    }
+    return `'${arg.replace(/'/g, "'\\''")}'`;
+};
+const resolveCheckCommand = (args) => {
+    if (args.length === 1) {
+        return {
+            command: args[0],
+            commandArgs: [],
+            commandLine: args[0],
+            shell: true,
+        };
+    }
+    return {
+        command: args[0],
+        commandArgs: args.slice(1),
+        commandLine: args.map(quoteCommandArg).join(" "),
+        shell: false,
+    };
+};
+const buildCheckResult = (name, status, tags, command, message, error) => ({
+    name,
+    status,
+    ...(tags?.length ? { tags } : {}),
+    details: {
+        command,
+        ...(message ? { message } : {}),
+        ...(error ? { error } : {}),
+    },
+});
+const collectCheckCommandOutput = (checkProcess) => {
+    const output = {
+        stdout: "",
+        stderr: "",
+    };
+    checkProcess.stdout?.setEncoding("utf8").on?.("data", (data) => {
+        output.stdout += data;
+        process.stdout.write(data);
+    });
+    checkProcess.stderr?.setEncoding("utf8").on?.("data", (data) => {
+        output.stderr += data;
+        process.stderr.write(data);
+    });
+    return output;
+};
+const writeCheckResultFile = async (output, result) => {
+    await mkdir(output, { recursive: true });
+    await writeFile(join(output, `${randomUUID()}-check.json`), `${JSON.stringify(result)}\n`, "utf-8");
+};
+const dumpCheckResult = async (config, result, dump) => {
+    const allureReport = new AllureReport({
+        ...config,
+        dump,
+        realTime: false,
+        plugins: [],
+    });
+    await allureReport.start();
+    await allureReport.store.addCheckResult(result);
+    await allureReport.done();
+};
+export class CheckCommand extends Command {
+    constructor() {
+        super(...arguments);
+        this.name = Option.String("--name", {
+            description: "The check name",
+            required: true,
+        });
+        this.status = Option.String("--status", {
+            description: "The manual check status: passed or failed",
+        });
+        this.message = Option.String("--message", {
+            description: "The manual check message",
+        });
+        this.tag = Option.Array("--tag", {
+            description: "Add a tag to the check result. Repeat the option for multiple tags",
+        });
+        this.config = Option.String("--config,-c", {
+            description: "The path Allure config file",
+        });
+        this.cwd = Option.String("--cwd", {
+            description: "The working directory for the command to run (default: current working directory)",
+        });
+        this.output = Option.String("--output,-o", {
+            description: "The output directory name. Absolute paths are accepted as well",
+        });
+        this.dump = Option.String("--dump", {
+            description: "Write the check result to a dump archive with the provided name instead of output",
+        });
+        this.commandToRun = Option.Rest();
+    }
+    async execute() {
+        const args = this.commandToRun.filter((arg) => arg !== "--");
+        const manualStatus = parseCheckStatus(this.status);
+        if (manualStatus && args.length > 0) {
+            throw new UsageError("Use either --status for a manual check or a command after --, not both");
+        }
+        if (!manualStatus && args.length === 0) {
+            throw new UsageError("expecting --status or command to be specified after --, e.g. allure check --name Lint -- npm run lint");
+        }
+        const cwd = await realpath(this.cwd ?? process.cwd());
+        let originalExitCode = manualStatus === "failed" ? 1 : 0;
+        let status = manualStatus;
+        let commandOutput;
+        const checkCommand = args.length ? resolveCheckCommand(args) : undefined;
+        if (!status) {
+            const checkProcess = runProcess({
+                command: checkCommand.command,
+                commandArgs: checkCommand.commandArgs,
+                cwd,
+                logs: "pipe",
+                shell: checkCommand.shell,
+            });
+            commandOutput = collectCheckCommandOutput(checkProcess);
+            const code = await terminationOf(checkProcess);
+            originalExitCode = code ?? 1;
+            status = originalExitCode === 0 ? "passed" : "failed";
+        }
+        const message = (commandOutput ? commandOutput.stdout : this.message)?.trim() ?? "";
+        const error = commandOutput?.stderr?.trim() ?? "";
+        const result = buildCheckResult(this.name, status, this.tag, checkCommand?.commandLine ?? "", message, error);
+        const config = await readConfig(cwd, this.config, {
+            output: this.output,
+            plugins: {},
+        });
+        const checkConfig = {
+            ...config,
+            plugins: [],
+        };
+        if (this.dump) {
+            await dumpCheckResult(checkConfig, result, this.dump);
+        }
+        else {
+            await writeCheckResultFile(checkConfig.output, result);
+        }
+        exit(status === "passed" ? 0 : originalExitCode || 1);
+    }
+}
+CheckCommand.paths = [["check"]];
+CheckCommand.usage = Command.Usage({
+    description: "Run a check command or record a manual check result",
+    details: "This command records an Allure check result based on a command exit code or an explicit status.",
+    examples: [
+        ['check --name "Lint" -- npm run lint', "Run npm run lint and record the check result"],
+        ['check --name "Manual approval" --status passed --tag release', "Record a manual passed check result"],
+        ['check --name "Lint" --dump=checks -- npm run lint', "Store the check result in checks.zip instead of output"],
+    ],
+});

package/dist/commands/index.d.ts

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

package/dist/commands/index.js

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

package/dist/commands/open.js

@@ -12,7 +12,7 @@ export class OpenCommand extends Command {
     constructor() {
         super(...arguments);
         this.resultsDir = Option.String({
-            name: "A report to open or a pattern to match test results directories in the current working directory (default: ./allure-results)",
+            name: "A report to open or a pattern to match test results directories in the current working directory (default: configured output)",
             required: false,
         });
         this.config = Option.String("--config,-c", {
@@ -31,7 +31,10 @@ export class OpenCommand extends Command {
     async execute() {
         const cwd = this.cwd ?? processCwd();
         const hideLabels = this.hideLabels?.length ? this.hideLabels : undefined;
-        const targetFullPath = join(cwd, this.resultsDir ?? "allure-report");
+        const config = await readConfig(cwd, this.config, {
+            port: this.port,
+        });
+        const targetFullPath = this.resultsDir ? join(cwd, this.resultsDir) : config.output;
         const summaryFiles = existsSync(targetFullPath)
             ? await glob(join(targetFullPath, "**", "summary.json"), {
                 mark: true,
@@ -43,9 +46,6 @@ export class OpenCommand extends Command {
             })
             : [];
         if (summaryFiles.length > 0) {
-            const config = await readConfig(cwd, this.config, {
-                port: this.port,
-            });
             await serve({
                 port: config.port ? parseInt(config.port, 10) : undefined,
                 servePath: targetFullPath,

package/dist/index.js

@@ -1,7 +1,7 @@
 import { readFileSync } from "node:fs";
 import { argv } from "node:process";
 import { Builtins, Cli } from "clipanion";
-import { AgentCommand, AgentLatestCommand, AgentSelectCommand, AgentStateDirCommand, Allure2Command, AwesomeCommand, ClassicCommand, CsvCommand, DashboardCommand, GenerateCommand, HistoryCommand, JiraClearCommand, KnownIssueCommand, LogCommand, OpenCommand, QualityGateCommand, ResultsPackCommand, ResultsUnpackCommand, RunCommand, SlackCommand, TestPlanCommand, WatchCommand, } from "./commands/index.js";
+import { AgentCommand, AgentLatestCommand, AgentSelectCommand, AgentStateDirCommand, Allure2Command, AwesomeCommand, CheckCommand, ClassicCommand, CsvCommand, DashboardCommand, GenerateCommand, HistoryCommand, JiraClearCommand, KnownIssueCommand, LogCommand, OpenCommand, QualityGateCommand, ResultsPackCommand, ResultsUnpackCommand, RunCommand, SlackCommand, TestPlanCommand, WatchCommand, } 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({
@@ -15,6 +15,7 @@ cli.register(AgentLatestCommand);
 cli.register(AgentSelectCommand);
 cli.register(AgentStateDirCommand);
 cli.register(AgentCommand);
+cli.register(CheckCommand);
 cli.register(ClassicCommand);
 cli.register(CsvCommand);
 cli.register(DashboardCommand);

package/dist/utils/process.d.ts

@@ -13,6 +13,7 @@ export declare const runProcess: (params: {
     cwd: string | undefined;
     environmentVariables?: Record<string, string>;
     logs?: "pipe" | "inherit" | "ignore";
+    shell?: boolean;
 }) => ChildProcess;
 export declare const terminationOf: (testProcess: ChildProcess) => Promise<number | null>;
 export declare const stopProcessTree: (pid: number, { signal }?: StopProcessTreeOpts) => Promise<ProcessBrief[]>;

package/dist/utils/process.js

@@ -5,7 +5,7 @@ import { invokeStdoutCliTool } from "@allurereport/reader-api";
 const IS_WIN = platform === "win32";
 const PS_OUTPUT_PATTERN = /(?<ppid>\d+)\s+(?<pid>\d+)\s+(?<comm>.*)/;
 export const runProcess = (params) => {
-    const { command, commandArgs, cwd, environmentVariables = {}, logs = "inherit" } = params;
+    const { command, commandArgs, cwd, environmentVariables = {}, logs = "inherit", shell = IS_WIN } = params;
     const env = {
         ...process.env,
         ...environmentVariables,
@@ -24,7 +24,7 @@ export const runProcess = (params) => {
         env,
         cwd,
         stdio: logs,
-        shell: IS_WIN,
+        shell,
     });
 };
 export const terminationOf = (testProcess) => new Promise((resolve) => {

package/package.json

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