viff
v2.0.0
Published
Find virtual differences between web pages in different environments(developing, staging, production) and browsers.
Downloads
54
Readme
Viff
Find visual differences between web pages in different environments (developing, staging, production) and browsers.
Video Quick Introduction
Installation
Viff runs on selenium sever. Don't worry, you can easily set up selenium server using wdm
.
$ npm install wdm -g
$ wdm update --standalone // install selenium and webdrivers
Then install viff
command line.
npm install -g viff
Examples
Checkout viff-examples
repository for more examples, including:
- Tiny CSS difference
- Chart difference
- Content difference
- Partial difference
- Event Handling
- Responsive
- Multiple browsers
- Multiple Environments
- Browserstack
- Programmable
- Using Viff Server (beta)
Quick example
Start server
$ wdm start // open selenium webdriver server
You could run it using a xx.config.js
file.
// build_prod.config.js
'use strict'
module.exports = {
seleniumHost: 'http://localhost:4444/wd/hub',
browsers: ['firefox'/*, 'chrome', 'safari', 'opera'*/],
envHosts: {
build: 'http://localhost:4000',
prod: 'http://www.ishouldbeageek.me'
},
paths: [
'/404.html',
'/',
'/page2',
'/page3',
'/page4',
'/page5',
'/strict-mode',
['/', function clickLink(browser) {
// need to return a promise
return browser.elementByPartialLinkText('viff').click();
}],
['/', '#main-content'/*, function (browser) { } */],
{ 'this is a testcase description' : ['/', '#main-content', function(browser) {
return browser.maximize();
}]}
],
maxInstance: 3
};
Then, you could run
viff ./build_prod.config.js
Programmable
Use viff
in your own project.
var Viff = require('viff');
var viff = new Viff('http://localhost:4444/wd/hub');
viff.takeScreenshot('firefox', 'http://localhost:3000', '/path1', function (bufferImg) {
/* buffer of images */
});
// partial of web pages
viff.takeScreenshot('firefox', 'http://localhost:3000', ['path1', '#css-selecor'], function (bufferPartialImg) {});
// responsive of web pages
function size(width) {
return function (driver) {
driver.setWindowSize(width, 600 /* any height*/);
};
}
viff.takeScreenshot('firefox', 'http://localhost:3000', ['path', size(1024)], function (bufferImg) {});
// Q promise
viff.takeScreenshot('firefox', 'http://localhost:3000', ['path', size(1024)])
.done(function (bufferImg) {
/* generate image here */
})
.catch(function (err) {
/* handle err here */
})
// using browserstack
viff = new Viff('http://hub.browserstack.com/wd/hub');
viff.takeScreenshot({
'browserName' : 'iPhone',
'platform' : 'MAC',
'device' : 'iPhone 5',
'browserstack.user': /* your name */,
'browserstack.key': /* your key */
}, 'http://www.google.com', 'path1', function (bufferImg) {});
file report embeded in viff reporter
repo for viff reporter is ViffReport
Using Viff Server (beta)
You could try viffserver
and viff-client
to do the viff testing with your functional testing.
Run the viff server first.
$ viffserver
And integrated viffclient.post
method in your functional testing code. Check more in Viff Examples or Viff Client.
History
2015-01-12 [email protected] use node-canvas
back for better performance. Ah~~~
2014-08-07 [email protected] no need to install coffee-script
before hand.
2014-06-08 [email protected] could use multi viff instances to improve testing performance (maxInstance
property).
2014-05-18 [email protected] finally replace canvas
by phantomjs
, so easy installation starts from now, even in Windows System.
2014-03-15 [email protected] could setup viff server and wait for screenshots from the place out of viff. Check out the viff client
example.
2014-03-11 [email protected] use wd
to replace selenium-webdriver
, so that you could use beautiful Q Promised API in your code.
2014-02-26 [email protected] simplify console output DEMO.
2014-02-17 [email protected] make viff programmable.
2013-12-25 [email protected] refactor testcases and compare differences cross browsers !!! Merry Christmas !!!
2013-11-13 [email protected] optimise memory usage and only support file
report format
2013-10-30 [email protected] add testcase running status in console.
2013-10-27 [email protected] won't stop testing if one of them fail.
2013-09-22 [email protected] could write testcase description.
2013-08-08 [email protected] add partial screenshot support. working perfectly in firefox, phantomjs.
2013-08-01 [email protected] add new report format file
, which will generate images.
2013-07-24 [email protected] use resemble.js to replace imagemagick
2013-07-16 [email protected] support resizing images before finding diff
License
Copyright (c) 2013 - 2016 Wang Qiu ([email protected])
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.