feat: AFTER_TESTS_READ event with suite tree

Author: j0tunn

doc/events.md

@@ -1,5 +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`:
+    * `data.suiteCollection` - suite collection with all suites parsed from test files
+
 * `UPDATE_RESULT` — emitted always during update. The event is emitted with 1 argument `result`:
     * `result.imagePath` — absolute path to the reference image
     * `result.updated` — boolean value which is `true` when reference image have been changed and `false` when not

lib/constants/events.js

@@ -1,6 +1,8 @@
 'use strict';
 
 module.exports = {
+    AFTER_TESTS_READ: 'afterTestsRead',
+
     START_RUNNER: 'startRunner',
     END_RUNNER: 'endRunner',
 

lib/gemini.js

@@ -116,7 +116,9 @@ module.exports = class Gemini extends PassthroughEmitter {
                     applyGrep_(options.grep, rootSuite);
                 }
 
-                return new SuiteCollection(rootSuite.children);
+                const suiteCollection = new SuiteCollection(rootSuite.children);
+                this.emit(Events.AFTER_TESTS_READ, {suiteCollection});
+                return suiteCollection;
             });
 
         function applyGrep_(grep, suite) {

test/unit/gemini.js

@@ -230,9 +230,16 @@ describe('gemini', () => {
 
         it('should return SuiteCollection instance', () => {
             return readTests_()
-                .then((result) => {
-                    assert.instanceOf(result, SuiteCollection);
-                });
+                .then((result) => assert.instanceOf(result, SuiteCollection));
+        });
+
+        it('should emit AFTER_TESTS_READ event with created suite collection', () => {
+            const onAfterTestRead = sinon.spy();
+            gemini = initGemini();
+            gemini.on(Events.AFTER_TESTS_READ, onAfterTestRead);
+
+            return gemini.readTests()
+                .then((suiteCollection) => assert.calledOnceWith(onAfterTestRead, {suiteCollection}));
         });
 
         it('should add to suite collection all read tests excluding root', () => {
@@ -353,6 +360,15 @@ describe('gemini', () => {
                     );
                 });
         });
+
+        it('should emit AFTER_TESTS_READ event with suite collection', () => {
+            const onAfterTestRead = sinon.spy();
+            gemini = initGemini();
+            gemini.on(Events.AFTER_TESTS_READ, onAfterTestRead);
+
+            return gemini.test()
+                .then(() => assert.calledOnceWith(onAfterTestRead, {suiteCollection: sinon.match.instanceOf(SuiteCollection)}));
+        });
     });
 
     describe('environment variables', () => {