@allurereport/plugin-log 3.18.0 → 3.19.0

package/README.md

@@ -46,9 +46,28 @@ export default defineConfig({
 
 The plugin accepts the following options:
 
-| Option               | Description                                      | Type                                     | Default |
-|----------------------|--------------------------------------------------|------------------------------------------|---------|
-| `allSteps`           | Include all steps in the report                  | `boolean`                                | `false` |
-| `withTrace`          | Include step trace in the report                 | `boolean`                                | `false` |
-| `groupBy`            | Group tests by given label                       | `suites \| features \| packages \| none` | `none`  |
-| `qualityGateResults` | Include quality gate validation results in logs  | `boolean`                                | `true`  |
+| Option               | Description                                           | Type                                                | Default                         |
+|----------------------|-------------------------------------------------------|-----------------------------------------------------|---------------------------------|
+| `allSteps`           | Include all steps in the report                       | `boolean`                                           | `false`                         |
+| `withTrace`          | Include step trace in the report                      | `boolean`                                           | `false`                         |
+| `groupBy`            | Group tests by given label                            | `suite \| feature \| package \| suites \| features \| packages \| none` | `suite`                         |
+| `qualityGateResults` | Include quality gate validation results in logs       | `boolean`                                           | `true`                          |
+| `qualityGateFilter`  | Select quality gate validation results shown in logs  | `(result: QualityGateValidationResult) => boolean`  | `({ success }) => !success`     |
+
+To show both successful and failed quality gate checks, configure the filter to include every result:
+
+```js
+export default {
+  plugins: {
+    log: {
+      options: {
+        qualityGateFilter: () => true,
+      },
+    },
+  },
+};
+```
+
+For `allure log`, use the `--all-quality-gate-results` flag to include successful quality gate checks. The command
+constructs its own log plugin configuration for that run, so plugin configuration from the Allure config file is not
+applied to `allure log`.

package/dist/model.d.ts

@@ -1,8 +1,10 @@
 import type { TestResult } from "@allurereport/core-api";
+import type { QualityGateValidationResult } from "@allurereport/plugin-api";
 export type LogPluginOptions = {
     allSteps?: boolean;
     withTrace?: boolean;
-    groupBy?: "suites" | "features" | "packages" | "none";
+    groupBy?: "suite" | "feature" | "package" | "suites" | "features" | "packages" | "none";
     qualityGateResults?: boolean;
+    qualityGateFilter?: (result: QualityGateValidationResult) => boolean;
     filter?: (testResult: TestResult) => boolean;
 };

package/dist/plugin.js

@@ -1,14 +1,17 @@
 import * as console from "node:console";
 import { gray } from "yoctocolors";
 import { printQualityGateResults, printSummary, printTest } from "./utils.js";
+const defaultQualityGateFilter = ({ success }) => !success;
 export class LogPlugin {
     constructor(options = {}) {
         this.options = options;
         this.done = async (context, store) => {
-            const { groupBy = "suite", filter = () => true, qualityGateResults = true } = this.options ?? {};
+            const { groupBy = "suite", filter = () => true, qualityGateResults = true, qualityGateFilter = defaultQualityGateFilter, } = this.options ?? {};
             const allTestResults = await store.allTestResults();
             const filteredTestResults = allTestResults.filter(filter);
-            const allQualityGateResults = qualityGateResults ? await store.qualityGateResults() : [];
+            const qualityGateResultsToPrint = qualityGateResults
+                ? (await store.qualityGateResults()).filter(qualityGateFilter)
+                : [];
             if (groupBy === "none") {
                 filteredTestResults.forEach((test) => {
                     printTest(test, this.options);
@@ -39,7 +42,7 @@ export class LogPlugin {
                 filtered: filteredTestResults.length,
             });
             if (qualityGateResults) {
-                printQualityGateResults(allQualityGateResults);
+                printQualityGateResults(qualityGateResultsToPrint);
             }
         };
     }

package/dist/utils.js

@@ -147,8 +147,9 @@ export const printSummary = (results, options) => {
 };
 export const printQualityGateResult = (result, indent = 0) => {
     const indentSpaces = "  ".repeat(indent);
+    const message = result.success ? green(result.message) : red(result.message);
     console.info(`${indentSpaces}${stringifyQualityGateResultTitle(result)}`);
-    console.info(`${indentSpaces}  ${red(result.message)}`);
+    console.info(`${indentSpaces}  ${message}`);
 };
 export const printQualityGateResults = (results) => {
     if (results.length === 0) {
@@ -156,9 +157,18 @@ export const printQualityGateResults = (results) => {
     }
     console.log("");
     console.info("Quality gates");
-    results.forEach((result) => {
+    const orderedResults = [...results.filter(({ success }) => !success), ...results.filter(({ success }) => success)];
+    orderedResults.forEach((result) => {
         printQualityGateResult(result, 1);
     });
-    const failures = `${results.length} ${results.length === 1 ? "failure" : "failures"}`;
-    console.info(`Quality gates: ${red(failures)}`);
+    const passed = results.filter(({ success }) => success).length;
+    const failed = results.length - passed;
+    const stats = [];
+    if (passed > 0) {
+        stats.push(green(`${passed} passed`));
+    }
+    if (failed > 0) {
+        stats.push(red(`${failed} failed`));
+    }
+    console.info(`Quality gates: ${stats.join(" | ")}`);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-log",
-  "version": "3.18.0",
+  "version": "3.19.0",
   "description": "Allure Plugin to write report in stdout",
   "keywords": [
     "allure",
@@ -31,8 +31,8 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.18.0",
-    "@allurereport/plugin-api": "3.18.0",
+    "@allurereport/core-api": "3.19.0",
+    "@allurereport/plugin-api": "3.19.0",
     "yoctocolors": "^2.2.0"
   },
   "devDependencies": {