@testomatio/reporter 1.4.11-beta-bitbucket-pipe → 1.4.13-beta-bitbucket-pipe

package/README.md

@@ -11,7 +11,7 @@ Testomat.io Reporter (this npm package) supports:
 - 🏄 Integarion with all popular [JavaScript/TypeScript frameworks](./docs/frameworks.md)
 - 🗄️ Screenshots, videos, traces [uploaded into S3 bucket](./docs/artifacts.md)
 - 🔎 [Stack traces](./docs/stacktrace.md) and error messages
-- 🐙 [GitHub](./docs/pipes/github.md) & [GitLab](./docs/pipes/gitlab.md) integration
+- 🐙 [GitHub](./docs/pipes/github.md), [GitLab](./docs/pipes/gitlab.md) & [Bitbucket](./docs/pipes/bitbucket.md) integration
 - 🚅 Realtime reports
 - 🗃️ Other test frameworks supported via [JUNit XML](./docs/junit.md)
 - 🚶‍♀️ Steps _(work in progress)_
@@ -128,6 +128,7 @@ Bring this reporter on CI and never lose test results again!
   - [Gitlab](./docs/pipes/gitlab.md)
   - [CSV](./docs/pipes/csv.md)
   - [HTML report](./docs/pipes/html.md)
+  - [Bitbucket](./docs/pipes/bitbucket.md)
 - 📓 [JUnit](./docs/junit.md)
 - 🗄️ [Artifacts](./docs/artifacts.md)
 - 🔂 [Workflows](./docs/workflows.md)

package/lib/pipe/bitbucket.js

@@ -8,7 +8,7 @@ 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
+//! BITBUCKET_ACCESS_TOKEN environment variable is required for this functionality to work
 //! and your pipeline trigger should be a pull request
 
 /**
@@ -23,8 +23,8 @@ class BitbucketPipe {
     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_STEP_NAME || ''} -->`;
+    this.token = params.BITBUCKET_ACCESS_TOKEN || process.env.BITBUCKET_ACCESS_TOKEN || this.ENV.BITBUCKET_ACCESS_TOKEN;
+    this.hiddenCommentData = `Testomat.io report: ${process.env.BITBUCKET_BRANCH || ''}`;
 
     debug(
       chalk.yellow('Bitbucket Pipe:'),
@@ -32,11 +32,6 @@ class BitbucketPipe {
       `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;
@@ -47,6 +42,11 @@ class BitbucketPipe {
     debug('Bitbucket Pipe: Enabled');
   }
 
+  async cleanLog(log) {
+    const stripAnsi = (await import('strip-ansi')).default;
+    return stripAnsi(log);
+  }
+
   // Prepare the run (if needed)
   async prepareRun() {}
 
@@ -71,6 +71,12 @@ class BitbucketPipe {
 
     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;
@@ -79,15 +85,15 @@ class BitbucketPipe {
     // Constructing the table
     let summary = `${this.hiddenCommentData}
     
-  | [![Testomat.io Report](${testomatLogoURL})](https://testomat.io)  | ${statusEmoji(
+  | ![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(
+  | **Tests** | ✔️ **${this.tests.length}** tests run |
+  | **Summary** | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji(
     'passed',
   )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
-  | Duration | 🕐  **${humanizeDuration(
+  | **Duration** | 🕐 **${humanizeDuration(
     parseInt(
       this.tests.reduce((a, t) => a + (t.run_time || 0), 0),
       10,
@@ -98,61 +104,62 @@ class BitbucketPipe {
   )}** |
   `;
 
-    if (this.ENV.BITBUCKET_STEP_NAME && this.ENV.BITBUCKET_STEP_UUID) {
+    if (this.ENV.BITBUCKET_BRANCH && this.ENV.BITBUCKET_COMMIT) {
       // eslint-disable-next-line max-len
-      summary += `| Job | 👷 [${this.ENV.BITBUCKET_STEP_UUID}](${this.ENV.BITBUCKET_PIPELINE_STEP_URL})<br>Name: **${this.ENV.BITBUCKET_STEP_NAME}** | `;
+      summary += `| **Job** | 👷 [#${this.ENV.BITBUCKET_BUILD_NUMBER}](https://bitbucket.org/${this.ENV.BITBUCKET_REPO_FULL_NAME}/pipelines/results/${this.ENV.BITBUCKET_BUILD_NUMBER}") by commit: **${this.ENV.BITBUCKET_COMMIT}** |`;
     }
 
     const failures = this.tests
       .filter(t => t.status === 'failed')
       .slice(0, 20)
       .map(t => {
-        let text = `#### ${statusEmoji('failed')} ${fullName(t)} `;
-        text += '\n\n';
-        if (t.message)
+        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 += `\`\`\`diff\n${t.stack.replace(ansiRegExp(), '').trim()}\n\`\`\`\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)
-            .filter(f => f.endsWith('.png'))
             .forEach(f => {
               if (f.endsWith('.png')) {
-                text += `![](${f})\n`;
-                return text;
+                text += `![Image](${f})\n`;
+              } else {
+                text += `[📄 ${path.basename(f)}](${f})\n`;
               }
-              text += `[📄 ${path.basename(f)}](${f})\n`;
-              return text;
             });
         }
-
-        text += '\n---\n';
-
+        text += `\n---\n`;
         return text;
       });
 
     let body = summary;
 
     if (failures.length) {
-      body += `\n<details>\n<summary><h3>🟥 Failures (${failures.length})</h3></summary>\n\n${failures.join('\n')}\n`;
-      if (failures.length > 20) {
-        body += '\n> Notice\n> Only first 20 failures shown*';
+      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.`;
       }
-      body += '\n\n</details>';
     }
 
     if (this.tests.length > 0) {
-      body += '\n<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n';
+      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))})`)
+        .map(t => `* **${fullName(t)}** (${humanizeDuration(parseFloat(t.run_time))})`)
         .join('\n');
-      body += '\n</details>';
     }
 
     // Construct Bitbucket API URL for comments
@@ -164,6 +171,7 @@ class BitbucketPipe {
 
     // Add current report
     debug(`Adding comment via URL: ${commentsRequestURL}`);
+    debug(`Final Bitbucket API call body: ${body}`);
 
     try {
       const addCommentResponse = await axios.post(
@@ -179,7 +187,7 @@ class BitbucketPipe {
 
       const commentID = addCommentResponse.data.id;
       // eslint-disable-next-line max-len
-      const commentURL = `${this.ENV.BITBUCKET_REPO_URL}/pull-requests/${this.ENV.BITBUCKET_PR_ID}#comment-${commentID}`;
+      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) {
@@ -235,7 +243,6 @@ async function deletePreviousReport(axiosInstance, commentsRequestURL, hiddenCom
       } 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.4.11-beta-bitbucket-pipe",
+  "version": "1.4.13-beta-bitbucket-pipe",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -33,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": [