allure 3.0.0-beta.4 → 3.0.0-beta.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,6 +6,7 @@ type AwesomeCommandOptions = {
6
6
  singleFile?: boolean;
7
7
  historyPath?: string;
8
8
  knownIssues?: string;
9
+ groupBy?: string;
9
10
  };
10
11
  export declare const AwesomeCommandAction: (resultsDir: string, options: AwesomeCommandOptions) => Promise<void>;
11
12
  export declare const AwesomeCommand: (cli: import("cac").CAC) => void;
@@ -3,7 +3,7 @@ import * as console from "node:console";
3
3
  import { createCommand } from "../utils/commands.js";
4
4
  export const AwesomeCommandAction = async (resultsDir, options) => {
5
5
  const before = new Date().getTime();
6
- const { output, reportName: name, historyPath, knownIssues: knownIssuesPath, ...rest } = options;
6
+ const { output, reportName: name, historyPath, knownIssues: knownIssuesPath, groupBy, ...rest } = options;
7
7
  const config = await resolveConfig({
8
8
  output,
9
9
  name,
@@ -11,7 +11,10 @@ export const AwesomeCommandAction = async (resultsDir, options) => {
11
11
  knownIssuesPath,
12
12
  plugins: {
13
13
  "@allurereport/plugin-awesome": {
14
- options: rest,
14
+ options: {
15
+ ...rest,
16
+ groupBy: groupBy?.split(","),
17
+ },
15
18
  },
16
19
  },
17
20
  });
@@ -77,6 +80,13 @@ export const AwesomeCommand = createCommand({
77
80
  description: "Path to the known issues file. Updates the file and quarantines failed tests when specified",
78
81
  },
79
82
  ],
83
+ [
84
+ "--group-by, -g <string>",
85
+ {
86
+ description: "Group test results by labels. The labels should be separated by commas",
87
+ default: "parentSuite,suite,subSuite",
88
+ },
89
+ ],
80
90
  ],
81
91
  action: AwesomeCommandAction,
82
92
  });
@@ -1,8 +1,8 @@
1
- import { AllureReport, readRuntimeConfig } from "@allurereport/core";
1
+ import { AllureReport, readConfig } from "@allurereport/core";
2
2
  import { createCommand } from "../utils/commands.js";
3
3
  export const GenerateCommandAction = async (resultsDir, options) => {
4
4
  const { config: configPath, output, cwd, reportName } = options;
5
- const config = await readRuntimeConfig(configPath, cwd, output, reportName);
5
+ const config = await readConfig(cwd, configPath, { name: reportName, output });
6
6
  const allureReport = new AllureReport(config);
7
7
  await allureReport.start();
8
8
  await allureReport.readDirectory(resultsDir);
@@ -1,13 +1,17 @@
1
- import { AllureReport, createConfig, writeKnownIssues } from "@allurereport/core";
1
+ import { AllureReport, resolveConfig, writeKnownIssues } from "@allurereport/core";
2
2
  import console from "node:console";
3
3
  import { resolve } from "node:path";
4
4
  import { createCommand } from "../utils/commands.js";
5
5
  export const KnownIssueCommandAction = async (resultsDir, options) => {
6
6
  const { output = "known-issues.json" } = options;
7
- const config = await createConfig({});
7
+ const config = await resolveConfig({
8
+ plugins: {},
9
+ });
8
10
  const allureReport = new AllureReport(config);
9
- const targetPath = resolve(output);
11
+ await allureReport.start();
10
12
  await allureReport.readDirectory(resultsDir);
13
+ await allureReport.done();
14
+ const targetPath = resolve(output);
11
15
  await writeKnownIssues(allureReport.store, output);
12
16
  console.log(`writing known-issues.json to ${targetPath}`);
13
17
  };
@@ -1,6 +1,6 @@
1
1
  import { AllureReport, resolveConfig } from "@allurereport/core";
2
- import { createCommand } from "../utils/commands.js";
3
2
  import * as console from "node:console";
3
+ import { createCommand } from "../utils/commands.js";
4
4
  export const LogCommandAction = async (resultsDir, options) => {
5
5
  const before = new Date().getTime();
6
6
  const config = await resolveConfig({
@@ -1,5 +1,6 @@
1
1
  type CommandOptions = {
2
2
  config?: string;
3
+ cwd?: string;
3
4
  port?: number;
4
5
  live: boolean;
5
6
  };
@@ -1,9 +1,9 @@
1
- import { readRuntimeConfig } from "@allurereport/core";
1
+ import { readConfig } from "@allurereport/core";
2
2
  import { serve } from "@allurereport/static-server";
3
3
  import { createCommand } from "../utils/commands.js";
4
4
  export const OpenCommandAction = async (reportDir, options) => {
5
- const { config: configPath, port, live } = options;
6
- const config = await readRuntimeConfig(configPath, undefined, reportDir);
5
+ const { config: configPath, port, live, cwd } = options;
6
+ const config = await readConfig(cwd, configPath, { output: reportDir });
7
7
  await serve({
8
8
  port: port,
9
9
  servePath: config.output,
@@ -34,6 +34,12 @@ export const OpenCommand = createCommand({
34
34
  default: false,
35
35
  },
36
36
  ],
37
+ [
38
+ "--cwd <cwd>",
39
+ {
40
+ description: "The working directory for the command to run (default: current working directory)",
41
+ },
42
+ ],
37
43
  ],
38
44
  action: OpenCommandAction,
39
45
  });
@@ -1,4 +1,5 @@
1
1
  type QualityGateCommandOptions = {
2
+ config?: string;
2
3
  cwd?: string;
3
4
  };
4
5
  export declare const QualityGateCommandAction: (resultsDir: string, options: QualityGateCommandOptions) => Promise<void>;
@@ -1,11 +1,11 @@
1
- import { AllureReport, readRuntimeConfig } from "@allurereport/core";
1
+ import { AllureReport, readConfig } from "@allurereport/core";
2
2
  import console from "node:console";
3
3
  import process from "node:process";
4
4
  import { bold, red } from "yoctocolors";
5
5
  import { createCommand } from "../utils/commands.js";
6
6
  export const QualityGateCommandAction = async (resultsDir, options) => {
7
- const cwd = options.cwd ?? process.cwd();
8
- const fullConfig = await readRuntimeConfig(cwd, "./allure-report");
7
+ const { cwd, config: configPath } = options;
8
+ const fullConfig = await readConfig(cwd, configPath);
9
9
  const allureReport = new AllureReport(fullConfig);
10
10
  await allureReport.start();
11
11
  await allureReport.readDirectory(resultsDir);
@@ -35,10 +35,16 @@ export const QualityGateCommand = createCommand({
35
35
  name: "quality-gate <resultsDir>",
36
36
  description: "Returns status code 1 if there any test failure above specified success rate",
37
37
  options: [
38
+ [
39
+ "--config, -c <file>",
40
+ {
41
+ description: "The path Allure config file",
42
+ },
43
+ ],
38
44
  [
39
45
  "--cwd <cwd>",
40
46
  {
41
- description: "The working directory for the command to run (default: current working directory)",
47
+ description: "The working directory for the command to run (Default: current working directory)",
42
48
  },
43
49
  ],
44
50
  ],
@@ -1,4 +1,4 @@
1
- import { AllureReport, isFileNotFoundError, readRuntimeConfig } from "@allurereport/core";
1
+ import { AllureReport, isFileNotFoundError, readConfig } from "@allurereport/core";
2
2
  import { createTestPlan } from "@allurereport/core-api";
3
3
  import { allureResultsDirectoriesWatcher, delayedFileProcessingWatcher, newFilesInDirectoryWatcher, } from "@allurereport/directory-watcher";
4
4
  import AllureAwesome from "@allurereport/plugin-awesome";
@@ -70,7 +70,7 @@ export const RunCommandAction = async (options) => {
70
70
  const cwd = await realpath(options.cwd ?? process.cwd());
71
71
  console.log(`${command} ${commandArgs.join(" ")}`);
72
72
  const { config: configPath, output, reportName, rerun: maxRerun = 0, silent = false } = options;
73
- const config = await readRuntimeConfig(configPath, cwd, output, reportName);
73
+ const config = await readConfig(cwd, configPath, { output, name: reportName });
74
74
  try {
75
75
  await rm(config.output, { recursive: true });
76
76
  }
@@ -1,4 +1,4 @@
1
- import { AllureReport, isFileNotFoundError, readRuntimeConfig } from "@allurereport/core";
1
+ import { AllureReport, isFileNotFoundError, readConfig } from "@allurereport/core";
2
2
  import { newFilesInDirectoryWatcher } from "@allurereport/directory-watcher";
3
3
  import AllureAwesome from "@allurereport/plugin-awesome";
4
4
  import ProgressPlugin from "@allurereport/plugin-progress";
@@ -17,7 +17,7 @@ export const WatchCommandAction = async (resultsDir, options) => {
17
17
  console.log(`exit code ${code} (${after - before}ms)`);
18
18
  });
19
19
  const { config: configPath, output, cwd, reportName } = options;
20
- const config = await readRuntimeConfig(configPath, cwd, output, reportName);
20
+ const config = await readConfig(cwd, configPath, { output, name: reportName });
21
21
  try {
22
22
  await rm(config.output, { recursive: true });
23
23
  }
package/dist/index.d.ts CHANGED
@@ -1,2 +1 @@
1
- import { defineConfig } from "@allurereport/core";
2
- export { defineConfig };
1
+ export { defineConfig } from "@allurereport/plugin-api";
package/dist/index.js CHANGED
@@ -1,4 +1,3 @@
1
- import { defineConfig } from "@allurereport/core";
2
1
  import { cac } from "cac";
3
2
  import console from "node:console";
4
3
  import { readFileSync } from "node:fs";
@@ -30,4 +29,4 @@ cli.on("command:*", () => {
30
29
  });
31
30
  console.log(cwd());
32
31
  cli.parse();
33
- export { defineConfig };
32
+ export { defineConfig } from "@allurereport/plugin-api";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "allure",
3
- "version": "3.0.0-beta.4",
3
+ "version": "3.0.0-beta.6",
4
4
  "description": "Allure Commandline Tool",
5
5
  "keywords": [
6
6
  "allure",
@@ -30,15 +30,16 @@
30
30
  "test": "vitest run"
31
31
  },
32
32
  "dependencies": {
33
- "@allurereport/core": "3.0.0-beta.4",
34
- "@allurereport/core-api": "3.0.0-beta.4",
35
- "@allurereport/directory-watcher": "3.0.0-beta.4",
36
- "@allurereport/plugin-awesome": "3.0.0-beta.4",
37
- "@allurereport/plugin-progress": "3.0.0-beta.4",
38
- "@allurereport/plugin-server-reload": "3.0.0-beta.4",
39
- "@allurereport/plugin-slack": "3.0.0-beta.4",
40
- "@allurereport/reader-api": "3.0.0-beta.4",
41
- "@allurereport/static-server": "3.0.0-beta.4",
33
+ "@allurereport/core": "3.0.0-beta.6",
34
+ "@allurereport/core-api": "3.0.0-beta.6",
35
+ "@allurereport/directory-watcher": "3.0.0-beta.6",
36
+ "@allurereport/plugin-api": "3.0.0-beta.6",
37
+ "@allurereport/plugin-awesome": "3.0.0-beta.6",
38
+ "@allurereport/plugin-progress": "3.0.0-beta.6",
39
+ "@allurereport/plugin-server-reload": "3.0.0-beta.6",
40
+ "@allurereport/plugin-slack": "3.0.0-beta.6",
41
+ "@allurereport/reader-api": "3.0.0-beta.6",
42
+ "@allurereport/static-server": "3.0.0-beta.6",
42
43
  "cac": "^6.7.14",
43
44
  "lodash.omit": "^4.5.0",
44
45
  "yoctocolors": "^2.1.1"