Reporter is now EventEmitter; You can also defined custom reporters; …

…Dropped progress bars

.dockerignore

@@ -2,6 +2,8 @@ example/
 lib/
 node_modules/
 report/
+docs/
+html-docs/
 .dockerignore
 .gitignore
 Dockerfile

.gitignore

@@ -3,3 +3,4 @@
 /lib/
 /coverage/
 /report/
+/html-docs/

.npmignore

@@ -5,6 +5,7 @@
 /qape.conf.js
 /example/
 /src/
+/html-docs/
 /.dockerignore
 /Dockerfile
 /.gitignore

README.md

@@ -49,8 +49,8 @@ module.exports = {
 	// only user defined scenarios will be executed
 	randomScenariosDisabled: false,
 	// When user defined scenario recieves an error,
-	// it will no longer try to minify the steps to reproduce this error.
-	minifyUserDefinedScenariosDisabled: false,
+	// it will try to minify the steps to reproduce this error.
+	minifyUserDefinedScenarios: true,
 	// Disables chromium headless mode and will display browser GUI.
 	headlessModeDisabled: false,
 	// Preview mode will overwrite other config values
@@ -82,6 +82,11 @@ module.exports = {
 	},
 	// A browser websocket endpoint to connect to (i.e. ws://5.5.5.5:3505)
 	browserWebSocketEndpoint: null,
+	// Define your reporters for the QApe run.
+	// You can pass a string for reporters in npm registry,
+	// i.e. if you pass \'super\', QApe will look for
+	// reporter 'qape-reporter-super'. You can also pass Class.
+	reporters: ['default'],
 	// Relative path for the report output
 	reportPath: './report',
 }

docs/Reporters.md

@@ -0,0 +1,49 @@
+# Reporters
+You can define reporters via config.reporters.
+
+```
+var LocalCool = require('/path/to/LocalCool');
+
+export default {
+	reporters: [
+		// For reporter published in npm registry as 'qape-reporter-cool'
+		'cool',
+		// LocalCool is Class extending EventEmitter
+		LocalCool
+	]
+}
+```
+
+## Example
+```javascript
+import EventEmitter from 'events';
+
+export default class DefaultReporter extends EventEmitter {
+	constructor(config) {
+		super();
+
+		// You will recieve configuration for current QApe run
+		this._config = config;
+
+		// runner:start is emitted after browser instance is initialized
+		// eventData contains scenario and browser instance
+		this.on('runner:start', eventData => console.log(eventData));
+		// scenarios:start is emitted after specific scenario starts
+		// eventData contains browser instance, scenario type
+		// For type 'defined' there is also scenario and name
+		// For type 'failing' there is also scenario and errors
+		this.on('scenario:start', eventData => console.log(eventData));
+		// scenarios:end is emitted after specific scenario is finished
+		// eventData contains browser instance, scenario type
+		// For type 'defined' there is also scenario, name and results
+		// For type 'failing' there is also scenario, errors and minified (boolean)
+		// For type 'random' there is also results
+		this.on('scenario:end', eventData => console.log(eventData));
+		// runner:end is emitted after browser instance is cleared
+		this.on('runner:end', () => console.log('it\'s done'));
+		// runner:error is emitted whenever an uncaught error occurred
+		// eventData contains scenario, and browser instance and error
+		this.on('runner:error', eventData => console.log(eventData));
+	}
+}
+```

package.json

@@ -5,6 +5,7 @@
   "main": "index.js",
   "scripts": {
     "test": "jest",
+    "docs:build": "documentation build src/** -f html -o html-docs",
     "build": "rm -rf lib && babel src --out-dir lib --ignore \"src/**/*Spec.js\" --copy-files --plugins=transform-es2015-modules-commonjs",
     "dev": "npm run build -- --source-maps --watch",
     "start": "node -r source-map-support/register bin/qape.js",
@@ -20,21 +21,21 @@
     "monkey"
   ],
   "repository": {
-      "type": "git",
-      "url": "https://github.com/seznam/qape.git"
-    },
+    "type": "git",
+    "url": "https://github.com/seznam/qape.git"
+  },
   "author": "Filip Satek <[email protected]>",
   "license": "MIT",
   "dependencies": {
     "commander": "2.17.1",
     "glob-all": "3.1.0",
-    "lodash": "4.17.10",
-    "progress": "2.0.0",
+    "lodash.isequal": "4.5.0",
     "puppeteer": "1.8.0"
   },
   "devDependencies": {
     "babel-cli": "6.26.0",
     "babel-plugin-transform-es2015-modules-commonjs": "6.26.2",
+    "documentation": "8.1.2",
     "express": "4.16.3",
     "jest": "23.6.0",
     "serve-static": "1.13.2",

qape.conf.js

@@ -19,8 +19,8 @@ module.exports = {
 	// only user defined scenarios will be executed
 	randomScenariosDisabled: false,
 	// When user defined scenario recieves an error,
-	// it will no longer try to minify the steps to reproduce this error.
-	minifyUserDefinedScenariosDisabled: false,
+	// it will try to minify the steps to reproduce this error.
+	minifyUserDefinedScenarios: true,
 	// Disables chromium headless mode and will display browser GUI.
 	headlessModeDisabled: false,
 	// Preview mode will overwrite other config values
@@ -52,6 +52,11 @@ module.exports = {
 	},
 	// A browser websocket endpoint to connect to (i.e. ws://5.5.5.5:3505)
 	browserWebSocketEndpoint: null,
+	// Define your reporters for the QApe run.
+	// You can pass a string for reporters in npm registry,
+	// i.e. if you pass \'super\', QApe will look for
+	// reporter 'qape-reporter-super'. You can also pass Class.
+	reporters: ['default'],
 	// Relative path for the report output
 	reportPath: './report',
 }

src/Runner.js

@@ -1,20 +1,19 @@
 import Browser from './browser/Browser';
 import Scenarios from './scenarios/Scenarios';
-import Reporter from './reporter/Reporter';
+import Reporter from './reporter/BaseReporter';
 import ActionsHandler from './actions/ActionsHandler';
 import Config from './config/Config';
-import Progress from './progress/Progress';
 import fs from 'fs';
 import path from 'path';
 
 export default class Runner {
 	constructor(config) {
 		this._config = config;
-		this._progress = null;
 		this._scenarios = null;
 		this._actionsHandler = null;
 		this._reporter = null;
 		this._initTime = null;
+		this._isSuccess = true;
 	}
 
 	start(files = []) {
@@ -27,15 +26,11 @@ export default class Runner {
 		let instances = [];
 
 		for (let i = 0; i < this._config.parallelInstances; i++) {
-			let progressBar = this._progress.newBar(this._config.actionsPerScenario);
-
-			instances.push(this._startScenario(progressBar));
+			instances.push(this._startInstance());
 		}
 
 		return Promise.all(instances).then(() => {
-			this._progress.terminate();
-
-			if (this._reporter.isSuccess()) {
+			if (this._isSuccess) {
 				return Promise.resolve();
 			}
 
@@ -58,40 +53,39 @@ export default class Runner {
 		});
 	}
 
-	async _startScenario(progressBar) {
+	async _startInstance() {
 		while (
 			!this._config.randomScenariosDisabled &&
 			this._isAllowedToStartNewScenario() ||
 			this._scenarios.hasScenario()
 		) {
 			let scenario = this._scenarios.getScenario();
-
-			if (!scenario) {
-				console.log('No scenario recieved.');
-				return;
-			}
-
 			let instance = await this._getBrowserInstance();
-			let log;
+			let results;
 
-			progressBar.tick(0, { info: '' });
+			this._reporter.emit('runner:start', {
+				scenario,
+				instance
+			});
 
 			try {
-				log = await scenario(instance, progressBar);
-			} catch (e) {
-				progressBar.tick(0, { info: e.toString() });
+				results = await scenario(instance);
+			} catch (error) {
+				this._reporter.emit('runner:error', {
+					scenario,
+					instance,
+					error
+				});
 			}
 
-			if (log && log.errors && log.errors.length > 0) {
-				this._scenarios.addFailingScenario(log);
-			}
-
-			if (log && log.executionError) {
-				console.log(log.executionError);
-				progressBar.tick(0, { info: log.executionError });
+			if (results && results.errors && results.errors.length > 0) {
+				this._isSuccess = false;
+				this._scenarios.addFailingScenario(results);
 			}
 
 			await instance.clear();
+
+			this._reporter.emit('runner:end');
 		}
 	}
 
@@ -105,7 +99,6 @@ export default class Runner {
 
 	_init() {
 		this._initConfig();
-		this._initProgress();
 		this._initActionsHandler();
 		this._initReporter();
 		this._initScenarios();
@@ -116,16 +109,12 @@ export default class Runner {
 		this._config = new Config().load(this._config);
 	}
 
-	_initProgress() {
-		this._progress = new Progress(this._config);
-	}
-
 	_initActionsHandler() {
 		this._actionsHandler = new ActionsHandler(this._config).init();
 	}
 
 	_initReporter() {
-		this._reporter = new Reporter(this._config, this._actionsHandler);
+		this._reporter = new Reporter(this._config).init();
 	}
 
 	_initScenarios() {

src/__tests__/RunnerSpec.js

@@ -9,20 +9,17 @@ describe('Runner', () => {
 
 	it('can be initialized', () => {
 		runner._initConfig = jest.fn();
-		runner._initProgress = jest.fn();
 		runner._initActionsHandler = jest.fn();
 		runner._initReporter = jest.fn();
 		runner._initScenarios = jest.fn();
 
 		runner._init();
 
 		expect(runner._initConfig).toHaveBeenCalledTimes(1);
-		expect(runner._initProgress).toHaveBeenCalledTimes(1);
 		expect(runner._initActionsHandler).toHaveBeenCalledTimes(1);
 		expect(runner._initReporter).toHaveBeenCalledTimes(1);
 		expect(runner._initScenarios).toHaveBeenCalledTimes(1);
 		expect(runner._config).toEqual({});
-		expect(runner._progress).toEqual(null);
 		expect(runner._scenarios).toEqual(null);
 		expect(runner._actionsHandler).toEqual(null);
 		expect(runner._reporter).toEqual(null);

src/__tests__/helpersSpec.js

@@ -1,19 +1,6 @@
-import {
-	sumPartialSeries,
-	formatDigits
-} from '../helpers'
+import { formatDigits } from '../helpers'
 
 describe('Helpers', () => {
-	describe('sumPartialSeries', () => {
-		it('can sum partial series', () => {
-			expect(sumPartialSeries(1)).toEqual(1);
-			expect(sumPartialSeries(2)).toEqual(3);
-			expect(sumPartialSeries(3)).toEqual(6);
-			expect(sumPartialSeries(4)).toEqual(10);
-			expect(sumPartialSeries(5)).toEqual(15);
-		});
-	});
-
 	describe('formatDigits', () => {
 		it('can format digits', () => {
 			expect(formatDigits(1)).toEqual('01');

src/actions/AbstractAction.js

@@ -10,7 +10,11 @@ export default class AbstractAction {
 
 		this._actionConfig = {};
 
-		this._results = { action: this.constructor.id, errors: [] };
+		this._results = {
+			action: this.constructor.id,
+			errors: [],
+			message: `Action: ${this.constructor.id}; Config: ${this.actionConfig}`
+		};
 	}
 
 	async execute(instance) {
@@ -49,11 +53,6 @@ export default class AbstractAction {
 		return this._actionConfig;
 	}
 
-	log() {
-		console.log('Action:', this.constructor.id);
-		console.log('Config:', this.actionConfig);
-	}
-
 	_addErrorToResults(error) {
 		this._results.errors.push({
 			type: 'pageError',

src/actions/ClickAction.js

@@ -75,6 +75,7 @@ export default class ClickAction extends AbstractAction {
 		let selector = await this._actionsHelper.getElementSelector(element);
 
 		this._results.config = { selector };
+		this._results.message = `Click on "${selector}"`;
 	}
 
 	_closeNewTab(target) {

src/config/Config.js

@@ -33,7 +33,7 @@ export default class Config {
 		this._config = Object.assign(this._config, {
 			parallelInstances: 1,
 			randomScenariosDisabled: true,
-			minifyUserDefinedScenariosDisabled: true,
+			minifyUserDefinedScenarios: false,
 			headlessModeDisabled: true
 		});
 	}