@testomatio/reporter 1.0.3 → 1.0.4

package/README.md

@@ -12,7 +12,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 and error messages
-* 🐙 [GitHub](./docs/pipes.md#github-pipe) & [GitLab](./docs/pipes.md#gitlab-pipe) integration
+* 🐙 [GitHub](./docs/pipes/github.d) & [GitLab](./docs/pipes/gitlab.d) integration
 * 🚅 Realtime reports
 * 🗃️ Other test frameworks supported via [JUNit XML](./docs/junit.md)
 * 🚶‍♀️ Steps *(work in progress)*
@@ -85,13 +85,13 @@ or any [other via JUnit](./docs/junit.md) report....
 
 ### 2️⃣ Configure Reports
 
-* [Create report on Testomat.io](./docs/pipes.md#testomatio-pipe).
-* [Create brief summary report for GitHub Pull Request](./docs/pipes.md#github-pipe) 👇
-* [Create brief summary report for GitLab Merge Request](./docs/pipes.md#gitlab-pipe).
-* [Configure other pipes](./docs/pipes.md) for other ways to process test results output.
+* [Create report on Testomat.io](./docs/pipes/testomatio.md).
+* [Create brief summary report for GitHub Pull Request](./docs/pipes/github.md) 👇
+* [Create brief summary report for GitLab Merge Request](./docs/pipes/gitlab.md).
+* [Configure other pipes](./docs/pipes/md) for other ways to process test results output.
 
 
-![GitHub report](./docs/images/github.png)
+![GitHub report](./docs/pipes/images/github.png)
 
 GitHub report published as a comment to Pull Request:
 
@@ -121,6 +121,10 @@ Bring this reporter on CI and never lose test results again!
 
 * 🛠️ [Frameworks](./docs/frameworks.md)
 * ⛲ [Pipes](./docs/pipes.md)
+  * [Testomat.io](./docs/pipes/testomatio.md)
+  * [GitHub](./docs/pipes/github.md)
+  * [Gitlab](./docs/pipes/gitlab.md)
+  * [CSV](./docs/pipes/csv.md)
 * 📓 [JUnit](./docs/junit.md)
 * 🗄️ [Artifacts](./docs/artifacts.md)
 * 🔂 [Workflows](./docs/workflows.md)

package/lib/pipe/github.js

@@ -21,7 +21,8 @@ class GitHubPipe {
     this.token = params.GH_PAT || process.env.GH_PAT;
     this.ref = process.env.GITHUB_REF;
     this.repo = process.env.GITHUB_REPOSITORY;
-    this.hiddenCommentData = `<!--- testomat.io report ${process.env.GITHUB_WORKFLOW || ''} -->`;
+    this.jobKey = `${process.env.GITHUB_WORKFLOW || ''} / ${process.env.GITHUB_JOB || ''}`;
+    this.hiddenCommentData = `<!--- testomat.io report ${this.jobKey} -->`;
 
     debug('GitHub Pipe: ', this.token ? 'TOKEN' : '*no token*', 'Ref:', this.ref, 'Repo:', this.repo);
 
@@ -73,35 +74,32 @@ class GitHubPipe {
     let summary = `${this.hiddenCommentData}
 
 | [![Testomat.io Report](https://avatars.githubusercontent.com/u/59105116?s=36&v=4)](https://testomat.io)  | ${
-  statusEmoji(runParams.status,)} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
+  statusEmoji(runParams.status,)} ${`${process.env.GITHUB_JOB} ${runParams.status}`.toUpperCase()} |
 | --- | --- |        
 | Tests | ✔️  **${this.tests.length}** tests run  |
-| Summary | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji(
+| Summary | ${failedCount ? `${statusEmoji('failed')} **${failedCount}** failed; ` : ''} ${statusEmoji(
       'passed',
     )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
-| Duration | 🕐  **${humanizeDuration(parseInt(this.tests.reduce((a, t) => a + (t.run_time || 0), 0), 10), {
-      maxDecimalPoints: 0,
-    })}** |
-`;
+| Duration | 🕐  **${humanizeDuration(
+      parseInt(
+        this.tests.reduce((a, t) => a + (t.run_time || 0), 0),
+        10,
+      ),
+      {
+        maxDecimalPoints: 0,
+      },
+    )}** |`;
+
     if (this.store.runUrl) {
-      summary += `| Testomat.io Report | 📊 [Run #${this.store.runId}](${this.store.runUrl})  | `;
+      summary += `\n| Testomat.io Report | 📊 [Run #${this.store.runId}](${this.store.runUrl})  | `;
     }
     if (process.env.GITHUB_WORKFLOW) {
-      summary += `| Workflow | 🗂️  ${process.env.GITHUB_WORKFLOW} | `;
+      summary += `\n| Job | 🗂️  [${this.jobKey}](${process.env.GITHUB_SERVER_URL || 'https://github.com'}/${
+        this.repo
+      }/actions/runs/${process.env.GITHUB_RUN_ID}) | `;
     }
     if (process.env.RUNNER_OS) {
-      summary += `| Operating System | 🖥️ \`${process.env.RUNNER_OS}\` ${process.env.RUNNER_ARCH || ''} | `;
-    }
-    if (process.env.GITHUB_HEAD_REF) {
-      summary += `| Branch | 🌳  \`${process.env.GITHUB_HEAD_REF}\` | `;
-    }
-    if (process.env.GITHUB_RUN_ATTEMPT) {
-      summary += `| Run Attempt | 🌒  \`${process.env.GITHUB_RUN_ATTEMPT}\` | `;
-    }
-    if (process.env.GITHUB_RUN_ID) {
-      summary += `| Build Log | ✒️  ${process.env.GITHUB_SERVER_URL || 'https://github.com'}/${
-        this.repo
-      }/actions/runs/${process.env.GITHUB_RUN_ID} | `;
+      summary += `\n| Operating System | 🖥️ \`${process.env.RUNNER_OS}\` ${process.env.RUNNER_ARCH || ''} | `;
     }
 
     const failures = this.tests

package/lib/pipe/testomatio.js

@@ -39,6 +39,7 @@ class TestomatioPipe {
     this.proceed = process.env.TESTOMATIO_PROCEED;
     this.runId = params.runId || process.env.runId;
     this.createNewTests = !!process.env.TESTOMATIO_CREATE;
+    this.hasUnmatchedTests = false;
 
     if (!isValidUrl(this.url.trim())) {
       this.isEnabled = false;
@@ -115,14 +116,17 @@ class TestomatioPipe {
           const responseData = err.response.data || { message: '' };
           console.log(
             APP_PREFIX,
-            chalk.blue(this.title),
-            `Report couldn't be processed: (${err.response.status}) ${responseData.message}`,
+            chalk.yellow(`Warning: ${responseData.message} (${err.response.status})`),
+            chalk.grey(data?.title || ''),
           );
+          if (err.response.data.message.includes('could not be matched')) {
+            this.hasUnmatchedTests = true;
+          }          
           return;
         }
-        console.log(APP_PREFIX, chalk.blue(this.title), `Report couldn't be processed: ${err.response.data.message}`);
+        console.log(APP_PREFIX, chalk.blue(data?.title || ''), `Report couldn't be processed: ${err.response.data.message}`);
       } else {
-        console.log(APP_PREFIX, chalk.blue(this.title), "Report couldn't be processed", err);
+        console.log(APP_PREFIX, chalk.blue(data?.title || ''), "Report couldn't be processed", err);
       }
     });
   }
@@ -159,6 +163,17 @@ class TestomatioPipe {
         console.log(APP_PREFIX, `📊 ${notFinishedMessage}. Report URL: ${chalk.magenta(this.runUrl)}`);
         console.log(APP_PREFIX, `🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx start-test-run --finish`);
       }
+      if (this.hasUnmatchedTests) {
+        console.log('');
+        console.log(APP_PREFIX, chalk.yellow.bold('⚠️ Some reported tests were not found in Testomat.io project'));
+        console.log(APP_PREFIX, `If you use Testomat.io as a reporter only, please re-run tests using ${chalk.bold('TESTOMATIO_CREATE=1')}`);
+        console.log(APP_PREFIX, `But to keep your tests consistent it is recommended to ${chalk.bold('import tests first')}`);
+        console.log(APP_PREFIX, 'If tests were imported but still not matched, assign test IDs to your tests.');
+        console.log(APP_PREFIX, 'You can do that automatically via command line tools:');
+        console.log(APP_PREFIX, chalk.bold('npx check-tests ... --update-ids'), 'See: https://bit.ly/js-update-ids');
+        console.log(APP_PREFIX, 'or for Cucumber:');
+        console.log(APP_PREFIX, chalk.bold('npx check-cucumber ... --update-ids'), 'See: https://bit.ly/bdd-update-ids');
+      }
     } catch (err) {
       console.log(APP_PREFIX, 'Error updating status, skipping...', err);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",