testbeats 2.2.4 → 2.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testbeats",
-  "version": "2.2.4",
+  "version": "2.2.5",
   "description": "Publish test results to Microsoft Teams, Google Chat, Slack and InfluxDB",
   "main": "src/index.js",
   "types": "./src/index.d.ts",

package/src/extensions/base.extension.js

@@ -1,6 +1,7 @@
 const TestResult = require('test-results-parser/src/models/TestResult');
 const logger = require('../utils/logger');
-const { addChatExtension, addSlackExtension, addTeamsExtension } = require('../helpers/extension.helper');
+const { addChatExtension, addSlackExtension, addTeamsExtension, addGithubExtension } = require('../helpers/extension.helper');
+const { getPlatform } = require('../platforms');
 
 class BaseExtension {
 
@@ -32,6 +33,11 @@ class BaseExtension {
      * @type {import('..').IExtensionDefaultOptions}
      */
     this.default_options = {};
+
+    /**
+     * @type {import('../platforms').BasePlatform}
+     */
+    this.platform = getPlatform(this.target.name);
   }
 
   updateExtensionInputs() {
@@ -46,6 +52,9 @@ class BaseExtension {
       case 'chat':
         this.extension.inputs = Object.assign({}, { separator: true }, this.extension.inputs);
         break;
+      case 'github':
+        this.extension.inputs = Object.assign({}, { separator: true }, this.extension.inputs);
+        break;
       default:
         break;
     }
@@ -67,6 +76,9 @@ class BaseExtension {
       case 'chat':
         addChatExtension({ payload: this.payload, extension: this.extension, text: this.text });
         break;
+      case 'github':
+        addGithubExtension({ payload: this.payload, extension: this.extension, text: this.text });
+        break;
       default:
         break;
     }
@@ -84,6 +96,8 @@ class BaseExtension {
         return _texts.join('\n');
       case 'chat':
         return _texts.join('<br>');
+      case 'github':
+        return _texts.join('\n');
       default:
         break;
     }
@@ -100,6 +114,8 @@ class BaseExtension {
         return `*${text}*`;
       case 'chat':
         return `<b>${text}</b>`;
+      case 'github':
+        return `**${text}**`;
       default:
         break;
     }

package/src/extensions/error-clusters.extension.js

@@ -38,7 +38,7 @@ class ErrorClustersExtension extends BaseExtension {
     for (const cluster of clusters) {
       texts.push(`${truncate(cluster.failure, 150)} - ${this.bold(`(x${cluster.count})`)}`);
     }
-    this.text = this.mergeTexts(texts);
+    this.text = this.platform.bullets(texts);
   }
 }
 

package/src/helpers/extension.helper.js

@@ -100,6 +100,15 @@ function addChatExtension({ payload, extension, text }) {
   });
 }
 
+function addGithubExtension({ payload, extension, text }) {
+  if (extension.inputs.title) {
+    const title = extension.inputs.title_link ? `[${extension.inputs.title}](${extension.inputs.title_link})` : extension.inputs.title;
+    payload.content.push(`**${title}**\n${text}\n\n`);
+  } else {
+    payload.content.push(`${text}\n\n`);
+  }
+}
+
 /**
  * Sort extensions by their order property.
  * Extensions without order will appear last, maintaining their original relative order.
@@ -123,5 +132,6 @@ module.exports = {
   addSlackExtension,
   addTeamsExtension,
   addChatExtension,
+  addGithubExtension,
   sortExtensionsByOrder
 }

package/src/platforms/base.platform.js

@@ -6,11 +6,29 @@ class BasePlatform {
    * @param {string|number} text
    */
   bold(text) {
-    throw new Error('Not Implemented');
+    return `**${text}**`;
   }
 
   break() {
-    throw new Error('Not Implemented');
+    return '\n';
+  }
+
+  /**
+   * @param {string[]} values
+   */
+  merge(values) {
+    return this.getValidTexts(values).join(this.break());
+  }
+
+  /**
+   * @param {string[]} items - Array of strings to convert to bullet points
+   * @returns {string} - Formatted bullet points as a string
+   */
+  bullets(items) {
+    if (!items || !Array.isArray(items) || items.length === 0) {
+      return '';
+    }
+    return this.merge(items.map(item => `- ${item}`));
   }
 
   /**
@@ -123,6 +141,14 @@ class BasePlatform {
 
     return texts.join(' • ');
   }
+
+  /**
+   * @param {string[]} texts
+   * @returns {string[]}
+   */
+  getValidTexts(texts) {
+    return texts.filter(text => !!text);
+  }
 }
 
 module.exports = { BasePlatform }

package/src/platforms/chat.platform.js

@@ -13,6 +13,17 @@ class ChatPlatform extends BasePlatform {
     return '<br>';
   }
 
+  /**
+   * @param {string[]} items - Array of strings to convert to bullet points
+   * @returns {string} - Formatted bullet points as a string
+   */
+  bullets(items) {
+    if (!items || !Array.isArray(items) || items.length === 0) {
+      return '';
+    }
+    return this.merge(items.map(item => `• ${item}`));
+  }
+
 }
 
 module.exports = { ChatPlatform }

package/src/platforms/github.platform.js

@@ -2,17 +2,6 @@ const { BasePlatform } = require('./base.platform');
 
 class GitHubPlatform extends BasePlatform {
 
-  /**
-   * @param {string|number} text
-   */
-  bold(text) {
-    return `**${text}**`;
-  }
-
-  break() {
-    return '\n';
-  }
-
 }
 
 module.exports = { GitHubPlatform };

package/src/platforms/slack.platform.js

@@ -9,8 +9,15 @@ class SlackPlatform extends BasePlatform {
     return `*${text}*`;
   }
 
-  break() {
-    return '\n';
+  /**
+   * @param {string[]} items - Array of strings to convert to bullet points
+   * @returns {string} - Formatted bullet points as a string
+   */
+  bullets(items) {
+    if (!items || !Array.isArray(items) || items.length === 0) {
+      return '';
+    }
+    return this.merge(items.map(item => `• ${item}`));
   }
 }
 

package/src/platforms/teams.platform.js

@@ -1,16 +1,21 @@
 const { BasePlatform } = require("./base.platform");
 
 class TeamsPlatform extends BasePlatform {
-  /**
-   * @param {string|number} text
-   */
-  bold(text) {
-    return `**${text}**`;
-  }
 
   break() {
     return '\n\n';
   }
+
+  /**
+   * @param {string[]} items - Array of strings to convert to bullet points
+   * @returns {string} - Formatted bullet points as a string
+   */
+  bullets(items) {
+    if (!items || !Array.isArray(items) || items.length === 0) {
+      return '';
+    }
+    return this.merge(items.map(item => `- ${item}`));
+  }
 }
 
 module.exports = { TeamsPlatform }

package/src/targets/github.js

@@ -136,7 +136,7 @@ async function publishToGitHub({ target, message }) {
   const token = target.inputs.token || process.env.GITHUB_TOKEN;
 
   if (!token) {
-    throw new Error('GitHub token is required. Set GITHUB_TOKEN environment variable or provide github_token in target inputs.');
+    throw new Error('GitHub token is required. Set GITHUB_TOKEN environment variable or provide token in target inputs.');
   }
 
   if (!pull_number) {
@@ -155,7 +155,7 @@ async function publishToGitHub({ target, message }) {
 
   if (target.inputs.update_comment) {
     // Try to find existing comment and update it
-    const existingComment = await findExistingComment({ owner, repo, pull_number, github_token: token, comment_title: target.inputs.comment_title });
+    const existingComment = await findExistingComment({ owner, repo, pull_number, token, comment_title: target.inputs.comment_title });
     if (existingComment) {
       return request.patch({
         url: `${url}/repos/${owner}/${repo}/issues/comments/${existingComment.id}`,
@@ -173,13 +173,13 @@ async function publishToGitHub({ target, message }) {
   });
 }
 
-async function findExistingComment({ owner, repo, pull_number, github_token, comment_title }) {
+async function findExistingComment({ owner, repo, pull_number, token, comment_title }) {
   if (!comment_title) return null;
 
   try {
     const url = `https://api.github.com/repos/${owner}/${repo}/issues/${pull_number}/comments`;
     const headers = {
-      'Authorization': `token ${github_token}`,
+      'Authorization': `token ${token}`,
       'Accept': 'application/vnd.github.v3+json',
       'User-Agent': 'testbeats'
     };
@@ -280,7 +280,7 @@ async function handleErrors({ target, errors }) {
 }
 
 const default_inputs = {
-  github_token: undefined,
+  token: undefined,
   comment_title: undefined,
   update_comment: false,
   owner: undefined,