@allurereport/plugin-slack 3.0.0-beta.3

package/README.md

@@ -0,0 +1,54 @@
+# Slack 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 sends notifications about failed tests to a given Slack channel.
+
+## Install
+
+Use your favorite package manager to install the package:
+
+```shell
+npm add @allurereport/plugin-slack
+yarn add @allurereport/plugin-slack
+pnpm add @allurereport/plugin-slack
+```
+
+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: {
++    slack: {
++      options: {
++        channel: "my_channel",
++        token: "my_token",
++      },
++    },
+  },
+});
+```
+
+## Options
+
+The plugin accepts the following options:
+
+| Option    | Description                | Type     |
+|-----------|----------------------------|----------|
+| `channel` | Name of the target channel | `string` |
+| `token`   | Slack API token            | `string` |

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { SlackPlugin } from "./plugin.js";
+export default SlackPlugin;

package/dist/index.js

@@ -0,0 +1,2 @@
+import { SlackPlugin } from "./plugin.js";
+export default SlackPlugin;

package/dist/plugin.d.ts

@@ -0,0 +1,11 @@
+import type { AllureStore, Plugin, PluginContext } from "@allurereport/plugin-api";
+interface SlackPluginOptions {
+    channel?: string;
+    token?: string;
+}
+export declare class SlackPlugin implements Plugin {
+    readonly options: SlackPluginOptions;
+    constructor(options?: SlackPluginOptions);
+    done: (context: PluginContext, store: AllureStore) => Promise<void>;
+}
+export {};

package/dist/plugin.js

@@ -0,0 +1,76 @@
+const defaultSort = (a, b) => (a.fullName ?? "").localeCompare(b.fullName ?? "");
+export class SlackPlugin {
+    constructor(options = {}) {
+        this.options = options;
+        this.done = async (context, store) => {
+            const { reportFiles } = context;
+            const statistic = await store.testsStatistic();
+            if (statistic.total === 0) {
+                throw new Error("no test results found");
+            }
+            const stat = (status) => {
+                if (statistic[status]) {
+                    return [
+                        {
+                            type: "text",
+                            text: `${status} tests: `,
+                            style: {
+                                bold: true,
+                            },
+                        },
+                        {
+                            type: "text",
+                            text: `${statistic[status]}\n`,
+                        },
+                    ];
+                }
+                return [];
+            };
+            const t = (result) => {
+                return {
+                    type: "rich_text_section",
+                    elements: [
+                        {
+                            type: "text",
+                            text: result.fullName ?? "unknown test",
+                        },
+                    ],
+                };
+            };
+            const testResults = await store.failedTestResults();
+            const tests = testResults.sort(defaultSort).map(t);
+            const blocks = [
+                {
+                    type: "rich_text",
+                    elements: [
+                        {
+                            type: "rich_text_section",
+                            elements: [...stat("failed"), ...stat("broken"), ...stat("passed"), ...stat("skipped"), ...stat("unknown")],
+                        },
+                        {
+                            type: "rich_text_list",
+                            style: "bullet",
+                            elements: [...tests],
+                        },
+                    ],
+                },
+            ];
+            const { token = process.env.ALLURE_SLACK_TOKEN, channel = process.env.ALLURE_SLACK_CHANNEL } = this.options;
+            const response = await fetch("https://slack.com/api/chat.postMessage", {
+                method: "POST",
+                body: JSON.stringify({
+                    channel,
+                    blocks,
+                }),
+                headers: {
+                    "Content-Type": "application/json;charset=utf-8",
+                    Authorization: `Bearer ${token}`,
+                },
+            });
+            const { ok, error } = (await response.json());
+            if (!ok) {
+                throw new Error(`slack error: ${error}`);
+            }
+        };
+    }
+}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@allurereport/plugin-slack",
+  "version": "3.0.0-beta.3",
+  "description": "Allure Plugin to Report results to Slack",
+  "keywords": [
+    "allure",
+    "testing",
+    "report",
+    "plugin",
+    "slack"
+  ],
+  "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",
+    "test": "rimraf ./out && vitest run"
+  },
+  "dependencies": {
+    "@allurereport/core-api": "3.0.0-beta.3",
+    "@allurereport/plugin-api": "3.0.0-beta.3"
+  },
+  "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.7",
+    "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"
+  }
+}