testomatio-reporter-cli 2.18.0 → 2.19.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testomatio-reporter-cli",
-  "version": "2.18.0",
+  "version": "2.19.0",
   "description": "Yarn Berry compatible standalone CLI for @testomatio/reporter",
   "type": "module",
   "bin": {

package/src/constants.js

@@ -60,6 +60,10 @@ const REPORTER_REQUEST_RETRIES = {
 
 const DEBUG_FILE = 'testomatio.debug';
 
+// temporary S3 tokens live ~1 hour; refresh credentials well before that so artifact
+// uploads keep working on long runs
+const S3_CREDENTIALS_REFRESH_INTERVAL_MS = 40 * 60 * 1000;
+
 function getCreateRunRequestTimeout() {
   return Math.max(REQUEST_TIMEOUT, 80 * 1000);
 }
@@ -78,4 +82,5 @@ export {
   REPORTER_REQUEST_RETRIES,
   SCREENSHOTS_ON_STEPS,
   DEBUG_FILE,
+  S3_CREDENTIALS_REFRESH_INTERVAL_MS,
 };

package/src/pipe/bitbucket.js

@@ -7,6 +7,7 @@ import {
   markdownTable,
   runSummary,
   totalDuration,
+  smallRunSections,
 } from '../utils/pipe_utils.js';
 import { Gaxios } from 'gaxios';
 import pc from 'picocolors';
@@ -174,7 +175,8 @@ export class BitbucketPipe {
     let body = summary;
 
     if (this.description) {
-      body += `\n\n> ${truncate(this.description, 1024).replace(/\r?\n/g, '\n> ')}`;
+      // Bitbucket strips HTML, so no <details> here
+      body += `\n\n**📝 Description**\n\n${truncate(this.description, 1024)}\n`;
     }
 
     if (failures.length) {
@@ -184,6 +186,10 @@ export class BitbucketPipe {
       }
     }
 
+    for (const { title, list } of smallRunSections(this.tests)) {
+      body += `\n\n**${title}**\n\n${list.join('\n')}`;
+    }
+
     if (this.tests.length > 0 && !isPendingRun) {
       body += `\n\n**🐢 Slowest Tests**\n\n`;
       body += this.tests

package/src/pipe/github.js

@@ -12,6 +12,7 @@ import {
   markdownTable,
   runSummary,
   totalDuration,
+  smallRunSections,
 } from '../utils/pipe_utils.js';
 import { log } from '../utils/log.js';
 
@@ -147,7 +148,8 @@ class GitHubPipe {
 
     let body = summary;
     if (this.description) {
-      body += `\n\n> ${truncate(this.description, 1024).replace(/\r?\n/g, '\n> ')}`;
+      body += '\n\n<details>\n<summary><h3>📝 Description</h3></summary>\n\n';
+      body += `${truncate(this.description, 1024)}\n\n</details>`;
     }
     const coverageConfiguration = this.store?.coverageConfiguration;
     const isManualRun = this.store?.runKind === 'manual';
@@ -172,6 +174,10 @@ class GitHubPipe {
       body += '\n\n</details>';
     }
 
+    for (const { title, list } of smallRunSections(this.tests)) {
+      body += `\n<details>\n<summary><h3>${title}</h3></summary>\n\n${list.join('\n')}\n</details>`;
+    }
+
     if (this.tests.length > 0 && !isPendingRun) {
       body += '\n<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n';
       body += this.tests

package/src/pipe/gitlab.js

@@ -13,6 +13,7 @@ import {
   markdownTable,
   runSummary,
   totalDuration,
+  smallRunSections,
 } from '../utils/pipe_utils.js';
 import { log } from '../utils/log.js';
 
@@ -148,7 +149,8 @@ class GitLabPipe {
     let body = summary;
 
     if (this.description) {
-      body += `\n\n> ${truncate(this.description, 1024).replace(/\r?\n/g, '\n> ')}`;
+      body += '\n\n<details>\n<summary><h3>📝 Description</h3></summary>\n\n';
+      body += `${truncate(this.description, 1024)}\n\n</details>`;
     }
 
     if (failures.length) {
@@ -159,6 +161,10 @@ class GitLabPipe {
       body += '\n\n</details>';
     }
 
+    for (const { title, list } of smallRunSections(this.tests)) {
+      body += `\n<details>\n<summary><h3>${title}</h3></summary>\n\n${list.join('\n')}\n</details>`;
+    }
+
     if (this.tests.length > 0 && !isPendingRun) {
       body += '\n<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n';
       body += this.tests

package/src/pipe/testomatio.js

@@ -9,6 +9,7 @@ import {
   REQUEST_TIMEOUT,
   getCreateRunRequestTimeout,
   REPORTER_REQUEST_RETRIES,
+  S3_CREDENTIALS_REFRESH_INTERVAL_MS,
 } from '../constants.js';
 import {
   isValidUrl,
@@ -72,6 +73,8 @@ class TestomatioPipe {
     this.retriesTimestamps = [];
     this.reportingCanceledDueToReqFailures = false;
     this.notReportedTestsCount = 0;
+    /** @type {NodeJS.Timeout | null} */
+    this.s3CredentialsRefreshTimer = null;
 
     this.isEnabled = false;
     this.url = params.testomatioUrl || process.env.TESTOMATIO_URL || 'https://app.testomat.io';
@@ -346,7 +349,10 @@ class TestomatioPipe {
         timeout: getCreateRunRequestTimeout(),
         responseType: 'json',
       });
-      if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
+      if (resp.data.artifacts) {
+        setS3Credentials(resp.data.artifacts);
+        this.#startS3CredentialsRefresh(runParams);
+      }
       if (resp.data.url) {
         const respUrl = new URL(resp.data.url);
         this.runUrl = `${this.url}${respUrl.pathname}`;
@@ -374,7 +380,10 @@ class TestomatioPipe {
       this.runUrl = `${this.url}/${resp.data.url.split('/').splice(3).join('/')}`;
       this.runPublicUrl = resp.data.public_url;
 
-      if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
+      if (resp.data.artifacts) {
+        setS3Credentials(resp.data.artifacts);
+        this.#startS3CredentialsRefresh(runParams);
+      }
 
       this.store.runUrl = this.runUrl;
       this.store.runPublicUrl = this.runPublicUrl;
@@ -401,6 +410,49 @@ class TestomatioPipe {
     debug('"createRun" function finished');
   }
 
+  /**
+   * Starts periodic refreshing of S3 credentials for long runs.
+   * Temporary S3 tokens (STS) expire after ~1 hour, so without refreshing,
+   * artifact uploads fail for every test reported later in the run.
+   * The same run params are re-sent on refresh (same as updating an existing run),
+   * and fresh credentials are taken from the response's `artifacts` field.
+   * @param {Record<string, any>} runParams
+   */
+  #startS3CredentialsRefresh(runParams) {
+    if (this.s3CredentialsRefreshTimer) return;
+    this.s3CredentialsRefreshTimer = setInterval(() => {
+      this.#refreshS3Credentials(runParams);
+    }, S3_CREDENTIALS_REFRESH_INTERVAL_MS);
+    this.s3CredentialsRefreshTimer.unref?.();
+    debug(`S3 credentials refresh started (every ${S3_CREDENTIALS_REFRESH_INTERVAL_MS / 60000} min)`);
+  }
+
+  #refreshS3Credentials = async runParams => {
+    if (!this.isEnabled || !this.runId) return;
+    const { ci, access_event, ...refreshParams } = runParams;
+    try {
+      const resp = await this.client.request({
+        method: 'PUT',
+        url: `/api/reporter/${this.runId}`,
+        data: { ...refreshParams, api_key: this.apiKey },
+        responseType: 'json',
+      });
+      if (resp.data?.artifacts) {
+        setS3Credentials(resp.data.artifacts);
+        debug('S3 credentials refreshed');
+      }
+    } catch (err) {
+      debug('Failed to refresh S3 credentials:', err.message || err);
+    }
+  };
+
+  #stopS3CredentialsRefresh() {
+    if (this.s3CredentialsRefreshTimer) {
+      clearInterval(this.s3CredentialsRefreshTimer);
+      this.s3CredentialsRefreshTimer = null;
+    }
+  }
+
   /**
    * Decides whether to skip test reporting in case of too many request failures
    * @returns {boolean}
@@ -545,6 +597,7 @@ class TestomatioPipe {
   async finishRun(params) {
     if (!this.isEnabled) return;
 
+    this.#stopS3CredentialsRefresh();
     await this.#batchUpload();
     if (this.batch.intervalFunction) {
       clearInterval(this.batch.intervalFunction);
@@ -637,6 +690,7 @@ class TestomatioPipe {
     this.isEnabled = false;
     this.apiKey = null;
 
+    this.#stopS3CredentialsRefresh();
     // clear interval function, otherwise the proccess will continue indefinitely
     if (this.batch.intervalFunction) {
       clearInterval(this.batch.intervalFunction);

package/src/utils/pipe_utils.js

@@ -122,6 +122,14 @@ function statusEmoji(status) {
   return '';
 }
 
+/**
+ * @param {string} str
+ * @returns {string} The string with its first letter in upper case, e.g. `passed` → `Passed`.
+ */
+function capitalize(str) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}
+
 /**
  * Generate a full name string based on the provided test object.
  * @param {object} t - The test object.
@@ -260,6 +268,37 @@ function totalDuration(tests) {
   return humanizeDuration(Math.trunc(milliseconds), { maxDecimalPoints: 0 });
 }
 
+/**
+ * Runs with fewer tests than this list every test in the report, not only the failed ones.
+ */
+const SMALL_RUN_TESTS_LIMIT = 10;
+
+/**
+ * Sections listing the passed, skipped and not yet run tests of a small run; failures have their own
+ * section. Not yet run tests (no status, or `pending`) are listed without any status label.
+ *
+ * @param {Array<{status?: string, title?: string, suite_title?: string, run_time?: number}>} tests
+ * @returns {Array<{title: string, list: string[]}>} Non-empty sections; none if the run is not small.
+ */
+function smallRunSections(tests) {
+  if (tests.length >= SMALL_RUN_TESTS_LIMIT) return [];
+
+  const sections = ['passed', 'skipped'].map(status => {
+    const list = tests
+      .filter(t => t.status === status)
+      .map(t => {
+        const runTime = t.run_time ? ` (${humanizeDuration(t.run_time)})` : '';
+        return `* ${statusEmoji(status)} ${fullName(t)}${runTime}`;
+      });
+    return { title: `${statusEmoji(status)} ${capitalize(status)} (${list.length})`, list };
+  });
+
+  const notRun = tests.filter(t => !t.status || t.status === 'pending').map(t => `* ${fullName(t)}`);
+  sections.push({ title: `📋 Tests (${notRun.length})`, list: notRun });
+
+  return sections.filter(section => section.list.length);
+}
+
 /**
  * Render a two-column markdown table. Rows with an empty value are skipped, so optional rows
  * need no surrounding `if`.
@@ -368,6 +407,7 @@ export {
   markdownTable,
   runSummary,
   totalDuration,
+  smallRunSections,
   plannedTestsLabel,
   parsePipeOptions,
   formatFilterListIds,