Perceptual diffing suite
built on Nightmare by Segment

Getting Started

You can look at test/index.js as an example for how to use Niffy. To run the example test just run make test after cloning this repo.

Reference

Niffy is built on Nightmare and used in combination with Mocha (though other test frameworks can be used). You'll also need to read and use both of those library's APIs to use niffy effectively.

Niffy(basehost, testhost[, options])

To create a new Niffy differ:

let niffy = new Niffy(basehost, testhost, options, testsFunction);

• basehost is the url that is assumed "good"
• testhost is the url that you are comparing to the base
• options aside from the few specific niffy options, all nightmare options can be used. They can be seen here in the Nightmare docs
  • pngPath is the folder the screenshots will be saved.
  • threshold is the maximum percentage difference for a passing test
  • targets a list of resolutions to test
• testsFunction

Niffy supplies these defaults:

{
  pngPath : ./niffy,
  threshold : 0.2,
  targets : {
    default : [ 1400, 1000 ]
  }
}

Usage

Whatever tests you want to run at each resolution must be wrapped in a function and passed as the testsFunction parameter of the Niffy constructor.

Mocha example:

new Niffy(
  'https://google.com',
  'https://google.co.jp',
  {
    targets: {
      small: [100,200],
      big: [1000,2000]
    }
  }, ( niffy, size ) => {

  const { label, width, height } = size;

  describe(`${label} : ${width} x ${height}`, () => {
    it('Homepage', function* () {
      yield niffy.test('/');
    })

    after(function* () {
      yield niffy.end();
    });
  }
);

(see test/index.js for a full example)

.test(url[, fn])

This method instructs niffy to go to a url (and optionally take additional actions like clicking, typing or checkboxing via the fn argument), and test basehost vs. testhost screenshots for pixel differences, and output the diff-highlight image. Typically you'll use .test(url, fn) in the body of a mocha test, like this:

it('/news', function* () {
  yield niffy.test('/news');
});

.goto(url[, fn])

This method instructs niffy to go to a url and optionally take additional actions like clicking, typing or checkboxing via the fn argument. Typically you'll use .goto(url, fn) in the before method of a mocha test suite, like this:

before(function* () {
  yield niffy.goto('/logout', function* (nightmare) {
    yield nightmare
      .type('input[name="email"]', 'fake@faketestfaketest.com')
      .type('input[name="password"]', 'fakepassword')
      .click('button[type="submit"]');
  });
});

.end()

This method closes the underlying Nightmare instance (e.g. freeing up memory). Typically you'll use .end() in the after method of a mocha test suite, like this:

after(function* () {
  yield niffy.end();
});

Contributing

Development of Niffy requires node 7 or higher.

Niffy's branch structure goes as follows:

• master - latest stable git repo.

• dev - current development branch. This is where feature branches should branch from.

• issue branches - these branches come from dev and are branched for a specific feature or bug, then get merged back into dev. The branch names should follow the structure GH-(issue number)-(name)

---

We gladly accept and review any pull-requests into the current dev branch. Feel free! ❤️

Otherwise, if you just want to talk, we are very easy to get a hold of!

• Email: mouse@knoblau.ch
• Git: https://github.com/mousemke/niffy/

This project adheres to the Contributor Covenant. By participating, you are expected to honor this code.

Niffy - Code of Conduct

License (MIT)

WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|

Copyright (c) 2017 Segment.io, Inc. friends@segment.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.