@testomatio/reporter 2.19.0-beta → 2.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -175,7 +175,8 @@ class BitbucketPipe {
175
175
  });
176
176
  let body = summary;
177
177
  if (this.description) {
178
- body += `\n\n> ${(0, utils_js_1.truncate)(this.description, 1024).replace(/\r?\n/g, '\n> ')}`;
178
+ // Bitbucket strips HTML, so no <details> here
179
+ body += `\n\n**📝 Description**\n\n${(0, utils_js_1.truncate)(this.description, 1024)}\n`;
179
180
  }
180
181
  if (failures.length) {
181
182
  body += `\n🟥 **Failures (${failures.length})**\n\n* ${failures.join('\n* ')}\n`;
@@ -183,6 +184,9 @@ class BitbucketPipe {
183
184
  body += `\n> Notice: Only the first 10 failures are shown.`;
184
185
  }
185
186
  }
187
+ for (const { title, list } of (0, pipe_utils_js_1.smallRunSections)(this.tests)) {
188
+ body += `\n\n**${title}**\n\n${list.join('\n')}`;
189
+ }
186
190
  if (this.tests.length > 0 && !isPendingRun) {
187
191
  body += `\n\n**🐢 Slowest Tests**\n\n`;
188
192
  body += this.tests
@@ -163,7 +163,8 @@ class GitHubPipe {
163
163
  });
164
164
  let body = summary;
165
165
  if (this.description) {
166
- body += `\n\n> ${(0, utils_js_1.truncate)(this.description, 1024).replace(/\r?\n/g, '\n> ')}`;
166
+ body += '\n\n<details>\n<summary><h3>📝 Description</h3></summary>\n\n';
167
+ body += `${(0, utils_js_1.truncate)(this.description, 1024)}\n\n</details>`;
167
168
  }
168
169
  const coverageConfiguration = this.store?.coverageConfiguration;
169
170
  const isManualRun = this.store?.runKind === 'manual';
@@ -187,6 +188,9 @@ class GitHubPipe {
187
188
  }
188
189
  body += '\n\n</details>';
189
190
  }
191
+ for (const { title, list } of (0, pipe_utils_js_1.smallRunSections)(this.tests)) {
192
+ body += `\n<details>\n<summary><h3>${title}</h3></summary>\n\n${list.join('\n')}\n</details>`;
193
+ }
190
194
  if (this.tests.length > 0 && !isPendingRun) {
191
195
  body += '\n<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n';
192
196
  body += this.tests
@@ -122,7 +122,8 @@ class GitLabPipe {
122
122
  });
123
123
  let body = summary;
124
124
  if (this.description) {
125
- body += `\n\n> ${(0, utils_js_1.truncate)(this.description, 1024).replace(/\r?\n/g, '\n> ')}`;
125
+ body += '\n\n<details>\n<summary><h3>📝 Description</h3></summary>\n\n';
126
+ body += `${(0, utils_js_1.truncate)(this.description, 1024)}\n\n</details>`;
126
127
  }
127
128
  if (failures.length) {
128
129
  body += `\n<details>\n<summary><h3>🟥 Failures (${failures.length})</h4></summary>\n\n${failures.join('\n')}\n`;
@@ -131,6 +132,9 @@ class GitLabPipe {
131
132
  }
132
133
  body += '\n\n</details>';
133
134
  }
135
+ for (const { title, list } of (0, pipe_utils_js_1.smallRunSections)(this.tests)) {
136
+ body += `\n<details>\n<summary><h3>${title}</h3></summary>\n\n${list.join('\n')}\n</details>`;
137
+ }
134
138
  if (this.tests.length > 0 && !isPendingRun) {
135
139
  body += '\n<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n';
136
140
  body += this.tests
@@ -72,6 +72,22 @@ export function runSummary(tests: Array<{
72
72
  export function totalDuration(tests: Array<{
73
73
  run_time?: number;
74
74
  }>): string;
75
+ /**
76
+ * Sections listing the passed, skipped and not yet run tests of a small run; failures have their own
77
+ * section. Not yet run tests (no status, or `pending`) are listed without any status label.
78
+ *
79
+ * @param {Array<{status?: string, title?: string, suite_title?: string, run_time?: number}>} tests
80
+ * @returns {Array<{title: string, list: string[]}>} Non-empty sections; none if the run is not small.
81
+ */
82
+ export function smallRunSections(tests: Array<{
83
+ status?: string;
84
+ title?: string;
85
+ suite_title?: string;
86
+ run_time?: number;
87
+ }>): Array<{
88
+ title: string;
89
+ list: string[];
90
+ }>;
75
91
  /**
76
92
  * Describe the scope of a run that was prepared but not executed yet. Prefers the server's count;
77
93
  * without it, falls back to the scoped ids, which mix tests (`T…`) and suites (`S…`).
@@ -12,6 +12,7 @@ exports.fullName = fullName;
12
12
  exports.markdownTable = markdownTable;
13
13
  exports.runSummary = runSummary;
14
14
  exports.totalDuration = totalDuration;
15
+ exports.smallRunSections = smallRunSections;
15
16
  exports.plannedTestsLabel = plannedTestsLabel;
16
17
  exports.parsePipeOptions = parsePipeOptions;
17
18
  exports.formatFilterListIds = formatFilterListIds;
@@ -135,6 +136,13 @@ function statusEmoji(status) {
135
136
  return '🕐';
136
137
  return '';
137
138
  }
139
+ /**
140
+ * @param {string} str
141
+ * @returns {string} The string with its first letter in upper case, e.g. `passed` → `Passed`.
142
+ */
143
+ function capitalize(str) {
144
+ return str.charAt(0).toUpperCase() + str.slice(1);
145
+ }
138
146
  /**
139
147
  * Generate a full name string based on the provided test object.
140
148
  * @param {object} t - The test object.
@@ -262,6 +270,33 @@ function totalDuration(tests) {
262
270
  const milliseconds = tests.reduce((total, t) => total + (t.run_time || 0), 0);
263
271
  return (0, humanize_duration_1.default)(Math.trunc(milliseconds), { maxDecimalPoints: 0 });
264
272
  }
273
+ /**
274
+ * Runs with fewer tests than this list every test in the report, not only the failed ones.
275
+ */
276
+ const SMALL_RUN_TESTS_LIMIT = 10;
277
+ /**
278
+ * Sections listing the passed, skipped and not yet run tests of a small run; failures have their own
279
+ * section. Not yet run tests (no status, or `pending`) are listed without any status label.
280
+ *
281
+ * @param {Array<{status?: string, title?: string, suite_title?: string, run_time?: number}>} tests
282
+ * @returns {Array<{title: string, list: string[]}>} Non-empty sections; none if the run is not small.
283
+ */
284
+ function smallRunSections(tests) {
285
+ if (tests.length >= SMALL_RUN_TESTS_LIMIT)
286
+ return [];
287
+ const sections = ['passed', 'skipped'].map(status => {
288
+ const list = tests
289
+ .filter(t => t.status === status)
290
+ .map(t => {
291
+ const runTime = t.run_time ? ` (${(0, humanize_duration_1.default)(t.run_time)})` : '';
292
+ return `* ${statusEmoji(status)} ${fullName(t)}${runTime}`;
293
+ });
294
+ return { title: `${statusEmoji(status)} ${capitalize(status)} (${list.length})`, list };
295
+ });
296
+ const notRun = tests.filter(t => !t.status || t.status === 'pending').map(t => `* ${fullName(t)}`);
297
+ sections.push({ title: `📋 Tests (${notRun.length})`, list: notRun });
298
+ return sections.filter(section => section.list.length);
299
+ }
265
300
  /**
266
301
  * Render a two-column markdown table. Rows with an empty value are skipped, so optional rows
267
302
  * need no surrounding `if`.
@@ -384,6 +419,8 @@ module.exports.runSummary = runSummary;
384
419
 
385
420
  module.exports.totalDuration = totalDuration;
386
421
 
422
+ module.exports.smallRunSections = smallRunSections;
423
+
387
424
  module.exports.plannedTestsLabel = plannedTestsLabel;
388
425
 
389
426
  module.exports.parsePipeOptions = parsePipeOptions;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@testomatio/reporter",
3
- "version": "2.19.0-beta",
3
+ "version": "2.19.0",
4
4
  "description": "Testomatio Reporter Client",
5
5
  "engines": {
6
6
  "node": ">=22"
@@ -7,6 +7,7 @@ import {
7
7
  markdownTable,
8
8
  runSummary,
9
9
  totalDuration,
10
+ smallRunSections,
10
11
  } from '../utils/pipe_utils.js';
11
12
  import { Gaxios } from 'gaxios';
12
13
  import pc from 'picocolors';
@@ -174,7 +175,8 @@ export class BitbucketPipe {
174
175
  let body = summary;
175
176
 
176
177
  if (this.description) {
177
- body += `\n\n> ${truncate(this.description, 1024).replace(/\r?\n/g, '\n> ')}`;
178
+ // Bitbucket strips HTML, so no <details> here
179
+ body += `\n\n**📝 Description**\n\n${truncate(this.description, 1024)}\n`;
178
180
  }
179
181
 
180
182
  if (failures.length) {
@@ -184,6 +186,10 @@ export class BitbucketPipe {
184
186
  }
185
187
  }
186
188
 
189
+ for (const { title, list } of smallRunSections(this.tests)) {
190
+ body += `\n\n**${title}**\n\n${list.join('\n')}`;
191
+ }
192
+
187
193
  if (this.tests.length > 0 && !isPendingRun) {
188
194
  body += `\n\n**🐢 Slowest Tests**\n\n`;
189
195
  body += this.tests
@@ -12,6 +12,7 @@ import {
12
12
  markdownTable,
13
13
  runSummary,
14
14
  totalDuration,
15
+ smallRunSections,
15
16
  } from '../utils/pipe_utils.js';
16
17
  import { log } from '../utils/log.js';
17
18
 
@@ -147,7 +148,8 @@ class GitHubPipe {
147
148
 
148
149
  let body = summary;
149
150
  if (this.description) {
150
- body += `\n\n> ${truncate(this.description, 1024).replace(/\r?\n/g, '\n> ')}`;
151
+ body += '\n\n<details>\n<summary><h3>📝 Description</h3></summary>\n\n';
152
+ body += `${truncate(this.description, 1024)}\n\n</details>`;
151
153
  }
152
154
  const coverageConfiguration = this.store?.coverageConfiguration;
153
155
  const isManualRun = this.store?.runKind === 'manual';
@@ -172,6 +174,10 @@ class GitHubPipe {
172
174
  body += '\n\n</details>';
173
175
  }
174
176
 
177
+ for (const { title, list } of smallRunSections(this.tests)) {
178
+ body += `\n<details>\n<summary><h3>${title}</h3></summary>\n\n${list.join('\n')}\n</details>`;
179
+ }
180
+
175
181
  if (this.tests.length > 0 && !isPendingRun) {
176
182
  body += '\n<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n';
177
183
  body += this.tests
@@ -13,6 +13,7 @@ import {
13
13
  markdownTable,
14
14
  runSummary,
15
15
  totalDuration,
16
+ smallRunSections,
16
17
  } from '../utils/pipe_utils.js';
17
18
  import { log } from '../utils/log.js';
18
19
 
@@ -148,7 +149,8 @@ class GitLabPipe {
148
149
  let body = summary;
149
150
 
150
151
  if (this.description) {
151
- body += `\n\n> ${truncate(this.description, 1024).replace(/\r?\n/g, '\n> ')}`;
152
+ body += '\n\n<details>\n<summary><h3>📝 Description</h3></summary>\n\n';
153
+ body += `${truncate(this.description, 1024)}\n\n</details>`;
152
154
  }
153
155
 
154
156
  if (failures.length) {
@@ -159,6 +161,10 @@ class GitLabPipe {
159
161
  body += '\n\n</details>';
160
162
  }
161
163
 
164
+ for (const { title, list } of smallRunSections(this.tests)) {
165
+ body += `\n<details>\n<summary><h3>${title}</h3></summary>\n\n${list.join('\n')}\n</details>`;
166
+ }
167
+
162
168
  if (this.tests.length > 0 && !isPendingRun) {
163
169
  body += '\n<details>\n<summary><h3>🐢 Slowest Tests</h3></summary>\n\n';
164
170
  body += this.tests
@@ -122,6 +122,14 @@ function statusEmoji(status) {
122
122
  return '';
123
123
  }
124
124
 
125
+ /**
126
+ * @param {string} str
127
+ * @returns {string} The string with its first letter in upper case, e.g. `passed` → `Passed`.
128
+ */
129
+ function capitalize(str) {
130
+ return str.charAt(0).toUpperCase() + str.slice(1);
131
+ }
132
+
125
133
  /**
126
134
  * Generate a full name string based on the provided test object.
127
135
  * @param {object} t - The test object.
@@ -260,6 +268,37 @@ function totalDuration(tests) {
260
268
  return humanizeDuration(Math.trunc(milliseconds), { maxDecimalPoints: 0 });
261
269
  }
262
270
 
271
+ /**
272
+ * Runs with fewer tests than this list every test in the report, not only the failed ones.
273
+ */
274
+ const SMALL_RUN_TESTS_LIMIT = 10;
275
+
276
+ /**
277
+ * Sections listing the passed, skipped and not yet run tests of a small run; failures have their own
278
+ * section. Not yet run tests (no status, or `pending`) are listed without any status label.
279
+ *
280
+ * @param {Array<{status?: string, title?: string, suite_title?: string, run_time?: number}>} tests
281
+ * @returns {Array<{title: string, list: string[]}>} Non-empty sections; none if the run is not small.
282
+ */
283
+ function smallRunSections(tests) {
284
+ if (tests.length >= SMALL_RUN_TESTS_LIMIT) return [];
285
+
286
+ const sections = ['passed', 'skipped'].map(status => {
287
+ const list = tests
288
+ .filter(t => t.status === status)
289
+ .map(t => {
290
+ const runTime = t.run_time ? ` (${humanizeDuration(t.run_time)})` : '';
291
+ return `* ${statusEmoji(status)} ${fullName(t)}${runTime}`;
292
+ });
293
+ return { title: `${statusEmoji(status)} ${capitalize(status)} (${list.length})`, list };
294
+ });
295
+
296
+ const notRun = tests.filter(t => !t.status || t.status === 'pending').map(t => `* ${fullName(t)}`);
297
+ sections.push({ title: `📋 Tests (${notRun.length})`, list: notRun });
298
+
299
+ return sections.filter(section => section.list.length);
300
+ }
301
+
263
302
  /**
264
303
  * Render a two-column markdown table. Rows with an empty value are skipped, so optional rows
265
304
  * need no surrounding `if`.
@@ -368,6 +407,7 @@ export {
368
407
  markdownTable,
369
408
  runSummary,
370
409
  totalDuration,
410
+ smallRunSections,
371
411
  plannedTestsLabel,
372
412
  parsePipeOptions,
373
413
  formatFilterListIds,