feat: emit async INIT event instead of async plugins load

j0tunn · j0tunn · commit b21aa5847522 · 2017-11-29T19:07:16.000+03:00
diff --git a/doc/events.md b/doc/events.md
@@ -1,6 +1,8 @@
 # Gemini events
 
-* `AFTER_TESTS_READ` - emitted after all tests were read (during `run`, `update` or `readTests` call). The event is emitted with 1 argument `data`:
+* `INIT` - emitted before any job start (`test`, `update` or `readTests`). If handler returns a promise then job will start only after the promise will be resolved. Emitted only once no matter how many times job will be performed.
+
+* `AFTER_TESTS_READ` - emitted after all tests were read (during `test`, `update` or `readTests` call). The event is emitted with 1 argument `data`:
     * `data.suiteCollection` - suite collection with all suites parsed from test files
 
 * `UPDATE_RESULT` &mdash; emitted always during update. The event is emitted with 1 argument `result`:
diff --git a/lib/constants/events.js b/lib/constants/events.js
@@ -1,6 +1,8 @@
 'use strict';
 
 module.exports = {
+    INIT: 'init',
+
     AFTER_TESTS_READ: 'afterTestsRead',
 
     START_RUNNER: 'startRunner',
diff --git a/lib/gemini.js b/lib/gemini.js
@@ -46,6 +46,7 @@ module.exports = class Gemini extends PassthroughEmitter {
         this.SuiteCollection = SuiteCollection;
 
         setupLog(this.config.system.debug);
+        this._loadPlugins();
     }
 
     getScreenshotPath(suite, stateName, browserId) {
@@ -89,12 +90,16 @@ module.exports = class Gemini extends PassthroughEmitter {
     }
 
     _exec(fn) {
-        return this._loadPlugins().then(() => fn());
+        return this._init().then(() => fn());
+    }
+
+    _init() {
+        this._init = () => Promise.resolve(); // init only once
+        return this.emitAndWait(Events.INIT);
     }
 
     _loadPlugins() {
-        this._loadPlugins = () => Promise.resolve(); // load plugins only once
-        return Promise.all(pluginsLoader.load(this, this.config.system.plugins, PREFIX));
+        pluginsLoader.load(this, this.config.system.plugins, PREFIX);
     }
 
     _readTests(paths, options) {
diff --git a/test/unit/gemini.js b/test/unit/gemini.js
@@ -67,7 +67,7 @@ describe('gemini', () => {
     beforeEach(() => {
         sandbox.stub(Runner.prototype, 'cancel').returns(Promise.resolve());
         sandbox.stub(console, 'warn');
-        sandbox.stub(pluginsLoader, 'load').returns([]);
+        sandbox.stub(pluginsLoader, 'load');
         sandbox.stub(temp, 'init');
     });
 
@@ -126,63 +126,36 @@ describe('gemini', () => {
     });
 
     describe('load plugins', () => {
-        it('should load plugins', () => {
-            return runGeminiTest()
-                .then(() => assert.calledOnce(pluginsLoader.load));
-        });
+        it('should load plugins on construction', () => {
+            initGemini();
 
-        it('should load plugins before reading tests', () => {
-            return runGeminiTest()
-                .then(() => assert.callOrder(pluginsLoader.load, testReaderStub));
+            assert.calledOnce(pluginsLoader.load);
         });
 
         it('should load plugins for gemini instance', () => {
             const gemini = initGemini();
 
-            return gemini.test()
-                .then(() => assert.calledWith(pluginsLoader.load, gemini));
-        });
-
-        it('should load plugins from config', () => {
-            return runGeminiTest({plugins: {'some-plugin': true}})
-                .then(() => assert.calledWith(pluginsLoader.load, sinon.match.any, {'some-plugin': true}));
+            assert.calledWith(pluginsLoader.load, gemini);
         });
 
-        it('should load plugins with appropriate prefix', () => {
-            const prefix = require('../../package').name + '-';
+        it('should fail on plugin load error', () => {
+            pluginsLoader.load.throws(new Error('o.O'));
 
-            return runGeminiTest()
-                .then(() => assert.calledWith(pluginsLoader.load, sinon.match.any, sinon.match.any, prefix));
+            assert.throws(() => initGemini(), /o.O/);
         });
 
-        it('should wait until plugins loaded', () => {
-            const afterPluginLoad = sinon.spy();
-            pluginsLoader.load.callsFake(() => {
-                return [Promise.delay(20).then(afterPluginLoad)];
-            });
-            sandbox.stub(Runner.prototype, 'run').returns(Promise.resolve());
+        it('should load plugins from config', () => {
+            initGemini({plugins: {'some-plugin': true}});
 
-            return runGeminiTest()
-                .then(() => assert.callOrder(afterPluginLoad, Runner.prototype.run));
+            assert.calledWith(pluginsLoader.load, sinon.match.any, {'some-plugin': true});
         });
 
-        it('should not run tests if plugin failed on load', () => {
-            const err = new Error('o.O');
-            pluginsLoader.load.callsFake(() => [Promise.reject(err)]);
-            sandbox.stub(Runner.prototype, 'run').returns(Promise.resolve());
+        it('should load plugins with appropriate prefix', () => {
+            const prefix = require('../../package').name + '-';
 
-            const result = runGeminiTest();
+            initGemini();
 
-            return assert.isRejected(result, err)
-                .then(() => assert.notCalled(Runner.prototype.run));
-        });
-
-        it('should load plugins only once', () => {
-            const gemini = initGemini();
-
-            return gemini.readTests()
-                .then((collection) => gemini.test(collection))
-                .then(() => assert.calledOnce(pluginsLoader.load));
+            assert.calledWith(pluginsLoader.load, sinon.match.any, sinon.match.any, prefix);
         });
     });
 
@@ -199,6 +172,46 @@ describe('gemini', () => {
             Config.prototype.getBrowserIds.returns([]);
         });
 
+        describe('INIT', () => {
+            it('should emit INIT event on reading', () => {
+                const onInit = sinon.spy();
+
+                gemini = initGemini()
+                    .on(Events.INIT, onInit);
+
+                return gemini.readTests()
+                    .then(() => assert.calledOnce(onInit));
+            });
+
+            it('should wait INIT handler before reading any test', () => {
+                const afterInit = sinon.spy();
+
+                gemini = initGemini()
+                    .on(Events.INIT, () => Promise.delay(10).then(afterInit));
+
+                return gemini.readTests()
+                    .then(() => assert.callOrder(afterInit, testReaderStub));
+            });
+
+            it('should fail on INIT handler reject', () => {
+                gemini = initGemini()
+                    .on(Events.INIT, () => Promise.reject('o.O'));
+
+                return assert.isRejected(gemini.readTests(), /o.O/);
+            });
+
+            it('should emit INIT only once', () => {
+                const onInit = sinon.spy();
+
+                gemini = initGemini()
+                    .on(Events.INIT, onInit);
+
+                return gemini.readTests()
+                    .then(() => gemini.readTests())
+                    .then(() => assert.calledOnce(onInit));
+            });
+        });
+
         it('should pass sets from cli to test-reader', () => {
             const opts = {
                 cliOpts: {sets: ['set1']}
@@ -363,6 +376,46 @@ describe('gemini', () => {
             return gemini.test()
                 .then(() => assert.calledOnceWith(onAfterTestRead, {suiteCollection: sinon.match.instanceOf(SuiteCollection)}));
         });
+
+        describe('INIT', () => {
+            it('should emit INIT event on run', () => {
+                const onInit = sinon.spy();
+
+                gemini = initGemini()
+                    .on(Events.INIT, onInit);
+
+                return gemini.test()
+                    .then(() => assert.calledOnce(onInit));
+            });
+
+            it('should wait INIT handler before run', () => {
+                const afterInit = sinon.spy();
+
+                gemini = initGemini()
+                    .on(Events.INIT, () => Promise.delay(10).then(afterInit));
+
+                return gemini.test()
+                    .then(() => assert.callOrder(afterInit, Runner.prototype.run));
+            });
+
+            it('should fail on INIT handler reject', () => {
+                gemini = initGemini()
+                    .on(Events.INIT, () => Promise.reject('o.O'));
+
+                return assert.isRejected(gemini.test(), /o.O/);
+            });
+
+            it('should emit INIT only once', () => {
+                const onInit = sinon.spy();
+
+                gemini = initGemini()
+                    .on(Events.INIT, onInit);
+
+                return gemini.test()
+                    .then(() => gemini.test())
+                    .then(() => assert.calledOnce(onInit));
+            });
+        });
     });
 
     describe('environment variables', () => {

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ module.exports = class Gemini extends PassthroughEmitter {`
`46`	`46`	`this.SuiteCollection = SuiteCollection;`
`47`	`47`
`48`	`48`	`setupLog(this.config.system.debug);`
	`49`	`+ this._loadPlugins();`
`49`	`50`	`}`
`50`	`51`
`51`	`52`	`getScreenshotPath(suite, stateName, browserId) {`
`@@ -89,12 +90,16 @@ module.exports = class Gemini extends PassthroughEmitter {`
`89`	`90`	`}`
`90`	`91`
`91`	`92`	`_exec(fn) {`
`92`		`- return this._loadPlugins().then(() => fn());`
	`93`	`+ return this._init().then(() => fn());`
	`94`	`+ }`
	`95`	`+`
	`96`	`+ _init() {`
	`97`	`+ this._init = () => Promise.resolve(); // init only once`
	`98`	`+ return this.emitAndWait(Events.INIT);`
`93`	`99`	`}`
`94`	`100`
`95`	`101`	`_loadPlugins() {`
`96`		`- this._loadPlugins = () => Promise.resolve(); // load plugins only once`
`97`		`- return Promise.all(pluginsLoader.load(this, this.config.system.plugins, PREFIX));`
	`102`	`+ pluginsLoader.load(this, this.config.system.plugins, PREFIX);`
`98`	`103`	`}`
`99`	`104`
`100`	`105`	`_readTests(paths, options) {`