testbeats 2.0.1 → 2.0.2

package/README.md

@@ -1,4 +1,4 @@
-> !IMPORTANT - 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.
+> 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">
 
@@ -19,35 +19,23 @@
 
 <hr>
 
-### Targets
-
-<img height="48" style="margin: 6px;" src="./assets/slack.png" alt="slack" /> <img height="48" style="margin: 6px;"  src="./assets/teams.png" alt="teams" /> <img height="48" style="margin: 6px;"  src="./assets/chat.png" alt="chat" />
-
-### Extensions
-
-<img height="48" style="margin: 6px;" src="./assets/reportportal.jpeg" alt="reportportal" /> <img height="48" style="margin: 6px;"  src="./assets/quickchart.png" alt="quickchart" /> <img height="48" style="margin: 6px;"  src="./assets/hyperlink.png" alt="hyperlink" /> <img height="48" style="margin: 6px;"  src="./assets/mentions.png" alt="mentions" />
-
-### Test Results
-
-<img height="48" style="margin: 6px;" src="./assets/testng.png" alt="testng" /> <img height="48" style="margin: 6px;"  src="./assets/junit.png" alt="junit" /> <img height="48" style="margin: 6px;"  src="./assets/cucumber.png" alt="cucumber" /> <img height="48" style="margin: 6px;"  src="./assets/mocha.png" alt="mocha" /> <img height="48" style="margin: 6px;"  src="./assets/xunit.png" alt="xunit" /> <img height="48" style="margin: 6px;"  src="./assets/jmeter.png" alt="jmeter" />
+</span>
 
-<hr>
+### Get Started
 
-## Sample Reports
+TestBeats is a tool designed to streamline the process of publishing test results from various automation testing frameworks to communication platforms like **slack**, **teams** and more for easy access and collaboration. It unifies your test reporting to build quality insights and make faster decisions.
 
-<br>
+Read more about the project at [https://testbeats.com](https://testbeats.com)
 
-![teams-summary-report](https://github.com/test-results-reporter/testbeats/raw/main/assets/teams-qc.png)
+### Sample Reports
 
-![slack-summary-report](https://github.com/test-results-reporter/testbeats/raw/main/assets/slack-report-portal-analysis.png)
+#### Alerts in Slack
 
-<br />
+![testbeats-failure-summary](./assets/testbeats-slack-failure-summary.png)
 
-<hr >
+#### Results in Portal
 
-# [Documentation](https://test-results-reporter.github.io/)
-
-</span>
+![testbeats-failure-summary](./assets/testbeats-failure-summary.png)
 
 <br />
 

package/package.json

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

package/src/beats/beats.api.js

@@ -0,0 +1,40 @@
+const request = require('phin-retry');
+
+class BeatsApi {
+
+  /**
+   * @param {import('../index').PublishReport} config
+   */
+  constructor(config) {
+    this.config = config;
+  }
+
+  postTestRun(payload) {
+    return request.post({
+      url: `${this.getBaseUrl()}/api/core/v1/test-runs`,
+      headers: {
+        'x-api-key': this.config.api_key
+      },
+      body: payload
+    });
+  }
+
+ /**
+  * @param {string} run_id
+  * @returns
+  */
+  getTestRun(run_id) {
+    return request.get({
+      url: `${this.getBaseUrl()}/api/core/v1/test-runs/key?id=${run_id}`,
+      headers: {
+        'x-api-key': this.config.api_key
+      }
+    });
+  }
+
+  getBaseUrl() {
+    return process.env.TEST_BEATS_URL || "https://app.testbeats.com";
+  }
+}
+
+module.exports = { BeatsApi }

package/src/beats/beats.js

@@ -0,0 +1,151 @@
+const { getCIInformation } = require('../helpers/ci');
+const logger = require('../utils/logger');
+const { BeatsApi } = require('./beats.api');
+const { HOOK } = require('../helpers/constants');
+
+class Beats {
+
+  /**
+   * @param {import('../index').PublishReport} config
+   * @param {TestResult} result
+   */
+  constructor(config, result) {
+    this.config = config;
+    this.result = result;
+    this.api = new BeatsApi(config);
+    this.test_run_id = '';
+  }
+
+  async publish() {
+    this.#setCIInfo();
+    this.#setProjectName();
+    this.#setRunName();
+    this.#setApiKey();
+    await this.#publishTestResults();
+    this.#updateTitleLink();
+    await this.#attachFailureSummary();
+  }
+
+  #setCIInfo() {
+    this.ci = getCIInformation();
+  }
+
+  #setProjectName() {
+    this.config.project = this.config.project || process.env.TEST_BEATS_PROJECT || (this.ci && this.ci.repository_name) || 'demo-project';
+  }
+
+  #setApiKey() {
+    this.config.api_key = this.config.api_key || process.env.TEST_BEATS_API_KEY;
+  }
+
+  #setRunName() {
+    this.config.run = this.config.run || process.env.TEST_BEATS_RUN || (this.ci && this.ci.build_name) || 'demo-run';
+  }
+
+  async #publishTestResults() {
+    if (!this.config.api_key) {
+      logger.warn('😿 No API key provided, skipping publishing results to TestBeats Portal');
+      return;
+    }
+    logger.info("🚀 Publishing results to TestBeats Portal...");
+    try {
+      const payload = this.#getPayload();
+      const response = await this.api.postTestRun(payload);
+      this.test_run_id = response.id;
+    } catch (error) {
+      logger.error(`❌ Unable to publish results to TestBeats Portal: ${error.message}`, error);
+    }
+  }
+
+  #getPayload() {
+    const payload = {
+      project: this.config.project,
+      run: this.config.run,
+      ...this.result
+    }
+    if (this.ci) {
+      payload.ci_details = [this.ci];
+    }
+    return payload;
+  }
+
+  #updateTitleLink() {
+    if (!this.test_run_id) {
+      return;
+    }
+    if (!this.config.targets) {
+      return;
+    }
+    const link = `${this.api.getBaseUrl()}/reports/${this.test_run_id}`;
+    for (const target of this.config.targets) {
+      target.inputs.title_link = link;
+    }
+  }
+
+  async #attachFailureSummary() {
+    if (!this.test_run_id) {
+      return;
+    }
+    if (!this.config.targets) {
+      return;
+    }
+    if (this.result.status !== 'FAIL') {
+      return;
+    }
+    if (this.config.show_failure_summary === false) {
+      return;
+    }
+    const text = await this.#getFailureSummary();
+    if (!text) {
+      return;
+    }
+    const extension = this.#getAIFailureSummaryExtension(text);
+    for (const target of this.config.targets) {
+      target.extensions = target.extensions || [];
+      target.extensions.push(extension);
+    }
+  }
+
+  async #getFailureSummary() {
+    logger.info('✨ Fetching AI Failure Summary...');
+    let retry = 3;
+    while (retry >= 0) {
+      retry = retry - 1;
+      await new Promise(resolve => setTimeout(resolve, this.#getDelay()));
+      const test_run = await this.api.getTestRun(this.test_run_id);
+      const status = test_run && test_run.failure_summary_status;
+      switch (status) {
+        case 'COMPLETED':
+          return test_run.execution_metrics[0].failure_summary;
+        case 'FAILED':
+          logger.error(`❌ Failed to generate AI Failure Summary`);
+          return;
+        case 'SKIPPED':
+          logger.warn(`❗ Skipped generating AI Failure Summary`);
+          return;
+      }
+      logger.info(`🔄 AI Failure Summary not generated, retrying...`);
+    }
+    logger.warn(`🙈 AI Failure Summary not generated in given time`);
+  }
+
+  #getDelay() {
+    if (process.env.TEST_BEATS_DELAY) {
+      return parseInt(process.env.TEST_BEATS_DELAY);
+    }
+    return 3000;
+  }
+
+  #getAIFailureSummaryExtension(text) {
+    return {
+      name: 'ai-failure-summary',
+      hook: HOOK.AFTER_SUMMARY,
+      inputs: {
+        failure_summary: text
+      }
+    };
+  }
+
+}
+
+module.exports = { Beats }

package/src/beats/index.js

@@ -1,174 +1,13 @@
-const request = require('phin-retry');
 const TestResult = require('test-results-parser/src/models/TestResult');
-const { getCIInformation } = require('../helpers/ci');
-const { HOOK } = require('../helpers/constants');
-
-function get_base_url() {
-  return process.env.TEST_BEATS_URL || "https://app.testbeats.com";
-}
+const { Beats } = require('./beats');
 
 /**
  * @param {import('../index').PublishReport} config
  * @param {TestResult} result
  */
 async function run(config, result) {
-  init(config);
-  if (isValid(config)) {
-    const run_id = await publishTestResults(config, result);
-    if (run_id) {
-      attachTestBeatsReportHyperLink(config, run_id);
-      await attachTestBeatsFailureSummary(config, result, run_id);
-    }
-  } else {
-    console.warn('Missing testbeats config parameters');
-  }
-}
-
-/**
- *
- * @param {import('../index').PublishReport} config
- */
-function init(config) {
-  config.project = config.project || process.env.TEST_BEATS_PROJECT;
-  config.run = config.run || process.env.TEST_BEATS_RUN;
-  config.api_key = config.api_key || process.env.TEST_BEATS_API_KEY;
-}
-
-/**
- *
- * @param {import('../index').PublishReport} config
- */
-function isValid(config) {
-  return config.project && config.run && config.api_key
-}
-
-/**
- * @param {import('../index').PublishReport} config
- * @param {TestResult} result
- */
-async function publishTestResults(config, result) {
-  console.log("Publishing results to TestBeats");
-  try {
-    const payload = {
-      project: config.project,
-      run: config.run,
-      ...result
-    }
-    const ci = getCIInformation();
-    if (ci) {
-      payload.ci_details = [ci];
-    }
-
-    const response = await request.post({
-      url: `${get_base_url()}/api/core/v1/test-runs`,
-      headers: {
-        'x-api-key': config.api_key
-      },
-      body: payload
-    });
-    return response.id;
-  } catch (error) {
-    console.log("Unable to publish results to TestBeats");
-    console.log(error);
-  }
-}
-
-/**
- * @param {import('../index').PublishReport} config
- * @param {string} run_id
- */
-function attachTestBeatsReportHyperLink(config, run_id) {
-  const beats_link = get_test_beats_report_link(run_id);
-  if (config.targets) {
-    for (const target of config.targets) {
-      target.inputs.title_link = beats_link;
-    }
-  }
-}
-
-/**
- * @param {import('../index').PublishReport} config
- * @param {TestResult} result
- * @param {string} run_id
- */
-async function attachTestBeatsFailureSummary(config, result, run_id) {
-  if (result.status !== 'FAIL') {
-    return;
-  }
-  if (config.show_failure_summary === false) {
-    return;
-  }
-  try {
-    await processFailureSummary(config, run_id);
-  } catch (error) {
-    console.log(error);
-    console.log("error processing failure summary");
-  }
-}
-
-async function processFailureSummary(config, run_id) {
-  let retry = 3;
-  while (retry > 0) {
-    const test_run = await getTestRun(config, run_id);
-    if (test_run && test_run.failure_summary_status) {
-      if (test_run.failure_summary_status === 'COMPLETED') {
-        addAIFailureSummaryExtension(config, test_run);
-        return;
-      } else if (test_run.failure_summary_status === 'FAILED') {
-        console.log(`Test run failure summary failed`);
-        return;
-      } else if (test_run.failure_summary_status === 'SKIPPED') {
-        console.log(`Test run failure summary failed`);
-        return;
-      }
-    }
-    console.log(`Test run failure summary not completed, retrying...`);
-    await new Promise(resolve => setTimeout(resolve, 3000));
-    retry = retry - 1;
-  }
-}
-
-/**
- * @param {import('../index').PublishReport} config
- * @param {string} run_id
- */
-function getTestRun(config, run_id) {
-  return request.get({
-    url: `${get_base_url()}/api/core/v1/test-runs/key?id=${run_id}`,
-    headers: {
-      'x-api-key': config.api_key
-    }
-  });
-}
-
-function getAIFailureSummaryExtension(test_run) {
-  const execution_metric = test_run.execution_metrics[0];
-  return {
-    name: 'ai-failure-summary',
-    hook: HOOK.AFTER_SUMMARY,
-    inputs: {
-      failure_summary: execution_metric.failure_summary
-    }
-  };
-}
-
-function addAIFailureSummaryExtension(config, test_run) {
-  const extension = getAIFailureSummaryExtension(test_run);
-  if (config.targets) {
-    for (const target of config.targets) {
-      target.extensions = target.extensions || [];
-      target.extensions.push(extension);
-    }
-  }
-}
-
-/**
- *
- * @param {string} run_id
- * @returns
- */
-function get_test_beats_report_link(run_id) {
-  return `${get_base_url()}/reports/${run_id}`;
+  const beats = new Beats(config, result);
+  await beats.publish();
 }
 
 module.exports = { run }

package/src/cli.js

@@ -5,17 +5,21 @@ const sade = require('sade');
 
 const prog = sade('testbeats');
 const publish = require('./commands/publish');
+const logger = require('./utils/logger');
 
 prog
   .version('2.0.1')
-  .option('-c, --config', 'Provide path to custom config', 'config.json');
+  .option('-c, --config', 'Provide path to custom config', 'config.json')
+  .option('-l, --logLevel', 'Log Level', "INFO");
 
 prog.command('publish')
   .action(async (opts) => {
     try {
+      logger.setLevel(opts.logLevel);
+      logger.info(`Initiating...`);
       await publish.run(opts);
     } catch (error) {
-      console.error(error);
+      logger.error(`Report publish failed: ${error.message}`);
       process.exit(1);
     }
   });

package/src/commands/publish.js

@@ -2,14 +2,17 @@ const path = require('path');
 const trp = require('test-results-parser');
 const prp = require('performance-results-parser');
 
+const pkg = require('../../package.json');
 const { processData } = require('../helpers/helper');
 const beats = require('../beats');
 const target_manager = require('../targets');
+const logger = require('../utils/logger');
 
 /**
  * @param {import('../index').PublishOptions} opts
  */
 async function run(opts) {
+  logger.info(`💡 TestBeats v${pkg.version}`);
   if (!opts) {
     throw new Error('Missing publish options');
   }
@@ -35,6 +38,7 @@ async function run(opts) {
     validateConfig(config);
     await processReport(config);
   }
+  logger.info('✅ Results published successfully!');
 }
 
 /**
@@ -42,6 +46,7 @@ async function run(opts) {
  * @param {import('../index').PublishReport} report
  */
 async function processReport(report) {
+  logger.debug("processReport: Started")
   const parsed_results = [];
   for (const result_options of report.results) {
     if (result_options.type === 'custom') {
@@ -61,9 +66,10 @@ async function processReport(report) {
         await target_manager.run(target, result);
       }
     } else {
-      console.log('No targets defined, skipping sending results to targets');
+      logger.warn('No targets defined, skipping sending results to targets');
     }
   }
+  logger.debug("processReport: Ended")
 }
 
 /**
@@ -71,8 +77,9 @@ async function processReport(report) {
  * @param {import('../index').PublishReport} config
  */
 function validateConfig(config) {
+  logger.info("🛠️  Validating configuration...")
   if (!config) {
-    throw new Error('Missing publish config');
+    throw new Error('Missing configuration');
   }
   validateResults(config);
   validateTargets(config);
@@ -83,6 +90,7 @@ function validateConfig(config) {
  * @param {import('../index').PublishReport} config
  */
 function validateResults(config) {
+  logger.debug("Validating results...")
   if (!config.results) {
     throw new Error('Missing results properties in config');
   }
@@ -112,6 +120,7 @@ function validateResults(config) {
       }
     }
   }
+  logger.debug("Validating results - Successful!")
 }
 
 /**
@@ -119,8 +128,9 @@ function validateResults(config) {
  * @param {import('../index').PublishReport} config
  */
 function validateTargets(config) {
+  logger.debug("Validating targets...")
   if (!config.targets) {
-    console.warn('targets are not defined in config');
+    logger.warn('⚠️ Targets are not defined in config');
     return;
   }
   if (!Array.isArray(config.targets)) {
@@ -150,6 +160,7 @@ function validateTargets(config) {
       }
     }
   }
+  logger.debug("Validating targets - Successful!")
 }
 
 module.exports = {

package/src/extensions/index.js

@@ -10,6 +10,7 @@ const ci_info = require('./ci-info');
 const ai_failure_summary = require('./ai-failure-summary');
 const { EXTENSION } = require('../helpers/constants');
 const { checkCondition } = require('../helpers/helper');
+const logger = require('../utils/logger');
 
 async function run(options) {
   const { target, result, hook } = options;
@@ -25,9 +26,9 @@ async function run(options) {
         try {
           await extension_runner.run(options);
         } catch (error) {
-          console.log('Failed to run extension');
-          console.log(extension);
-          console.log(error);
+          logger.error(`Failed to run extension: ${error.message}`);
+          logger.debug(`Extension details`, extension);
+          logger.debug(`Error: `, error);
         }
       }
     }

package/src/extensions/report-portal-history.js

@@ -1,6 +1,7 @@
 const { getSuiteHistory, getLastLaunchByName, getLaunchDetails } = require('../helpers/report-portal');
 const { addChatExtension, addSlackExtension, addTeamsExtension } = require('../helpers/extension.helper');
 const { HOOK, STATUS } = require('../helpers/constants');
+const logger = require('../utils/logger');
 
 async function getLaunchHistory(extension) {
   const { inputs, outputs } = extension;
@@ -71,8 +72,8 @@ async function run({ extension, target, payload }) {
       }
     }
   } catch (error) {
-    console.log('Failed to get report portal history');
-    console.log(error);
+    logger.error(`Failed to get report portal history: ${error.message}`);
+    logger.debug(`Error: ${error}`);
   }
 }
 

package/src/utils/logger.js

@@ -0,0 +1,98 @@
+const trm = console;
+
+const LEVEL_VERBOSE = 2;
+const LEVEL_TRACE = 3;
+const LEVEL_DEBUG = 4;
+const LEVEL_INFO = 5;
+const LEVEL_WARN = 6;
+const LEVEL_ERROR = 7;
+const LEVEL_SILENT = 8;
+
+/**
+ * returns log level value
+ * @param {string} level - log level
+ */
+function getLevelValue(level) {
+  const logLevel = level.toUpperCase();
+  switch (logLevel) {
+    case 'TRACE':
+      return LEVEL_TRACE;
+    case 'DEBUG':
+      return LEVEL_DEBUG;
+    case 'INFO':
+      return LEVEL_INFO;
+    case 'WARN':
+      return LEVEL_WARN;
+    case 'ERROR':
+      return LEVEL_ERROR;
+    case 'SILENT':
+      return LEVEL_SILENT;
+    case 'VERBOSE':
+      return LEVEL_VERBOSE;
+    default:
+      return LEVEL_INFO;
+  }
+}
+
+class Logger {
+
+  constructor() {
+    this.level = process.env.TESTBEATS_LOG_LEVEL || 'INFO';
+    this.levelValue = getLevelValue(this.level);
+    if (process.env.TESTBEATS_DISABLE_LOG_COLORS === 'true') {
+      options.disableColors = true;
+    }
+  }
+
+  /**
+   * sets log level
+   * @param {('TRACE'|'DEBUG'|'INFO'|'WARN'|'ERROR')} level - log level
+   */
+  setLevel(level) {
+    this.level = level;
+    this.levelValue = getLevelValue(this.level);
+  }
+
+  trace(...msg) {
+    if (this.levelValue <= LEVEL_TRACE) {
+      msg.forEach(m => trm.debug(m));
+    }
+  }
+
+  debug(...msg) {
+    if (this.levelValue <= LEVEL_DEBUG) {
+      msg.forEach(m => trm.debug(m));
+    }
+  }
+
+  info(...msg) {
+    if (this.levelValue <= LEVEL_INFO) {
+      msg.forEach(m => trm.info(m));
+    }
+  }
+
+  warn(...msg) {
+    if (this.levelValue <= LEVEL_WARN) {
+      msg.forEach(m => trm.warn(getMessage(m)));
+    }
+  }
+
+  error(...msg) {
+    if (this.levelValue <= LEVEL_ERROR) {
+      msg.forEach(m => trm.error(getMessage(m)));
+    }
+  }
+
+}
+
+
+function getMessage(msg) {
+  try {
+    return typeof msg === 'object' ? JSON.stringify(msg, null, 2) : msg;
+  } catch (_) {
+    return msg;
+  }
+}
+
+
+module.exports = new Logger();