added event to receive report

Author: Mykhailo Bodnarchuk

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.2.3
+
+* added `reportportal.result` event to notify when report was created
+
 # 0.2.0
 
 * Added debug messages logs

README.md

@@ -84,6 +84,20 @@ reportPortal.addLog({
 
 See [`sendLog` method of ReportPortal JavaScript Client](https://github.com/reportportal/client-javascript#sendlog) for more oprtions.
 
+### Get Report URL
+
+Once report is posted a special `reportportal.result` event is created. 
+
+You can use it to pass URL of a report into other plugins. For instance, you can use it to send Slack or Email notifications including a link to a report.
+
+```js
+// inside your custom plugin:
+event.dispatcher.on('reportportal.result', (result) => {
+  // use result.link as URL to report
+  console.log('Report was published at', result.link);
+})
+```
+
 ## Todo
 
 - [ ] Support `run-workers` command to aggregate all tests under one launch.

index.js

@@ -51,6 +51,7 @@ module.exports = (config) => {
     if (!config[field]) throw new Error(`ReportPortal config is invalid. Key ${field} is missing in config.\nRequired fields: ${requiredFields} `)
   }
 
+  let reportUrl;
   let launchObj;
   let suiteObj;
   let testObj;
@@ -282,7 +283,9 @@ module.exports = (config) => {
 
       const response = await launch.promise;
 
+      reportUrl = response.link;
       output.print(` 📋 Report #${response.number} saved ➡`, response.link);
+      event.emit('reportportal.result', response);
     } catch (error) {
       console.log(error);
       debug(error);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reportportal/agent-js-codecept",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Reportportal plugin for Codecept JS tests",
   "repository": {
     "type": "git",