@testomatio/reporter 1.2.2-beta.show-error.1 → 1.2.2

package/lib/fileUploader.js

@@ -20,6 +20,7 @@ const keys = [
   'S3_BUCKET',
   'S3_ACCESS_KEY_ID',
   'S3_SECRET_ACCESS_KEY',
+  'S3_SESSION_TOKEN',
   'TESTOMATIO_DISABLE_ARTIFACTS',
   'TESTOMATIO_PRIVATE_ARTIFACTS',
   'S3_FORCE_PATH_STYLE',
@@ -74,7 +75,8 @@ const _getFileExtBase64 = str => {
 };
 
 const _getS3Config = () => {
-  const { S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_FORCE_PATH_STYLE, S3_ENDPOINT } = getConfig();
+  const { S3_REGION, S3_SESSION_TOKEN, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_FORCE_PATH_STYLE, S3_ENDPOINT } =
+    getConfig();
 
   const cfg = {
     region: S3_REGION,
@@ -85,6 +87,10 @@ const _getS3Config = () => {
     },
   };
 
+  if (S3_SESSION_TOKEN) {
+    cfg.credentials.sessionToken = S3_SESSION_TOKEN;
+  }
+
   if (S3_ENDPOINT) {
     cfg.endpoint = S3_ENDPOINT;
   }

package/lib/pipe/html.js

@@ -91,7 +91,7 @@ class HtmlPipe {
       // GENERATE HTML reports based on the results data
       this.buildReport({
         runParams,
-        // TODO: this.tests=[] in case of Mocha
+        // TODO: this.tests=[] in case of Mocha, need retest by Vitalii
         tests: this.tests,
         outputPath: this.htmlOutputPath,
         templatePath: this.templateHtmlPath,
@@ -123,30 +123,31 @@ class HtmlPipe {
     }
 
     tests.forEach(test => {
-      if (!test.message || test.message.trim() === '') {
+      if (!test.message?.trim()) {
         test.message = "This test has no 'message' code";
       }
 
-      if (!test.suite_title || test.suite_title.trim() === '') {
+      if (!test.suite_title?.trim()) {
         test.suite_title = 'Unknown suite';
       }
 
-      if (!test.title || test.title.trim() === '') {
+      if (!test.title?.trim()) {
         test.title = 'Unknown test title';
       }
 
-      if (!test.files || test.files.length === 0) {
+      if (!test.files?.length) {
         test.files = 'This test has no files';
       }
 
-      if (test.steps) {
-        if (!test.steps || test.steps.trim() === '') {
-          test.steps = "This test has no 'steps' code";
-        } else {
-          test.steps = removeAnsiColorCodes(test.steps);
-        }
+      if (!test.steps?.trim()) {
+        test.steps = "This test has no 'steps' code";
+      } else {
+        test.steps = removeAnsiColorCodes(test.steps);
       }
 
+      // TODO: future-proof: currently there is no need to display Artifacts and Metadata in HTML
+      test.artifacts = test.artifacts || [];
+      test.meta = test.meta || {};
       // TODO: u can added an additional test values to this checks in the future
     });
 
@@ -199,7 +200,8 @@ class HtmlPipe {
 
       return template(data);
     } catch (e) {
-      console.log('Unknown HTML report generation error: ', e);
+      console.log(chalk.red('❌ Oops! An unknown error occurred when generating an HTML report'));
+      console.log(chalk.red(e));
     }
   }
 
@@ -209,42 +211,77 @@ class HtmlPipe {
       (tests, status) => tests.filter(test => test.status.toLowerCase() === status.toLowerCase()).length,
     );
 
-    handlebars.registerHelper('json', tests => {
-      // TODO: please refactor the code below, add meaningful variable names, separate into functions
-      function replaceScriptTagsInArray(array) {
-        return array.map(obj => {
-          const keysToCheck = ['steps', 'stack', 'title', 'suite_title', 'message', 'code'];
-          const newObj = {};
-
-          for (const key in obj) {
-            if (Object.prototype.hasOwnProperty.call(obj, key)) {
-              if (key === 'example') {
-                newObj[key] = {};
-                for (const subKey in obj[key]) {
-                  if (Object.prototype.hasOwnProperty.call(obj[key], subKey)) {
-                    newObj[key][subKey] =
-                      typeof obj[key][subKey] === 'string'
-                        ? obj[key][subKey].replace(/<script>/g, '<$cript>').replace(/<\/script>/g, '</$cript>')
-                        : obj[key][subKey];
-                  }
-                }
-              } else if (keysToCheck.includes(key)) {
-                newObj[key] =
-                  typeof obj[key] === 'string'
-                    ? obj[key].replace(/<script>/g, '<$cript>').replace(/<\/script>/g, '</$cript>')
-                    : obj[key];
-              } else {
-                newObj[key] = obj[key];
-              }
+    handlebars.registerHelper(
+      'selectComponent',
+      () =>
+        new handlebars.SafeString(
+          `<select style="width: 70px;height: 38px;" class="form-select" aria-label="Tests counter on page">
+          <option value="0">10</option>
+          <option value="1">25</option>
+          <option value="2">50</option>
+        </select>`,
+        ),
+    );
+
+    handlebars.registerHelper(
+      'emptyDataComponent',
+      () =>
+        new handlebars.SafeString(
+          `<div class="noData m-0">
+          NO MATCHING TESTS
+        </div>`,
+        ),
+    );
+
+    handlebars.registerHelper('pageDispleyElements', tests => {
+      // We wrapp the lines to the HTML format we need
+      const totalTests = JSON.parse(
+        JSON.stringify(tests)
+          .replace(/<script>/g, '&lt;script&gt;')
+          .replace(/<\/script>/g, '&lt;/script&gt;'), // eslint-disable-line
+      );
+
+      const paginationOptions = {
+        0: 10,
+        1: 25,
+        2: 50,
+      };
+      const statuses = ['all', 'passed', 'failed', 'skipped'];
+      const pageItemGroups = {
+        all: {},
+        passed: {},
+        failed: {},
+        skipped: {},
+        totalTests,
+      };
+
+      function paginateItems(items, pageSize) {
+        const paginatedItems = [];
+        for (let i = 0; i < items.length; i += pageSize) {
+          paginatedItems.push(items.slice(i, i + pageSize));
+        }
+        return paginatedItems;
+      }
+
+      statuses.forEach(status => {
+        for (const option in paginationOptions) {
+          // eslint-disable-next-line no-prototype-builtins
+          if (paginationOptions.hasOwnProperty(option)) {
+            const pageSize = paginationOptions[option];
+            let filteredItems = totalTests;
+
+            if (status !== 'all') {
+              filteredItems = totalTests.filter(item => item.status === status);
             }
+
+            pageItemGroups[status][option] = paginateItems(filteredItems, pageSize);
           }
+        }
+      });
 
-          return newObj;
-        });
-      }
+      pageItemGroups.totalTests = totalTests;
 
-      // Remove ANSI escape codes
-      return JSON.stringify(replaceScriptTagsInArray(tests));
+      return JSON.stringify(pageItemGroups);
     });
   }
 
@@ -261,7 +298,7 @@ class HtmlPipe {
  */
 function testExecutionSumTime(tests) {
   const totalMilliseconds = tests.reduce((sum, test) => {
-    if (typeof test.run_time === 'number') {
+    if (typeof test.run_time === 'number' && !Number.isNaN(test.run_time)) {
       return sum + test.run_time;
     }
     return sum;

package/lib/pipe/testomatio.js

@@ -190,7 +190,6 @@ class TestomatioPipe {
         'Error creating Testomat.io report, please check if your API key is valid. Skipping report | ',
         err?.response?.statusText || err?.status || err.message,
       );
-      printCreateIssue(err);
     }
     debug('"createRun" function finished');
   }
@@ -232,11 +231,8 @@ class TestomatioPipe {
             chalk.yellow(`Warning: ${data?.title || ''} (${err.response?.status})`),
             `Report couldn't be processed: ${err?.response?.data?.message}`,
           );
-          printCreateIssue(err);
         } else {
           console.log(APP_PREFIX, chalk.blue(data?.title || ''), "Report couldn't be processed", err);
-
-
         }
       });
   }
@@ -304,7 +300,6 @@ class TestomatioPipe {
       }
     } catch (err) {
       console.log(APP_PREFIX, 'Error updating status, skipping...', err);
-      printCreateIssue(err);
     }
     debug('Run finished');
   }
@@ -314,24 +309,4 @@ class TestomatioPipe {
   }
 }
 
-let registeredErrorHints = false;
-function printCreateIssue(err) {
-  if (registeredErrorHints) return;
-  registeredErrorHints = true;
-  process.on('beforeExit', () => {
-    console.log(APP_PREFIX, 'There was error reporting to Testomat.io:');    
-    console.log(APP_PREFIX, 'If you think this is a bug please create an issue: https://github.com/testomatio/app/issues/new');
-    console.log(APP_PREFIX, 'Provide this information:');
-    console.log(APP_PREFIX, 'Error:', err.message || err.code);
-    if (!err.config) return;
-
-    const time = new Date().toUTCString();
-    const { data, url, baseURL, method } = err?.config || {}
-    console.log('```js')
-    console.log({ data, url, baseURL, method, time });
-    console.log('```')
-    console.log();
-  });
-}
-
 module.exports = TestomatioPipe;