browsery 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c6352942319e9568eee4ea1bbeb19b969996e3d
-  data.tar.gz: 11aa06f7cc11de87e47199b0765149641866e2d7
+  metadata.gz: 290fd85dbec79c15456ca64597df0c3d36954352
+  data.tar.gz: cb0bee66fb36a7f57c6f4ae7273a95a2dc268e31
 SHA512:
-  metadata.gz: 7d778a1238befd79de6b935f33c1c4ae025fe29336a41302f726b0da0f9f67df6e2d36e27c0abc7b9f82cc8ae302f866df645bd03800b8e23927018b9fdadd04
-  data.tar.gz: ae45c3aa0c59af81b9a5425a22df522693ee597836693ca43b5ab54144b9808202ed49645d3dc3285abfd62623fe99ace0e6a5eee54acd95172da8964e6c9b4b
+  metadata.gz: b5fdb785c1cf6db0f3e40c858b6d679d8b172b0751d5fb91543f26e0efa8597bc77a686991936fce544c9ff762e63fa515b3ac382d9def8b2da1d50950873378
+  data.tar.gz: 294d1f43adcc23ae124e7219ae7c05dadffe205c7754f438329906a5d6a0d1dc69567b09c209152619506360cb858a6e3ca9c2750aabd795e45cf70a18747891

data/README.md

@@ -8,3 +8,4 @@ Browsery is a browser automation test framework built on top of minitest and sel
 Add this line to your Gemfile and run `bundle install`:
 
     gem 'browsery'
+

data/browsery.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'minitest', '~>5.4.0'
   s.add_dependency 'selenium-webdriver', '~> 2.46'
   s.add_dependency 'rest-client', '~> 1.8'
+  s.add_dependency 'chunky_png', '~> 1.3'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'yard'

data/lib/browsery/diff_image.rb

@@ -0,0 +1,48 @@
+require 'chunky_png'
+include ChunkyPNG::Color
+
+module Browsery
+  class DiffImage
+
+    def initialize(base_image, new_image)
+      @base_image = ChunkyPNG::Image.from_file(base_image)
+      @new_image = ChunkyPNG::Image.from_file(new_image)
+      @diff_image = ChunkyPNG::Image.new(@base_image.width, @new_image.width, BLACK)
+    end
+
+    def calculate_changes
+      diff = []
+
+      @base_image.height.times do |y|
+        @base_image.row(y).each_with_index do |pixel, x|
+          unless pixel == @new_image[x,y]
+            score = Math.sqrt(
+              (r(@new_image[x,y]) - r(pixel)) ** 2 +
+              (g(@new_image[x,y]) - g(pixel)) ** 2 +
+              (b(@new_image[x,y]) - b(pixel)) ** 2
+            ) / Math.sqrt(MAX ** 2 * 3)
+            diff << score
+          end
+          @diff_image[x,y] = rgb(
+            r(pixel) + r(@new_image[x,y]) - 2 * [r(pixel), r(@new_image[x,y])].min,
+            g(pixel) + g(@new_image[x,y]) - 2 * [g(pixel), g(@new_image[x,y])].min,
+            b(pixel) + b(@new_image[x,y]) - 2 * [b(pixel), b(@new_image[x,y])].min
+          )
+        end
+      end
+
+      total_pixels = @base_image.pixels.length
+      diff_percentage = diff.empty? ? 0 : diff.inject {|sum, value| sum + value} / total_pixels
+      puts "pixels (total):     #{total_pixels}"
+      puts "pixels changed:     #{diff.length}"
+      puts "image changed (%):  #{diff_percentage * 100} %"
+
+      diff_percentage
+    end
+
+    def save_diff(diff_image)
+      @diff_image.save(diff_image)
+    end
+
+  end
+end

data/lib/browsery/init.rb

@@ -55,6 +55,6 @@ require_relative 'connector'
 require_relative 'page_objects'
 require_relative 'parallel'
 require_relative 'settings'
-
+require_relative 'diff_image'
 require_relative 'test_case'
 require_relative 'console'

data/lib/browsery/settings.rb

@@ -77,6 +77,10 @@ module Browsery
       hsh.fetch(:rerun_failure)
     end
 
+    def visual_regression
+      hsh.fetch(:visual_regression)
+    end
+
     def seed
       hsh.fetch(:seed, nil).to_i
     end

data/lib/browsery/utils/page_object_helper.rb

@@ -220,6 +220,25 @@ module Browsery
         calling_page.class.to_s.split('::').last.downcase
       end
 
+      def visual_regression(test_step_id)
+        if Browsery.settings.visual_regression
+          if File.exist?("visual_regression/#{test_step_id}-base.png")
+            base_image_path = "visual_regression/#{test_step_id}-base.png"
+            new_image_path = @driver.save_screenshot("visual_regression/#{test_step_id}-new.png")
+            diff_image = Browsery::DiffImage.new(base_image_path, new_image_path)
+            diff_percentage = diff_image.calculate_changes
+            if diff_percentage > Browsery.settings.visual_regression
+              diff_image_path = "visual_regression/#{test_step_id}-diff.png"
+              diff_image.save(diff_image_path)
+              puts "failed at visual regression, diff image saved - #{diff_image_path}"
+              fail
+            end
+          else
+            @driver.save_screenshot("visual_regression/#{test_step_id}-base.png")
+          end
+        end
+      end
+
       private
 
       # @param  eg. (:css, 'button.cancel') or (*BUTTON_SUBMIT_SEARCH)

data/lib/browsery/version.rb

@@ -1,3 +1,3 @@
 module Browsery
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/minitest/browsery_settings_plugin.rb

@@ -78,6 +78,14 @@ module Minitest
       integer_value = value.nil? ? 1 : value.to_i
       options[:rerun_failure] = integer_value
     end
+
+    options[:visual_regression] = false
+    parser.on('-V', '--visual-regression [TOLERANCE]', 'Enable visual regression,
+    can optionally set tolerance level in percentage(0 tolerance by default),
+    eg. -V 0.01 fails a test if visual difference is larger than 1%') do |value|
+      float_value = value.nil? ? 0 : value.to_f
+      options[:visual_regression] = float_value
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browsery
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Peijie Hu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +167,7 @@ files:
 - lib/browsery.rb
 - lib/browsery/connector.rb
 - lib/browsery/console.rb
+- lib/browsery/diff_image.rb
 - lib/browsery/init.rb
 - lib/browsery/logger.rb
 - lib/browsery/page_objects.rb