@testomatio/reporter 1.4.10 → 1.4.12-beta-bitbucket-pipe

package/lib/bin/startTest.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-const { spawn } = require('child_process');
+const spawn = require('cross-spawn');
 const program = require('commander');
 const chalk = require('chalk');
 const TestomatClient = require('../client');

package/lib/client.js

@@ -279,7 +279,10 @@ class Client {
     logs = logs?.trim();
 
     if (Array.isArray(steps)) {
-      steps = steps.map(step => formatStep(step)).flat().join('\n');      
+      steps = steps
+        .map(step => formatStep(step))
+        .flat()
+        .join('\n');
     }
 
     let testLogs = '';
@@ -358,8 +361,8 @@ function formatStep(step, shift = 0) {
 
   for (const child of step.steps || []) {
     lines.push(...formatStep(child, shift + 2));
-  } 
-  
+  }
+
   return lines;
 }
 

package/lib/pipe/bitbucket.js

@@ -0,0 +1,259 @@
+const debug = require('debug')('@testomatio/reporter:pipe:bitbucket');
+const { default: axios } = require('axios');
+const chalk = require('chalk');
+const humanizeDuration = require('humanize-duration');
+const merge = require('lodash.merge');
+const path = require('path');
+const { APP_PREFIX, testomatLogoURL } = require('../constants');
+const { ansiRegExp, isSameTest } = require('../utils/utils');
+const { statusEmoji, fullName } = require('../utils/pipe_utils');
+
+//! BITBUCKET_PAT environment variable is required for this functionality to work
+//! and your pipeline trigger should be a pull request
+
+/**
+ * @class BitbucketPipe
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
+ */
+class BitbucketPipe {
+  constructor(params, store = {}) {
+    this.isEnabled = false;
+    this.ENV = process.env;
+    this.store = store;
+    this.tests = [];
+    // Bitbucket PAT looks like bbpat-*****
+    this.token = params.BITBUCKET_PAT || process.env.BITBUCKET_PAT || this.ENV.BITBUCKET_PAT;
+    this.hiddenCommentData = `Testomat.io report: ${process.env.BITBUCKET_BRANCH || ''}`;
+
+    debug(
+      chalk.yellow('Bitbucket Pipe:'),
+      this.token ? 'TOKEN passed' : '*no token*',
+      `Project key: ${this.ENV.BITBUCKET_PROJECT_KEY}, Pull request ID: ${this.ENV.BITBUCKET_PR_ID}`,
+    );
+
+    if (!this.ENV.BITBUCKET_PROJECT_KEY || !this.ENV.BITBUCKET_PR_ID) {
+      debug(`CI pipeline should be run in a Pull Request to have the ability to add the report comment.`);
+      return;
+    }
+
+    if (!this.token) {
+      debug(`Hint: Bitbucket CI variables are unavailable for unprotected branches by default.`);
+      return;
+    }
+
+    this.isEnabled = true;
+
+    debug('Bitbucket Pipe: Enabled');
+  }
+
+  async cleanLog(log) {
+    const stripAnsi = (await import('strip-ansi')).default;
+    return stripAnsi(log);
+  }
+
+  // Prepare the run (if needed)
+  async prepareRun() {}
+
+  // Create a new run (if needed)
+  async createRun() {}
+
+  addTest(test) {
+    if (!this.isEnabled) return;
+
+    const index = this.tests.findIndex(t => isSameTest(t, test));
+    // Update if they were already added
+    if (index >= 0) {
+      this.tests[index] = merge(this.tests[index], test);
+      return;
+    }
+
+    this.tests.push(test);
+  }
+
+  async finishRun(runParams) {
+    if (!this.isEnabled) return;
+
+    if (runParams.tests) runParams.tests.forEach(t => this.addTest(t));
+
+    // Clean up the logs from ANSI codes
+    for (let i = 0; i < this.tests.length; i++) {
+      this.tests[i].message = await this.cleanLog(this.tests[i].message || '');
+      this.tests[i].stack = await this.cleanLog(this.tests[i].stack || '');
+    }
+
+    // Create a comment on Bitbucket
+    const passedCount = this.tests.filter(t => t.status === 'passed').length;
+    const failedCount = this.tests.filter(t => t.status === 'failed').length;
+    const skippedCount = this.tests.filter(t => t.status === 'skipped').length;
+
+    // Constructing the table
+    let summary = `${this.hiddenCommentData}
+    
+  | ![Testomat.io Report](${testomatLogoURL}) | ${statusEmoji(
+    runParams.status,
+  )} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
+  | --- | --- |
+  | **Tests** | ✔️ **${this.tests.length}** tests run |
+  | **Summary** | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji(
+    'passed',
+  )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
+  | **Duration** | 🕐 **${humanizeDuration(
+    parseInt(
+      this.tests.reduce((a, t) => a + (t.run_time || 0), 0),
+      10,
+    ),
+    {
+      maxDecimalPoints: 0,
+    },
+  )}** |
+  `;
+
+    if (this.ENV.BITBUCKET_BRANCH && this.ENV.BITBUCKET_COMMIT) {
+      // eslint-disable-next-line max-len
+      summary += `| **Job** | 👷 [Run: ${this.ENV.BITBUCKET_COMMIT}](https://bitbucket.org/${this.ENV.BITBUCKET_REPO_FULL_NAME}/pipelines/results/${this.ENV.BITBUCKET_BUILD_NUMBER}") Branch: **${this.ENV.BITBUCKET_BRANCH}** |`;
+    }
+
+    const failures = this.tests
+      .filter(t => t.status === 'failed')
+      .slice(0, 20)
+      .map(t => {
+        let text = `${statusEmoji('failed')} ${fullName(t)}\n`;
+        if (t.message) {
+          text += `> ${t.message
+            .replace(/[^\x20-\x7E]/g, '')
+            .replace(ansiRegExp(), '')
+            .trim()}\n`;
+        }
+        if (t.stack) {
+          text += `\n\`\`\`diff\n${t.stack
+            .replace(ansiRegExp(), '')
+            .replace(
+              /^[\s\S]*################\[ Failure \]################/g,
+              '################[ Failure ]################',
+            )
+            .trim()}\n\`\`\`\n`;
+        }
+        if (t.artifacts && t.artifacts.length && !this.ENV.TESTOMATIO_PRIVATE_ARTIFACTS) {
+          t.artifacts
+            .filter(f => !!f)
+            .forEach(f => {
+              if (f.endsWith('.png')) {
+                text += `![Image](${f})\n`;
+              } else {
+                text += `[📄 ${path.basename(f)}](${f})\n`;
+              }
+            });
+        }
+        text += `\n---\n`;
+        return text;
+      });
+
+    let body = summary;
+
+    if (failures.length) {
+      body += `\n🟥 **Failures (${failures.length})**\n\n* ${failures.join('\n* ')}\n`;
+      if (failures.length > 10) {
+        body += `\n> Notice: Only the first 10 failures are shown.`;
+      }
+    }
+
+    if (this.tests.length > 0) {
+      body += `\n\n**🐢 Slowest Tests**\n\n`;
+      body += this.tests
+        .sort((a, b) => b.run_time - a.run_time)
+        .slice(0, 5)
+        .map(t => `* **${fullName(t)}** (${humanizeDuration(parseFloat(t.run_time))})`)
+        .join('\n');
+    }
+
+    // Construct Bitbucket API URL for comments
+    // eslint-disable-next-line max-len
+    const commentsRequestURL = `https://api.bitbucket.org/2.0/repositories/${this.ENV.BITBUCKET_WORKSPACE}/${this.ENV.BITBUCKET_REPO_SLUG}/pullrequests/${this.ENV.BITBUCKET_PR_ID}/comments`;
+
+    // Delete previous report
+    await deletePreviousReport(axios, commentsRequestURL, this.hiddenCommentData, this.token);
+
+    // Add current report
+    debug(`Adding comment via URL: ${commentsRequestURL}`);
+    debug(`Final Bitbucket API call body: ${body}`);
+
+    try {
+      const addCommentResponse = await axios.post(
+        commentsRequestURL,
+        { content: { raw: body } },
+        {
+          headers: {
+            Authorization: `Bearer ${this.token}`,
+            'Content-Type': 'application/json',
+          },
+        },
+      );
+
+      const commentID = addCommentResponse.data.id;
+      // eslint-disable-next-line max-len
+      const commentURL = `https://bitbucket.org/${this.ENV.BITBUCKET_WORKSPACE}/${this.ENV.BITBUCKET_REPO_SLUG}/pull-requests/${this.ENV.BITBUCKET_PR_ID}#comment-${commentID}`;
+
+      console.log(APP_PREFIX, chalk.yellow('Bitbucket'), `Report created: ${chalk.magenta(commentURL)}`);
+    } catch (err) {
+      console.error(
+        APP_PREFIX,
+        chalk.yellow('Bitbucket'),
+        `Couldn't create Bitbucket report\n${err}.
+      Request URL: ${commentsRequestURL}
+      Request data: ${body}`,
+      );
+    }
+  }
+
+  toString() {
+    return 'Bitbucket Reporter';
+  }
+
+  updateRun() {}
+}
+
+async function deletePreviousReport(axiosInstance, commentsRequestURL, hiddenCommentData, token) {
+  if (process.env.BITBUCKET_KEEP_OUTDATED_REPORTS) return;
+
+  // Get comments
+  let comments = [];
+
+  try {
+    const response = await axiosInstance.get(commentsRequestURL, {
+      headers: {
+        Authorization: `Bearer ${token}`,
+        'Content-Type': 'application/json',
+      },
+    });
+    comments = response.data.values;
+  } catch (e) {
+    console.error('Error while attempting to retrieve comments on Bitbucket Pull Request:\n', e);
+  }
+
+  if (!comments.length) return;
+
+  for (const comment of comments) {
+    // If comment was left by the same workflow
+    if (comment.content.raw.includes(hiddenCommentData)) {
+      try {
+        // Delete previous comment
+        const deleteCommentURL = `${commentsRequestURL}/${comment.id}`;
+        await axiosInstance.delete(deleteCommentURL, {
+          headers: {
+            Authorization: `Bearer ${token}`,
+            'Content-Type': 'application/json',
+          },
+        });
+      } catch (e) {
+        console.warn(`Can't delete previously added comment with testomat.io report. Ignored.`);
+      }
+      // Pass next env var if need to clear all previous reports;
+      // only the last one is removed by default
+      if (!process.env.BITBUCKET_REMOVE_ALL_OUTDATED_REPORTS) break;
+      // TODO: in case of many reports should implement pagination
+    }
+  }
+}
+
+module.exports = BitbucketPipe;

package/lib/pipe/index.js

@@ -7,6 +7,7 @@ const GitHubPipe = require('./github');
 const GitLabPipe = require('./gitlab');
 const CsvPipe = require('./csv');
 const HtmlPipe = require('./html');
+const BitbucketPipe = require('./bitbucket');
 
 function PipeFactory(params, opts) {
   const extraPipes = [];
@@ -45,6 +46,7 @@ function PipeFactory(params, opts) {
     new GitLabPipe(params, opts),
     new CsvPipe(params, opts),
     new HtmlPipe(params, opts),
+    new BitbucketPipe(params, opts),
     ...extraPipes,
   ];
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.4.10",
+  "version": "1.4.12-beta-bitbucket-pipe",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -17,6 +17,7 @@
     "callsite-record": "^4.1.4",
     "chalk": "^4.1.0",
     "commander": "^4.1.1",
+    "cross-spawn": "^7.0.3",
     "csv-writer": "^1.6.0",
     "debug": "^4.3.4",
     "dotenv": "^16.0.1",
@@ -32,6 +33,7 @@
     "lodash.merge": "^4.6.2",
     "minimatch": "^9.0.3",
     "promise-retry": "^2.0.1",
+    "strip-ansi": "^7.1.0",
     "uuid": "^9.0.0"
   },
   "files": [