image_diff 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e683fbd3804792c92b8e40c260909dcdda3d1ea9654059530ce153fc1f15314
+  data.tar.gz: d43baf340a58f2f64118ab7e13eb1bf34165fed757b9297dca05fb49652c7d2c
+SHA512:
+  metadata.gz: 71a3ab91a47531a9001a7ddb3f3b1600abd23c558d6e866415a5c96880631da6d4194bb2422d1b8ddc2ddd39b6aa52edc7218cc2d8b16a43553fb962063500f2
+  data.tar.gz: ef1f767a4750d154df6ed739ff0263b23c816b3dc243fab0d81b8811895ee96b7270dffeccf061cfbf0f0ff3669c2b1e08c26bbb539c9047062a6a15c690375b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.iml
+.idea

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in imagediff.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rubocop', '0.80.0'

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    image_diff (0.1.0)
+      capybara (~> 3.31.0)
+      require_all (= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    capybara (3.31.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.5)
+      xpath (~> 3.2)
+    jaro_winkler (1.5.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    public_suffix (4.0.5)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.0)
+    require_all (3.0.0)
+    rexml (3.2.4)
+    rubocop (0.80.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  image_diff!
+  rake (~> 12.0)
+  rubocop (= 0.80.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dan Oades
+
+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.

data/README.md

@@ -0,0 +1,79 @@
+# ImageDiff
+
+Ruby image comparison library for integration with automated Selenium tests and Cucumber. Use ImageDiff to take full page snapshot images of web pages and compare them against recent screenshots from Selenium/Capybara tests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'image_diff', git: 'git@github.com:ITV/image_diff.git'
+```
+
+And then execute:
+
+    $ bundle install
+
+ImageDiff uses ImageMagick for screenshot manipulation, install it via HomeBrew:
+
+```
+brew install imagemagick
+```
+
+## Usage
+
+Set up your Selenium/Cucumber project as usual and add the following profiles to `/config/cucumber.yml`:
+
+```
+generate_screenshots: IMAGE_DIFF=generate
+visual_regression:    IMAGE_DIFF=regression
+```
+
+Add ImageDiff to `features/support/env.rb`:
+
+```
+require 'image_diff'
+```
+
+Create a new cucumber hook to execute against tests tagged for visual testing in `features/support/hooks.rb`:
+
+```
+After '@visual_test' do |scenario|
+  filename = scenario.location
+  if ENV['IMAGE_DIFF'] == 'generate'
+    # Take a screenshot of the current Selenium/Capybara driver window and save to /reference
+    ImageDiff::PNGSnapshot.new('reference', filename).write
+  else
+    # Take a screenshot of the current Selenium/Capybara driver window and compare to same file in /reference folder
+    # If screenshots differ then a diff.png file will be generated
+    ImageDiff::PNGSnapshot.new('visual_regression', filename).compare
+    ImageDiff::Differ::Results::Output.flush
+
+    # Optional - fail the cucumber test if screenshot difference fails
+    expect(ImageDiff::Differ::Results::List.instance).to(
+        be_empty, 'Visual regression tests failed'
+    )
+  end
+end
+```
+
+Tag any cucumber feature tests with '@visual_test' and run the cucumber profile to generate reference screenshots for the test:
+
+```
+$ bundle exec cucumber -p generate_screenshots -t @visual_test
+```
+
+Replay the test and compare the result against the reference screenshot, if they match then the test will pass if not a diff.png file highlighting the differences will be generated:
+
+```
+$ bundle exec cucumber -p visual_regression -t @visual_test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/itv/imagediff.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'image_diff'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/image_diff.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/image_diff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'image_diff'
+  spec.version       = ImageDiff::VERSION
+  spec.authors       = ['']
+  spec.email         = ['daniel.oades@itv.com']
+
+  spec.summary       = 'Full page screenshot comparison tool'
+  spec.description   = 'Full page screenshot comparison tool for use with Capybara and Selenium'
+  spec.homepage      = 'https://github.com/ITV/image_diff'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ITV/image_diff'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('capybara', '~> 3.31.0')
+  spec.add_dependency('require_all', '3.0.0')
+end

data/lib/helpers/screenshot.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Helpers
+  # Screenshot helper
+  module Screenshot
+    def resize_window(width, height)
+      Capybara.page.driver.browser.manage.window.resize_to(width, height)
+    end
+
+    def fullpage_height
+      Capybara.page.evaluate_script(%(document.documentElement.offsetHeight + 100;))
+    end
+
+    def fullpage
+      size = Capybara.page.current_window.size
+      resize_window(size[0], fullpage_height)
+    end
+
+    def fullpage_screenshot(filename)
+      size = Capybara.page.current_window.size
+      resize_window(size[0], fullpage_height)
+      screenshot(filename)
+      resize_window(size[0], size[1])
+    end
+
+    def screenshot(filename)
+      Capybara.page.save_screenshot(filename)
+    end
+  end
+end

data/lib/image_diff.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'require_all'
+require 'capybara'
+
+require_rel 'helpers'
+require_rel 'image_diff'
+
+module ImageDiff
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/image_diff/differ/differ.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_rel 'results'
+
+module ImageDiff
+  # Diff YAML files
+  module Differ
+    # TODO: Move this code smell
+    def reference_file
+      path_and_filename.sub(%r{^[^/]*}, 'reference')
+    end
+
+    # Diff class
+    class Diff
+      include Differ::Results
+
+      attr_reader :snapshot
+
+      def initialize(snapshot)
+        @snapshot = snapshot
+        result
+      end
+
+      def reference
+        @reference ||= @snapshot.reference_file
+      end
+    end
+
+    # Singleton to store differences
+    class Differences
+      extend Forwardable
+      include Singleton
+
+      def_delegators :@list, :map
+
+      def initialize(list = {})
+        @list = list
+      end
+
+      def []=(key, str)
+        @list[key] = str unless str.chomp.empty?
+      end
+
+      # TODO: output failures separately from reference file misses
+      #       also produce screenshot on failure
+      def self.result
+        instance.map { |diff| puts(*diff) }
+      end
+    end
+  end
+end

data/lib/image_diff/differ/image_diff.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_rel 'image_magick'
+
+# TODO: Refactor out ImageMagick code
+module ImageDiff
+  module Differ
+    # ImageDiff class
+    class ImageDiff < Diff
+      def result
+        index, debug = ImageMagick.absolute_error(args)
+        send(%i[pass fail][index] || :error, debug)
+      end
+
+      private
+
+      def comparison
+        File.join(snapshot.fullpath, snapshot.filename.gsub('.png', '_diff.png'))
+      end
+
+      def args
+        [reference, snapshot.path_and_filename, comparison].join(' ')
+      end
+
+      def pass(_debug)
+        File.delete(comparison, snapshot.path_and_filename)
+      end
+
+      def fail(debug)
+        Results::PixelRegression.new(reference, snapshot, debug, comparison)
+      end
+
+      def error(debug)
+        if debug[/unable to open image/]
+          Results::ReferenceFileNotFound.new(snapshot)
+        else
+          # TODO: This is a failure so should add Result to Results list
+          print %(\033[31m#{debug}\033[0m)
+        end
+      end
+    end
+  end
+end

data/lib/image_diff/differ/image_magick.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module ImageDiff
+  module Differ
+    # ImageMagick compare interface
+    module ImageMagick
+      CMD = 'compare -metric rmse '
+
+      module_function
+
+      def absolute_error(args)
+        Open3.popen2e(CMD + args) do |_stdin, stdout_stderr, wait_thr|
+          [wait_thr.value.exitstatus, stdout_stderr.readlines.join("\n")]
+        end
+      end
+    end
+  end
+end

data/lib/image_diff/differ/results/list.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_rel 'result'
+
+module ImageDiff
+  module Differ
+    module Results
+      # Results list
+      class List
+        extend Forwardable
+        include Singleton
+
+        def_delegators :@list, :ai, :[], :each_with_object, :empty?
+
+        def initialize
+          clear
+        end
+
+        def clear
+          @list = Hash.new { |hash, key| hash[key] = [] }
+        end
+
+        def filter(method)
+          each_with_object({}) do |(component, results), hash|
+            selected = Filter.apply(results, method)
+            hash[component] = selected unless selected.empty?
+          end
+        end
+
+        def reference_errors
+          filter(:select)
+        end
+
+        def regressions
+          filter(:reject)
+        end
+      end
+
+      # Helper class to filter array
+      class Filter
+        KLASS = ImageDiff::Differ::Results::ReferenceFileNotFound
+        LAMBDA = ->(result) { result.is_a?(KLASS) }
+
+        def self.apply(arr, method)
+          arr.send(method, &LAMBDA)
+        end
+      end
+    end
+  end
+end

data/lib/image_diff/differ/results/output.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require 'erb'
+
+module ImageDiff
+  module Differ
+    module Results
+      # Decorator for Results hash
+      class Output < SimpleDelegator
+        CURRENT_DIR = File.dirname(__FILE__)
+
+        def initialize
+          super(List.instance)
+          @regressions = regressions
+          @reference_errors = reference_errors
+        end
+
+        def out
+          render_reference_errors
+          render_regression_errors
+        end
+
+        def render_reference_errors
+          print_str = String.new ''
+          unless @reference_errors.empty?
+            @reference_errors.map do |component, failures|
+              print_str << "The following reference files were not found, you need to generate screenshots before comparing...\n"
+              failures.each do |failure|
+                print_str << "\033[31m#{failure.snapshot.filename}\033[0m\n"
+              end
+            end
+          end
+          print print_str
+        end
+
+        def render_regression_errors
+          print_str = String.new ''
+          unless @regressions.empty?
+            @regressions.map do |component, failures|
+              print_str << "The following screenshots are different from the comparison image, if this expected then regenerate comparison images...\n"
+              failures.each do |failure|
+                print_str << "\033[31m#{failure.output}\033[0m\n"
+              end
+            end
+          end
+          print print_str
+        end
+
+        def self.clear
+          List.instance.clear
+        end
+
+        def self.flush
+          return if List.instance.empty?
+
+          new.out
+        end
+      end
+    end
+  end
+end

data/lib/image_diff/differ/results/result.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ImageDiff
+  module Differ
+    module Results
+      # Comparison result
+      class Result
+        attr_reader :snapshot
+
+        def initialize(snapshot)
+          @snapshot = snapshot
+          add_to_results_list
+        end
+
+        def add_to_results_list
+          List.instance[@snapshot.filepath] << self
+        end
+      end
+
+      # Reference File Not Found
+      class ReferenceFileNotFound < Result
+      end
+
+      # Pixel Regression
+      class PixelRegression < Result
+        def initialize(reference, snapshot, error, comparison)
+          @error = error
+          @comparison = comparison
+          @reference = reference
+          super(snapshot)
+        end
+
+        def output
+          <<~BODY
+            ----------------------
+            Reference file: #{@reference}
+            Screenshot:  #{snapshot.filepath}.png
+            Difference: #{@comparison}
+            ----------------------
+          BODY
+        end
+      end
+    end
+  end
+end

data/lib/image_diff/png_snapshot.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_rel 'snapshot'
+
+module ImageDiff
+  # Screenshot class
+  class PNGSnapshot < Snapshot
+    include Helpers::Screenshot
+
+    @id = 'PNG'
+
+    class << self
+      attr_reader :master_screenshot_path
+    end
+
+    def extension
+      '.png'
+    end
+
+    def write
+      fullpage_screenshot(path_and_filename)
+    end
+
+    def compare
+      write
+      ImageDiff.new(self)
+    end
+  end
+end

data/lib/image_diff/snapshot.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_rel 'writer'
+require_rel 'differ'
+
+module ImageDiff
+  # Snapshot class
+  class Snapshot
+    include Writer
+    include Differ
+
+    class << self
+      attr_reader :id
+    end
+
+    attr_reader :snapshot_path, :file
+
+    def initialize(snapshot_path, file)
+      @snapshot_path = snapshot_path
+      @file = file
+    end
+
+    def fullpath
+      FileUtils.mkdir_p(snapshot_path)
+    end
+
+    def filepath
+      File.join(fullpath, @file)
+    end
+
+    def filename
+      "#{@file}#{extension}"
+    end
+  end
+end

data/lib/image_diff/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ImageDiff
+  VERSION = '0.0.1'
+end

data/lib/image_diff/writer/writer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ImageDiff
+  # Write Snapshots to File
+  module Writer
+    def path_and_filename
+      File.join(fullpath, filename)
+    end
+
+    def write
+      File.open(path_and_filename, 'w') do |file|
+        file.write(content)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: image_diff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.31.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.31.0
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Full page screenshot comparison tool for use with Capybara and Selenium
+email:
+- daniel.oades@itv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- image_diff.gemspec
+- lib/helpers/screenshot.rb
+- lib/image_diff.rb
+- lib/image_diff/differ/differ.rb
+- lib/image_diff/differ/image_diff.rb
+- lib/image_diff/differ/image_magick.rb
+- lib/image_diff/differ/results/list.rb
+- lib/image_diff/differ/results/output.rb
+- lib/image_diff/differ/results/result.rb
+- lib/image_diff/png_snapshot.rb
+- lib/image_diff/snapshot.rb
+- lib/image_diff/version.rb
+- lib/image_diff/writer/writer.rb
+homepage: https://github.com/ITV/image_diff
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ITV/image_diff
+  source_code_uri: https://github.com/ITV/image_diff
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Full page screenshot comparison tool
+test_files: []