testbeats 2.2.1 → 2.2.3

package/README.md

@@ -1,5 +1,3 @@
-> This npm package has been renamed from [test-results-reporter](https://www.npmjs.com/package/test-results-reporter) to [testbeats](https://www.npmjs.com/package/testbeats). test-results-reporter will soon be phased out, and users are encouraged to transition to testbeats.
-
 <span align="center">
 
 ![logo](https://github.com/test-results-reporter/testbeats/raw/main/assets/logo.png)
@@ -37,10 +35,12 @@ Read more about the project at [https://testbeats.com](https://testbeats.com)
 
 #### Results in Portal
 
-![testbeats-failure-summary](./assets/testbeats-failure-summary.png)
+![testbeats-test-run-case-details](./assets/testbeats-test-run-case-details.png)
 
 <br />
 
+> Read more about the project at [https://testbeats.com](https://testbeats.com)
+
 ## Need Help
 
 We use [Github Discussions](https://github.com/test-results-reporter/testbeats/discussions) to receive feedback, discuss ideas & answer questions. Head over to it and feel free to start a discussion. We are always happy to help 😊.
@@ -51,4 +51,9 @@ Like this project! Star it on [Github](https://github.com/test-results-reporter/
 
 <br />
 
-> Read more about the project at [https://testbeats.com](https://testbeats.com)
+> Read more about the project at [https://testbeats.com](https://testbeats.com)
+
+
+## Notes
+
+This npm package has been renamed from [test-results-reporter](https://www.npmjs.com/package/test-results-reporter) to [testbeats](https://www.npmjs.com/package/testbeats). test-results-reporter will soon be phased out, and users are encouraged to transition to testbeats.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testbeats",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "description": "Publish test results to Microsoft Teams, Google Chat, Slack and InfluxDB",
   "main": "src/index.js",
   "types": "./src/index.d.ts",
@@ -56,7 +56,7 @@
     "prompts": "^2.4.2",
     "rosters": "0.0.1",
     "sade": "^1.8.1",
-    "test-results-parser": "0.2.5"
+    "test-results-parser": "0.2.8"
   },
   "devDependencies": {
     "c8": "^10.1.2",

package/src/beats/beats.attachments.js

@@ -99,7 +99,7 @@ class BeatsAttachments {
         }
         form.append('file_images', JSON.stringify(file_images));
         await this.api.uploadAttachments(form.getHeaders(), form.getBuffer());
-        logger.info(`🏞️  Uploaded ${count} attachments`);
+        logger.info(`🏞️ Uploaded ${count} attachments`);
       }
     } catch (error) {
       logger.error(`❌ Unable to upload attachments: ${error.message}`, error);

package/src/beats/beats.js

@@ -128,6 +128,7 @@ class Beats {
       this.config.extensions.push({
         name: 'ai-failure-summary',
         hook: HOOK.AFTER_SUMMARY,
+        order: 100,
         inputs: {
           data: this.test_run
         }
@@ -151,6 +152,7 @@ class Beats {
       this.config.extensions.push({
         name: 'failure-analysis',
         hook: HOOK.AFTER_SUMMARY,
+        order: 200,
         inputs: {
           data: metrics
         }
@@ -170,6 +172,7 @@ class Beats {
       this.config.extensions.push({
         name: 'smart-analysis',
         hook: HOOK.AFTER_SUMMARY,
+        order: 300,
         inputs: {
           data: this.test_run
         }
@@ -225,6 +228,7 @@ class Beats {
       this.config.extensions.push({
         name: 'error-clusters',
         hook: HOOK.AFTER_SUMMARY,
+        order: 400,
         inputs: {
           data: res.values
         }

package/src/commands/publish.command.js

@@ -11,6 +11,7 @@ const { processData } = require('../helpers/helper');
 const { ExtensionsSetup } = require('../setups/extensions.setup');
 const pkg = require('../../package.json');
 const { MIN_NODE_VERSION } = require('../helpers/constants');
+const { sortExtensionsByOrder } = require('../helpers/extension.helper');
 
 class PublishCommand {
 
@@ -212,7 +213,7 @@ class PublishCommand {
   }
 
   async #setupExtensions() {
-    logger.info('⚙️  Setting up extensions...');
+    logger.info('⚙️ Setting up extensions...');
     try {
       for (const config of this.configs) {
         const extensions = config.extensions || [];
@@ -242,6 +243,7 @@ class PublishCommand {
             }
             target.extensions = target.extensions || [];
             target.extensions = config.extensions.concat(target.extensions);
+            target.extensions = sortExtensionsByOrder(target.extensions);
             await target_manager.run(target, result);
           }
         } else {

package/src/helpers/browserstack.helper.js

@@ -19,7 +19,7 @@ async function getAutomationBuilds(inputs) {
     url: `${getBaseUrl(inputs)}/automate/builds.json?limit=100`,
     auth: {
       username: inputs.username,
-      password: inputs.password
+      password: inputs.access_key
     },
   });
 }
@@ -34,7 +34,7 @@ async function getAutomationBuildSessions(inputs, build_id) {
     url: `${getBaseUrl(inputs)}/automate/builds/${build_id}/sessions.json`,
     auth: {
       username: inputs.username,
-      password: inputs.password
+      password: inputs.access_key
     },
   });
 }

package/src/helpers/extension.helper.js

@@ -100,8 +100,28 @@ function addChatExtension({ payload, extension, text }) {
   });
 }
 
+/**
+ * Sort extensions by their order property.
+ * Extensions without order will appear last, maintaining their original relative order.
+ *
+ * @param {import("..").IExtension[]} extensions - the extensions array to sort
+ * @return {import("..").IExtension[]} sorted extensions array
+ */
+function sortExtensionsByOrder(extensions) {
+  if (!extensions || !Array.isArray(extensions)) {
+    return extensions;
+  }
+
+  return extensions.slice().sort((a, b) => {
+    const orderA = typeof a.order === 'number' ? a.order : 1000;
+    const orderB = typeof b.order === 'number' ? b.order : 1000;
+    return orderA - orderB;
+  });
+}
+
 module.exports = {
   addSlackExtension,
   addTeamsExtension,
-  addChatExtension
+  addChatExtension,
+  sortExtensionsByOrder
 }

package/src/index.d.ts

@@ -2,7 +2,9 @@ import { PerformanceParseOptions } from 'performance-results-parser';
 import PerformanceTestResult from 'performance-results-parser/src/models/PerformanceTestResult';
 import { Schedule, User } from 'rosters';
 import { ParseOptions } from 'test-results-parser';
-export import TestResult from 'test-results-parser/src/models/TestResult';
+import TestResult from 'test-results-parser/src/models/TestResult';
+
+export { TestResult };
 
 export interface ITarget {
   name: TargetName;
@@ -17,6 +19,7 @@ export interface IExtension {
   enable?: string | boolean;
   condition?: Condition;
   hook?: Hook;
+  order?: number;
   inputs?: ReportPortalAnalysisInputs | ReportPortalHistoryInputs | HyperlinkInputs | MentionInputs | QuickChartTestSummaryInputs | PercyAnalysisInputs | CustomExtensionInputs | MetadataInputs | CIInfoInputs | AIFailureSummaryInputs | BrowserstackInputs;
 }
 
@@ -229,7 +232,9 @@ export interface TargetInputs {
   metrics?: MetricConfig[];
 }
 
-export interface SlackInputs extends TargetInputs { }
+export interface SlackInputs extends TargetInputs {
+  message_format?: 'blocks' | 'attachments';
+}
 
 export interface TeamsInputs extends TargetInputs {
   width?: string;

package/src/targets/slack.js

@@ -9,7 +9,11 @@ const { getValidMetrics, getMetricValuesText } = require('../helpers/performance
 const TestResult = require('test-results-parser/src/models/TestResult');
 const { getPlatform } = require('../platforms');
 
-
+const STATUSES = {
+  GOOD: ':white_check_mark:',
+  WARNING: ':warning:',
+  DANGER: ':x:'
+}
 
 const COLORS = {
   GOOD: '#36A64F',
@@ -78,7 +82,15 @@ function getTitleText(result, target, {allowTitleLink = true} = {}) {
   if (allowTitleLink && target.inputs.title_link) {
     text = `<${target.inputs.title_link}|${text}>`;
   }
-  return text;
+  if (target.inputs.message_format === 'blocks') {
+    if (result.status !== 'PASS') {
+      return `${STATUSES.DANGER} ${text}`;
+    } else {
+      return `${STATUSES.GOOD} ${text}`;
+    }
+  } else {
+    return text;
+  }
 }
 
 function getResultText(result) {
@@ -160,15 +172,25 @@ function getRootPayload({ result, target, payload }) {
       color = COLORS.DANGER;
     }
   }
-  return {
-    "attachments": [
-      {
-        "color": color,
-        "blocks": payload.blocks,
-        "fallback": `${getTitleText(result, target, {allowTitleLink: false})}\nResults: ${getResultText(result)}`,
-      }
-    ]
-  };
+
+  const fallback_text = `${getTitleText(result, target, {allowTitleLink: false})}\nResults: ${getResultText(result)}`;
+
+  if (target.inputs.message_format === 'blocks') {
+    return {
+      "text": fallback_text,
+      "blocks": payload.blocks
+    }
+  } else {
+    return {
+      "attachments": [
+        {
+          "color": color,
+          "blocks": payload.blocks,
+          "fallback": fallback_text,
+        }
+      ]
+    }
+  }
 }
 
 async function setPerformancePayload({ result, target, payload }) {
@@ -280,7 +302,7 @@ async function handleErrors({ target, errors }) {
     }
   });
 
-  const payload = {
+  let payload = {
     "attachments": [
       {
         "color": COLORS.DANGER,
@@ -290,6 +312,13 @@ async function handleErrors({ target, errors }) {
     ]
   };
 
+  if (target.inputs.message_format === 'blocks') {
+    payload = {
+      "text": title, // fallback text
+      blocks
+    }
+  }
+
   return request.post({
     url: target.inputs.url,
     body: payload