testbeats 2.2.4 → 2.2.6

package/package.json

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

package/src/commands/publish.command.js

@@ -173,21 +173,40 @@ class PublishCommand {
         }
       }
       if (target.inputs) {
-        const inputs = target.inputs;
-        if (target.name === 'slack' || target.name === 'teams' || target.name === 'chat') {
-          if (!inputs.url) {
-            throw new Error(`missing url in ${target.name} target inputs`);
-          }
-          if (typeof inputs.url !== 'string') {
-            throw new Error(`url in ${target.name} target inputs must be a string`);
-          }
-          if (!inputs.url.startsWith('http')) {
-            throw new Error(`url in ${target.name} target inputs must start with 'http' or 'https'`);
+        this.#validateURL(target);
+      }
+    }
+    logger.debug("Validating targets - Successful!")
+  }
+
+  #validateURL(target) {
+    const inputs = target.inputs;
+    if (target.name === 'slack' || target.name === 'teams' || target.name === 'chat') {
+      if (inputs.token) {
+        if (!Array.isArray(inputs.channels)) {
+          throw new Error(`channels in ${target.name} target inputs must be an array`);
+        }
+        if (!inputs.channels.length) {
+          throw new Error(`at least one channel must be defined in ${target.name} target inputs`);
+        }
+        for (const channel of inputs.channels) {
+          if (typeof channel !== 'string') {
+            throw new Error(`channel in ${target.name} target inputs must be a string`);
           }
         }
+        return;
+      }
+
+      if (!inputs.url) {
+        throw new Error(`missing url in ${target.name} target inputs`);
+      }
+      if (typeof inputs.url !== 'string') {
+        throw new Error(`url in ${target.name} target inputs must be a string`);
+      }
+      if (!inputs.url.startsWith('http')) {
+        throw new Error(`url in ${target.name} target inputs must start with 'http' or 'https'`);
       }
     }
-    logger.debug("Validating targets - Successful!")
   }
 
   #processResults() {

package/src/extensions/ai-failure-summary.extension.js

@@ -36,7 +36,7 @@ class AIFailureSummaryExtension extends BaseExtension {
      * @type {import('../beats/beats.types').IBeatExecutionMetric}
      */
     const execution_metrics = data.execution_metrics[0];
-    this.text = execution_metrics.failure_summary;
+    this.text = this.platform.code(execution_metrics.failure_summary);
   }
 }
 

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/base.platform').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/constants.js

@@ -18,6 +18,7 @@ const TARGET = Object.freeze({
   CUSTOM: 'custom',
   DELAY: 'delay',
   INFLUX: 'influx',
+  HTTP: 'http',
 });
 
 const EXTENSION = Object.freeze({

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/index.d.ts

@@ -10,7 +10,7 @@ export interface ITarget {
   name: TargetName;
   enable?: string | boolean;
   condition?: Condition;
-  inputs?: SlackInputs | TeamsInputs | ChatInputs | GitHubInputs | CustomTargetInputs | InfluxDBTargetInputs;
+  inputs?: SlackInputs | TeamsInputs | ChatInputs | GitHubInputs | ICustomTargetInputs | InfluxDBTargetInputs;
   extensions?: IExtension[];
 }
 
@@ -234,6 +234,8 @@ export interface TargetInputs {
 
 export interface SlackInputs extends TargetInputs {
   message_format?: 'blocks' | 'attachments';
+  token?: string;
+  channels?: string[];
 }
 
 export interface TeamsInputs extends TargetInputs {
@@ -275,11 +277,19 @@ export interface CustomTargetFunctionContext {
 
 export type CustomTargetFunction = (ctx: CustomTargetFunctionContext) => void | Promise<void>;
 
-export interface CustomTargetInputs {
+export interface ICustomTargetInputs {
   load: string | CustomTargetFunction;
 }
 
+export interface IDelayTargetInputs {
+  seconds: number;
+}
 
+export interface IHttpTargetInputs {
+  url: string;
+  method: string;
+  headers: object;
+}
 
 export interface CustomResultOptions {
   type: string;
@@ -337,5 +347,9 @@ export type IExtensionDefaultOptions = {
   condition: Condition
 }
 
+export type ITargetDefaultOptions = {
+  condition: Condition
+}
+
 export function publish(options: PublishOptions): Promise<any>
 export function defineConfig(config: PublishConfig): PublishConfig

package/src/platforms/base.platform.js

@@ -6,13 +6,41 @@ 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}`));
+  }
+
+  /**
+   * @param {string} text
+   * @returns {string}
+   */
+  code(text) {
+    return text;
+  }
+
+
+
   /**
    *
    * @param {import('..').ITarget} target
@@ -123,6 +151,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/index.js

@@ -3,6 +3,7 @@ const { SlackPlatform } = require('./slack.platform');
 const { TeamsPlatform } = require('./teams.platform');
 const { ChatPlatform } = require('./chat.platform');
 const { GitHubPlatform } = require('./github.platform');
+const { BasePlatform } = require('./base.platform');
 
 /**
  *
@@ -19,7 +20,7 @@ function getPlatform(name) {
     case TARGET.GITHUB:
       return new GitHubPlatform();
     default:
-      throw new Error('Invalid Platform');
+      return new BasePlatform();
   }
 }
 

package/src/platforms/slack.platform.js

@@ -9,8 +9,19 @@ 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}`));
+  }
+
+  code(text) {
+    return `\`\`\`${text}\`\`\``;
   }
 }
 

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/base.target.js

@@ -0,0 +1,45 @@
+const { getPlatform } = require('../platforms');
+const { STATUS } = require('../helpers/constants');
+
+class BaseTarget {
+
+  constructor({ target }) {
+
+    /**
+     * @type {import('../index').ITarget}
+     */
+    this.target = target;
+
+    /**
+     * @type {string}
+     */
+    this.name = target.name;
+
+    /**
+     * @type {string | boolean}
+     */
+    this.enable = target.enable;
+
+    /**
+     * @type {import('../index').Condition}
+     */
+    this.condition = target.condition || STATUS.PASS_OR_FAIL;
+
+    /**
+     * @type {import('../index').IExtension[]}
+     */
+    this.extensions = target.extensions || [];
+
+    /**
+     * @type {import('../platforms/base.platform').BasePlatform}
+     */
+    this.platform = getPlatform(this.name);
+  }
+
+  async run({ result }) {
+    // throw new Error('Not implemented');
+  }
+
+}
+
+  module.exports = { BaseTarget};

package/src/targets/custom.target.js

@@ -0,0 +1,31 @@
+const { BaseTarget } = require('./base.target');
+const path = require('path');
+
+const DEFAULT_INPUTS = {};
+
+class CustomTarget extends BaseTarget {
+
+  constructor({ target }) {
+    super({ target });
+
+    /**
+     * @type {import('../index').ICustomTargetInputs}
+     */
+    this.inputs = Object.assign({}, DEFAULT_INPUTS, target.inputs);
+  }
+
+  async run({ result }) {
+    if (typeof this.inputs.load === 'string') {
+      const cwd = process.cwd();
+      const target_runner = require(path.join(cwd, this.inputs.load));
+      await target_runner.run({ target: this.target, result });
+    } else if (typeof this.inputs.load === 'function') {
+      await this.inputs.load({ target: this.target, result });
+    } else {
+      throw `Invalid 'load' input in custom target - ${this.inputs.load}`;
+    }
+  }
+
+}
+
+module.exports = { CustomTarget };

package/src/targets/delay.target.js

@@ -0,0 +1,24 @@
+const { BaseTarget } = require('./base.target');
+
+const DEFAULT_INPUTS = {
+  seconds: 5
+};
+
+class DelayTarget extends BaseTarget {
+
+  constructor({ target }) {
+    super({ target });
+
+    /**
+     * @type {import('../index').IDelayTargetInputs}
+     */
+    this.inputs = Object.assign({}, DEFAULT_INPUTS, target.inputs);
+  }
+
+  async run() {
+    await new Promise(resolve => setTimeout(resolve, this.inputs.seconds * 1000));
+  }
+
+}
+
+module.exports = { DelayTarget };

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,

package/src/targets/http.target.js

@@ -0,0 +1,36 @@
+const { BaseTarget } = require('./base.target');
+const request = require('phin-retry');
+
+const DEFAULT_INPUTS = {
+  url: '',
+  method: 'POST',
+  headers: {}
+};
+
+class HttpTarget extends BaseTarget {
+
+  constructor({ target }) {
+    super({ target });
+
+    /**
+     * @type {import('../index').IHttpTargetInputs}
+     */
+    this.inputs = Object.assign({}, DEFAULT_INPUTS, target.inputs);
+  }
+
+  async run({ result }) {
+    const { url, method, headers } = this.inputs;
+    await request.__fetch({
+      url,
+      method,
+      headers: {
+        'Content-Type': 'application/json',
+        ...headers
+      },
+      body: { result }
+    });
+  }
+
+}
+
+module.exports = { HttpTarget };

package/src/targets/index.js

@@ -2,8 +2,9 @@ const teams = require('./teams');
 const slack = require('./slack');
 const chat = require('./chat');
 const github = require('./github');
-const custom = require('./custom');
-const delay = require('./delay');
+const { CustomTarget } = require('./custom.target');
+const { DelayTarget } = require('./delay.target');
+const { HttpTarget } = require('./http.target');
 const influx = require('./influx');
 const { TARGET } = require('../helpers/constants');
 const { checkCondition } = require('../helpers/helper');
@@ -19,11 +20,13 @@ function getTargetRunner(target) {
     case TARGET.GITHUB:
       return github;
     case TARGET.CUSTOM:
-      return custom;
+      return new CustomTarget({ target });
     case TARGET.DELAY:
-      return delay;
+      return new DelayTarget({ target });
     case TARGET.INFLUX:
       return influx;
+    case TARGET.HTTP:
+      return new HttpTarget({ target });
     default:
       return require(target.name);
   }
@@ -31,8 +34,9 @@ function getTargetRunner(target) {
 
 async function run(target, result) {
   const target_runner = getTargetRunner(target);
-  const target_options = Object.assign({}, target_runner.default_options, target);
-  if (await checkCondition({ condition: target_options.condition, result, target })) {
+  // const target_options = Object.assign({}, target_runner.default_options, target);
+  const condition = target.condition ||  target_runner.default_options?.condition || target_runner.condition;
+  if (await checkCondition({ condition, result, target })) {
     await target_runner.run({result, target});
   }
 }

package/src/targets/slack.js

@@ -9,6 +9,8 @@ const { getValidMetrics, getMetricValuesText } = require('../helpers/performance
 const TestResult = require('test-results-parser/src/models/TestResult');
 const { getPlatform } = require('../platforms');
 
+const SLACK_BASE_URL = 'https://slack.com';
+
 const STATUSES = {
   GOOD: ':white_check_mark:',
   WARNING: ':warning:',
@@ -31,10 +33,7 @@ async function run({ result, target }) {
   }
   const message = getRootPayload({ result, target, payload });
   logger.info(`🔔 Publishing results to Slack...`);
-  return request.post({
-    url: target.inputs.url,
-    body: message
-  });
+  return publish({ inputs: target.inputs, message });
 }
 
 async function setFunctionalPayload({ result, target, payload }) {
@@ -325,6 +324,28 @@ async function handleErrors({ target, errors }) {
   });
 }
 
+async function publish({ inputs, message}) {
+  const { url, token, channels } = inputs;
+  if (token) {
+    for (let i = 0; i < channels.length; i++) {
+      message.channel = channels[i];
+      return request.post({
+        url: url ? url : `${SLACK_BASE_URL}/api/chat.postMessage`,
+        headers: {
+          'Authorization': `Bearer ${token}`
+        },
+        body: message
+      });
+    }
+
+  } else {
+    return request.post({
+      url,
+      body: message
+    });
+  }
+}
+
 module.exports = {
   run,
   handleErrors,

package/src/targets/custom.js

@@ -1,28 +0,0 @@
-const path = require('path');
-const { STATUS } = require('../helpers/constants');
-
-/**
- *
- * @param {object} param0
- * @param {import('../index').ITarget} param0.target
- */
-async function run({result, target}) {
-  if (typeof target.inputs.load === 'string') {
-    const cwd = process.cwd();
-    const target_runner = require(path.join(cwd, target.inputs.load));
-    await target_runner.run({ target, result });
-  } else if (typeof target.inputs.load === 'function') {
-    await target.inputs.load({ target, result });
-  } else {
-    throw `Invalid 'load' input in custom target - ${target.inputs.load}`;
-  }
-}
-
-const default_options = {
-  condition: STATUS.PASS_OR_FAIL
-}
-
-module.exports = {
-  run,
-  default_options
-}

package/src/targets/delay.js

@@ -1,19 +0,0 @@
-const { STATUS } = require("../helpers/constants");
-
-async function run({ target }) {
-  target.inputs = Object.assign({}, default_inputs, target.inputs);
-  await new Promise(resolve => setTimeout(resolve, target.inputs.seconds * 1000));
-}
-
-const default_options = {
-  condition: STATUS.PASS_OR_FAIL
-}
-
-const default_inputs = {
-  seconds: 5
-}
-
-module.exports = {
-  run,
-  default_options
-}