playwright-slack-report 1.0.20 → 1.1.1

package/README.md

@@ -43,7 +43,7 @@ Modify your `playwright.config.ts` file to include the following:
   ],
 ```
 
-Run your tests by providing your` SLACK_BOT_USER_OAUTH_TOKEN` as an environment variable:
+Run your tests by providing your `SLACK_BOT_USER_OAUTH_TOKEN` as an environment variable or specifying `slackOAuthToken` option in the config:
 
 `SLACK_BOT_USER_OAUTH_TOKEN=[your Slack bot user OAUTH token] npx playwright test`
 
@@ -102,7 +102,7 @@ An example advanced configuration is shown below:
 
 ```typescript
   import { generateCustomLayout } from "./my_custom_layout";
-
+  import { LogLevel } from '@slack/web-api';
   ...
 
   reporter: [
@@ -127,6 +127,8 @@ An example advanced configuration is shown below:
                 value: '<https://your-build-artifacts.my.company.dev/pw/23887/playwright-report/index.html|📊>',
             },
         ],
+        slackOAuthToken: 'YOUR_SLACK_OAUTH_TOKEN',
+        slackLogLevel: LogLevel.DEBUG
       },
 
     ],
@@ -147,6 +149,11 @@ A function that returns a layout object, this configuration is optional.  See se
 Same as **layout** above, but asynchronous in that it returns a promise.
 ### **maxNumberOfFailuresToShow**
 Limits the number of failures shown in the Slack message, defaults to 10.
+### **slackOAuthToken**
+Instead of providing an environment variable `SLACK_BOT_USER_OAUTH_TOKEN` you can specify the token in the config in the `slackOAuthToken` field.
+### **slackLogLevel** (default LogLevel.DEBUG)
+This option allows you to control slack client severity levels for log entries. It accepts a value from @slack/web-api `LogLevel` enum
+
 
 **Examples:**
 ```typescript

package/dist/src/SlackClient.d.ts

@@ -1,4 +1,4 @@
-import { WebClient, KnownBlock, Block, ChatPostMessageResponse } from '@slack/web-api';
+import { WebClient, KnownBlock, Block, ChatPostMessageResponse, LogLevel } from '@slack/web-api';
 import { SummaryResults } from '.';
 export declare type additionalInfo = Array<{
     key: string;
@@ -10,11 +10,13 @@ export default class SlackClient {
     sendMessage({ options, }: {
         options: {
             channelIds: Array<string>;
-            summaryResults: SummaryResults;
             customLayout: Function | undefined;
             customLayoutAsync: Function | undefined;
             fakeRequest?: Function;
             maxNumberOfFailures: number;
+            slackOAuthToken?: string;
+            slackLogLevel?: LogLevel;
+            summaryResults: SummaryResults;
         };
     }): Promise<Array<{
         channel: string;

package/dist/src/SlackReporter.d.ts

@@ -1,13 +1,15 @@
 import { FullConfig, Reporter, Suite, TestCase, TestResult } from '@playwright/test/reporter';
 declare class SlackReporter implements Reporter {
-    private suite;
-    private sendResults;
-    private slackChannels;
-    private meta;
     private customLayout;
     private customLayoutAsync;
     private maxNumberOfFailuresToShow;
+    private meta;
     private resultsParser;
+    private sendResults;
+    private slackChannels;
+    private slackLogLevel;
+    private slackOAuthToken;
+    private suite;
     logs: string[];
     onBegin(fullConfig: FullConfig, suite: Suite): void;
     onTestEnd(test: TestCase, result: TestResult): void;

package/dist/src/SlackReporter.js

@@ -4,14 +4,16 @@ const web_api_1 = require("@slack/web-api");
 const ResultsParser_1 = require("./ResultsParser");
 const SlackClient_1 = require("./SlackClient");
 class SlackReporter {
-    suite;
-    sendResults = 'on-failure';
-    slackChannels = [];
-    meta = [];
     customLayout;
     customLayoutAsync;
     maxNumberOfFailuresToShow;
+    meta = [];
     resultsParser;
+    sendResults = 'on-failure';
+    slackChannels = [];
+    slackLogLevel;
+    slackOAuthToken;
+    suite;
     logs = [];
     onBegin(fullConfig, suite) {
         this.suite = suite;
@@ -45,16 +47,16 @@ class SlackReporter {
             this.log('⏩ Slack reporter - no failures found');
             return;
         }
-        const slackClient = new SlackClient_1.default(new web_api_1.WebClient(process.env.SLACK_BOT_USER_OAUTH_TOKEN, {
-            logLevel: web_api_1.LogLevel.DEBUG,
+        const slackClient = new SlackClient_1.default(new web_api_1.WebClient(this.slackOAuthToken || process.env.SLACK_BOT_USER_OAUTH_TOKEN, {
+            logLevel: this.slackLogLevel || web_api_1.LogLevel.DEBUG,
         }));
         const result = await slackClient.sendMessage({
             options: {
                 channelIds: this.slackChannels,
-                summaryResults: resultSummary,
                 customLayout: this.customLayout,
                 customLayoutAsync: this.customLayoutAsync,
                 maxNumberOfFailures: this.maxNumberOfFailuresToShow,
+                summaryResults: resultSummary,
             },
         });
         // eslint-disable-next-line no-console
@@ -64,10 +66,10 @@ class SlackReporter {
         if (this.sendResults === 'off') {
             return { okToProceed: false, message: '❌ Slack reporter is disabled' };
         }
-        if (!process.env.SLACK_BOT_USER_OAUTH_TOKEN) {
+        if (!this.slackOAuthToken && !process.env.SLACK_BOT_USER_OAUTH_TOKEN) {
             return {
                 okToProceed: false,
-                message: '❌ SLACK_BOT_USER_OAUTH_TOKEN was not found',
+                message: '❌ Neither slackOAuthToken nor process.env.SLACK_BOT_USER_OAUTH_TOKEN were found',
             };
         }
         if (!this.sendResults

package/package.json

@@ -28,7 +28,7 @@
     "lint":"npx eslint . --ext .ts"
   },
   "name": "playwright-slack-report",
-  "version": "1.0.20",
+  "version": "1.1.1",
   "main": "index.js",
   "types": "dist/index.d.ts",
   "repository": "git@github.com:ryanrosello-og/playwright-slack-report.git",