testbeats 2.2.7 → 2.2.9

package/src/targets/github.target.js

@@ -0,0 +1,316 @@
+const request = require('phin-retry');
+const { getPercentage, truncate, getPrettyDuration } = require('../helpers/helper');
+const extension_manager = require('../extensions');
+const { HOOK, STATUS } = require('../helpers/constants');
+const logger = require('../utils/logger');
+
+const PerformanceTestResult = require('performance-results-parser/src/models/PerformanceTestResult');
+const { getValidMetrics, getMetricValuesText } = require('../helpers/performance');
+const { BaseTarget } = require('./base.target');
+
+const STATUSES = {
+  GOOD: '✅',
+  WARNING: '⚠️',
+  DANGER: '❌'
+}
+
+const DEFAULT_INPUTS = {
+  token: undefined,
+  comment_title: undefined,
+  update_comment: false,
+  owner: undefined,
+  repo: undefined,
+  pull_number: undefined,
+  title: undefined,
+  title_suffix: undefined,
+  title_link: undefined,
+  include_suites: true,
+  include_failure_details: false,
+  only_failures: false,
+  max_suites: 10,
+  duration: 'long',
+  publish: 'test-summary'
+};
+
+const default_options = {
+  condition: STATUS.PASS_OR_FAIL
+};
+
+class GitHubTarget extends BaseTarget {
+  constructor({ target }) {
+    super({ target });
+  }
+
+  async run({ result, target }) {
+    this.result = result;
+    this.setTargetInputs(target);
+    const payload = this.getMainPayload();
+    if (result instanceof PerformanceTestResult) {
+      await this.setPerformancePayload({ result, target, payload });
+    } else {
+      await this.setFunctionalPayload({ result, target, payload });
+    }
+    const message = this.getMarkdownMessage({ result, target, payload });
+    logger.info(`🔔 Publishing results to GitHub PR...`);
+    return await this.publishToGitHub({ target, message });
+  }
+
+  async setFunctionalPayload({ result, target, payload }) {
+    await extension_manager.run({ result, target, payload, hook: HOOK.START });
+    this.setMainContent({ result, target, payload });
+    await extension_manager.run({ result, target, payload, hook: HOOK.AFTER_SUMMARY });
+    this.setSuiteContent({ result, target, payload });
+    await extension_manager.run({ result, target, payload, hook: HOOK.END });
+  }
+
+  setTargetInputs(target) {
+    target.inputs = Object.assign({}, DEFAULT_INPUTS, target.inputs);
+    if (target.inputs.publish === 'test-summary-slim') {
+      target.inputs.include_suites = false;
+    }
+    if (target.inputs.publish === 'failure-details') {
+      target.inputs.include_failure_details = true;
+    }
+  }
+
+  getMainPayload() {
+    return {
+      content: []
+    };
+  }
+
+  setMainContent({ result, target, payload }) {
+    const titleText = this.getTitleText(result, target);
+    const resultText = this.getResultText(result);
+    const durationText = getPrettyDuration(result.duration, target.inputs.duration);
+
+    let content = `## ${titleText}\n\n`;
+    content += `**Results**: ${resultText}\n`;
+    content += `**Duration**: ${durationText}\n\n`;
+
+    payload.content.push(content);
+  }
+
+  getTitleText(result, target) {
+    let text = target.inputs.title ? target.inputs.title : result.name;
+    if (target.inputs.title_suffix) {
+      text = `${text} ${target.inputs.title_suffix}`;
+    }
+    if (target.inputs.title_link) {
+      text = `[${text}](${target.inputs.title_link})`;
+    }
+
+    const status = result.status !== 'PASS' ? STATUSES.DANGER : STATUSES.GOOD;
+    return `${status} ${text}`;
+  }
+
+  getResultText(result) {
+    const percentage = getPercentage(result.passed, result.total);
+    return `${result.passed} / ${result.total} Passed (${percentage}%)`;
+  }
+
+  setSuiteContent({ result, target, payload }) {
+    let suite_count = 0;
+    if (target.inputs.include_suites) {
+      for (let i = 0; i < result.suites.length && suite_count < target.inputs.max_suites; i++) {
+        const suite = result.suites[i];
+        if (target.inputs.only_failures && suite.status !== 'FAIL') {
+          continue;
+        }
+
+        // if suites length eq to 1 then main content will include suite summary
+        if (result.suites.length > 1) {
+          payload.content.push(this.getSuiteSummary({ target, suite }));
+          suite_count += 1;
+        }
+
+        if (target.inputs.include_failure_details) {
+          // Only attach failure details if there were failures
+          if (suite.failed > 0) {
+            payload.content.push(this.getFailureDetails(suite));
+          }
+        }
+      }
+    }
+  }
+
+  getSuiteSummary({ target, suite }) {
+    const text = this.getSuiteSummaryText(target, suite);
+    return `### ${suite.name}\n${text}\n\n`;
+  }
+
+  getFailureDetails(suite) {
+    let content = `<details>\n<summary>❌ Failed Tests</summary>\n\n`;
+    const cases = suite.cases;
+    for (let i = 0; i < cases.length; i++) {
+      const test_case = cases[i];
+      if (test_case.status === 'FAIL') {
+        content += `**Test**: ${test_case.name}\n`;
+        content += `**Error**: \n\`\`\`\n${truncate(test_case.failure ?? 'N/A', 500)}\n\`\`\`\n\n`;
+      }
+    }
+    content += `</details>\n\n`;
+    return content;
+  }
+
+  getMarkdownMessage({ result, target, payload }) {
+    return payload.content.join('');
+  }
+
+  async publishToGitHub({ target, message }) {
+    const { url, repo, owner, pull_number } = this.extractGitHubInfo(target);
+    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 token in target inputs.');
+    }
+
+    if (!pull_number) {
+      throw new Error('Pull request number not found. This target only works in GitHub Actions triggered by pull requests.');
+    }
+
+    const comment_body = target.inputs.comment_title ?
+      `${target.inputs.comment_title}\n\n${message}` :
+      message;
+
+    const headers = {
+      'Authorization': `token ${token}`,
+      'Accept': 'application/vnd.github.v3+json',
+      'User-Agent': 'testbeats'
+    };
+
+    if (target.inputs.update_comment) {
+      // Try to find existing comment and update it
+      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}`,
+          headers,
+          body: { body: comment_body }
+        });
+      }
+    }
+
+    // Create new comment
+    return request.post({
+      url: `${url}/repos/${owner}/${repo}/issues/${pull_number}/comments`,
+      headers,
+      body: { body: comment_body }
+    });
+  }
+
+  async 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 ${token}`,
+        'Accept': 'application/vnd.github.v3+json',
+        'User-Agent': 'testbeats'
+      };
+
+      const response = await request.get({ url, headers });
+      const comments = JSON.parse(response.body);
+
+      return comments.find(comment => comment.body.includes(comment_title));
+    } catch (error) {
+      logger.warn('Failed to find existing comment:', error.message);
+      return null;
+    }
+  }
+
+  extractGitHubInfo(target) {
+    let url = target.inputs.url;
+    let owner = target.inputs.owner;
+    let repo = target.inputs.repo;
+    let pull_number = target.inputs.pull_number;
+
+    if (!owner || !repo) {
+      const repository = process.env.GITHUB_REPOSITORY;
+      const ref = process.env.GITHUB_REF;
+      [owner, repo] = repository.split('/');
+      if (ref && ref.includes('refs/pull/')) {
+        pull_number = ref.replace('refs/pull/', '').replace('/merge', '');
+      }
+    }
+
+    if (!url) {
+      url = `https://api.github.com`;
+    }
+
+    return {
+      url,
+      owner,
+      repo,
+      pull_number
+    };
+  }
+
+  async setPerformancePayload({ result, target, payload }) {
+    await extension_manager.run({ result, target, payload, hook: HOOK.START });
+    await this.setPerformanceMainContent({ result, target, payload });
+    await extension_manager.run({ result, target, payload, hook: HOOK.AFTER_SUMMARY });
+    await this.setTransactionContent({ result, target, payload });
+    await extension_manager.run({ result, target, payload, hook: HOOK.END });
+  }
+
+  async setPerformanceMainContent({ result, target, payload }) {
+    const titleText = this.getTitleText(result, target);
+    let content = `## ${titleText}\n\n`;
+
+    const metrics = getValidMetrics(result.metrics);
+    if (metrics.length > 0) {
+      content += `**Performance Metrics**:\n`;
+      content += getMetricValuesText(metrics);
+      content += '\n\n';
+    }
+
+    content += `**Duration**: ${getPrettyDuration(result.duration, target.inputs.duration)}\n\n`;
+    payload.content.push(content);
+  }
+
+  async setTransactionContent({ result, target, payload }) {
+    let transaction_count = 0;
+    if (target.inputs.include_suites) {
+      for (let i = 0; i < result.transactions.length && transaction_count < target.inputs.max_suites; i++) {
+        const transaction = result.transactions[i];
+        if (target.inputs.only_failures && transaction.status !== 'FAIL') {
+          continue;
+        }
+
+        payload.content.push(getTransactionSummary({ target, transaction }));
+        transaction_count += 1;
+      }
+    }
+  }
+
+  getTransactionSummary({ target, transaction }) {
+    let content = `### ${transaction.name}\n`;
+    content += `**Status**: ${transaction.status === 'PASS' ? STATUSES.GOOD : STATUSES.DANGER}\n`;
+    content += `**Duration**: ${getPrettyDuration(transaction.duration, target.inputs.duration)}\n`;
+
+    if (transaction.metrics && transaction.metrics.length > 0) {
+      const metrics = getValidMetrics(transaction.metrics);
+      if (metrics.length > 0) {
+        content += `**Metrics**: ${getMetricValuesText(metrics)}\n`;
+      }
+    }
+
+    content += '\n';
+    return content;
+  }
+
+  async handleErrors({ target, errors }) {
+    logger.error('GitHub target errors:', errors);
+  }
+}
+
+module.exports = {
+  // name: 'GitHub',
+  // run,
+  // handleErrors,
+  // default_inputs,
+  // default_options,
+  GitHubTarget
+};

package/src/targets/index.js

@@ -1,7 +1,8 @@
 const teams = require('./teams');
 const slack = require('./slack');
 const chat = require('./chat');
-const github = require('./github');
+const { GitHubTarget} = require('./github.target');
+const { GitHubOutputTarget } = require('./github-output.target');
 const { CustomTarget } = require('./custom.target');
 const { DelayTarget } = require('./delay.target');
 const { HttpTarget } = require('./http.target');
@@ -18,7 +19,9 @@ function getTargetRunner(target) {
     case TARGET.CHAT:
       return chat;
     case TARGET.GITHUB:
-      return github;
+      return new GitHubTarget({ target });
+    case TARGET.GITHUB_OUTPUT:
+      return new GitHubOutputTarget({ target });
     case TARGET.CUSTOM:
       return new CustomTarget({ target });
     case TARGET.DELAY:

package/src/targets/slack.js

@@ -1,13 +1,15 @@
 const request = require('phin-retry');
 const { getPercentage, truncate, getPrettyDuration } = require('../helpers/helper');
 const extension_manager = require('../extensions');
-const { HOOK, STATUS, TARGET } = require('../helpers/constants');
+const { HOOK, STATUS } = require('../helpers/constants');
 const logger = require('../utils/logger');
+const ctx = require('../utils/context.utils');
 
 const PerformanceTestResult = require('performance-results-parser/src/models/PerformanceTestResult');
 const { getValidMetrics, getMetricValuesText } = require('../helpers/performance');
 const TestResult = require('test-results-parser/src/models/TestResult');
-const { getPlatform } = require('../platforms');
+const { BaseTarget } = require('./base.target');
+
 
 const SLACK_BASE_URL = 'https://slack.com';
 
@@ -33,7 +35,7 @@ async function run({ result, target }) {
   }
   const message = getRootPayload({ result, target, payload });
   logger.info(`🔔 Publishing results to Slack...`);
-  return publish({ inputs: target.inputs, message });
+  return publish({ target, message });
 }
 
 async function setFunctionalPayload({ result, target, payload }) {
@@ -73,7 +75,7 @@ function setMainBlock({ result, target, payload }) {
   });
 }
 
-function getTitleText(result, target, {allowTitleLink = true} = {}) {
+function getTitleText(result, target, { allowTitleLink = true } = {}) {
   let text = target.inputs.title ? target.inputs.title : result.name;
   if (target.inputs.title_suffix) {
     text = `${text} ${target.inputs.title_suffix}`;
@@ -121,8 +123,8 @@ function setSuiteBlock({ result, target, payload }) {
 }
 
 function getSuiteSummary({ target, suite }) {
-  const platform = getPlatform(TARGET.SLACK);
-  const text = platform.getSuiteSummaryText(target, suite);
+  const tg = new SlackTarget({ target });
+  const text = tg.getSuiteSummaryText(target, suite);
   return {
     "type": "section",
     "text": {
@@ -172,7 +174,7 @@ function getRootPayload({ result, target, payload }) {
     }
   }
 
-  const fallback_text = `${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 {
@@ -324,18 +326,29 @@ async function handleErrors({ target, errors }) {
   });
 }
 
-async function publish({ inputs, message}) {
-  const { url, token, channels } = inputs;
+async function publish({ target, message }) {
+  const { url, token, channels } = target.inputs;
   if (token) {
-    for (let i = 0; i < channels.length; i++) {
-      message.channel = channels[i];
-      return request.post({
+    for (const channel of channels) {
+      message.channel = channel;
+      const response = await request.post({
         url: url ? url : `${SLACK_BASE_URL}/api/chat.postMessage`,
         headers: {
+          'Content-Type': 'application/json',
           'Authorization': `Bearer ${token}`
         },
         body: message
       });
+      ctx.stores.push({
+        target,
+        response,
+      });
+      if (response && response.ok) {
+        logger.info(`✔ Published to Slack channel - ${channel}`);
+      } else {
+        logger.error(`✖ Failed to publish to Slack channel - ${channel}`);
+        logger.error(response);
+      }
     }
 
   } else {
@@ -346,6 +359,13 @@ async function publish({ inputs, message}) {
   }
 }
 
+
+class SlackTarget extends BaseTarget {
+  constructor({ target }) {
+    super({ target });
+  }
+}
+
 module.exports = {
   run,
   handleErrors,

package/src/targets/teams.js

@@ -2,12 +2,12 @@ const request = require('phin-retry');
 const { getPercentage, truncate, getPrettyDuration } = require('../helpers/helper');
 const { getValidMetrics, getMetricValuesText } = require('../helpers/performance');
 const extension_manager = require('../extensions');
-const { HOOK, STATUS, TARGET } = require('../helpers/constants');
+const { HOOK, STATUS } = require('../helpers/constants');
 const logger = require('../utils/logger');
 
 const TestResult = require('test-results-parser/src/models/TestResult');
 const PerformanceTestResult = require('performance-results-parser/src/models/PerformanceTestResult');
-const { getPlatform } = require('../platforms');
+const { BaseTarget } = require('./base.target');
 
 /**
  * @param {object} param0
@@ -145,11 +145,11 @@ function setSuiteBlock({ result, target, payload }) {
 }
 
 function getSuiteSummary({ suite, target }) {
-
-  const platform = getPlatform(TARGET.TEAMS);
-  const suite_title = platform.getSuiteTitle(suite);
-  const suite_results = platform.getSuiteResults(suite);
-  const duration = platform.getSuiteDuration(target, suite);
+  const tg = new TeamsTarget({ target });
+  // const platform = getPlatform(TARGET.TEAMS);
+  const suite_title = tg.getSuiteTitle(suite);
+  const suite_results = tg.getSuiteResults(suite);
+  const duration = tg.getSuiteDuration(target, suite);
 
   const blocks = [
     {
@@ -174,7 +174,7 @@ function getSuiteSummary({ suite, target }) {
     }
   ];
 
-  const suite_metadata_text = platform.getSuiteMetaDataText(suite);
+  const suite_metadata_text = tg.getSuiteMetaDataText(suite);
   if (suite_metadata_text) {
     blocks.push({
       "type": "TextBlock",
@@ -348,6 +348,12 @@ async function handleErrors({ target, errors }) {
   });
 }
 
+class TeamsTarget extends BaseTarget {
+  constructor({ target }) {
+    super({ target });
+  }
+}
+
 module.exports = {
   run,
   handleErrors,

package/src/utils/context.utils.js

@@ -0,0 +1,5 @@
+const stores = [];
+
+module.exports = {
+  stores,
+}