Classic updates (#85)

.eslintrc.cjs

@@ -67,7 +67,10 @@ module.exports = {
     "@typescript-eslint/consistent-type-assertions": "error",
     "@typescript-eslint/consistent-type-definitions": "off",
     "@typescript-eslint/consistent-type-exports": "error",
-    "@typescript-eslint/consistent-type-imports": "error",
+    "@typescript-eslint/consistent-type-imports": ["error", {
+      fixStyle: 'separate-type-imports',
+      prefer: 'type-imports',
+    }],
     "@typescript-eslint/dot-notation": "error",
     "@typescript-eslint/explicit-member-accessibility": [
       "off",

allurerc.mjs

@@ -11,6 +11,13 @@ export default defineConfig({
         groupBy: ["module", "parentSuite", "suite", "subSuite"],
       },
     },
+    allure2: {
+      options: {
+        singleFile: true,
+        reportLanguage: "en",
+        groupBy: ["module", "parentSuite", "suite", "subSuite"],
+      },
+    },
     log: {
       options: {
         groupBy: "none",

packages/cli/package.json

@@ -33,8 +33,10 @@
     "@allurereport/core": "workspace:*",
     "@allurereport/core-api": "workspace:*",
     "@allurereport/directory-watcher": "workspace:*",
+    "@allurereport/plugin-allure2": "workspace:*",
     "@allurereport/plugin-api": "workspace:*",
     "@allurereport/plugin-awesome": "workspace:*",
+    "@allurereport/plugin-classic": "workspace:*",
     "@allurereport/plugin-progress": "workspace:*",
     "@allurereport/plugin-server-reload": "workspace:*",
     "@allurereport/plugin-slack": "workspace:*",

packages/cli/src/commands/allure2.ts

@@ -0,0 +1,84 @@
+import { AllureReport, resolveConfig } from "@allurereport/core";
+import * as console from "node:console";
+import { createCommand } from "../utils/commands.js";
+
+type ClassicCommandOptions = {
+  output?: string;
+  reportName?: string;
+  reportLanguage?: string;
+  singleFile?: boolean;
+  historyPath?: string;
+  knownIssues?: string;
+};
+
+export const ClassicLegacyCommandAction = async (resultsDir: string, options: ClassicCommandOptions) => {
+  const before = new Date().getTime();
+  const { output, reportName: name, historyPath, knownIssues: knownIssuesPath, ...rest } = options;
+  const config = await resolveConfig({
+    output,
+    name,
+    historyPath,
+    knownIssuesPath,
+    plugins: {
+      "@allurereport/plugin-allure2": {
+        options: rest,
+      },
+    },
+  });
+  const allureReport = new AllureReport(config);
+
+  await allureReport.start();
+  await allureReport.readDirectory(resultsDir);
+  await allureReport.done();
+
+  const after = new Date().getTime();
+
+  console.log(`the report successfully generated (${after - before}ms)`);
+};
+
+export const ClassicLegacyCommand = createCommand({
+  name: "allure2 <resultsDir>",
+  description: "Generates Allure Classic report based on provided Allure Results",
+  options: [
+    [
+      "--output, -o <file>",
+      {
+        description: "The output directory name. Absolute paths are accepted as well",
+        default: "allure-report",
+      },
+    ],
+    [
+      "--report-name, --name <string>",
+      {
+        description: "The report name",
+        default: "Allure Report",
+      },
+    ],
+    [
+      "--report-language, --lang <string>",
+      {
+        description: "Default language of the report (default: OS language)",
+      },
+    ],
+    [
+      "--single-file",
+      {
+        description: "Generate single file report",
+        default: false,
+      },
+    ],
+    [
+      "--history-path, -h <file>",
+      {
+        description: "The path to history file",
+      },
+    ],
+    [
+      "--known-issues <file>",
+      {
+        description: "Path to the known issues file. Updates the file and quarantines failed tests when specified",
+      },
+    ],
+  ],
+  action: ClassicLegacyCommandAction,
+});

packages/cli/src/commands/index.ts

@@ -1,6 +1,7 @@
 export * from "./history.js";
 export * from "./testplan.js";
 export * from "./classic.js";
+export * from "./allure2.js";
 export * from "./awesome.js";
 export * from "./csv.js";
 export * from "./history.js";

packages/cli/src/index.ts

@@ -5,6 +5,7 @@ import { cwd } from "node:process";
 import {
   AwesomeCommand,
   ClassicCommand,
+  ClassicLegacyCommand,
   CsvCommand,
   GenerateCommand,
   HistoryCommand,
@@ -25,6 +26,7 @@ const pkg: { name: string; description: string; version: string } = JSON.parse(
 const cli = cac(pkg.name).usage(pkg.description).help().version(pkg.version);
 const commands = [
   ClassicCommand,
+  ClassicLegacyCommand,
   AwesomeCommand,
   CsvCommand,
   GenerateCommand,

packages/core-api/src/model.ts

@@ -60,6 +60,7 @@ export interface TestResult {
   runSelector?: string;
 
   retries?: TestResult[];
+  categories?: any;
 }
 
 export interface TestFixtureResult {

packages/core/package.json

@@ -26,6 +26,7 @@
   },
   "dependencies": {
     "@allurereport/core-api": "workspace:*",
+    "@allurereport/plugin-allure2": "workspace:*",
     "@allurereport/plugin-api": "workspace:*",
     "@allurereport/plugin-awesome": "workspace:*",
     "@allurereport/plugin-classic": "workspace:*",

packages/plugin-allure2/.eslintrc.cjs

@@ -0,0 +1,13 @@
+module.exports = {
+  env: { browser: true, es2020: true },
+  extends: ["../../.eslintrc.cjs"],
+  ignorePatterns: ["dist", ".eslintrc.cjs"],
+  parser: "@typescript-eslint/parser",
+  overrides: [
+    {
+      extends: ["plugin:@typescript-eslint/disable-type-checked"],
+      files: [".eslintrc.cjs"],
+    },
+
+  ],
+};

packages/plugin-allure2/README.md

@@ -0,0 +1,54 @@
+# Classic Plugin
+
+[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")
+
+- Learn more about Allure Report at https://allurereport.org
+- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
+- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
+- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – be in touch with the latest updates
+- 💬 [General Discussion ](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
+
+---
+
+## Overview
+
+The plugin generates a classic Allure Report.
+
+## Install
+
+Use your favorite package manager to install the package:
+
+```shell
+npm add @allurereport/plugin-classic
+yarn add @allurereport/plugin-classic
+pnpm add @allurereport/plugin-classic
+```
+
+Then, add the plugin to the Allure configuration file:
+
+```diff
+import { defineConfig } from "allure";
+
+export default defineConfig({
+  name: "Allure Report",
+  output: "./allure-report",
+  historyPath: "./history.jsonl",
+  plugins: {
++    classic: {
++      options: {
++        reportName: "HelloWorld",
++      },
++    },
+  },
+});
+```
+
+## Options
+
+The plugin accepts the following options:
+
+| Option           | Description                                     | Type                                                         | Default         |
+|------------------|-------------------------------------------------|--------------------------------------------------------------|-----------------|
+| `reportName`     | Name of the report                              | `string`                                                     | `Allure Report` |
+| `singleFile`     | Writes the report as a single `index.html` file | `boolean`                                                    | `false`         |
+| `reportLanguage` | Default language of the report                  | `string`                                                     | OS language     |

packages/plugin-allure2/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@allurereport/plugin-allure2",
+  "version": "3.0.0-beta.7",
+  "description": "The classic version of Allure HTML report",
+  "keywords": [
+    "allure",
+    "testing",
+    "report",
+    "plugin",
+    "html"
+  ],
+  "repository": "https://github.com/allure-framework/allure3",
+  "license": "Apache-2.0",
+  "author": "Qameta Software",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist"
+  ],
+  "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}",
+    "test": "rimraf ./out && vitest run"
+  },
+  "dependencies": {
+    "@allurereport/core-api": "workspace:*",
+    "@allurereport/plugin-api": "workspace:*",
+    "@allurereport/web-allure2": "workspace:*",
+    "@allurereport/web-commons": "workspace:*",
+    "handlebars": "^4.7.8"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^2.6.1",
+    "@types/eslint": "^8.56.11",
+    "@types/node": "^20.17.9",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@vitest/runner": "^2.1.8",
+    "allure-vitest": "^3.0.9",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^50.0.0",
+    "eslint-plugin-n": "^17.10.1",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.8"
+  }
+}

packages/plugin-allure2/src/categories.ts

@@ -0,0 +1,54 @@
+import type { Allure2Category, Allure2Status } from "./model.js";
+
+const productDefects: Allure2Category = {
+  name: "Product defects",
+  matchedStatuses: ["failed"],
+};
+
+const testDefects: Allure2Category = {
+  name: "Test defects",
+  matchedStatuses: ["broken"],
+};
+
+export const matchCategories = (
+  categories: Allure2Category[],
+  result: { statusMessage?: string; statusTrace?: string; status: Allure2Status; flaky: boolean },
+) => {
+  const matched = categories.filter((category) => categoryMatch(category, result));
+
+  if (matched.length === 0 && categoryMatch(productDefects, result)) {
+    matched.push(productDefects);
+  }
+  if (matched.length === 0 && categoryMatch(testDefects, result)) {
+    matched.push(testDefects);
+  }
+  return matched;
+};
+
+const categoryMatch = (
+  category: Allure2Category,
+  result: { statusMessage?: string; statusTrace?: string; status: Allure2Status; flaky: boolean },
+): boolean => {
+  const { status, statusMessage, statusTrace, flaky } = result;
+  const matchesStatus =
+    !category.matchedStatuses || category.matchedStatuses.length === 0 || category.matchedStatuses.includes(status);
+  const matchesMessage = match(category.messageRegex, statusMessage);
+  const matchesTrace = match(category.traceRegex, statusTrace);
+  const matchesFlaky = (category.flaky ?? flaky) === flaky;
+  return matchesStatus && matchesMessage && matchesTrace && matchesFlaky;
+};
+
+const match = (regex?: string, value?: string): boolean => {
+  if (!regex) {
+    return true;
+  }
+  if (!value) {
+    return false;
+  }
+  try {
+    const b = new RegExp(regex, "s").test(value);
+    return b;
+  } catch (ignored) {
+    return false;
+  }
+};