Custom reporter feature: users can plug-in their reporters now

kiranz · kiranz · commit e6706fdfc41d · 2018-06-26T21:05:28.000+05:30
diff --git a/README.md b/README.md
@@ -39,14 +39,17 @@ You can choose to validate any or all of response status code, headers, JSON dat
 - Importing specs from multiple external suites
 - Intrasuite and Intersuite spec dependencies
 - Reusing test specification
-- Retry failed tests with wait time
+- Retry failed tests
 - Looping: Generate 'n' number of tests with a list
+- Built-in HTML, JSON reporters
 - Ability to generate reports in multiple formats for the same run
 - Logging HTTP request/response data for failed tests
 - Proper error reporting
 - Runs only tests matching with a given pattern/text
 - Skipping tests with specification
 - Disable or Enable redirections
+- Reports test duration
+- Allows user to plug-in custom reporters
 
 [Find out all features](https://kiranz.github.io/just-api/features/)
 
diff --git a/docs/docs/features.md b/docs/docs/features.md
@@ -661,6 +661,7 @@ And you can import specs from multiple suites by listing their relative paths.
 Note that these imported specs will only be available when you run them using `this.runSpec`.
 
 Please find some examples on dependencies [here](https://github.com/kiranz/just-api/blob/master/test/cli/src/suites/suitedependencies/intersuitedeps.suite.yml)
+
 ## Skipping
 You can explicitly skip suites and tests with specification.
 
diff --git a/lib/just-api.js b/lib/just-api.js
@@ -56,7 +56,7 @@ export default class JustAPI {
             chosenReporters.push('specs')
         }
 
-        chosenReporters =  Array.from(new Set(chosenReporters));
+        chosenReporters = Array.from(new Set(chosenReporters));
 
         for (let reporterInput of chosenReporters) {
             let Reporter;
@@ -72,8 +72,14 @@ export default class JustAPI {
                     Reporter = require('./reporters/json.js');
                     break;
                 default:
-                    console.error(`Reporter: ${reporterInput} is unknown. Please provide a valid reporter`);
-                    process.exit(1);
+                    try {
+                        Reporter = require(reporterInput.trim());
+                        break;
+                    } catch (err) {
+                        console.error(`\nError occurred while loading the reporter: ${reporterInput.trim()}`);
+                        console.error(`\n  ${err.stack}`);
+                        process.exit(1);
+                    }
             }
 
             this.reporters.push(Reporter);
diff --git a/lib/launcher.js b/lib/launcher.js
@@ -36,12 +36,18 @@ export default class Launcher extends EventEmitter {
         this.reporters = [];
 
         for (let Reporter of reporters) {
-            let reporter = new Reporter(this, {
-                parallel: this.parallel,
-                reporterOptions: {...this.reporterOptions}
-            });
+            try {
+                let reporter = new Reporter(this, {
+                    parallel: this.parallel,
+                    reporterOptions: {...this.reporterOptions}
+                });
+
+                this.reporters.push(reporter);
+            } catch (err) {
+                console.error(`Error occurred while initializing reporter: ${Reporter.name} \n ${err.stack}`);
+                process.exit(1);
+            }
 
-            this.reporters.push(reporter);
         }
     }
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "just-api",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "description": "Specification based API test framework for HTTP APIs (REST, GraphQL)",
   "keywords": [
     "API",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "just-api",`
`3`		`- "version": "1.0.9",`
	`3`	`+ "version": "1.1.0",`
`4`	`4`	`"description": "Specification based API test framework for HTTP APIs (REST, GraphQL)",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"API",`