allure 3.18.0 → 3.19.0

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

@@ -1,7 +1,12 @@
+import { type ReportContext } from "@allurereport/ci";
 import type { FullConfig } from "@allurereport/core";
+export type GenerateResult = {
+    summary?: ReportContext;
+};
 export declare const generate: (params: {
     cwd: string;
     config: FullConfig;
     resultsDir?: string[];
     dump?: string[];
-}) => Promise<void>;
+    collectSummary?: boolean;
+}) => Promise<GenerateResult | undefined>;

package/dist/commands/commons/generate.js

@@ -1,4 +1,5 @@
 import { exit } from "node:process";
+import { createReportContext } from "@allurereport/ci";
 import { AllureReport } from "@allurereport/core";
 import { KnownError } from "@allurereport/service";
 import { red } from "yoctocolors";
@@ -26,6 +27,23 @@ export const generate = async (params) => {
             await allureReport.readDirectory(dir);
         }
         await allureReport.done();
+        if (!params.collectSummary) {
+            return;
+        }
+        const result = {};
+        try {
+            const summary = await createReportContext(params.config.output, {
+                onError: (message) => console.warn(message),
+            });
+            if (!summary.testResults && summary.reports.length === 0) {
+                throw new Error("no report context data found");
+            }
+            result.summary = summary;
+        }
+        catch (error) {
+            console.warn(`Report summary skipped: ${error instanceof Error ? error.message : String(error)}`);
+        }
+        return result;
     }
     catch (error) {
         if (error instanceof KnownError) {

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

@@ -0,0 +1,15 @@
+import { Command } from "clipanion";
+export declare class GitlabGenerateCommand extends Command {
+    static paths: string[][];
+    static usage: import("clipanion").Usage;
+    resultsDir: string[];
+    config: string | undefined;
+    output: string | undefined;
+    reportName: string | undefined;
+    dump: string[] | undefined;
+    historyPath: string | undefined;
+    historyLimit: string | undefined;
+    historyBaseUrl: string | undefined;
+    gitlabToken: string | undefined;
+    execute(): Promise<void>;
+}

package/dist/commands/gitlab/generate.js

@@ -0,0 +1,137 @@
+import { existsSync } from "node:fs";
+import { isAbsolute, join, relative, resolve, sep } from "node:path";
+import { cwd as processCwd } from "node:process";
+import { restoreGitlabHistory, upsertGitlabJobNote, detect } from "@allurereport/ci";
+import { readConfig } from "@allurereport/core";
+import { CiType } from "@allurereport/core-api";
+import { Command, Option } from "clipanion";
+import { generate } from "../commons/generate.js";
+const DEFAULT_HISTORY_LIMIT = 100;
+const isDecimalString = (value) => /^[0-9]+$/.test(value);
+const parseHistoryLimit = (value) => {
+    if (typeof value === "string") {
+        if (!isDecimalString(value)) {
+            return DEFAULT_HISTORY_LIMIT;
+        }
+        const parsed = Number(value);
+        return Number.isFinite(parsed) && Number.isInteger(parsed) && parsed >= 0 ? parsed : DEFAULT_HISTORY_LIMIT;
+    }
+    if (typeof value === "number") {
+        return Number.isFinite(value) && Number.isInteger(value) && value >= 0 ? value : DEFAULT_HISTORY_LIMIT;
+    }
+    return DEFAULT_HISTORY_LIMIT;
+};
+const reportBaseUrl = (historyBaseUrl, output) => {
+    const gitlab = detect();
+    const isGitlabCiDescriptor = (ci) => ci.type === CiType.Gitlab;
+    if (!isGitlabCiDescriptor(gitlab)) {
+        throw new Error("GitLab CI environment was not detected");
+    }
+    if (isAbsolute(output)) {
+        const projectDirectory = resolve(gitlab.projectDirectory);
+        const absoluteOutput = resolve(output);
+        if (absoluteOutput !== projectDirectory && !absoluteOutput.startsWith(join(projectDirectory, sep))) {
+            throw new Error("Absolute output path must be within CI_PROJECT_DIR");
+        }
+        output = relative(projectDirectory, absoluteOutput).split(sep).join("/");
+    }
+    return historyBaseUrl || `${gitlab.jobArtifactsUrlBase}/${output}`;
+};
+export class GitlabGenerateCommand extends Command {
+    constructor() {
+        super(...arguments);
+        this.resultsDir = Option.Rest({
+            name: "Patterns to match test results directories. Overrides config.resultsDir. Defaults to ./**/allure-results when neither is set.",
+        });
+        this.config = Option.String("--config,-c", {
+            description: "The path to Allure config file",
+        });
+        this.output = Option.String("--output,-o", {
+            description: "The output directory name. Absolute paths are accepted as well (default: allure-report)",
+        });
+        this.reportName = Option.String("--report-name,--name", {
+            description: "The report name (default: Allure Report)",
+        });
+        this.dump = Option.Array("--dump", {
+            description: "Path or pattern that matches one or more archives created by `allure run --dump ...`. " +
+                "Allure loads the matched archives before generating the report. " +
+                "This option can be specified multiple times.",
+        });
+        this.historyPath = Option.String("--history-path", {
+            description: "History file path",
+        });
+        this.historyLimit = Option.String("--history-limit", {
+            description: "Limits the number of history entries to keep (default: 100)",
+        });
+        this.historyBaseUrl = Option.String("--history-base-url", {
+            description: "The public base URL of the generated report directory",
+        });
+        this.gitlabToken = Option.String("--gitlab-token", {
+            description: "GitLab api token with api write permissions",
+        });
+    }
+    async execute() {
+        const cwd = processCwd();
+        const token = this.gitlabToken?.trim() || process.env.GITLAB_TOKEN?.trim() || undefined;
+        const output = this.output ?? "allure-report";
+        const configPath = this.config && existsSync(this.config) ? this.config : undefined;
+        const historyPath = this.historyPath === undefined ? "history.jsonl" : this.historyPath;
+        const config = await readConfig(cwd, configPath, {
+            output,
+            name: this.reportName,
+            historyPath: historyPath,
+            historyBaseUrl: reportBaseUrl(this.historyBaseUrl, output),
+            historyLimit: parseHistoryLimit(this.historyLimit),
+        });
+        const runGitlabOperation = async (errPrefix, operation) => {
+            try {
+                await operation();
+            }
+            catch (error) {
+                console.error(`${errPrefix}: ${error instanceof Error ? error.message : String(error)}`);
+            }
+        };
+        console.log("Generating allure report");
+        if (!config.allureService?.accessToken) {
+            console.log("  fetching previous run history");
+            await runGitlabOperation("  history fetch failed", () => restoreGitlabHistory({
+                token,
+                historyPath,
+            }));
+        }
+        const result = await generate({
+            cwd,
+            config,
+            dump: this.dump,
+            resultsDir: this.resultsDir,
+            collectSummary: true,
+        });
+        if (!result) {
+            return;
+        }
+        const reportUrl = `${config.historyBaseUrl}/index.html`;
+        console.log(`GitLab report URL: ${reportUrl}`);
+        if (result.summary && existsSync(join(config.output, "index.html"))) {
+            console.log("Posting report summary comment");
+            if (!token) {
+                console.log("  no API token provided, skipping");
+                return;
+            }
+            const { summary } = result;
+            await runGitlabOperation("  failed to add summary comment", () => upsertGitlabJobNote({
+                token,
+                summary,
+                reportUrl,
+            }));
+        }
+    }
+}
+GitlabGenerateCommand.paths = [["gitlab"]];
+GitlabGenerateCommand.usage = Command.Usage({
+    category: "Integrations",
+    description: "Generate test report and post report summary in merge request comments",
+    details: "This command generates a report from the provided Allure Results directories. When api access token is configured, " +
+        "integration will post summary as comment for merge request pipelines and attempt to lookup history file from previously executed job ." +
+        "This integration is designed to be executed from within GitLab CI job.",
+    examples: [["gitlab ./allure-results", "Generate a report from the ./allure-results directory"]],
+});

package/dist/commands/gitlab/index.d.ts

@@ -0,0 +1 @@
+export * from "./generate.js";

package/dist/commands/gitlab/index.js

@@ -0,0 +1 @@
+export * from "./generate.js";

package/dist/commands/index.d.ts

@@ -19,3 +19,4 @@ export * from "./generate.js";
 export * from "./dashboard.js";
 export * from "./results/index.js";
 export * from "./jira/index.js";
+export * from "./gitlab/index.js";

package/dist/commands/index.js

@@ -19,3 +19,4 @@ export * from "./generate.js";
 export * from "./dashboard.js";
 export * from "./results/index.js";
 export * from "./jira/index.js";
+export * from "./gitlab/index.js";

package/dist/commands/log.d.ts

@@ -9,5 +9,6 @@ export declare class LogCommand extends Command {
     allSteps: boolean | undefined;
     withTrace: boolean | undefined;
     qualityGateResults: boolean;
+    allQualityGateResults: boolean;
     execute(): Promise<void>;
 }

package/dist/commands/log.js

@@ -31,6 +31,9 @@ export class LogCommand extends Command {
         this.qualityGateResults = Option.Boolean("--quality-gate-results", true, {
             description: "Print quality gate validation results after tests (default: true). Pass --no-quality-gate-results to hide them",
         });
+        this.allQualityGateResults = Option.Boolean("--all-quality-gate-results", false, {
+            description: "Include successful quality gate validation results in addition to failures",
+        });
     }
     async execute() {
         const cwd = await realpath(this.cwd ?? process.cwd());
@@ -40,6 +43,7 @@ export class LogCommand extends Command {
             withTrace: this.withTrace ?? false,
             groupBy: this.groupBy ?? "suite",
             qualityGateResults: this.qualityGateResults,
+            qualityGateFilter: this.allQualityGateResults ? () => true : undefined,
         };
         const config = await readConfig(cwd, this.config);
         const resolvedEnvironment = resolveCommandEnvironment(config, {});

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, LogCommand, OpenCommand, QualityGateCommand, ResultsPackCommand, ResultsUnpackCommand, RunCommand, SlackCommand, TestOpsPlanCommand, 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, GitlabGenerateCommand, HistoryCommand, JiraClearCommand, LogCommand, OpenCommand, QualityGateCommand, ResultsPackCommand, ResultsUnpackCommand, RunCommand, SlackCommand, TestOpsPlanCommand, 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({
@@ -35,6 +35,7 @@ cli.register(TestPlanCommand);
 cli.register(WatchCommand);
 cli.register(ResultsPackCommand);
 cli.register(ResultsUnpackCommand);
+cli.register(GitlabGenerateCommand);
 cli.register(Builtins.HelpCommand);
 cli.register(Builtins.VersionCommand);
 void cli

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "allure",
-  "version": "3.18.0",
+  "version": "3.19.0",
   "description": "Allure Commandline Tool",
   "keywords": [
     "allure",
@@ -32,26 +32,26 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/charts-api": "3.18.0",
-    "@allurereport/ci": "3.18.0",
-    "@allurereport/core": "3.18.0",
-    "@allurereport/core-api": "3.18.0",
-    "@allurereport/directory-watcher": "3.18.0",
-    "@allurereport/plugin-agent": "3.18.0",
-    "@allurereport/plugin-allure2": "3.18.0",
-    "@allurereport/plugin-api": "3.18.0",
-    "@allurereport/plugin-awesome": "3.18.0",
-    "@allurereport/plugin-classic": "3.18.0",
-    "@allurereport/plugin-csv": "3.18.0",
-    "@allurereport/plugin-dashboard": "3.18.0",
-    "@allurereport/plugin-jira": "3.18.0",
-    "@allurereport/plugin-log": "3.18.0",
-    "@allurereport/plugin-progress": "3.18.0",
-    "@allurereport/plugin-server-reload": "3.18.0",
-    "@allurereport/plugin-slack": "3.18.0",
-    "@allurereport/reader-api": "3.18.0",
-    "@allurereport/service": "3.18.0",
-    "@allurereport/static-server": "3.18.0",
+    "@allurereport/charts-api": "3.19.0",
+    "@allurereport/ci": "3.19.0",
+    "@allurereport/core": "3.19.0",
+    "@allurereport/core-api": "3.19.0",
+    "@allurereport/directory-watcher": "3.19.0",
+    "@allurereport/plugin-agent": "3.19.0",
+    "@allurereport/plugin-allure2": "3.19.0",
+    "@allurereport/plugin-api": "3.19.0",
+    "@allurereport/plugin-awesome": "3.19.0",
+    "@allurereport/plugin-classic": "3.19.0",
+    "@allurereport/plugin-csv": "3.19.0",
+    "@allurereport/plugin-dashboard": "3.19.0",
+    "@allurereport/plugin-jira": "3.19.0",
+    "@allurereport/plugin-log": "3.19.0",
+    "@allurereport/plugin-progress": "3.19.0",
+    "@allurereport/plugin-server-reload": "3.19.0",
+    "@allurereport/plugin-slack": "3.19.0",
+    "@allurereport/reader-api": "3.19.0",
+    "@allurereport/service": "3.19.0",
+    "@allurereport/static-server": "3.19.0",
     "adm-zip": "^0.6.0",
     "clipanion": "^4.0.0-rc.4",
     "glob": "^13.0.6",