WIP: Nested steps (#2)

* rewrite reportportal as plugin

* testing phase

* fix some errors

* handle events

* handle events

* add tests

* fix tests

* add test script

* changed name of the package

* updated

* updated nested steps and better reports + adde ddebug

* updated index

* implemented right order for nested steps

* udpated readme

Co-authored-by: Peter Nguyen Tr <peter.nguyentr@gmail.com>

Author: DavertMik

.gitignore

@@ -1,2 +1,3 @@
 package-lock.json
-node_modules
+node_modules
+test/output/*

README.md

@@ -1,41 +1,44 @@
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/6e6495428bbd41f0807e4239c42403eb)](https://www.codacy.com/manual/PeterNgTr/codeceptjs-rphelper?utm_source=github.com&utm_medium=referral&utm_content=PeterNgTr/codeceptjs-rphelper&utm_campaign=Badge_Grade) [![npm version](https://badge.fury.io/js/codeceptjs-rphelper.svg)](https://badge.fury.io/js/codeceptjs-rphelper) [![Greenkeeper badge](https://badges.greenkeeper.io/PeterNgTr/codeceptjs-rphelper.svg)](https://greenkeeper.io/)
 
 # codeceptjs-rphelper
+
 This helpes you integrate the test results of CodeceptJS with ReportPortal
 
-codeceptjs-rphelper is a [CodeceptJS](https://codecept.io/) helper which can publish tests results on [ReportPortal](https://reportportal.io/) after execution.
+`@reportportal/agent-js-codecept` is a [CodeceptJS](https://codecept.io/) plugin which can publish tests results on [ReportPortal](https://reportportal.io/) after execution.
 
 ## Installation
+
 ```sh
-npm i codeceptjs-rphelper --save
+npm i @reportportal/agent-js-codecept --save
 ```
 
 ## Configuration
 
-This helper should be added in codecept.json/codecept.conf.js
+This plugin should be added in `codecept.conf.js`
 
 Example:
 
 ```js
 {
   ...
-   helpers: {
-    ReportPortalHelper: {
-      require: 'codeceptjs-rphelper',
+   plugins: {
+    reportportal: {
+      require: '@reportportal/agent-js-codecept',
       token: 'YOUR_TOKEN',
       endpoint: 'http://localhost:8080/api/v1',
       launchName: 'This is awesome',
       launchDescription: 'This is a description of your launch',
       launchAttributes: [{ key: 'yourKey', value: 'yourValue' }],
       projectName: 'YOUR_PROJECT',
       rerun: false,
-      debug: false
+      debug: false,
+      enabled: true
     }
   ...
 }
 ```
 
-To use this helper you need to provide the following info:
+To use this plugin you need to provide the following info:
 
 ```sh
 - `token`: which can be found by navigating to the user profile page, clicking the username drop-down in the right header and selecting the "Profile" > "UUID" – is a unique user identifier. UUID is used in automated test configuration files for a user authentication instead of a password. It will allow you to post data, without logging it in the UI.
@@ -105,10 +108,20 @@ Success finish launch 65ndx5jucolqsp
 ```
 
 ## Screenshot
+
 ![ReportPortal Test](https://i.ibb.co/Qm52G0n/Screenshot-2019-04-11-at-15-57-40.png)
 
 All the feature tests are now combine in a single launch
 ![ReportPortal Launch](http://g.recordit.co/GKsRlB4Fi4.gif)
 
 ## Notes
+
 Right now, when running with `codeceptjs run`, all tests will be added under a launch. However, if you run with `codeceptjs run-workers no_of_workers`, there will be multiple launches that match `no_of_workers` and all tests will be added under any random launch. One thing you could try right now is trying to use `codeceptjs run-workers --suites no_of_workers`, by that, you won't get the messy results on `reportportal`.
+
+## Debugging Plugin
+
+To debug this plugin run script enabing DEBUG env variable:
+
+```
+DEBUG="codeceptjs:reportportal"  npx codeceptjs run
+```

index.js

@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "allowJs": true
+  }
+}

jsconfig.json

@@ -1,7 +1,7 @@
 {
-  "name": "codeceptjs-rphelper",
-  "version": "1.1.12",
-  "description": "Reportportal helper for Codecept JS tests",
+  "name": "@reportportal/agent-js-codecept",
+  "version": "2.0.0",
+  "description": "Reportportal plugin for Codecept JS tests",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/PeterNgTr/codeceptjs-rphelper.git"
@@ -22,11 +22,17 @@
   "main": "index.js",
   "dependencies": {
     "reportportal-client": "5.5.0",
-    "codeceptjs": "^2.3.5"
+    "codeceptjs": "2.5.0"
+  },
+  "scripts": {
+    "test": "mocha test/acceptance_test.js --timeout 6000"
   },
   "devDependencies": {
+    "chai": "^4.2.0",
     "eslint": "^6.6.0",
     "eslint-config-airbnb-base": "^14.0.0",
-    "eslint-plugin-import": "^2.18.2"
+    "eslint-plugin-import": "^2.18.2",
+    "mocha": "^7.0.1",
+    "puppeteer": "^2.1.1"
   }
 }

package.json

@@ -0,0 +1,42 @@
+const { exec } = require("child_process");
+const { expect } = require('chai');
+const runner = './node_modules/.bin/codeceptjs run rp_plugin_test.js'
+const configFilePath = './test/codecept.conf.js'
+
+describe('RP Plugin - Codeceptjs Integration', () => {
+
+    describe('Passed test', () => {
+        it('should push data to rp', (done) => {
+            exec(`${runner} --grep @pass -c ${configFilePath} --verbose`, (error, stdout, stderr) => {
+                expect(stderr).to.be.empty;
+                expect(stdout).to.include('The launchId is started.');
+                expect(stdout).to.include('The suiteId is started.');
+                expect(stdout).to.include('The testId is started.');
+                expect(stdout).to.include('The stepId is started.');
+                expect(stdout).to.include('The passed stepId is updated.');
+                expect(stdout).to.include('OK  | 1 passed ');
+                done();
+            });
+        });
+    
+    });
+
+    describe('Failed test', () => {
+        it('should push data to rp', (done) => {
+            exec(`${runner} --grep @fail -c ${configFilePath} --verbose`, (error, stdout, stderr) => {
+                expect(stderr).to.be.empty;
+                expect(stdout).to.include('The launchId is started.');
+                expect(stdout).to.include('The launchId is started.');
+                expect(stdout).to.include('The suiteId is started.');
+                expect(stdout).to.include('The testId is started.');
+                expect(stdout).to.include('The stepId is started.');
+                expect(stdout).to.include('The failed stepId is updated.');
+                expect(stdout).to.include('Screenshot is attached to failed step');
+                expect(stdout).to.include('FAIL  | 0 passed, 1 failed');
+                done();
+            });
+        });
+    });
+
+});
+

test/acceptance_test.js

@@ -0,0 +1,40 @@
+const { setHeadlessWhen } = require('@codeceptjs/configure');
+
+// turn on headless mode when running with HEADLESS=true environment variable
+// HEADLESS=true npx codecept run
+setHeadlessWhen(process.env.HEADLESS);
+
+exports.config = {
+  tests: './*_test.js',
+  output: './output',
+  timeout: 10000,
+  helpers: {
+    Puppeteer: {
+      url: 'https://www.google.de/',
+      show: false
+    }
+  },
+  bootstrap: null,
+  mocha: {},
+  name: 'codeceptjs-rphelper',
+  plugins: {
+    retryFailedStep: {
+      enabled: false
+    },
+    screenshotOnFail: {
+      enabled: true
+    },
+    reportportal: {
+      require: '../index',
+      token: process.env['RP_TOKEN'],
+      endpoint: 'https://web.demo.reportportal.io/api/v1',
+      launchName: 'This is demo launch',
+      launchDescription: 'This is a description of your launch',
+      launchAttributes: [{ key: 'yourKey', value: 'yourValue' }],
+      projectName: 'peterngtr_personal',
+      rerun: false,
+      debug: false,
+      enabled: true
+    }
+  }
+}

test/codecept.conf.js

@@ -0,0 +1,11 @@
+Feature('RP Plugin tests');
+
+Scenario('Send passed results to RP @pass', (I) => {
+    I.amOnPage('/');
+    I.dontSee('abc');
+});
+
+Scenario('Send failed results to RP @fail', (I) => {
+    I.amOnPage('/');
+    I.see('abcdef');
+});