wraith 3.0.4 → 3.1.0

data/spec/gallery_spec.rb

@@ -34,5 +34,4 @@ describe Wraith do
       expect(dirs['home'][0][:diff][:thumb]).to eq 'thumbnails/home/test_image-diff.png'
     end
   end
-
-end
+end

data/spec/js/custom_snap_file.js

@@ -39,25 +39,35 @@ casper.start();
 casper.open(url);
 casper.viewport(dimensions.viewportWidth, dimensions.viewportHeight);
 casper.then(function() {
-  if (globalBeforeCaptureJS) {
-    require('./' + globalBeforeCaptureJS)(this);
+  var self = this;
+  if (globalBeforeCaptureJS && pathBeforeCaptureJS) {
+    require(globalBeforeCaptureJS)(self, function thenExecuteOtherBeforeCaptureFile() {
+      require(pathBeforeCaptureJS)(self, captureImage);
+    });
   }
-});
-casper.then(function() {
-  if (pathBeforeCaptureJS) {
-    require('./' + pathBeforeCaptureJS)(this);
+  else if (globalBeforeCaptureJS) {
+    require(globalBeforeCaptureJS)(self, captureImage);
+  }
+  else if (pathBeforeCaptureJS) {
+    require(pathBeforeCaptureJS)(self, captureImage);
+  }
+  else {
+    captureImage();
   }
 });
-// waits for all images to download before taking screenshots
-// (broken images are a big cause of Wraith failures!)
-// Credit: http://reff.it/8m3HYP
-casper.waitFor(function() {
-  return this.evaluate(function() {
-    var images = document.getElementsByTagName('img');
-    return Array.prototype.every.call(images, function(i) { return i.complete; });
+
+function captureImage() {
+  // waits for all images to download before taking screenshots
+  // (broken images are a big cause of Wraith failures!)
+  // Credit: http://reff.it/8m3HYP
+  casper.waitFor(function() {
+    return this.evaluate(function() {
+      var images = document.getElementsByTagName('img');
+      return Array.prototype.every.call(images, function(i) { return i.complete; });
+    });
+  }, function then () {
+    snap.bind(this)();
   });
-}, function then () {
-  snap.bind(this)();
-});
+}
 
 casper.run();

data/spec/js/global.js

@@ -1,6 +1,7 @@
-module.exports = function (browserEngine) {
+module.exports = function (browserEngine, ready) {
     browserEngine.evaluate(function () {
         document.body.innerHTML = ' ';
         document.body.style['background-color'] = 'red';
     });
+    ready();
 }

data/spec/js/path.js

@@ -1,6 +1,7 @@
-module.exports = function (browserEngine) {
+module.exports = function (browserEngine, ready) {
     browserEngine.evaluate(function () {
         document.body.innerHTML = ' ';
         document.body.style['background-color'] = 'green';
     });
+    ready();
 }

data/spec/resize_reload_spec.rb

@@ -1,12 +1,10 @@
 require "_helpers"
 
 describe "wraith config" do
-
   let(:config_name) { get_path_relative_to __FILE__, "./configs/test_config--phantom.yaml" }
   let(:saving) { Wraith::SaveImages.new(config_name) }
 
   describe "saving images" do
-
     it "should pass the width plainly to the CLI when running in inefficient mode" do
       prepared_width = saving.prepare_widths_for_cli 432
       expect(prepared_width).to eq 432
@@ -14,7 +12,7 @@ describe "wraith config" do
 
     it "should pass an array of widths to CLI when running in efficient mode" do
       prepared_width = saving.prepare_widths_for_cli [432, 21, 100]
-      expect(prepared_width).to eq "'432','21','100'"
+      expect(prepared_width).to eq "432,21,100"
     end
 
     it "should create fewer jobs when in efficient mode" do
@@ -43,13 +41,11 @@ describe "wraith config" do
       expect(efficient_jobs.length).to be 1
       expect(inefficient_jobs.length).to be 3 # 1 for each screen width
 
-      # [["test", "/mypage", "'320','464','624'", "http://www.bbc.com/mypage", "/test/MULTI__test.png", " ", "false", "false"]]
-      expect(efficient_jobs[0][2]).to eq "'320','464','624'"
+      # [["test", "/mypage", "320,464,624", "http://www.bbc.com/mypage", "/test/MULTI__test.png", " ", "false", "false"]]
+      expect(efficient_jobs[0][2]).to eq "320,464,624"
 
       # [["test", "/mypage", 320, "http://www.bbc.com/mypage", "/test/320__test.png", " ", "false", "false"], ["test", "/mypage", 464, "http://www.bbc.com/mypage", "/test/464__test.png", " ", "false", "false"], ["test", "/mypage", 624, "http://www.bbc.com/mypage", "/test/624__test.png", " ", "false", "false"]]
       expect(inefficient_jobs[0][2]).to eq 320
     end
-
   end
-
-end
+end

data/spec/save_images_spec.rb

@@ -22,7 +22,8 @@ describe Wraith do
     let(:image_size) { ImageSize.path(test_image1).size }
 
     it "saves image" do
-      saving.capture_page_image(wraith.engine, test_url1, 320, test_image1, selector, 'false', 'false')
+      capture_image = saving.construct_command(320, test_url1, test_image1, selector, false, false)
+      `#{capture_image}`
       expect(image_size[0]).to eq 320
     end
   end
@@ -51,4 +52,4 @@ describe Wraith do
       expect(File).to exist("shots/thumbnails/test/test_diff.png")
     end
   end
-end
+end

data/spec/validate_spec.rb

@@ -0,0 +1,76 @@
+require "_helpers"
+
+describe "Wraith config validator" do
+  let(:config) do
+    YAML.load('
+      domains:
+        test: http://www.bbc.com
+
+      browser: "casperjs"
+    ')
+  end
+
+  describe "universal, basic validation for all modes" do
+    it "should validate a basic config" do
+      validate = Wraith::Validate.new(config, true).validate
+    end
+
+    it "should complain if the `domains` property is missing" do
+      config['domains'] = nil
+      expect { Wraith::Validate.new(config, true).validate }.to raise_error MissingRequiredPropertyError
+    end
+
+    it "should complain if the `browser` property is missing" do
+      config['browser'] = nil
+      expect { Wraith::Validate.new(config, true).validate }.to raise_error MissingRequiredPropertyError
+    end
+  end
+
+  describe "validation specific to capture mode" do
+    it "should complain if fewer than two domains are specified" do
+      expect { Wraith::Validate.new(config, true).validate('capture') }.to raise_error InvalidDomainsError
+    end
+
+    it "should complain if more than two domains are specified" do
+      config['domains'] = YAML.load('
+        test:  http://something.bbc.com
+        stage: http://something-else.bbc.com
+        live:  http://www.bbc.com
+      ')
+      expect { Wraith::Validate.new(config, true).validate('capture') }.to raise_error InvalidDomainsError
+    end
+
+    it "should be happy if exactly two domains are specified" do
+      config['domains'] = YAML.load('
+          test:  http://something.bbc.com
+          live:  http://www.bbc.com
+      ')
+      validate = Wraith::Validate.new(config, true).validate('capture')
+    end
+  end
+
+  describe "validations specific to history mode" do
+    let(:history_conf) do
+      config.merge(YAML.load('
+        history_dir: "history_shots"
+      '))
+    end
+
+    it "should complain if more than one domain is specified" do
+      history_conf['domains'] = YAML.load('
+        test: http://something.bbc.com
+        live: http://www.bbc.com
+      ')
+      expect { Wraith::Validate.new(history_conf, true).validate('history') }.to raise_error InvalidDomainsError
+    end
+
+    it "should complain if no history_dir is specified" do
+      history_conf['history_dir'] = nil
+      expect { Wraith::Validate.new(history_conf, true).validate('history') }.to raise_error MissingRequiredPropertyError
+    end
+
+    it "should be happy if a history_dir and one domain is specified" do
+      validate = Wraith::Validate.new(history_conf, true).validate('history')
+    end
+  end
+end

data/templates/configs/capture.yaml

@@ -0,0 +1,61 @@
+##############################################################
+##############################################################
+# This is an example configuration provided by Wraith.
+# Feel free to amend for your own requirements.
+# ---
+# This particular config is intended to demonstrate how
+# to use Wraith in 'capture' mode, which is best suited to
+# comparing a test and live version of the same website.
+#
+# `wraith capture capture.yaml`
+#
+##############################################################
+##############################################################
+
+# (required) The engine to run Wraith with. Examples: 'phantomjs', 'casperjs', 'slimerjs'
+browser: "phantomjs"
+
+# (required) The domains to take screenshots of.
+domains:
+  current:  "http://www.example.com"
+  new:      "http://develop.example.com"
+
+# (required) The paths to capture. All paths should exist for both of the domains specified above.
+paths:
+  home:     /
+  about:    /about
+  contact:  /get-in-touch
+
+# (required) Screen widths (and optional height) to resize the browser to before taking the screenshot.
+screen_widths:
+  - 320
+  - 600x768
+  - 768
+  - 1024
+  - 1280
+
+# (optional) JavaScript file to execute before taking screenshot of every path. Default: nil
+before_capture: 'javascript/disable_javascript--phantom.js'
+
+# (required) The directory that your screenshots will be stored in
+directory: 'shots'
+
+# (required) Amount of fuzz ImageMagick will use when comparing images. A higher fuzz makes the comparison less strict.
+fuzz: '20%'
+
+# (optional) The maximum acceptable level of difference (in %) between two images before Wraith reports a failure. Default: 0
+threshold: 5
+
+# (optional) Specify the template (and generated thumbnail sizes) for the gallery output.
+gallery:
+  template: 'slideshow_template' # Examples: 'basic_template' (default), 'slideshow_template'
+  thumb_width:  200
+  thumb_height: 200
+
+# (optional) Choose which results are displayed in the gallery, and in what order. Default: alphanumeric
+# Options:
+#   alphanumeric - all paths (with or without a difference) are shown, sorted by path
+#   diffs_first - all paths (with or without a difference) are shown, sorted by difference size (largest first)
+#   diffs_only - only paths with a difference are shown, sorted by difference size (largest first)
+# Note: different screen widths are always grouped together.
+mode: diffs_first

data/templates/configs/history.yaml

@@ -0,0 +1,81 @@
+##############################################################
+##############################################################
+# This is an example configuration provided by Wraith.
+# Feel free to amend for your own requirements.
+# ---
+# This particular config is intended to demonstrate how
+# to use Wraith in 'history' mode, which is best suited to
+# making sure your site's appearance remains consistent over
+# time.
+#
+# `wraith history history.yaml` # generate base screenshots
+# `wraith latest history.yaml`  # take new shots and compare
+#
+##############################################################
+##############################################################
+
+# (required) The engine to run Wraith with. Examples: 'phantomjs', 'casperjs', 'slimerjs'
+browser: "casperjs"
+
+# (required) The domain to take screenshots of.
+domains:
+  english: "http://www.bbc.co.uk"
+
+# (required) The paths to capture. This particular config is using casperjs, so we can take screenshots of selectors rather than the entire page.
+paths:
+  clickable_guide:
+    path: /news/entertainment-arts-27221191
+    selector: '.idt__news' # (optional) selector to take a screenshot of
+  clickable_guide__after_click:
+    path: /news/entertainment-arts-27221191
+    selector: '.idt__news'
+    before_capture: 'javascript/beforeCapture--casper_example.js' # (optional) JavaScript file to execute before taking the screenshot of this path.
+
+# (optional) JavaScript file to execute before taking screenshot of every path. Default: nil
+before_capture: 'javascript/wait--casper.js'
+
+# (required) Screen widths (and optional height) to resize the browser to before taking the screenshot.
+screen_widths:
+  - 320
+  - 600x768
+  - 768
+  - 1024
+  - 1280
+
+# (optional) Resize to each screen width (efficient), or reload at each screen width (costly). Default: 'reload'
+resize_or_reload: 'resize'
+
+# (required for history mode, otherwise optional) The directory that your base screenshots will be stored in.
+history_dir: 'shots_base'
+
+# (required) The directory that your latest screenshots will be stored in
+directory: 'shots'
+
+# (required) Amount of fuzz ImageMagick will use when comparing images. A higher fuzz makes the comparison less strict.
+fuzz: '20%'
+
+# (optional) The maximum acceptable level of difference (in %) between two images before Wraith reports a failure. Default: 0
+threshold: 5
+
+# (optional) Specify the template (and generated thumbnail sizes) for the gallery output.
+gallery:
+  template: 'slideshow_template' # Examples: 'basic_template' (default), 'slideshow_template'
+  thumb_width:  200
+  thumb_height: 200
+
+# (optional) Choose which results are displayed in the gallery, and in what order. Default: alphanumeric
+# Options:
+#   alphanumeric - all paths (with or without a difference) are shown, sorted by path
+#   diffs_first - all paths (with or without a difference) are shown, sorted by difference size (largest first)
+#   diffs_only - only paths with a difference are shown, sorted by difference size (largest first)
+# Note: different screen widths are always grouped together.
+mode: diffs_first
+
+# (optional) Choose to run Wraith in verbose mode, for easier debugging. Default: false
+verbose: true
+
+# (optional) Color to highlight the image diff. Default: 'blue'
+highlight_color: red
+
+# (optional) Parameters to pass to Phantom/Casper command line. Default: '--ignore-ssl-errors=true --ssl-protocol=tlsv1'
+phantomjs_options: ''

data/templates/configs/spider.yaml

@@ -1,6 +1,17 @@
+##############################################################
+##############################################################
+# This is an example configuration provided by Wraith.
+# Feel free to amend for your own requirements.
+# ---
+# This particular config is intended to demonstrate how
+# to use Wraith in 'spider' mode.
+##############################################################
+##############################################################
+
+
 # Add as many domains as necessary. Key will act as a label
 domains:
-  my_site:  "http://www.example.com"
+  my_site:       "http://www.example.com"
   my_other_site: "http://www.test.example.com"
 
 # Notice the absence of a `paths` property. When no paths are provided, Wraith defaults to
@@ -38,7 +49,7 @@ screen_widths:
 browser: "phantomjs"
 
 # the directory that your latest screenshots will be stored in
-directory: 'shots_nojs'
+directory: 'shots'
 
 # choose how results are displayed in the gallery (default is `alphanumeric` if omitted)
 # Different screen widths are always grouped together.

data/templates/javascript/cookies_and_headers--casper.js

@@ -0,0 +1,16 @@
+// ######################################################
+// This is an example module provided by Wraith.
+// Feel free to amend for your own requirements.
+// ######################################################
+module.exports = function (casper, ready) {
+    // reload page with headers set
+    casper.open(casper.page.url, {
+        method: 'get',
+        headers: {
+            'SOME-HEADER': 'fish'
+        }
+    });
+    casper.then(function () {
+        setTimeout(ready, 1000);
+    });
+}

data/templates/javascript/cookies_and_headers--phantom.js

@@ -0,0 +1,26 @@
+// ######################################################
+// This is an example module provided by Wraith.
+// Feel free to amend for your own requirements.
+// ######################################################
+module.exports = function (phantom, ready) {
+
+    page.customHeaders = {
+        'SOME-HEADER': 'fish'
+    };
+
+    phantom.addCookie({
+        'name': 'ckns_policy',
+        'value': '111',
+        'domain': '.bbc.co.uk'
+    });
+
+    phantom.addCookie({
+        'name': 'locserv',
+        'value': '1#l1#i=6691484:n=Oxford+Circus:h=e@w1#i=8:p=London@d1#1=l:2=e:3=e:4=2@n1#r=40',
+        'domain': '.bbc.co.uk'
+    });
+
+    phantom.open(phantom.url, function () {
+        setTimeout(ready, 5000);
+    });
+}

data/templates/javascript/disable_javascript--casper.js

@@ -0,0 +1,11 @@
+// ######################################################
+// This is an example module provided by Wraith.
+// Feel free to amend for your own requirements.
+// ######################################################
+module.exports = function (casper, ready) {
+    // disable JavaScript
+    casper.options.pageSettings.javascriptEnabled = false;
+
+    // reload the page without JS enabled
+    casper.thenOpen(casper.page.url);
+}

data/templates/javascript/disable_javascript--phantom.js

@@ -0,0 +1,13 @@
+// ######################################################
+// This is an example module provided by Wraith.
+// Feel free to amend for your own requirements.
+// ######################################################
+module.exports = function (phantom, ready) {
+    // disable JavaScript
+    phantom.settings.javascriptEnabled = false;
+
+    // reload the page without JS enabled
+    phantom.open(phantom.url, function () {
+        setTimeout(ready, 5000);
+    });
+}