gatling 1.0.7 → 1.0.8

data/.gitignore

@@ -10,4 +10,4 @@ test*
 spec/support/ready_candidate_ref/temp/*
 reports/*
 vendor/*
-
+/.rbenv*

data/Gemfile

@@ -1,10 +1,3 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in gatling.gemspec
 gemspec
-
-group :development, :test, :smoke do
-  gem 'rake'
-  gem 'rspec-instafail'
-  gem 'pry'
-end

data/README.rdoc

@@ -1,10 +1,10 @@
 = Gatling
 
-Gatling Comparison allows one to build an Rspec / Capybara custom matcher comparing a :css or :xpath element to a referenced screenshot.
+An integrated visual RSpec matcher which makes real visual testing easy.
 
 -------------------------------------
 
-=== Installation:
+== Installation:
 
   gem install gatling
 
@@ -16,63 +16,71 @@ In spec_helper.rb :
   #plug and play custom rspec matcher
   require 'gatling/matchers/look_like_matcher'
 
-=== Usage:
+=== Configuration settings:
 
-Identify an element to match, for example:
+==== Reference_image_path - sets where the reference and diff images are saved to.
 
-        @element = page.find(:css, #button)
-	
-Use Gatling's custom matcher (conveniently supplied in the gatling gem) and specify the reference image:
+For Rails application, a default reference images folder will be created at spec/reference_images. This folder is root to all the reference
+images to be compares.
 
-        @element.should look_like('button_ref.png')
-	
-Gatling will take care of cropping the element and try and make a targeted match without the noise of the whole page.
+Also created are subfolders:
+- /candidate  - will hold candidate images which can be used as reference images
+- /diff - will hold the diff images generated by failed comparison tests
+- /temp - will only ever hold one screenshot at a time, used to create the cropped element
 
+=== max_no_tries - sets how many times Gatling will try and match the element against the reference image. Handy to reduce fragility of tests due to animations and load times. Defaults to 5.
 
-If the matcher fails, the test will fail, an exception will be raised and both a diff image and a new candidate image will be created.
+=== Sleep_between_tries - sets the sleep time (in seconds) between match tries (requires max_no_tries > 1). Defaults to 0.5
 
+=== Configuration settings are set with the following:
 
-If no reference image exits, the test will fail, an exception will be raised and a candidate will be created which can be used as a reference.
+Gatling.config do |setting|
+  Gatling.reference_image_path = 'my_custom_path'
+  Gatling.max_no_tries = 3
+  Gatling.sleep_between_tries = 0.7
+end
 
+GATLING::CONFIGURATION will be depreciated in future versions.
 -------------------------------------
+=== Usage:
 
-=== The path config:
+Identify an element to match, for example:
 
-For Rails application, a default reference images folder will be created at spec/reference_images. This folder is root to all the reference
-images to be compares. 
+        @element = page.find(:css, #button)
 
-Also created are subfolders: 
-- /candidate  - will hold candidate images which can be used as reference images
-- /diff - will hold the diff images generated by failed comparison tests
-- /temp - will only ever hold one screenshot at a time, used to create the cropped element
+Use Gatling's custom matcher (conveniently supplied in the gatling gem) and specify the reference image:
+
+        @element.should look_like('button_ref.png')
 
-==== For non-Rails apps or just to change the root reference folder specify in spec_help:
+Gatling will take care of cropping the element and try and make a targeted match without the noise of the whole page.
 
-  Gatling::Configuration.reference_image_path = "my custom path"
+If the matcher fails, the test will fail, an exception will be raised and both a diff image and a new candidate image will be created.
 
+If no reference image exits, the test will fail, an exception will be raised and a candidate will be created which can be used as a reference
+(see Training mode below)
 
 -------------------------------------
 
 === Training mode:
 
-Gatling can be run in training mode which will create reference images where ones do not exist. 
+Gatling can be run in training mode which will create reference images where ones do not exist.
 
-<b>CAUTION: Trainer mode will pass all the test which rely on the Gatling custom matcher, this can mean a false green build. 
+<b>CAUTION: Trainer mode will pass all the test which rely on the Gatling custom matcher, this can mean a false green build.
 Please make sure you are saving 'clean' references</b>
 
 Trainer mode will not overwrite existing references. If you are updating, just delete the old reference image.
 
-To set trainer mode, prefix rspec command line with $GATLING_TRAINER = true 
+To set trainer mode, prefix rspec command line with $GATLING_TRAINER = true
 
 
-Example:        
+Example:
         $GATLING_TRAINER = true rspec spec/my_spec.rb
 
 -------------------------------------
 
 ==== Non-gem dependencies:
 
-Imagemagick must be installed: 
+Imagemagick must be installed:
 
   $sudo apt-get install imagemagick
 
@@ -80,7 +88,7 @@ Imagemagick must be installed:
 
 
 == Contributing to gatling
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project

data/Rakefile

@@ -1,13 +1,23 @@
 require 'bundler/gem_tasks'
 require 'rspec/core'
-require 'rspec/core/rake_task' 
+require 'rspec/core/rake_task'
 require File.expand_path('spec/spec_helper.rb')
 
-task :default => ["run"]
 
-desc "default test run"
-RSpec::Core::RakeTask.new(:run) do |t|
+task :default => :full_build
+
+desc "full build, run all the tests"
+task :full_build => [:unit, :acceptance]
+
+desc "Run unit tests"
+RSpec::Core::RakeTask.new(:unit) do |t|
   t.pattern = ['spec/*_spec.rb']
   t.rspec_opts = ['--options', "spec/spec.opts"]
 end
-  
+
+
+desc "Run acceptance tests"
+RSpec::Core::RakeTask.new(:acceptance) do |t|
+  t.pattern = ['spec/acceptance/*_spec.rb']
+  t.rspec_opts = ['--options', "spec/spec.opts"]
+end

data/gatling.gemspec

@@ -5,7 +5,7 @@ require "gatling/version"
 Gem::Specification.new do |s|
   s.name        = "gatling"
   s.version     = Gatling::VERSION
-  s.authors     = ["Gabriel Rotbart, Amanda Koh"]
+  s.authors     = ["Gabriel Rotbart, Amanda Koh, Mike Bain"]
   s.email       = ["grotbart@gmail.com"]
   s.homepage    = "http://github.com/GabrielRotbart/gatling"
   s.summary     = %q{Automated visual testing}
@@ -18,8 +18,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "rmagick"
-  s.add_dependency "rspec-core"
-  s.add_dependency "rspec"
-  s.add_dependency "capybara"
+  s.add_runtime_dependency('rmagick', ['>=2.13.1'])
+  s.add_runtime_dependency('rspec-core',['>=2.8.0'])
+  s.add_runtime_dependency('rspec',['>=2.8.0'])
+  s.add_runtime_dependency('capybara',['>=1.1.2'])
+
+  s.add_development_dependency('rake',['>=0.9.2'])
+  s.add_development_dependency('rspec-instafail',['>=0.1.8'])
+  s.add_development_dependency('pry',['>=0.9.8.2'])
 end

data/lib/gatling.rb

@@ -1,18 +1,12 @@
-#Dir["/gatling/*.rb"].each {|file| require file}
-
 require 'RMagick'
 require 'capybara'
 require 'capybara/dsl'
 
 require 'gatling/config'
-require 'gatling/file_helper'
 require 'gatling/image'
 require 'gatling/comparison'
 require 'gatling/capture_element'
 
-# include Gatling::Comparison
-
-#TODO: Fuzz matches
 #TODO: Helpers for cucumber
 #TODO: Make directories as needed
 
@@ -20,39 +14,58 @@ module Gatling
 
   class << self
 
+    attr_accessor :reference_image_path, :max_no_tries, :sleep_between_tries
+
     def matches?(expected_reference_filename, actual_element)
 
-      Gatling::FileHelper.make_required_directories
+      expected_reference_file = (File.join(Gatling::Configuration.path(:reference), expected_reference_filename))
 
-      expected_reference_file = (File.join(Gatling::Configuration.paths[:reference], expected_reference_filename))
-      actual_image = Gatling::Image.new(:from_element, expected_reference_filename, actual_element)
 
       if Gatling::Configuration.trainer_toggle
+        actual_image = Gatling::ImageFromElement.new(actual_element, expected_reference_filename)
         save_image_as_reference(actual_image)
         return true
       end
 
       if !File.exists?(expected_reference_file)
+        actual_image = Gatling::ImageFromElement.new(actual_element, expected_reference_filename)
         save_image_as_candidate(actual_image)
         return false
       else
-        expected_image = Gatling::Image.new(:from_file, expected_reference_filename)
-        comparison = Gatling::Comparison.new(expected_image, actual_image)
-        unless comparison.match
-          actual_image.save(:as => :candidate)
+        comparison = compare_until_match(actual_element, expected_reference_filename, Gatling::Configuration.max_no_tries)
+        matches = comparison.matches?
+        if !matches
+          comparison.actual_image.save(:as => :candidate)
           save_image_as_diff(comparison.diff_image)
         end
-        comparison.match
+        matches
       end
     end
 
-    private
+    def compare_until_match actual_element, expected_reference_filename, max_no_tries
+      tries = max_no_tries
+      try = 0
+      match = false
+      expected_image = Gatling::ImageFromFile.new(expected_reference_filename)
+      comparison = nil
+      while !match && try < tries
+        actual_image = Gatling::ImageFromElement.new(actual_element, expected_reference_filename)
+        comparison = Gatling::Comparison.new(expected_image, actual_image)
+        match = comparison.matches?
+        if !match
+          sleep 0.5
+          try += 1
+          puts "Tried to match #{try} times"
+        end
+      end
+      comparison
+    end
 
     def save_image_as_diff(image)
       image.save(:as => :diff)
       raise "element did not match #{image.file_name}. A diff image: #{image.file_name} was created in " +
-      "#{File.join(Gatling::Configuration.paths[:diff],image.file_name)}. " +
-      "A new reference #{File.join(Gatling::Configuration.paths[:candidate],image.file_name)} can be used to fix the test"
+      "#{File.join(Gatling::Configuration.path(:diff),image.file_name)}. " +
+      "A new reference #{File.join(Gatling::Configuration.path(:candidate),image.file_name)} can be used to fix the test"
     end
 
     def save_image_as_candidate(image)
@@ -70,5 +83,9 @@ module Gatling
       end
     end
 
+    def config
+      yield
+    end
+
   end
 end

data/lib/gatling/capture_element.rb

@@ -3,15 +3,16 @@ require_relative 'image_wrangler'
 module Gatling
   class CaptureElement
 
+  include ImageWrangler
+
     def initialize element_to_capture, *element_to_exclude
       @reference_image_path = Gatling::Configuration.reference_image_path
       @element_to_capture = element_to_capture
-      @element_to_exclude = element_to_exclude.first
+      # @element_to_exclude = element_to_exclude.first
 
     end
 
     def capture
-
       screenshot = self.take_screenshot
       screenshot = exclude(screenshot, @element_to_exclude) if @element_to_exclude
       Gatling::ImageWrangler.crop_element(screenshot, @element_to_capture)

data/lib/gatling/comparison.rb

@@ -1,24 +1,20 @@
 module Gatling
   class Comparison
 
-    attr_accessor :match, :diff_image
+    attr_accessor :diff_image, :actual_image, :expected_image
 
-    def initialize(actual_image, expected_image)
-      compare(actual_image, expected_image)
-    end
-
-    def compare(actual_image, expected_image)
-      diff_metric = actual_image.image.compare_channel(expected_image.image, Magick::MeanAbsoluteErrorMetric)
-      @match = diff_metric[1] == 0.0
-      unless @match
-        diff_image = diff_metric.first
-        @diff_image = Gatling::Image.new(:from_diff, actual_image.file_name, diff_image)
+    def initialize actual_image, expected_image
+      @actual_image = actual_image
+      @expected_image = expected_image
+      @comparison = @actual_image.image.compare_channel(@expected_image.image, Magick::MeanAbsoluteErrorMetric)
+      @match = @comparison[1] == 0.0
+      if !@matches
+         @diff_image =Gatling::Image.new(@comparison.first, @expected_image.file_name)
       end
-      @match
     end
 
-    def diff_image
-      @diff_image
+    def matches?
+      @match
     end
 
   end

data/lib/gatling/config.rb

@@ -1,41 +1,29 @@
 module Gatling
- module Configuration
+  module Configuration
 
     class << self
 
-      attr_accessor :reference_image_path, :trainer_toggle
+      attr_accessor :reference_image_path, :trainer_toggle, :max_no_tries, :sleep_between_tries
 
       attr_reader :paths
 
       def reference_image_path
-        @reference_image_path ||= set_default_path
+        Gatling.reference_image_path || @reference_image_path ||= set_default_path
       end
 
-      def paths
-        Hash[reference:reference_image_path,
-        candidate:File.join(reference_image_path, 'candidate'),
-        diff:File.join(reference_image_path, 'diff'),
-        temp:File.join(reference_image_path, 'temp')]
+      def max_no_tries
+        Gatling.max_no_tries || @max_no_tries ||= 5
       end
 
-      def trainer_toggle
-        @trainer_value = ENV['GATLING_TRAINER']
-
-        case @trainer_value
-          when nil
-            @trainer_value = nil
-          when 'true'
-            @trainer_value = true
-          when 'false'
-            @trainer_value = false
-          else
-            @trainer_value = false
-            puts 'Unknown GATLING_TRAINER argument. Please supply true, false or nil. DEFAULTING TO FALSE'
-        end
-        @trainer_toggle ||= @trainer_value ||= false
+      def sleep_between_tries
+        Gatling.sleep_between_tries || @sleep_between_tries ||= 0.5
       end
 
-      def path_from_type(type)
+      def path(type)
+        paths = Hash[:reference => reference_image_path,
+                     :candidate => File.join(reference_image_path, 'candidate'),
+                     :diff => File.join(reference_image_path, 'diff'),
+                     :temp => File.join(reference_image_path, 'temp')]
         if paths.keys.include? type
           return paths[type]
         else
@@ -43,11 +31,28 @@ module Gatling
         end
       end
 
-      private
+      def trainer_toggle
+        @trainer_value = ENV['GATLING_TRAINER']
+
+        case @trainer_value
+        when nil
+          @trainer_value = nil
+        when 'true'
+          @trainer_value = true
+        when 'false'
+          @trainer_value = false
+        else
+          @trainer_value = false
+          puts 'Unknown GATLING_TRAINER argument. Please supply true, false or nil. DEFAULTING TO FALSE'
+        end
+        @trainer_toggle ||= @trainer_value ||= false
+      end
+
 
       def set_default_path
+        private
         begin
-        @reference_image_path ||= File.join(Rails.root, 'spec/reference_images')
+          @reference_image_path ||= File.join(Rails.root, 'spec/reference_images')
         rescue
           @reference_image_path = 'spec/reference_images'
           puts "Currently defaulting to #{@reference_image_path}. Overide this by setting Gatling::Configuration.reference_image_path=[refpath]"
@@ -57,4 +62,4 @@ module Gatling
     end
 
   end
-end
+end

data/lib/gatling/image.rb

@@ -5,46 +5,50 @@ module Gatling
 
     attr_reader :type
 
-    def initialize(type, file_name, element_or_image = nil)
+    def initialize image, file_name
 
       @file_name = file_name
 
-      case type
-      when :from_file
-        @image = image_from_file(file_name)
-      when :from_element
-        @image = image_from_element(element_or_image)
-      when :from_diff
-        @image = element_or_image
-      else
-        raise 'WRONG IMAGE TYPE'
-      end
+      @image = image
 
     end
 
     def save type
-      @path = File.join(Gatling::Configuration.path_from_type(type[:as]), @file_name)
+      path = Gatling::Configuration.path(type[:as])
+      FileUtils::mkdir_p(path) unless File.exists?(path)
+      @path = File.join(path, @file_name)
       @image.write @path
       @path
     end
 
     def exists?
-      File.exists?(File.join(Gatling::Configuration.path_from_type(:reference), @file_name))
+      File.exists?(File.join(Gatling::Configuration.path(:reference), @file_name))
     end
 
-    private
+  end
 
-    def image_from_element element
-      Gatling::CaptureElement.new(element).capture
-    end
+  class ImageFromElement < Image
 
-    def image_from_file file_name
-      Magick::Image.read(File.join(Gatling::Configuration.path_from_type(:reference), file_name)).first
+    def initialize element, file_name
+      super(image, file_name)
+
+      @image = Gatling::CaptureElement.new(element).capture
     end
+    
+    #TODO: make save a relevant subclass method
+  end
 
+  class ImageFromFile < Image
 
-  end
+    def initialize file_name
+      super(image, file_name)
+
+      @image = Magick::Image.read(File.join(Gatling::Configuration.path(:reference), @file_name)).first
+    end
 
+    #TODO: make save a relevant subclass method
+    
+  end
 end