testbeats 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Anudeep
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,60 @@
+> !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.
+
+<span align="center">
+
+![logo](https://github.com/test-results-reporter/testbeats/raw/main/assets/logo.png)
+
+
+#### Publish test results to Microsoft Teams, Google Chat, Slack and many more.
+
+<br />
+
+![Build](https://github.com/test-results-reporter/testbeats/workflows/Build/badge.svg?branch=main)
+![Downloads](https://img.shields.io/npm/dt/test-results-reporter?logo=npm&label=downloads-old)
+![Downloads](https://img.shields.io/npm/dt/testbeats?logo=npm)
+![Size](https://img.shields.io/bundlephobia/minzip/testbeats)
+
+[![Stars](https://img.shields.io/github/stars/test-results-reporter/testbeats?style=social)](https://github.com/test-results-reporter/testbeats/stargazers)
+![Downloads](https://img.shields.io/github/downloads/test-results-reporter/testbeats/total?logo=github)
+
+<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" />
+
+<hr>
+
+## Sample Reports
+
+<br>
+
+![teams-summary-report](https://github.com/test-results-reporter/testbeats/raw/main/assets/teams-qc.png)
+
+![slack-summary-report](https://github.com/test-results-reporter/testbeats/raw/main/assets/slack-report-portal-analysis.png)
+
+<br />
+
+<hr >
+
+# [Documentation](https://test-results-reporter.github.io/)
+
+</span>
+
+<br />
+
+## Need Help
+
+We use [Github Discussions](https://github.com/test-results-reporter/testbeats/discussions) to receive feedback, discuss ideas & answer questions. Head over to it and feel free to start a discussion. We are always happy to help 😊.
+
+## Support Us
+
+Like this project! Star it on [Github](https://github.com/test-results-reporter/testbeats) ⭐. Your support means a lot to us.

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "testbeats",
+  "version": "2.0.0",
+  "description": "Publish test results to Microsoft Teams, Google Chat, Slack and InfluxDB",
+  "main": "src/index.js",
+  "types": "./src/index.d.ts",
+  "bin": {
+    "testbeats": "src/cli.js"
+  },
+  "files": [
+    "/src"
+  ],
+  "scripts": {
+    "test": "c8 mocha test",
+    "build": "pkg --out-path dist ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/test-results-reporter/testbeats.git"
+  },
+  "keywords": [
+    "test",
+    "results",
+    "publish",
+    "report",
+    "microsoft teams",
+    "teams",
+    "slack",
+    "influx",
+    "influxdb",
+    "junit",
+    "mocha",
+    "cucumber",
+    "testng",
+    "xunit",
+    "reportportal",
+    "google chat",
+    "chat",
+    "percy",
+    "jmeter"
+  ],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/test-results-reporter/testbeats/issues"
+  },
+  "homepage": "https://test-results-reporter.github.io",
+  "dependencies": {
+    "async-retry": "^1.3.3",
+    "dotenv": "^14.3.2",
+    "influxdb-lite": "^1.0.0",
+    "performance-results-parser": "latest",
+    "phin-retry": "^1.0.3",
+    "pretty-ms": "^7.0.1",
+    "rosters": "0.0.1",
+    "sade": "^1.8.1",
+    "test-results-parser": "latest"
+  },
+  "devDependencies": {
+    "c8": "^7.12.0",
+    "mocha": "^10.1.0",
+    "pactum": "^3.2.3",
+    "pkg": "^5.8.0"
+  }
+}

package/src/beats/index.js

@@ -0,0 +1,74 @@
+const request = require('phin-retry');
+const TestResult = require('test-results-parser/src/models/TestResult');
+const { getCIInformation } = require('../helpers/ci');
+
+function get_base_url() {
+  return process.env.TEST_BEATS_URL || "https://app.testbeats.com";
+}
+
+/**
+ * @param {import('../index').PublishReport} config
+ * @param {TestResult} result
+ */
+async function run(config, result) {
+  if (config.project && config.run && config.api_key) {
+    const run_id = await publishTestResults(config, result);
+    if (run_id) {
+      attachTestBeatsReportHyperLink(config, run_id);
+    }
+  }
+}
+
+/**
+ * @param {import('../index').PublishReport} config 
+ * @param {TestResult} result
+ */
+async function publishTestResults(config, result) {
+  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 {string} run_id 
+ * @returns 
+ */
+function get_test_beats_report_link(run_id) {
+  return `${get_base_url()}/reports/${run_id}`;
+}
+
+module.exports = { run }

package/src/cli.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+require('dotenv').config();
+
+const sade = require('sade');
+ 
+const prog = sade('test-results-reporter');
+const publish = require('./commands/publish');
+ 
+prog
+  .version('0.0.7')
+  .option('-c, --config', 'Provide path to custom config', 'config.json');
+
+prog.command('publish')
+  .action(async (opts) => {
+    try {
+      await publish.run(opts);
+    } catch (error) {
+      console.error(error);
+      process.exit(1);
+    }
+  });
+
+prog.parse(process.argv);

package/src/commands/publish.js

@@ -0,0 +1,54 @@
+const path = require('path');
+const trp = require('test-results-parser');
+const prp = require('performance-results-parser');
+
+const { processData } = require('../helpers/helper');
+const beats = require('../beats');
+const target_manager = require('../targets');
+
+/**
+ * @param {import('../index').PublishOptions} opts 
+ */
+async function run(opts) {
+  if (typeof opts.config === 'string') {
+    const cwd = process.cwd();
+    opts.config = require(path.join(cwd, opts.config));
+  }
+  const config = processData(opts.config);
+  if (config.reports) {
+    for (const report of config.reports) {
+      await processReport(report);
+    }
+  } else {
+    await processReport(config);
+  }
+}
+
+/**
+ * 
+ * @param {import('../index').PublishReport} report 
+ */
+async function processReport(report) {
+  const parsed_results = [];
+  for (const result_options of report.results) {
+    if (result_options.type === 'custom') {
+      parsed_results.push(result_options.result);
+    } else if (result_options.type === 'jmeter') {
+      parsed_results.push(prp.parse(result_options));
+    } else {
+      parsed_results.push(trp.parse(result_options));
+    }
+  }
+
+  for (let i = 0; i < parsed_results.length; i++) {
+    const result = parsed_results[i];
+    await beats.run(report, result);
+    for (const target of report.targets) {
+      await target_manager.run(target, result);
+    }
+  }
+}
+
+module.exports = {
+  run
+}

package/src/extensions/ci-info.js

@@ -0,0 +1,134 @@
+const { STATUS, HOOK } = require("../helpers/constants");
+const { getCIInformation } = require('../helpers/ci');
+const { addTeamsExtension, addSlackExtension, addChatExtension } = require('../helpers/extension.helper');
+const { getTeamsMetaDataText, getSlackMetaDataText, getChatMetaDataText } = require('../helpers/metadata.helper');
+
+/**
+ * 
+ * @param {object} param0 - the payload object
+ * @param {import('..').Extension} param0.extension - The result object
+ *  
+ */
+async function run({ target, extension, payload, result }) {
+  extension.inputs = Object.assign({}, default_inputs, extension.inputs);
+  if (target.name === 'teams') {
+    extension.inputs = Object.assign({}, default_inputs_teams, extension.inputs);
+    const text = await get_text({ target, extension, result });
+    if (text) {
+      addTeamsExtension({ payload, extension, text });
+    }
+  } else if (target.name === 'slack') {
+    extension.inputs = Object.assign({}, default_inputs_slack, extension.inputs);
+    const text = await get_text({ target, extension, result });
+    if (text) {
+      addSlackExtension({ payload, extension, text });
+    }
+  } else if (target.name === 'chat') {
+    extension.inputs = Object.assign({}, default_inputs_chat, extension.inputs);
+    const text = await get_text({ target, extension, result });
+    if (text) {
+      addChatExtension({ payload, extension, text });
+    }
+  }
+}
+
+/**
+ * 
+ * @param {import('..').CIInfoInputs} inputs 
+ */
+function get_repository_elements(inputs) {
+  const elements = [];
+  const ci = getCIInformation();
+  if (inputs.show_repository && ci && ci.repository_url && ci.repository_name) {
+    elements.push({ label: 'Repository', key: ci.repository_name, value: ci.repository_url, type: 'hyperlink' });
+  }
+  if (inputs.show_repository_branch && ci && ci.repository_ref) {
+    if (ci.repository_ref.includes('refs/pull')) {
+      const pr_url = ci.repository_url + ci.repository_ref.replace('refs/pull/', '/pull/');
+      const pr_name = ci.repository_ref.replace('refs/pull/', '').replace('/merge', '');
+      elements.push({ label: 'Pull Request', key: pr_name, value: pr_url, type: 'hyperlink' });
+    } else {
+      const branch_url = ci.repository_url + ci.repository_ref.replace('refs/heads/', '/tree/');
+      const branch_name = ci.repository_ref.replace('refs/heads/', '');
+      elements.push({ label: 'Branch', key: branch_name, value: branch_url, type: 'hyperlink' });
+    }
+  }
+  return elements;
+}
+
+/**
+ * 
+ * @param {import('..').CIInfoInputs} inputs 
+ */
+function get_build_elements(inputs) {
+  let elements = [];
+  const ci = getCIInformation();
+  if (inputs.show_build && ci && ci.build_url) {
+    const name = (ci.build_name || 'Build') + (ci.build_number ? ` #${ci.build_number}` : '');
+    elements.push({ label: 'Build', key: name, value: ci.build_url, type: 'hyperlink' });
+  }
+  if (inputs.data) {
+    elements = elements.concat(inputs.data);
+  }
+  return elements;
+}
+
+async function get_text({ target, extension, result }) {
+  const repository_elements = get_repository_elements(extension.inputs);
+  const build_elements = get_build_elements(extension.inputs);
+  if (target.name === 'teams') {
+    const repository_text = await getTeamsMetaDataText({ elements: repository_elements, target, extension, result, default_condition: default_options.condition });
+    const build_text = await getTeamsMetaDataText({ elements: build_elements, target, extension, result, default_condition: default_options.condition });
+    if (build_text) {
+      return `${repository_text ? `${repository_text}\n\n` : '' }${build_text}`;
+    } else {
+      return repository_text;
+    }
+  } else if (target.name === 'slack') {
+    const repository_text = await getSlackMetaDataText({ elements: repository_elements, target, extension, result, default_condition: default_options.condition });
+    const build_text = await getSlackMetaDataText({ elements: build_elements, target, extension, result, default_condition: default_options.condition });
+    if (build_text) {
+      return `${repository_text ? `${repository_text}\n` : '' }${build_text}`;
+    } else {
+      return repository_text;
+    }
+  } else if (target.name === 'chat') {
+    const repository_text = await getChatMetaDataText({ elements: repository_elements, target, extension, result, default_condition: default_options.condition });
+    const build_text = await getChatMetaDataText({ elements: build_elements, target, extension, result, default_condition: default_options.condition });
+    if (build_text) {
+      return `${repository_text ? `${repository_text}<br>` : '' }${build_text}`;
+    } else {
+      return repository_text;
+    }
+  }
+}
+
+const default_options = {
+  hook: HOOK.AFTER_SUMMARY,
+  condition: STATUS.PASS_OR_FAIL,
+}
+
+const default_inputs = {
+  title: '',
+  show_repository: true,
+  show_repository_branch: true,
+  show_build: true,
+}
+
+const default_inputs_teams = {
+  
+  separator: true
+}
+
+const default_inputs_slack = {
+  separator: false
+}
+
+const default_inputs_chat = {
+  separator: true
+}
+
+module.exports = {
+  run,
+  default_options
+}

package/src/extensions/custom.js

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

package/src/extensions/hyperlinks.js

@@ -0,0 +1,60 @@
+const { STATUS, HOOK } = require("../helpers/constants");
+const { addChatExtension, addSlackExtension, addTeamsExtension } = require('../helpers/extension.helper');
+const { getTeamsMetaDataText, getSlackMetaDataText, getChatMetaDataText } = require("../helpers/metadata.helper");
+
+async function run({ target, extension, payload, result }) {
+  const elements = get_elements(extension.inputs.links);
+  if (target.name === 'teams') {
+    extension.inputs = Object.assign({}, default_inputs_teams, extension.inputs);
+    const text = await getTeamsMetaDataText({ elements, target, extension, result, default_condition: default_options.condition });
+    if (text) {
+      addTeamsExtension({ payload, extension, text });
+    }
+  } else if (target.name === 'slack') {
+    extension.inputs = Object.assign({}, default_inputs_slack, extension.inputs);
+    extension.inputs.block_type = 'context';
+    const text = await getSlackMetaDataText({ elements, target, extension, result, default_condition: default_options.condition });
+    if (text) {
+      addSlackExtension({ payload, extension, text });
+    }
+  } else if (target.name === 'chat') {
+    extension.inputs = Object.assign({}, default_inputs_chat, extension.inputs);
+    const text = await getChatMetaDataText({ elements, target, extension, result, default_condition: default_options.condition });
+    if (text) {
+      addChatExtension({ payload, extension, text });
+    }
+  }
+}
+
+/**
+ * 
+ * @param {import("..").Link[]} links 
+ */
+function get_elements(links) {
+  return links.map(_ => { return { key: _.text, value: _.url, type: 'hyperlink', condition: _.condition } });
+}
+
+const default_options = {
+  hook: HOOK.END,
+  condition: STATUS.PASS_OR_FAIL,
+}
+
+const default_inputs_teams = {
+  title: '',
+  separator: true
+}
+
+const default_inputs_slack = {
+  title: '',
+  separator: false
+}
+
+const default_inputs_chat = {
+  title: '',
+  separator: true
+}
+
+module.exports = {
+  run,
+  default_options
+}

package/src/extensions/index.js

@@ -0,0 +1,63 @@
+const hyperlinks = require('./hyperlinks');
+const mentions = require('./mentions');
+const rp_analysis = require('./report-portal-analysis');
+const rp_history = require('./report-portal-history');
+const qc_test_summary = require('./quick-chart-test-summary');
+const percy_analysis = require('./percy-analysis');
+const custom = require('./custom');
+const metadata = require('./metadata');
+const ci_info = require('./ci-info');
+const { EXTENSION } = require('../helpers/constants');
+const { checkCondition } = require('../helpers/helper');
+
+async function run(options) {
+  const { target, result, hook } = options;
+  const extensions = target.extensions || [];
+  for (let i = 0; i < extensions.length; i++) {
+    const extension = extensions[i];
+    const extension_runner = getExtensionRunner(extension);
+    const extension_options = Object.assign({}, extension_runner.default_options, extension);
+    if (extension_options.hook === hook) {
+      if (await checkCondition({ condition: extension_options.condition, result, target, extension })) {
+        extension.outputs = {};
+        options.extension = extension;
+        try {
+          await extension_runner.run(options);
+        } catch (error) {
+          console.log('Failed to run extension');
+          console.log(extension);
+          console.log(error);
+        }
+      }
+    }
+  }
+}
+
+function getExtensionRunner(extension) {
+  switch (extension.name) {
+    case EXTENSION.HYPERLINKS:
+      return hyperlinks;
+    case EXTENSION.MENTIONS:
+      return mentions;
+    case EXTENSION.REPORT_PORTAL_ANALYSIS:
+      return rp_analysis;
+    case EXTENSION.REPORT_PORTAL_HISTORY:
+      return rp_history;
+    case EXTENSION.QUICK_CHART_TEST_SUMMARY:
+      return qc_test_summary;
+    case EXTENSION.PERCY_ANALYSIS:
+      return percy_analysis;
+    case EXTENSION.CUSTOM:
+      return custom;
+    case EXTENSION.METADATA:
+      return metadata;
+    case EXTENSION.CI_INFO:
+      return ci_info;
+    default:
+      return require(extension.name);
+  }
+}
+
+module.exports = {
+  run
+}