EPMRPP-89652 || Report the last error log to the test description for…

… Vitest agent (#16)
reportportal · Apr 29, 2024 · f500050 · f500050
1 parent 783e54c
commit f500050
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 ### Added
 - ReportingApi with attachment support
+- `extendTestDescriptionWithLastError` option to the RP config to be able to toggle the last error log attaching to the test description.
 
 ## [5.0.0] - 2024-02-15
 ### Added

diff --git a/README.md b/README.md
@@ -61,6 +61,7 @@ The full list of available options presented below.
 | restClientConfig                            | Optional   | Not set   | The object with `agent` property for configure [http(s)](https://nodejs.org/api/https.html#https_https_request_url_options_callback) client, may contain other client options eg. [`timeout`](https://github.com/reportportal/client-javascript#timeout-30000ms-on-axios-requests). <br/> Visit [client-javascript](https://github.com/reportportal/client-javascript) for more details. |
 | launchUuidPrint                             | Optional   | false     | Whether to print the current launch UUID.                                                                                                                                                                                                                                                                                                                                                |
 | launchUuidPrintOutput                       | Optional   | 'STDOUT'  | Launch UUID printing output. Possible values: 'STDOUT', 'STDERR'. Works only if `launchUuidPrint` set to `true`.                                                                                                                                                                                                                                                                         |
+| extendTestDescriptionWithLastError          | Optional   | true      | If set to `true` the latest error log will be attached to the test case description. |
 
 The following options can be overridden using ENVIRONMENT variables:
 

diff --git a/src/models/configs.ts b/src/models/configs.ts
@@ -48,4 +48,5 @@ export interface ReportPortalConfig extends ClientConfig {
 
   // agent specific options
   skippedIssue?: boolean;
+  extendTestDescriptionWithLastError?: boolean;
 }
diff --git a/src/reporter.ts b/src/reporter.ts
@@ -70,6 +70,7 @@ export class RPReporter implements Reporter {
 
   constructor(config: ReportPortalConfig) {
     this.config = {
+      extendTestDescriptionWithLastError: true,
       ...config,
       launchId: process.env.RP_LAUNCH_ID || config.launchId,
     };
@@ -183,6 +184,13 @@ export class RPReporter implements Reporter {
 
       if (taskResult?.errors?.length) {
         const error = taskResult.errors[0];
+
+        if (this.config.extendTestDescriptionWithLastError) {
+          finishTestItemObj.description = (finishTestItemObj.description || '').concat(
+            `\n\`\`\`error\n${error.stack}\n\`\`\``,
+          );
+        }
+
         const logRq: LogRQ = {
           time: finishTestItemObj.endTime,
           level: LOG_LEVELS.ERROR,