Merge pull request #72 from gemini-testing/feature/only-implementation

only implementation + silent skip

Author: DudaGod

README.md

@@ -19,6 +19,7 @@ Hermione is the utility for integration testing of web pages using [WebdriverIO]
   - [Auto initialization and closing grid sessions](#auto-initialization-and-closing-grid-sessions)
 - [Prerequisites](#prerequisites)
 - [Skip](#skip)
+- [Only](#only)
 - [WebdriverIO extensions](#webdriverio-extensions)
   - [Sharable meta info](#sharable-meta-info)
   - [Execution context](#execution-context)
@@ -82,29 +83,45 @@ hermione --grep login
 or simply use `mocha` `only()` API in the test
 
 ```
-describe.only('user login', () => {...});
+describe.only('user login', function() {...});
 ```
 
 ### Skip tests in specific browsers
 Sometimes you need to skip test not in all browsers but in a specific one. For example, you don't need to run
 some test in ~~ugly~~ IE browsers. In `hermione` you can do it with [hermione helper](#skip). For example,
 you can skip some tests in the specific browser
 ```js
-describe('feature', () => {
+describe('feature', function() {
     hermione.skip.in('ie8', 'it can not work in this browser');
-    it('nowaday functionality', () => {...});
+    it('nowaday functionality', function() {...});
 });
 ```
 
 or run tests in one of the browsers
 ```js
-describe('feature', () => {
+describe('feature', function() {
     // will be skipped in all browsers except chrome
     hermione.skip.notIn('chrome', 'it should work only in Chrome');
-    it('specific functionality', () => {...});
+    it('specific functionality', function() {...});
 });
 ```
 
+In these cases you will see messages with a skip reason in reports.
+
+To skip suite or test silently (without any messages in reports), you can pass the third argument with silent flag:
+```js
+hermione.skip.in('ie8', 'skipReason', {silent: true});
+// or
+hermione.skip.notIn('chrome', 'skipReason', {silent: true});
+```
+
+Or you can use another hermione helper - [only](#only), which is silent by default:
+```js
+hermione.only.in('chrome');
+```
+
+It will run tests only in one browser and skip rest silently.
+
 ### Flexible tests configuration
 `Hermione` has possibility to configure running some set of tests in specific browsers. For example,
 ```js
@@ -138,32 +155,39 @@ selenium-standalone start
 This feature allows you to ignore the specified suite or test in any browser with additional comment.
 You can do it by using global `hermione.skip` helper. It supports the following methods:
 
- - `.in` — adds matchers for browsers with additional comment
+ - `.in` — adds matchers for browsers with additional comment;
  - `.notIn` — `.in` method with reverted value;
 
-Each method takes following arguments:
- - browser {String|RegExp|Array<String|RegExp>} — matcher for browser(s) to skip
+Each of these methods takes following arguments:
+ - browser {String|RegExp|Array<String|RegExp>} — matcher for browser(s) to skip;
  - [comment] {String} — comment for skipped test;
+ - [options] {Object} - additional options;
 
 **Note that matchers will be compared with `browserId` specified in a config file, e.g. `chrome-desktop`.**
 
 For example,
 ```js
-describe('feature', () => {
+describe('feature', function() {
     hermione.skip.in('chrome', "It shouldn't work this way in Chrome");
-    it('should work this way', () => runTestThisWay());
+    it('should work this way', function() {
+        return runTestThisWay();
+    });
 
-    it('should work that way', () => runTestThatWay());
+    it('should work that way', function() {
+        return runTestThatWay();
+    });
 
     hermione.skip.in(['chrome', 'firefox', /ie\d*/], 'Unstable test, see ticket TEST-487');
-    it('should done some tricky things', () => runTrickyTest());
+    it('should done some tricky things', function() {
+        return runTrickyTest();
+    });
 });
 ```
 
 in this case behaviour `it should work this way` will be skipped only in `chrome` browser, but will be run in other browsers. `It should work that way` will not be ignored. So skip will be applied only to the nearest test. If you need to skip all tests within a suite you can apply `skip` helper to a `describe` - all tests within this suite will be skipped with the same comment.
 ```js
 hermione.skip.in('chrome', 'skip comment');
-describe('some feature', () => {
+describe('some feature', function() {
     it(...);
     it(...);
 });
@@ -173,24 +197,49 @@ Also you can use `.notIn` method to invert matching. For example,
 ```js
 // ...
 hermione.skip.notIn('chrome', 'some comment');
-it('should work this way', () => doSomething());
+it('should work this way', function() {
+    return doSomething();
+});
 // ...
 ```
 
 in this case test will be skipped in all browsers except `chrome`.
 
-Methods `in` and `notIn` are chainable. So you can skip test in several browsers with different comments. For example,
+All of these methods are chainable. So you can skip test in several browsers with different comments. For example,
 ```js
 // ...
 hermione.skip
     .in('chrome', 'some comment')
     .notIn('ie9', 'another comment');
-it('test1', () => doSomething());
+it('test1', function() {
+    return doSomething();
+});
 // ...
 ```
 
 If you need to skip test in all browsers without a comment you can use [mocha `.skip` method](http://mochajs.org/#inclusive-tests) instead of `hermione.skip.in(/.*/);`. The result will be the same.
 
+## Only
+This feature allows you to ignore the specified suite or test in any browser silently (without any messages in reports).
+You can do it by using global `hermione.only` helper. It supports only one method:
+
+- `.in` — `hermione.skip.notIn` method with silent flag
+
+This method takes following arguments:
+ - browser {String|RegExp|Array<String|RegExp>} — matcher for browser(s) to skip;
+
+For example:
+```js
+// ...
+hermione.only.in('chrome');
+it('should work this way', function() {
+    return doSomething();
+});
+// ...
+```
+
+in this case test will be skipped in all browsers **silently** except `chrome`.
+
 ## WebdriverIO extensions
 `Hermione` adds some usefull methods and properties to the `webdriverio` session after its initialization.
 

lib/runner/mocha-runner/mocha-adapter.js

@@ -4,6 +4,7 @@ const ProxyReporter = require('./proxy-reporter');
 const logger = require('../../utils').logger;
 const Skip = require('./skip/');
 const SkipBuilder = require('./skip/skip-builder');
+const OnlyBuilder = require('./skip/only-builder');
 const Mocha = require('mocha');
 const path = require('path');
 const clearRequire = require('clear-require');
@@ -94,10 +95,15 @@ module.exports = class MochaAdapter {
         const skip = new Skip();
 
         this.suite.on('pre-require', () => {
+            const skipBuilder = new SkipBuilder(skip, this._browserAgent.browserId);
+            const onlyBuilder = new OnlyBuilder(skipBuilder);
+
             global.hermione = {
-                skip: new SkipBuilder(skip, this._browserAgent.browserId)
+                skip: skipBuilder,
+                only: onlyBuilder
             };
         });
+
         this.suite.on('post-require', () => delete global.hermione);
 
         this._addEventHandler(['suite', 'test'], (runnable) => skip.handleEntity(runnable));

lib/runner/mocha-runner/skip/index.js

@@ -5,19 +5,33 @@ const _ = require('lodash');
 module.exports = class Skip {
     constructor() {
         this.shouldSkip = false;
+        this.silent = false;
     }
 
     handleEntity(entity) {
         if (!this.shouldSkip) {
             return;
         }
 
+        if (this.silent) {
+            this._rmFromTree(entity);
+            return;
+        }
+
         _.extend(entity, {pending: true, skipReason: this.comment});
+
         this._resetInfo();
     }
 
+    _rmFromTree(entity) {
+        entity.type === 'test'
+            ? entity.parent.tests.pop()
+            : entity.parent.suites.pop();
+    }
+
     _resetInfo() {
         this.shouldSkip = false;
+        this.silent = false;
         this.comment = '';
     }
 };

lib/runner/mocha-runner/skip/only-builder.js

@@ -0,0 +1,11 @@
+'use strict';
+
+module.exports = class OnlyBuilder {
+    constructor(skipBuilder) {
+        this._skipBuilder = skipBuilder;
+    }
+
+    in(matcher) {
+        return this._skipBuilder.notIn(matcher, '', {silent: true});
+    }
+};

lib/runner/mocha-runner/skip/skip-builder.js

@@ -17,20 +17,28 @@ module.exports = class SkipBuilder {
         this._currentBrowserId = browserId;
     }
 
-    in(matcher, comment) {
-        return this._processSkip(matcher, comment);
+    in(matcher, comment, opts) {
+        return this._processSkip(matcher, comment, opts);
     }
 
-    notIn(matcher, comment) {
-        return this._processSkip(matcher, comment, {negate: true});
+    notIn(matcher, comment, opts) {
+        opts = _.extend(opts || {}, {negate: true});
+        return this._processSkip(matcher, comment, opts);
     }
 
     _processSkip(matcher, comment, opts) {
-        const skipFunc = (opts || {}).negate ? _.negate(shouldBeSkipped) : shouldBeSkipped;
+        opts = _.defaults(opts || {}, {
+            negate: false,
+            silent: false
+        });
+
+        const skipFunc = opts.negate ? _.negate(shouldBeSkipped) : shouldBeSkipped;
         const shouldSkip = skipFunc(this._currentBrowserId, matcher);
         this._skip.shouldSkip = shouldSkip || this._skip.shouldSkip;
+
         if (shouldSkip) {
             this._skip.comment = comment;
+            this._skip.silent = opts.silent === true;
         }
 
         return this;

lib/runner/test-skipper.js

@@ -21,7 +21,7 @@ module.exports = class TestSkipper {
     constructor(config) {
         this._skipBrowsers = TestSkipper._getBrowsersToSkip();
 
-        TestSkipper._validateUnknownBrowsers(this._skipBrowsers, this._getBtowsersFromConfig(config));
+        TestSkipper._validateUnknownBrowsers(this._skipBrowsers, this._getBrowsersFromConfig(config));
     }
 
     applySkip(suite, browserId) {
@@ -35,7 +35,7 @@ module.exports = class TestSkipper {
         return _.contains(this._skipBrowsers, browserId);
     }
 
-    _getBtowsersFromConfig(config) {
+    _getBrowsersFromConfig(config) {
         return _.keys(config.browsers);
     }
 };

test/lib/reporter/flat.js

@@ -144,60 +144,61 @@ describe('Flat reporter', () => {
             assert.equal(result, 'suite test [chrome:test_session] - 100500ms');
         });
 
-        it('should add skip comment if test was skipped', () => {
-            test = mkTestStub_({
-                pending: true,
-                skipReason: 'some comment'
-            });
-
-            emit(RunnerEvents.TEST_PENDING, test);
+        describe('skipped tests report', () => {
+            it('should add skip comment if test was skipped', () => {
+                test = mkTestStub_({
+                    pending: true,
+                    skipReason: 'some comment'
+                });
 
-            const result = getDeserealizedResult(logger.log.firstCall.args[0]);
+                emit(RunnerEvents.TEST_PENDING, test);
 
-            assert.equal(result, 'suite test [chrome] - 100500ms reason: some comment');
-        });
+                const result = getDeserealizedResult(logger.log.firstCall.args[0]);
 
-        it('should use parent skip comment if all describe was skipped', () => {
-            test = mkTestStub_({
-                pending: true,
-                skipReason: 'test comment',
-                parent: {
-                    skipReason: 'suite comment'
-                }
+                assert.match(result, /reason: some comment/);
             });
 
-            emit(RunnerEvents.TEST_PENDING, test);
+            it('should use parent skip comment if all describe was skipped', () => {
+                test = mkTestStub_({
+                    pending: true,
+                    skipReason: 'test comment',
+                    parent: {
+                        skipReason: 'suite comment'
+                    }
+                });
 
-            const result = getDeserealizedResult(logger.log.firstCall.args[0]);
+                emit(RunnerEvents.TEST_PENDING, test);
 
-            assert.match(result, /reason: suite comment/);
-        });
+                const result = getDeserealizedResult(logger.log.firstCall.args[0]);
 
-        it('should use test skip comment if describe was skipped without comment', () => {
-            test = mkTestStub_({
-                pending: true,
-                skipReason: 'test comment',
-                parent: {some: 'data'}
+                assert.match(result, /reason: suite comment/);
             });
 
-            emit(RunnerEvents.TEST_PENDING, test);
+            it('should use test skip comment if describe was skipped without comment', () => {
+                test = mkTestStub_({
+                    pending: true,
+                    skipReason: 'test comment',
+                    parent: {some: 'data'}
+                });
 
-            const result = getDeserealizedResult(logger.log.firstCall.args[0]);
+                emit(RunnerEvents.TEST_PENDING, test);
 
-            assert.equal(result, 'suite test [chrome] - 100500ms reason: test comment');
-            assert.match(result, /reason: test comment/);
-        });
+                const result = getDeserealizedResult(logger.log.firstCall.args[0]);
 
-        it('should use default message if test was skipped without comment', () => {
-            test = mkTestStub_({
-                pending: true
+                assert.match(result, /reason: test comment/);
             });
 
-            emit(RunnerEvents.TEST_PENDING, test);
+            it('should use default message if test was skipped without comment', () => {
+                test = mkTestStub_({
+                    pending: true
+                });
 
-            const result = getDeserealizedResult(logger.log.firstCall.args[0]);
+                emit(RunnerEvents.TEST_PENDING, test);
 
-            assert.match(result, /reason: no comment/);
+                const result = getDeserealizedResult(logger.log.firstCall.args[0]);
+
+                assert.match(result, /reason: no comment/);
+            });
         });
 
         describe('failed tests report', () => {