Merge pull request #87 from reportportal/develop

Release 5.0.2

Author: AmsterGet

.github/workflows/publish.yml

@@ -14,9 +14,8 @@
 name: publish
 
 on:
-  release:
-    types:
-      - published
+  repository_dispatch:
+    types: [version-released]
 
 jobs:
   build:

.github/workflows/release.yml

@@ -74,6 +74,10 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
+      - name: Setup NodeJS
+        uses: actions/setup-node@v2
+        with:
+          node-version: '12'
       - name: Configure git
         run: |
           git config --global user.email "reportportal.io"
@@ -139,3 +143,9 @@ jobs:
           body: ${{ needs.create-tag.outputs.versionInfo }}
           draft: false
           prerelease: false
+      - name: Trigger the publish workflow
+        if: success()
+        uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+          event-type: version-released

CHANGELOG.md

@@ -1,7 +1,21 @@
+### Fixed
+- `skippedIssue` config property processing using .mocharc or string values
+- Skipped test duplication
+- Config attributes parsing using .mocharc
+
+### Security
+- Versions of several vulnerable dependencies updated
+
+### Added
+- `mode` option for submitting results to Debug tab
+- Latest error log to the step description
+
+### Changed
+- Package size reduced
 
 ## [5.0.1] - 2020-06-23
 ### Added
-- Added link to the example in readme. 
+- Added link to the example in readme.
 
 ## [5.0.0] - 2020-06-22
 ### Added

README.md

@@ -10,13 +10,13 @@ npm install @reportportal/agent-js-mocha
 ```
 
 ## How to use:
-Fill reporterOptions in Mocha configuration. 
+Fill reporterOptions in Mocha configuration.
 ```javascript
 const Mocha = require("mocha");
 let mochaMain = new Mocha({
   reporter: '@reportportal/agent-js-mocha',
   reporterOptions: {
-    "token": "00000000-0000-0000-0000-000000000000",                
+    "token": "00000000-0000-0000-0000-000000000000",
     "endpoint": "https://your.reportportal.server/api/v1",
     "project": "YourReportPortalProjectName",
     "launch": "YourLauncherName",
@@ -31,6 +31,25 @@ let mochaMain = new Mocha({
     ]
   }
 });
+```
+Using `.mocharc.js`:
+```javascript
+module.exports = {
+  'extension': ['js', 'cjs', 'mjs'],
+  'package': './package.json',
+  reporter: '@reportportal/agent-js-mocha',
+  'reporter-option':[
+    'endpoint=https://your.reportportal.server/api/v1',
+    'token=00000000-0000-0000-0000-000000000000',
+    'launch=YourLauncherName',
+    'project=YourReportPortalProjectName',
+    'attributes=YourKey:YourValue;YourValue',
+  ],
+  'file': [
+    'spec/someTest.spec.js',
+  ]
+}
+
 ```
 
 #### You can find an example of using Mocha Reporter [here](https://github.com/reportportal/examples-js/tree/master/example-mocha).
@@ -44,7 +63,8 @@ Runs support following options:
 | token                 | User's Report Portal token from which you want to send requests. It can be found on the profile page of this user.|
 | endpoint              | URL of your server. For example 'https://server:8080/api/v1'.                                                     |
 | launch                | Name of launch at creation.                                                                                       |
-| project               | The name of the project in which the launches will be created.                                                    |
+| project               | The name of the project in which the launches will be created.
+| mode               | *Default: "default".* Results will be submitting to Launches tab<br> *"debug"* - Results will be submitting to Debug tab.                                                          |
 | rerun                 | *Default: false.* Enable [rerun](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/rerun.md)|
 | rerunOf               | UUID of launch you want to rerun. If not specified, report portal will update the latest launch with the same name|
 | reportHooks           | *Default: false.* Determines report before and after hooks or not.                                                |
@@ -112,7 +132,7 @@ describe('suite',()=>{
 ```
 #### Report attributes for steps and suites
 
-**addAttributes (*attributes*)**. Add attributes(tags) to the current test/suite. Should be called inside of corresponding test or suite.</br> 
+**addAttributes (*attributes*)**. Add attributes(tags) to the current test/suite. Should be called inside of corresponding test or suite.</br>
 *attributes* is array of pairs of key and value:
 ```javascript
 [{
@@ -141,7 +161,7 @@ describe('suite',()=>{
 
 #### Integration with Sauce Labs
 
-To integrate with Sauce Labs just add attributes: 
+To integrate with Sauce Labs just add attributes:
 
 ```javascript
 [{
@@ -155,9 +175,9 @@ To integrate with Sauce Labs just add attributes:
 
 #### Report description for steps and suites
 
-**setDescription (*description*)**. Set text description to the current test/suite. Should be called inside of corresponding test or suite.</br> 
+**setDescription (*description*)**. Set text description to the current test/suite. Should be called inside of corresponding test or suite.</br>
 
-Mocha doesn't allow functional calls directly into describe section. You can call setDescription inside of before/after hooks to set description to the corresponding suite. 
+Mocha doesn't allow functional calls directly into describe section. You can call setDescription inside of before/after hooks to set description to the corresponding suite.
 
 **Example:**
 ```javascript
@@ -175,9 +195,9 @@ describe('suite',()=>{
 
 #### Report test case id for steps and suites
 
-**setTestCaseId (*testCaseId*)**. Set test case id to the current test/suite. Should be called inside of corresponding test or suite.</br> 
+**setTestCaseId (*testCaseId*)**. Set test case id to the current test/suite. Should be called inside of corresponding test or suite.</br>
 
-Mocha doesn't allow functional calls directly into describe section. You can call setTestCaseId inside of before/after hooks to set test case id to the corresponding suite. 
+Mocha doesn't allow functional calls directly into describe section. You can call setTestCaseId inside of before/after hooks to set test case id to the corresponding suite.
 
 **Example:**
 ```javascript
@@ -233,7 +253,7 @@ describe('suite',()=>{
   });
 });
 ```
- 
+
 # Copyright Notice
 
 Licensed under the [Apache License v2.0](LICENSE)

VERSION

@@ -1 +1 @@
-5.0.1
+5.0.2-SNAPSHOT

lib/mochaReporter.js

@@ -21,7 +21,7 @@ const { EVENTS } = require('@reportportal/client-javascript/lib/constants/events
 const { entityType, hookTypes, hookTypesMap } = require('./constants/itemTypes');
 const logLevels = require('./constants/logLevels');
 const testStatuses = require('./constants/testStatuses');
-const { getCodeRef, getAgentInfo } = require('./utils');
+const { getCodeRef, getAgentInfo, parseAttributes } = require('./utils');
 
 const {
   EVENT_RUN_BEGIN,
@@ -151,7 +151,8 @@ class ReportportalAgent extends Mocha.reporters.Base {
         system: true,
       },
     ];
-    if (this.options.reporterOptions.skippedIssue === false) {
+    if (String(this.options.reporterOptions.skippedIssue).toLowerCase() === 'false') {
+      this.options.reporterOptions.skippedIssue = false;
       const skippedIssueAttribute = {
         key: 'skippedIssue',
         value: 'false',
@@ -164,14 +165,14 @@ class ReportportalAgent extends Mocha.reporters.Base {
 
   onLaunchStart() {
     const systemAttributes = this.getSystemAttributes();
-    const launchAttributes = (this.options.reporterOptions.attributes || []).concat(
-      systemAttributes,
-    );
+    const attributes = parseAttributes(this.options.reporterOptions.attributes);
+    const launchAttributes = (attributes || []).concat(systemAttributes);
     const { tempId, promise } = this.rpClient.startLaunch({
       token: this.options.reporterOptions.token,
       name: this.options.reporterOptions.launch,
       startTime: this.rpClient.helpers.now(),
       description: this.options.reporterOptions.description,
+      mode: this.options.reporterOptions.mode,
       rerun: this.options.reporterOptions.rerun,
       rerunOf: this.options.reporterOptions.rerunOf,
       attributes: launchAttributes,
@@ -271,7 +272,12 @@ class ReportportalAgent extends Mocha.reporters.Base {
   finishTest(test, autoStatus) {
     if (this.currentTest) {
       const testAttributes = this.attributes.get(this.currentTest.tempId);
-      const testDescription = this.descriptions.get(this.currentTest.tempId);
+      let testDescription = this.descriptions.get(this.currentTest.tempId);
+      if (test.err) {
+        testDescription = (testDescription || '').concat(
+          `\n\`\`\`error\n${test.err.stack}\n\`\`\``,
+        );
+      }
       const testCaseId = this.testCaseIds.get(this.currentTest.tempId);
       const testStatus = this.testItemStatuses.get(this.currentTest.tempId) || autoStatus;
       const withoutIssue =
@@ -352,7 +358,9 @@ class ReportportalAgent extends Mocha.reporters.Base {
   }
 
   onTestPending(test) {
-    this.onTestStart(test);
+    if (this.currentTest === null) {
+      this.onTestStart(test);
+    }
     this.finishTest(test, testStatuses.SKIPPED);
   }
 

lib/utils.js

@@ -30,4 +30,16 @@ const getAgentInfo = () => ({
   name: pjson.name,
 });
 
-module.exports = { getCodeRef, getAgentInfo };
+const parseAttributes = (attributes) => {
+  if (typeof attributes === 'string') {
+    return attributes.split(';').map((attributeStr) => {
+      const attribute = attributeStr.split(':');
+      return attribute.length === 2
+        ? { key: attribute[0], value: attribute[1] }
+        : { value: attribute[0] };
+    });
+  }
+  return attributes;
+};
+
+module.exports = { getCodeRef, getAgentInfo, parseAttributes };