testbeats 2.2.7 → 2.2.9

package/src/platforms/base.platform.js

@@ -6,7 +6,10 @@ class BasePlatform {
    * @param {string|number} text
    */
   bold(text) {
-    return `**${text}**`;
+    if (text) {
+      return `**${text}**`;
+    }
+    return text;
   }
 
   break() {
@@ -39,117 +42,19 @@ class BasePlatform {
     return text;
   }
 
-
-
-  /**
-   *
-   * @param {import('..').ITarget} target
-   * @param {import('test-results-parser').ITestSuite} suite
-   */
-  getSuiteSummaryText(target, suite) {
-    const suite_title = this.getSuiteTitle(suite);
-    const suite_results_text = this.#getSuiteResultsText(suite);
-    const duration_text = this.#getSuiteDurationText(target, suite);
-
-    const texts = [
-      this.bold(suite_title),
-      this.break(),
-      this.break(),
-      suite_results_text,
-      this.break(),
-      duration_text,
-    ];
-
-    const metadata_text = this.getSuiteMetaDataText(suite);
-
-    if (metadata_text) {
-      texts.push(this.break());
-      texts.push(this.break());
-      texts.push(metadata_text);
-    }
-
-    return texts.join('');
-  }
-
-  /**
-   *
-   * @param {import('test-results-parser').ITestSuite} suite
-   * @returns {string}
-   */
-  getSuiteTitle(suite) {
-    const emoji = suite.status === 'PASS' ? '✅' : suite.total === suite.skipped ? '⏭️' : '❌';
-    return `${emoji} ${suite.name}`;
-  }
-
   /**
-   *
-   * @param {import('test-results-parser').ITestSuite} suite
-   * @returns {string}
-   */
-  #getSuiteResultsText(suite) {
-    const suite_results = this.getSuiteResults(suite);
-    return `${this.bold('Results')}: ${suite_results}`;
-  }
-
-  /**
-   *
-   * @param {import('test-results-parser').ITestSuite} suite
-   * @returns {string}
-   */
-  getSuiteResults(suite) {
-    return `${suite.passed} / ${suite.total} Passed (${getPercentage(suite.passed, suite.total)}%)`;
-  }
-
-  /**
-   *
-   * @param {import('..').ITarget} target
-   * @param {import('test-results-parser').ITestSuite} suite
-   */
-  #getSuiteDurationText(target, suite) {
-    const duration = this.getSuiteDuration(target, suite);
-    return `${this.bold('Duration')}: ${duration}`
-  }
-
-  /**
-   *
-   * @param {import('..').ITarget} target
-   * @param {import('test-results-parser').ITestSuite} suite
-   */
-  getSuiteDuration(target, suite) {
-    return getPrettyDuration(suite.duration, target.inputs.duration);
-  }
-
-  /**
-   *
-   * @param {import('test-results-parser').ITestSuite} suite
+   * @param {string} text
+   * @param {string} url
    * @returns {string}
    */
-  getSuiteMetaDataText(suite) {
-    if (!suite || !suite.metadata) {
-      return;
-    }
-
-    const texts = [];
-
-    // webdriver io
-    if (suite.metadata.device && typeof suite.metadata.device === 'string') {
-      texts.push(`${suite.metadata.device}`);
-    }
-
-    if (suite.metadata.platform && suite.metadata.platform.name && suite.metadata.platform.version) {
-      texts.push(`${suite.metadata.platform.name} ${suite.metadata.platform.version}`);
+  link(text, url) {
+    if (url) {
+      if (!text) {
+        text = url;
+      }
+      return `[${text}](${url})`;
     }
-
-    if (suite.metadata.browser && suite.metadata.browser.name && suite.metadata.browser.version) {
-      texts.push(`${suite.metadata.browser.name} ${suite.metadata.browser.version}`);
-    }
-
-    // playwright
-    if (suite.metadata.hostname && typeof suite.metadata.hostname === 'string') {
-      texts.push(`${suite.metadata.hostname}`);
-    }
-
-    return texts.join(' • ');
+    return url;
   }
 
   /**

package/src/platforms/chat.platform.js

@@ -6,7 +6,10 @@ class ChatPlatform extends BasePlatform {
    * @param {string|number} text
    */
   bold(text) {
-    return `<b>${text}</b>`;
+    if (text) {
+      return `<b>${text}</b>`;
+    }
+    return text;
   }
 
   break() {

package/src/platforms/slack.platform.js

@@ -6,7 +6,10 @@ class SlackPlatform extends BasePlatform {
    * @param {string|number} text
    */
   bold(text) {
-    return `*${text}*`;
+    if (text) {
+      return `*${text}*`;
+    }
+    return text;
   }
 
   /**
@@ -26,6 +29,16 @@ class SlackPlatform extends BasePlatform {
     }
     return text;
   }
+
+  link(text, url) {
+    if (url) {
+      if (!text) {
+        text = url;
+      }
+      return `<${url}|${text}>`;
+    }
+    return text;
+  }
 }
 
 module.exports = { SlackPlatform }

package/src/targets/base.target.js

@@ -1,5 +1,6 @@
 const { getPlatform } = require('../platforms');
 const { STATUS } = require('../helpers/constants');
+const { getPercentage, getPrettyDuration } = require('../helpers/helper');
 
 class BaseTarget {
 
@@ -34,12 +35,124 @@ class BaseTarget {
      * @type {import('../platforms/base.platform').BasePlatform}
      */
     this.platform = getPlatform(this.name);
+
   }
 
   async run({ result }) {
     // throw new Error('Not implemented');
   }
 
+  /**
+   *
+   * @param {import('..').ITarget} target
+   * @param {import('test-results-parser').ITestSuite} suite
+   */
+  getSuiteSummaryText(target, suite) {
+    const suite_title = this.getSuiteTitle(suite);
+    const suite_results_text = this.#getSuiteResultsText(suite);
+    const duration_text = this.#getSuiteDurationText(target, suite);
+
+    const texts = [
+      this.platform.bold(suite_title),
+      this.platform.break(),
+      this.platform.break(),
+      suite_results_text,
+      this.platform.break(),
+      duration_text,
+    ];
+
+    const metadata_text = this.getSuiteMetaDataText(suite);
+
+    if (metadata_text) {
+      texts.push(this.platform.break());
+      texts.push(this.platform.break());
+      texts.push(metadata_text);
+    }
+
+    return texts.join('');
+  }
+
+  /**
+   *
+   * @param {import('test-results-parser').ITestSuite} suite
+   * @returns {string}
+   */
+  getSuiteTitle(suite) {
+    const emoji = suite.status === 'PASS' ? '✅' : suite.total === suite.skipped ? '⏭️' : '❌';
+    return `${emoji} ${suite.name}`;
+  }
+
+  /**
+   *
+   * @param {import('test-results-parser').ITestSuite} suite
+   * @returns {string}
+   */
+  #getSuiteResultsText(suite) {
+    const suite_results = this.getSuiteResults(suite);
+    return `${this.platform.bold('Results')}: ${suite_results}`;
+  }
+
+  /**
+   *
+   * @param {import('test-results-parser').ITestSuite} suite
+   * @returns {string}
+   */
+  getSuiteResults(suite) {
+    return `${suite.passed} / ${suite.total} Passed (${getPercentage(suite.passed, suite.total)}%)`;
+  }
+
+  /**
+   *
+   * @param {import('..').ITarget} target
+   * @param {import('test-results-parser').ITestSuite} suite
+   */
+  #getSuiteDurationText(target, suite) {
+    const duration = this.getSuiteDuration(target, suite);
+    return `${this.platform.bold('Duration')}: ${duration}`
+  }
+
+  /**
+   *
+   * @param {import('..').ITarget} target
+   * @param {import('test-results-parser').ITestSuite} suite
+   */
+  getSuiteDuration(target, suite) {
+    return getPrettyDuration(suite.duration, target.inputs.duration);
+  }
+
+  /**
+   *
+   * @param {import('test-results-parser').ITestSuite} suite
+   * @returns {string}
+   */
+  getSuiteMetaDataText(suite) {
+    if (!suite || !suite.metadata) {
+      return;
+    }
+
+    const texts = [];
+
+    // webdriver io
+    if (suite.metadata.device && typeof suite.metadata.device === 'string') {
+      texts.push(`${suite.metadata.device}`);
+    }
+
+    if (suite.metadata.platform && suite.metadata.platform.name && suite.metadata.platform.version) {
+      texts.push(`${suite.metadata.platform.name} ${suite.metadata.platform.version}`);
+    }
+
+    if (suite.metadata.browser && suite.metadata.browser.name && suite.metadata.browser.version) {
+      texts.push(`${suite.metadata.browser.name} ${suite.metadata.browser.version}`);
+    }
+
+    // playwright
+    if (suite.metadata.hostname && typeof suite.metadata.hostname === 'string') {
+      texts.push(`${suite.metadata.hostname}`);
+    }
+
+    return texts.join(' • ');
+  }
+
 }
 
-  module.exports = { BaseTarget};
+module.exports = { BaseTarget };

package/src/targets/chat.js

@@ -1,11 +1,11 @@
 const request = require('phin-retry');
 const { getTitleText, getResultText, truncate, getPrettyDuration } = require('../helpers/helper');
 const extension_manager = require('../extensions');
-const { HOOK, STATUS, TARGET } = require('../helpers/constants');
+const { HOOK, STATUS } = require('../helpers/constants');
 const PerformanceTestResult = require('performance-results-parser/src/models/PerformanceTestResult');
 const { getValidMetrics, getMetricValuesText } = require('../helpers/performance');
 const logger = require('../utils/logger');
-const { getPlatform } = require('../platforms');
+const { BaseTarget } = require('./base.target');
 
 async function run({ result, target }) {
   setTargetInputs(target);
@@ -101,8 +101,9 @@ function setSuiteBlock({ result, target, payload }) {
 }
 
 function getSuiteSummary({ target, suite }) {
-  const platform = getPlatform(TARGET.CHAT);
-  const text = platform.getSuiteSummaryText(target, suite);
+  const tg = new ChatTarget({ target });
+  // const platform = getPlatform(TARGET.CHAT);
+  const text = tg.getSuiteSummaryText(target, suite);
   return text;
 }
 
@@ -260,6 +261,12 @@ async function handleErrors({ target, errors }) {
   });
 }
 
+class ChatTarget extends BaseTarget {
+  constructor({ target }) {
+    super({ target });
+  }
+}
+
 module.exports = {
   run,
   handleErrors,

package/src/targets/custom.target.js

@@ -1,5 +1,6 @@
 const { BaseTarget } = require('./base.target');
 const path = require('path');
+const ctx = require('../utils/context.utils');
 
 const DEFAULT_INPUTS = {};
 
@@ -18,9 +19,9 @@ class CustomTarget extends BaseTarget {
     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 });
+      await target_runner.run({ target: this.target, result, ctx });
     } else if (typeof this.inputs.load === 'function') {
-      await this.inputs.load({ target: this.target, result });
+      await this.inputs.load({ target: this.target, result, ctx });
     } else {
       throw `Invalid 'load' input in custom target - ${this.inputs.load}`;
     }

package/src/targets/github-output.target.js

@@ -0,0 +1,64 @@
+const fs = require('fs');
+const path = require('path');
+const logger = require('../utils/logger');
+const { BaseTarget } = require('./base.target');
+const context = require('../utils/context.utils');
+
+const DEFAULT_INPUTS = {
+  output_file: process.env.GITHUB_OUTPUT, // Path to output file, defaults to GITHUB_OUTPUT env var
+  key: 'testbeats' // Key name for the output
+};
+
+const default_options = {
+  condition: 'passOrFail'
+};
+
+class GitHubOutputTarget extends BaseTarget {
+  constructor({ target }) {
+    super({ target });
+  }
+
+  async run({ result, target }) {
+    this.result = result;
+    this.setTargetInputs(target);
+
+    logger.info(`🔔 Writing results to GitHub Actions outputs...`);
+    return await this.writeToGitHubOutput({ target, result });
+  }
+
+  setTargetInputs(target) {
+    target.inputs = Object.assign({}, DEFAULT_INPUTS, target.inputs);
+  }
+
+  async writeToGitHubOutput({ target, result }) {
+    const outputFile = target.inputs.output_file || process.env.GITHUB_OUTPUT;
+
+    if (!outputFile) {
+      throw new Error('GitHub output file path is required. Set GITHUB_OUTPUT environment variable or provide output_file in target inputs.');
+    }
+
+    // Ensure the directory exists
+    const outputDir = path.dirname(outputFile);
+    if (!fs.existsSync(outputDir)) {
+      fs.mkdirSync(outputDir, { recursive: true });
+    }
+
+    const lines = []
+    lines.push(`${target.inputs.key}_results=${JSON.stringify(result)}`)
+    lines.push(`${target.inputs.key}_stores=${JSON.stringify(context.stores)}`)
+    const outputContent = lines.join('\n');
+
+    fs.appendFileSync(outputFile, outputContent);
+
+    logger.info(`✅ Successfully wrote results to ${outputFile}`);
+    return { success: true, key: target.inputs.key };
+  }
+
+  async handleErrors({ target, errors }) {
+    logger.error('GitHub Output target errors:', errors);
+  }
+}
+
+module.exports = {
+  GitHubOutputTarget
+};