allure 3.0.0-beta.3 → 3.0.0-beta.5

package/dist/commands/awesome.d.ts

@@ -6,6 +6,7 @@ type AwesomeCommandOptions = {
     singleFile?: boolean;
     historyPath?: string;
     knownIssues?: string;
+    groupBy?: string;
 };
 export declare const AwesomeCommandAction: (resultsDir: string, options: AwesomeCommandOptions) => Promise<void>;
 export declare const AwesomeCommand: (cli: import("cac").CAC) => void;

package/dist/commands/awesome.js

@@ -1,8 +1,9 @@
 import { AllureReport, resolveConfig } from "@allurereport/core";
+import * as console from "node:console";
 import { createCommand } from "../utils/commands.js";
 export const AwesomeCommandAction = async (resultsDir, options) => {
     const before = new Date().getTime();
-    const { output, reportName: name, historyPath, knownIssues: knownIssuesPath, ...rest } = options;
+    const { output, reportName: name, historyPath, knownIssues: knownIssuesPath, groupBy, ...rest } = options;
     const config = await resolveConfig({
         output,
         name,
@@ -10,7 +11,10 @@ export const AwesomeCommandAction = async (resultsDir, options) => {
         knownIssuesPath,
         plugins: {
             "@allurereport/plugin-awesome": {
-                options: rest,
+                options: {
+                    ...rest,
+                    groupBy: groupBy?.split(","),
+                },
             },
         },
     });
@@ -76,6 +80,13 @@ export const AwesomeCommand = createCommand({
                 description: "Path to the known issues file. Updates the file and quarantines failed tests when specified",
             },
         ],
+        [
+            "--group-by, -g <string>",
+            {
+                description: "Group test results by labels. The labels should be separated by commas",
+                default: "parentSuite,suite,subSuite",
+            }
+        ]
     ],
     action: AwesomeCommandAction,
 });

package/dist/commands/classic.js

@@ -1,4 +1,5 @@
 import { AllureReport, resolveConfig } from "@allurereport/core";
+import * as console from "node:console";
 import { createCommand } from "../utils/commands.js";
 export const ClassicCommandAction = async (resultsDir, options) => {
     const before = new Date().getTime();

package/dist/commands/csv.js

@@ -1,4 +1,5 @@
 import { AllureReport, resolveConfig } from "@allurereport/core";
+import * as console from "node:console";
 import { createCommand } from "../utils/commands.js";
 export const CsvCommandAction = async (resultsDir, options) => {
     const before = new Date().getTime();

package/dist/commands/generate.js

@@ -1,8 +1,8 @@
-import { AllureReport, readRuntimeConfig } from "@allurereport/core";
+import { AllureReport, readConfig } from "@allurereport/core";
 import { createCommand } from "../utils/commands.js";
 export const GenerateCommandAction = async (resultsDir, options) => {
     const { config: configPath, output, cwd, reportName } = options;
-    const config = await readRuntimeConfig(configPath, cwd, output, reportName);
+    const config = await readConfig(cwd, configPath, { name: reportName, output });
     const allureReport = new AllureReport(config);
     await allureReport.start();
     await allureReport.readDirectory(resultsDir);

package/dist/commands/knownIssue.js

@@ -1,13 +1,17 @@
-import { AllureReport, createConfig, writeKnownIssues } from "@allurereport/core";
+import { AllureReport, resolveConfig, writeKnownIssues } from "@allurereport/core";
 import console from "node:console";
 import { resolve } from "node:path";
 import { createCommand } from "../utils/commands.js";
 export const KnownIssueCommandAction = async (resultsDir, options) => {
     const { output = "known-issues.json" } = options;
-    const config = await createConfig({});
+    const config = await resolveConfig({
+        plugins: {},
+    });
     const allureReport = new AllureReport(config);
-    const targetPath = resolve(output);
+    await allureReport.start();
     await allureReport.readDirectory(resultsDir);
+    await allureReport.done();
+    const targetPath = resolve(output);
     await writeKnownIssues(allureReport.store, output);
     console.log(`writing known-issues.json to ${targetPath}`);
 };

package/dist/commands/log.js

@@ -1,4 +1,5 @@
 import { AllureReport, resolveConfig } from "@allurereport/core";
+import * as console from "node:console";
 import { createCommand } from "../utils/commands.js";
 export const LogCommandAction = async (resultsDir, options) => {
     const before = new Date().getTime();

package/dist/commands/open.d.ts

@@ -1,5 +1,6 @@
 type CommandOptions = {
     config?: string;
+    cwd?: string;
     port?: number;
     live: boolean;
 };

package/dist/commands/open.js

@@ -1,9 +1,9 @@
-import { readRuntimeConfig } from "@allurereport/core";
+import { readConfig } from "@allurereport/core";
 import { serve } from "@allurereport/static-server";
 import { createCommand } from "../utils/commands.js";
 export const OpenCommandAction = async (reportDir, options) => {
-    const { config: configPath, port, live } = options;
-    const config = await readRuntimeConfig(configPath, undefined, reportDir);
+    const { config: configPath, port, live, cwd } = options;
+    const config = await readConfig(cwd, configPath, { output: reportDir });
     await serve({
         port: port,
         servePath: config.output,
@@ -34,6 +34,12 @@ export const OpenCommand = createCommand({
                 default: false,
             },
         ],
+        [
+            "--cwd <cwd>",
+            {
+                description: "The working directory for the command to run (default: current working directory)",
+            },
+        ],
     ],
     action: OpenCommandAction,
 });

package/dist/commands/qualityGate.d.ts

@@ -1,4 +1,5 @@
 type QualityGateCommandOptions = {
+    config?: string;
     cwd?: string;
 };
 export declare const QualityGateCommandAction: (resultsDir: string, options: QualityGateCommandOptions) => Promise<void>;

package/dist/commands/qualityGate.js

@@ -1,11 +1,11 @@
-import { AllureReport, readRuntimeConfig } from "@allurereport/core";
+import { AllureReport, readConfig } from "@allurereport/core";
 import console from "node:console";
 import process from "node:process";
 import { bold, red } from "yoctocolors";
 import { createCommand } from "../utils/commands.js";
 export const QualityGateCommandAction = async (resultsDir, options) => {
-    const cwd = options.cwd ?? process.cwd();
-    const fullConfig = await readRuntimeConfig(cwd, "./allure-report");
+    const { cwd, config: configPath } = options;
+    const fullConfig = await readConfig(cwd, configPath);
     const allureReport = new AllureReport(fullConfig);
     await allureReport.start();
     await allureReport.readDirectory(resultsDir);
@@ -28,17 +28,23 @@ export const QualityGateCommandAction = async (resultsDir, options) => {
         }
         console.error(red(`⨯ ${bold(`${result.rule}${scope}`)}: expected ${result.expected}, actual ${result.actual}`));
     }
-    console.error(red(`\nThe process has been exited with code 1`));
+    console.error(red("\nThe process has been exited with code 1"));
     process.exit(allureReport.exitCode);
 };
 export const QualityGateCommand = createCommand({
     name: "quality-gate <resultsDir>",
     description: "Returns status code 1 if there any test failure above specified success rate",
     options: [
+        [
+            "--config, -c <file>",
+            {
+                description: "The path Allure config file",
+            },
+        ],
         [
             "--cwd <cwd>",
             {
-                description: "The working directory for the command to run (default: current working directory)",
+                description: "The working directory for the command to run (Default: current working directory)",
             },
         ],
     ],

package/dist/commands/run.js

@@ -1,4 +1,4 @@
-import { AllureReport, isFileNotFoundError, readRuntimeConfig } from "@allurereport/core";
+import { AllureReport, isFileNotFoundError, readConfig } from "@allurereport/core";
 import { createTestPlan } from "@allurereport/core-api";
 import { allureResultsDirectoriesWatcher, delayedFileProcessingWatcher, newFilesInDirectoryWatcher, } from "@allurereport/directory-watcher";
 import AllureAwesome from "@allurereport/plugin-awesome";
@@ -70,7 +70,7 @@ export const RunCommandAction = async (options) => {
     const cwd = await realpath(options.cwd ?? process.cwd());
     console.log(`${command} ${commandArgs.join(" ")}`);
     const { config: configPath, output, reportName, rerun: maxRerun = 0, silent = false } = options;
-    const config = await readRuntimeConfig(configPath, cwd, output, reportName);
+    const config = await readConfig(cwd, configPath, { output, name: reportName });
     try {
         await rm(config.output, { recursive: true });
     }

package/dist/commands/slack.js

@@ -1,4 +1,5 @@
 import { AllureReport, resolveConfig } from "@allurereport/core";
+import * as console from "node:console";
 import { createCommand } from "../utils/commands.js";
 export const SlackCommandAction = async (resultsDir, options) => {
     const before = new Date().getTime();

package/dist/commands/testplan.js

@@ -1,4 +1,5 @@
 import { AllureReport, resolveConfig } from "@allurereport/core";
+import * as console from "node:console";
 import { basename, dirname, resolve } from "node:path";
 import { createCommand } from "../utils/commands.js";
 export const TestPlanCommandAction = async (resultsDir, options) => {

package/dist/commands/watch.js

@@ -1,4 +1,4 @@
-import { AllureReport, isFileNotFoundError, readRuntimeConfig } from "@allurereport/core";
+import { AllureReport, isFileNotFoundError, readConfig } from "@allurereport/core";
 import { newFilesInDirectoryWatcher } from "@allurereport/directory-watcher";
 import AllureAwesome from "@allurereport/plugin-awesome";
 import ProgressPlugin from "@allurereport/plugin-progress";
@@ -17,7 +17,7 @@ export const WatchCommandAction = async (resultsDir, options) => {
         console.log(`exit code ${code} (${after - before}ms)`);
     });
     const { config: configPath, output, cwd, reportName } = options;
-    const config = await readRuntimeConfig(configPath, cwd, output, reportName);
+    const config = await readConfig(cwd, configPath, { output, name: reportName });
     try {
         await rm(config.output, { recursive: true });
     }
@@ -28,7 +28,7 @@ export const WatchCommandAction = async (resultsDir, options) => {
     }
     const server = await serve({
         servePath: config.output,
-        port: options.port ? parseInt(options.port) : undefined,
+        port: options.port ? parseInt(options.port, 10) : undefined,
         live: false,
         open: false,
     });

package/dist/index.d.ts

@@ -1,2 +1 @@
-import { defineConfig } from "@allurereport/core";
-export { defineConfig };
+export { defineConfig } from "@allurereport/plugin-api";

package/dist/index.js

@@ -1,9 +1,8 @@
-import { defineConfig } from "@allurereport/core";
 import { cac } from "cac";
 import console from "node:console";
 import { readFileSync } from "node:fs";
 import { cwd } from "node:process";
-import { ClassicCommand, AwesomeCommand, CsvCommand, GenerateCommand, HistoryCommand, KnownIssueCommand, LogCommand, OpenCommand, QualityGateCommand, RunCommand, SlackCommand, TestPlanCommand, WatchCommand, } from "./commands/index.js";
+import { AwesomeCommand, ClassicCommand, CsvCommand, GenerateCommand, HistoryCommand, KnownIssueCommand, LogCommand, OpenCommand, QualityGateCommand, RunCommand, SlackCommand, TestPlanCommand, WatchCommand, } from "./commands/index.js";
 const pkg = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
 const cli = cac(pkg.name).usage(pkg.description).help().version(pkg.version);
 const commands = [
@@ -30,4 +29,4 @@ cli.on("command:*", () => {
 });
 console.log(cwd());
 cli.parse();
-export { defineConfig };
+export { defineConfig } from "@allurereport/plugin-api";

package/dist/utils/commands.d.ts

@@ -1,4 +1,4 @@
-import { CAC } from "cac";
+import type { CAC } from "cac";
 export type OptionDescription = [string] | [
     string,
     {

package/dist/utils/commands.js

@@ -1,8 +1,10 @@
 export const createCommand = (payload) => {
-    if (!payload.name)
+    if (!payload.name) {
         throw new Error("Command name is not provided!");
-    if (!payload.action)
+    }
+    if (!payload.action) {
         throw new Error("Command action is not provided!");
+    }
     return (cli) => {
         const command = cli.command(payload.name, payload.description);
         payload?.options?.forEach(([name, parameters]) => {

package/dist/utils/process.d.ts

@@ -1,3 +1,3 @@
-import { ChildProcess } from "node:child_process";
+import type { ChildProcess } from "node:child_process";
 export declare const runProcess: (command: string, commandArgs: string[], cwd: string | undefined, environment: Record<string, string>, silent?: boolean) => ChildProcess;
 export declare const terminationOf: (testProcess: ChildProcess) => Promise<number | null>;

package/dist/utils/terminal.d.ts

@@ -1,3 +1,3 @@
-import { TestResult, TestStatus } from "@allurereport/core-api";
+import type { TestResult, TestStatus } from "@allurereport/core-api";
 export declare const status2color: (status: TestStatus) => import("yoctocolors").Format;
 export declare const logTests: (testResults: TestResult[]) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "allure",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.5",
   "description": "Allure Commandline Tool",
   "keywords": [
     "allure",
@@ -24,19 +24,22 @@
   "scripts": {
     "build": "run clean && tsc --project ./tsconfig.json",
     "clean": "rimraf ./dist",
+    "eslint": "eslint ./src/**/*.{js,jsx,ts,tsx}",
+    "eslint:format": "eslint --fix ./src/**/*.{js,jsx,ts,tsx}",
     "start": "node ./cli.js",
     "test": "vitest run"
   },
   "dependencies": {
-    "@allurereport/core": "3.0.0-beta.3",
-    "@allurereport/core-api": "3.0.0-beta.3",
-    "@allurereport/directory-watcher": "3.0.0-beta.3",
-    "@allurereport/plugin-awesome": "3.0.0-beta.3",
-    "@allurereport/plugin-progress": "3.0.0-beta.3",
-    "@allurereport/plugin-server-reload": "3.0.0-beta.3",
-    "@allurereport/plugin-slack": "3.0.0-beta.3",
-    "@allurereport/reader-api": "3.0.0-beta.3",
-    "@allurereport/static-server": "3.0.0-beta.3",
+    "@allurereport/core": "3.0.0-beta.5",
+    "@allurereport/core-api": "3.0.0-beta.5",
+    "@allurereport/directory-watcher": "3.0.0-beta.5",
+    "@allurereport/plugin-api": "3.0.0-beta.5",
+    "@allurereport/plugin-awesome": "3.0.0-beta.5",
+    "@allurereport/plugin-progress": "3.0.0-beta.5",
+    "@allurereport/plugin-server-reload": "3.0.0-beta.5",
+    "@allurereport/plugin-slack": "3.0.0-beta.5",
+    "@allurereport/reader-api": "3.0.0-beta.5",
+    "@allurereport/static-server": "3.0.0-beta.5",
     "cac": "^6.7.14",
     "lodash.omit": "^4.5.0",
     "yoctocolors": "^2.1.1"