Merge pull request #69 from reportportal/develop

Release 5.0.3

Author: AmsterGet

CHANGELOG.md

@@ -1,3 +1,11 @@
+### Fixed
+- Nested describe blocks are not visible in report
+
+### Updated
+- `@reportportal/client-javascript` version to the latest
+
+### Added
+- `restClientConfig` configuration property support (more details in [client-javascript](https://github.com/reportportal/client-javascript))
 
 ## [5.0.2] - 2021-02-09
 ### Added

README.md

@@ -9,7 +9,9 @@ npm install --save-dev @reportportal/agent-js-jest
 ```
 
 ## Usage
+
 In your jest config section of `package.json`, add the following entry:
+
 ```JSON
 {
     "jest": {
@@ -31,7 +33,10 @@ In your jest config section of `package.json`, add the following entry:
                     {
                         "value": "YourValue"
                     },
-                ]
+                ],
+                "restClientConfig": {
+                  "timeout": 0
+                }
             }]
         ],
         ...
@@ -74,23 +79,28 @@ It's possible by using environment variables, it's important to mention that env
 
 ```shell
 $ export RP_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
-$ export RP_PROJECT=MY_AWESOME_PROJECT
+$ export RP_PROJECT_NAME=MY_AWESOME_PROJECT
 $ export RP_LAUNCH=MY_COOL_LAUNCHER
 $ export RP_ATTRIBUTES=key:value,key:value,value
 ```
+
 This for your convenience in case you has a continuous job that run your tests and may post the results pointing to a different Report Portal definition of project, launcher name or tags.
 
 ## Disable the colors of test output:
+
 In the Report Portal, the output of the test results may contain ANSI character set, this may be caused by the color setting in Jest. For version `"jest": "^24.8.0"`, use `jest --no-colors` command to disable the colors of test output.
 
 ## Used to report retry of test:
+
 The agent supports of Retries.
 Read more about [retries in jest](https://jestjs.io/docs/ru/jest-object#jestretrytimes).
 
 ## Rerun:
+
 To report [rerun](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/rerun.md) to the report portal you need to specify the following options:
-- rerun - to enable rerun
-- rerunOf - UUID of launch you want to rerun. If not specified, report portal will update the latest launch with the same name
+
+-   rerun - to enable rerun
+-   rerunOf - UUID of launch you want to rerun. If not specified, report portal will update the latest launch with the same name
 
 Example:
 
@@ -100,7 +110,8 @@ Example:
 ```
 
 ## Skipped issue:
-*Default: true.* ReportPortal provides feature to mark skipped tests as not 'To Investigate' items on WS side.<br> Parameter could be equal boolean values:<br> *TRUE* - skipped tests considered as issues and will be marked as 'To Investigate' on Report Portal.<br> *FALSE* - skipped tests will not be marked as 'To Investigate' on application.
+
+_Default: true._ ReportPortal provides feature to mark skipped tests as not 'To Investigate' items on WS side.<br> Parameter could be equal boolean values:<br> _TRUE_ - skipped tests considered as issues and will be marked as 'To Investigate' on Report Portal.<br> _FALSE_ - skipped tests will not be marked as 'To Investigate' on application.
 
 Example:
 
@@ -109,7 +120,8 @@ Example:
 ```
 
 ## Launch mode:
-Launch mode. Allowable values *DEFAULT* (by default) or *DEBUG*.
+
+Launch mode. Allowable values _DEFAULT_ (by default) or _DEBUG_.
 
 Example:
 
@@ -118,6 +130,7 @@ Example:
 ```
 
 ## Debug flag:
+
 This flag allows seeing the logs of the client-javascript. Useful for debugging an agent.
 
 Example:
@@ -126,11 +139,18 @@ Example:
 "debug": true
 ```
 
+## REST Client config:
+
+Optional property.<br/>
+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`.<br/>
+Visit [client-javascript](https://github.com/reportportal/client-javascript) for more details.
+
 # Copyright Notice
 
 Licensed under the [Apache License v2.0](LICENSE)
 
 # Contribution
+
 This code was based on the [jest-junit](https://github.com/jest-community/jest-junit)
 and adapted by team members of [Ontoforce](https://www.ontoforce.com) for the
 ReportPortal upload. Ontoforce contributed this effort as Open Source to the

VERSION

@@ -1 +1 @@
-5.0.2
+5.0.3-SNAPSHOT