allure 3.16.0 → 3.17.0

package/dist/commands/agent-run.js

@@ -197,11 +197,9 @@ export const executeAgentMode = async (params) => {
             realTime: false,
             plugins: [...humanReport.plugins, ...(config.plugins ?? [])],
         });
-        const knownIssues = await allureReport.store.allKnownIssues();
         const resultsPatterns = resolveResultsPatterns(cliResultsPatterns, config.resultsDir);
         const { globalExitCode } = await executeAllureRun({
             allureReport,
-            knownIssues,
             cwd,
             command,
             commandArgs,

package/dist/commands/allure2.js

@@ -47,7 +47,7 @@ export class Allure2Command extends Command {
         const config = await readConfig(cwd, this.config, {
             output: this.output,
             name: this.reportName,
-            knownIssuesPath: this.knownIssues,
+            resolutions: { knownIssuesPath: this.knownIssues },
             historyPath: this.historyPath,
         });
         const { resultDirectories, patterns } = await resolveAndFindResultsDirs(cwd, this.resultsDir, config.resultsDir);

package/dist/commands/awesome.js

@@ -56,7 +56,7 @@ export class AwesomeCommand extends Command {
         const config = await readConfig(cwd, this.config, {
             output: this.output,
             name: this.reportName,
-            knownIssuesPath: this.knownIssues,
+            resolutions: { knownIssuesPath: this.knownIssues },
             historyPath: this.historyPath,
             hideLabels,
         });

package/dist/commands/classic.js

@@ -47,7 +47,7 @@ export class ClassicCommand extends Command {
         const config = await readConfig(cwd, this.config, {
             output: this.output,
             name: this.reportName,
-            knownIssuesPath: this.knownIssues,
+            resolutions: { knownIssuesPath: this.knownIssues },
             historyPath: this.historyPath,
         });
         const { resultDirectories, patterns } = await resolveAndFindResultsDirs(cwd, this.resultsDir, config.resultsDir);

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

@@ -1,5 +1,4 @@
 import { AllureReport } from "@allurereport/core";
-import { type KnownTestFailure } from "@allurereport/core-api";
 import type { ExitCode, QualityGateValidationResult } from "@allurereport/plugin-api";
 export type TestProcessResult = {
     code: number | null;
@@ -18,7 +17,6 @@ export declare const executeNestedAllureCommand: (params: {
 }) => Promise<number | null>;
 export declare const runTests: (params: {
     allureReport: AllureReport;
-    knownIssues: KnownTestFailure[];
     cwd: string;
     command: string;
     commandArgs: string[];
@@ -32,7 +30,6 @@ export declare const runTests: (params: {
 }) => Promise<TestProcessResult | null>;
 export declare const executeAllureRun: (params: {
     allureReport: AllureReport;
-    knownIssues: KnownTestFailure[];
     cwd: string;
     command: string;
     commandArgs: string[];

package/dist/commands/commons/run.js

@@ -34,7 +34,7 @@ const attachResultsDirectoryWatchers = (params) => {
     return allureResultsDirectoriesWatcher(params.cwd, params.onUpdate, { indexDelay: 600 });
 };
 export const runTests = async (params) => {
-    const { allureReport, knownIssues, cwd, command, commandArgs, logs, environmentVariables, environment, withQualityGate, silent, logProcessExit = true, resultsPatterns = [], } = params;
+    const { allureReport, cwd, command, commandArgs, logs, environmentVariables, environment, withQualityGate, silent, logProcessExit = true, resultsPatterns = [], } = params;
     let testProcessStarted = false;
     const allureResultsWatchers = new Map();
     const processWatcher = delayedFileProcessingWatcher(async (path) => {
@@ -99,7 +99,6 @@ export const runTests = async (params) => {
                 trs: filteredTrs,
                 state: qualityGateState,
                 environment,
-                knownIssues,
             });
             if (!fastFailed) {
                 return;
@@ -161,7 +160,7 @@ export const runTests = async (params) => {
     };
 };
 export const executeAllureRun = async (params) => {
-    const { allureReport, knownIssues, cwd, command, commandArgs, environmentVariables = {}, environment, withQualityGate, silent, logs, ignoreLogs, maxRerun = 0, logProcessExit = true, resultsPatterns = [], } = params;
+    const { allureReport, cwd, command, commandArgs, environmentVariables = {}, environment, withQualityGate, silent, logs, ignoreLogs, maxRerun = 0, logProcessExit = true, resultsPatterns = [], } = params;
     await allureReport.start();
     const globalExitCode = {
         original: 0,
@@ -174,7 +173,6 @@ export const executeAllureRun = async (params) => {
             logs,
             silent,
             allureReport,
-            knownIssues,
             cwd,
             command,
             commandArgs,
@@ -205,7 +203,6 @@ export const executeAllureRun = async (params) => {
                 silent,
                 logs,
                 allureReport,
-                knownIssues,
                 cwd,
                 command,
                 commandArgs,
@@ -232,7 +229,6 @@ export const executeAllureRun = async (params) => {
         if (withQualityGate && !qualityGateResults.length) {
             const { results } = await allureReport.validate({
                 trs,
-                knownIssues,
                 environment,
             });
             qualityGateResults = results;

package/dist/commands/csv.js

@@ -41,7 +41,7 @@ export class CsvCommand extends Command {
             fileName: this.output && isAbsolute(this.output) ? this.output : this.output ? join(cwd, this.output) : undefined,
         };
         const config = await readConfig(cwd, this.config, {
-            knownIssuesPath: this.knownIssues,
+            resolutions: { knownIssuesPath: this.knownIssues },
         });
         const { resultDirectories, patterns } = await resolveAndFindResultsDirs(cwd, this.resultsDir, config.resultsDir);
         if (!resultDirectories.length) {

package/dist/commands/generate.js

@@ -39,7 +39,8 @@ export class GenerateCommand extends Command {
             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",
+            description: "Path to known issues file. " +
+                "Allure loads the file and updates it every time with the actual resolutions data of type `issue`",
         });
     }
     async execute() {
@@ -52,7 +53,7 @@ export class GenerateCommand extends Command {
             port: this.port,
             hideLabels,
             historyLimit: this.historyLimit !== undefined ? parseInt(this.historyLimit, 10) : undefined,
-            knownIssuesPath: this.knownIssues,
+            resolutions: { knownIssuesPath: this.knownIssues },
         });
         await generate({
             dump: this.dump,

package/dist/commands/index.d.ts

@@ -10,6 +10,7 @@ export * from "./history.js";
 export * from "./run.js";
 export * from "./slack.js";
 export * from "./testplan.js";
+export * from "./testopsPlan.js";
 export * from "./watch.js";
 export * from "./open.js";
 export * from "./qualityGate.js";

package/dist/commands/index.js

@@ -10,6 +10,7 @@ export * from "./history.js";
 export * from "./run.js";
 export * from "./slack.js";
 export * from "./testplan.js";
+export * from "./testopsPlan.js";
 export * from "./watch.js";
 export * from "./open.js";
 export * from "./qualityGate.js";

package/dist/commands/qualityGate.js

@@ -49,7 +49,7 @@ export class QualityGateCommand extends Command {
         const cwd = await realpath(this.cwd ?? processCwd());
         const { maxFailures, minTestsCount, successRate, fastFail } = this;
         const config = await readConfig(cwd, this.config, {
-            knownIssuesPath: this.knownIssues,
+            resolutions: { knownIssuesPath: this.knownIssues },
         });
         const resolvedEnvironment = resolveCommandEnvironment(config, environmentOptions);
         const rules = {};
@@ -87,7 +87,6 @@ export class QualityGateCommand extends Command {
             exit(1);
             return;
         }
-        const knownIssues = await allureReport.store.allKnownIssues();
         const state = new QualityGateState();
         allureReport.realtimeSubscriber.onTestResults(async (trsIds) => {
             const trs = await Promise.all(trsIds.map((id) => allureReport.store.testResultById(id)));
@@ -95,7 +94,6 @@ export class QualityGateCommand extends Command {
             const { results, fastFailed } = await allureReport.validate({
                 trs: nonRetryTrs,
                 environment: resolvedEnvironment?.id,
-                knownIssues,
                 state,
             });
             if (!fastFailed) {
@@ -112,7 +110,6 @@ export class QualityGateCommand extends Command {
         const allTrs = await allureReport.store.allTestResults({ includeRetries: false });
         const validationResults = await allureReport.validate({
             trs: allTrs,
-            knownIssues,
             environment: resolvedEnvironment?.id,
         });
         if (validationResults.results.length === 0) {

package/dist/commands/run.js

@@ -101,7 +101,7 @@ export class RunCommand extends Command {
             port: this.port,
             hideLabels,
             historyLimit: this.historyLimit !== undefined ? parseInt(this.historyLimit, 10) : undefined,
-            knownIssuesPath: this.knownIssues,
+            resolutions: { knownIssuesPath: this.knownIssues },
         });
         const resultsPatterns = resolveResultsPatterns(this.resultsDir ?? [], config.resultsDir);
         const resolvedEnvironment = resolveCommandEnvironment(config, environmentOptions);
@@ -139,10 +139,8 @@ export class RunCommand extends Command {
                     ]),
             ],
         });
-        const knownIssues = await allureReport.store.allKnownIssues();
         const { globalExitCode } = await executeAllureRun({
             allureReport,
-            knownIssues,
             cwd,
             command,
             commandArgs,

package/dist/commands/testopsPlan.d.ts

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

package/dist/commands/testopsPlan.js

@@ -0,0 +1,65 @@
+import * as console from "node:console";
+import { rm, writeFile } from "node:fs/promises";
+import { resolve } from "node:path";
+import { env, exit } from "node:process";
+import { applyAllureCiEnv } from "@allurereport/ci";
+import { createServiceHttpClient } from "@allurereport/service";
+import { Command, Option } from "clipanion";
+import { red } from "yoctocolors";
+export class TestOpsPlanCommand extends Command {
+    constructor() {
+        super(...arguments);
+        this.output = Option.String("--output,-o", {
+            description: "The output file name. Absolute paths are accepted as well (default: ./testplan.json)",
+        });
+    }
+    async execute() {
+        applyAllureCiEnv();
+        const jobRunId = Number(env.ALLURE_JOB_RUN_ID);
+        if (!Number.isInteger(jobRunId) || jobRunId <= 0) {
+            console.log("ALLURE_JOB_RUN_ID isn't set, skipping test plan generation");
+            return;
+        }
+        const endpoint = env.ALLURE_ENDPOINT;
+        const accessToken = env.ALLURE_TOKEN;
+        if (!endpoint || !accessToken) {
+            console.error(red("ALLURE_ENDPOINT and ALLURE_TOKEN are required to fetch a test plan from TestOps"));
+            exit(1);
+            return;
+        }
+        const client = createServiceHttpClient(endpoint, { apiToken: accessToken });
+        const output = resolve(this.output ?? "./testplan.json");
+        let tests;
+        try {
+            tests = await client.get(`/api/rs/jobrun/${jobRunId}/plan`, {
+                params: { expected: "true" },
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            await rm(output, { force: true });
+            console.error(red(`Could not fetch the test plan for job run ${jobRunId}, continuing without one: ${message}`));
+            return;
+        }
+        const testPlan = {
+            version: "1.0",
+            tests: (tests ?? []).map(({ id, selector }) => ({
+                ...(id !== undefined ? { id: String(id) } : {}),
+                ...(selector !== undefined ? { selector } : {}),
+            })),
+        };
+        await writeFile(output, JSON.stringify(testPlan), "utf-8");
+        console.log(`test plan for job run ${jobRunId} written to ${output} (${testPlan.tests.length} test(s))`);
+    }
+}
+TestOpsPlanCommand.paths = [["testops-plan"]];
+TestOpsPlanCommand.usage = Command.Usage({
+    description: "Fetches a testplan.json for the current TestOps job run",
+    details: "Reads ALLURE_JOB_RUN_ID and, when it's set, downloads the test cases selected for that job run " +
+        "from TestOps and writes them as a testplan.json compatible with ALLURE_TESTPLAN_PATH. " +
+        "Does nothing when ALLURE_JOB_RUN_ID isn't set, which covers every run TestOps didn't trigger itself.",
+    examples: [
+        ["testops-plan", "Write ./testplan.json from the current job run, if any"],
+        ["testops-plan --output custom-testplan.json", "Write to a custom path instead"],
+    ],
+});

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, 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, 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({
@@ -30,6 +30,7 @@ cli.register(OpenCommand);
 cli.register(QualityGateCommand);
 cli.register(RunCommand);
 cli.register(SlackCommand);
+cli.register(TestOpsPlanCommand);
 cli.register(TestPlanCommand);
 cli.register(WatchCommand);
 cli.register(ResultsPackCommand);

package/dist/rules.d.ts

@@ -1,2 +1,2 @@
-export { qualityGateDefaultRules, maxFailuresRule, minTestsCountRule, successRateRule } from "@allurereport/core";
+export { qualityGateDefaultRules, maxFailuresRule, minTestsCountRule, successRateRule, metricMaxRule, metricMinRule, metricMaxDeltaRule, metricMaxDeltaPercentRule, } from "@allurereport/core";
 export type { QualityGateRule, QualityGateRuleState, QualityGateValidationResult } from "@allurereport/plugin-api";

package/dist/rules.js

@@ -1 +1 @@
-export { qualityGateDefaultRules, maxFailuresRule, minTestsCountRule, successRateRule } from "@allurereport/core";
+export { qualityGateDefaultRules, maxFailuresRule, minTestsCountRule, successRateRule, metricMaxRule, metricMinRule, metricMaxDeltaRule, metricMaxDeltaPercentRule, } from "@allurereport/core";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "allure",
-  "version": "3.16.0",
+  "version": "3.17.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.16.0",
-    "@allurereport/ci": "3.16.0",
-    "@allurereport/core": "3.16.0",
-    "@allurereport/core-api": "3.16.0",
-    "@allurereport/directory-watcher": "3.16.0",
-    "@allurereport/plugin-agent": "3.16.0",
-    "@allurereport/plugin-allure2": "3.16.0",
-    "@allurereport/plugin-api": "3.16.0",
-    "@allurereport/plugin-awesome": "3.16.0",
-    "@allurereport/plugin-classic": "3.16.0",
-    "@allurereport/plugin-csv": "3.16.0",
-    "@allurereport/plugin-dashboard": "3.16.0",
-    "@allurereport/plugin-jira": "3.16.0",
-    "@allurereport/plugin-log": "3.16.0",
-    "@allurereport/plugin-progress": "3.16.0",
-    "@allurereport/plugin-server-reload": "3.16.0",
-    "@allurereport/plugin-slack": "3.16.0",
-    "@allurereport/reader-api": "3.16.0",
-    "@allurereport/service": "3.16.0",
-    "@allurereport/static-server": "3.16.0",
+    "@allurereport/charts-api": "3.17.0",
+    "@allurereport/ci": "3.17.0",
+    "@allurereport/core": "3.17.0",
+    "@allurereport/core-api": "3.17.0",
+    "@allurereport/directory-watcher": "3.17.0",
+    "@allurereport/plugin-agent": "3.17.0",
+    "@allurereport/plugin-allure2": "3.17.0",
+    "@allurereport/plugin-api": "3.17.0",
+    "@allurereport/plugin-awesome": "3.17.0",
+    "@allurereport/plugin-classic": "3.17.0",
+    "@allurereport/plugin-csv": "3.17.0",
+    "@allurereport/plugin-dashboard": "3.17.0",
+    "@allurereport/plugin-jira": "3.17.0",
+    "@allurereport/plugin-log": "3.17.0",
+    "@allurereport/plugin-progress": "3.17.0",
+    "@allurereport/plugin-server-reload": "3.17.0",
+    "@allurereport/plugin-slack": "3.17.0",
+    "@allurereport/reader-api": "3.17.0",
+    "@allurereport/service": "3.17.0",
+    "@allurereport/static-server": "3.17.0",
     "adm-zip": "^0.6.0",
     "clipanion": "^4.0.0-rc.4",
     "glob": "^13.0.6",