kontrast 0.2.1 → 0.6.0

data/lib/kontrast/page_test.rb

@@ -0,0 +1,32 @@
+require 'uri'
+require 'rack'
+
+module Kontrast
+    class PageTest < Test
+
+        attr_reader :width, :url_params
+
+        def initialize(prefix, name, path, headers: {}, url_params: {})
+            super(prefix, name, path, headers)
+            @width = prefix
+            @url_params = url_params
+
+            # Re-define path so it includes all URL params
+            @path = get_path_with_params(url_params)
+        end
+
+        def get_path_with_params(url_params)
+            uri = URI(@path)
+            original_query = Rack::Utils.parse_query(uri.query)
+            new_query = url_params.merge(original_query)
+            uri.query = Rack::Utils.build_query(new_query)
+
+            # Ensure there's no trailing "?"
+            if uri.query == ""
+                uri.query = nil
+            end
+
+            return uri.to_s
+        end
+    end
+end

data/lib/kontrast/selenium_handler.rb

@@ -31,22 +31,33 @@ module Kontrast
             end
         end
 
-        def run_comparison(width, path, name)
+        def run_comparison(test)
             # Create folder for this test
-            current_output = FileUtils.mkdir_p("#{@path}/#{width}_#{name}").join('')
+            current_output = FileUtils.mkdir_p("#{@path}/#{test}").join('')
 
             # Open test host tabs
-            navigate(path)
+            navigate(test.path)
 
             # Resize to given width and total height
-            resize(width)
+            resize(test.width)
+
+            screenshot_args = [@test_driver[:driver], @production_driver[:driver], { width: test.width, name: test.name }]
 
             # Take screenshot
             begin
-                Kontrast.configuration.before_screenshot(@test_driver[:driver], @production_driver[:driver], { width: width, name: name })
+                # Global callback
+                Kontrast.configuration.before_screenshot(*screenshot_args)
+
+                # Spec callback
+                test.run_callback(:before_screenshot, *screenshot_args)
+
                 screenshot(current_output)
             ensure
-                Kontrast.configuration.after_screenshot(@test_driver[:driver], @production_driver[:driver], { width: width, name: name })
+                # Global callback
+                Kontrast.configuration.after_screenshot(*screenshot_args)
+
+                # Spec callback
+                test.run_callback(:after_screenshot, *screenshot_args)
             end
         end
 
@@ -81,4 +92,4 @@ module Kontrast
                 end
             end
     end
-end
+end

data/lib/kontrast/spec.rb

@@ -0,0 +1,21 @@
+module Kontrast
+    class Spec
+        attr_accessor :name, :_before_screenshot, :_after_screenshot
+
+        def initialize(name)
+            @name = name
+        end
+
+        def before_screenshot(test_driver, production_driver, current_test)
+            if @_before_screenshot
+                @_before_screenshot.call(test_driver, production_driver, current_test)
+            end
+        end
+
+        def after_screenshot(test_driver, production_driver, current_test)
+            if @_after_screenshot
+                @_after_screenshot.call(test_driver, production_driver, current_test)
+            end
+        end
+    end
+end

data/lib/kontrast/spec_builder.rb

@@ -0,0 +1,54 @@
+module Kontrast
+    class << self
+        attr_accessor :spec_builder
+
+        def get_spec_builder
+            self.spec_builder ||= SpecBuilder.new
+        end
+
+        def describe(spec_name)
+            self.get_spec_builder.add(spec_name)
+            yield(self.get_spec_builder)
+        end
+    end
+
+    class SpecBuilder
+        attr_reader :specs
+
+        def initialize
+            @specs = []
+        end
+
+        def add(spec_name)
+            @current_spec = Spec.new(spec_name)
+            @specs << @current_spec
+        end
+
+        def before_screenshot(&block)
+            @current_spec._before_screenshot = block
+        end
+
+        def after_screenshot(&block)
+            @current_spec._after_screenshot = block
+        end
+
+        def self.load_specs(specs_path = nil)
+            if !specs_path.nil?
+                spec_folder = specs_path
+            elsif Kontrast.in_rails?
+                spec_folder = Rails.root.to_s + "/kontrast_specs"
+            else
+                spec_folder = "./kontrast_specs"
+            end
+
+            spec_files = Dir[spec_folder + "/**/*_spec.rb"]
+            spec_files.each do |file|
+                require file
+            end
+        end
+
+        def clear!
+            @specs = []
+        end
+    end
+end

data/lib/kontrast/test.rb

@@ -0,0 +1,27 @@
+module Kontrast
+    class Test
+        attr_reader :name, :path, :spec, :prefix, :headers
+
+        def initialize(prefix, name, path, headers: {})
+            @prefix, @name, @path, @headers = prefix, name, path, headers
+        end
+
+        def bind_spec(spec)
+            @spec = spec
+        end
+
+        # Usage: test.run_callback(:before_screenshot, arg1, arg2, arg3)
+        def run_callback(name, *args)
+            return if @spec.nil?
+            @spec.send(name.to_sym, *args)
+        end
+
+        def to_s
+            return "#{@prefix}_#{@name}"
+        end
+
+        def to_str
+            return to_s
+        end
+    end
+end

data/lib/kontrast/test_builder.rb

@@ -1,12 +1,16 @@
 module Kontrast
+
+    LazyTest = Struct.new(:prefix, :headers, :block)
+
     class TestBuilder
-        def initialize
-            @tests = Hash.new
-        end
+        attr_reader :suite
+        attr_accessor :prefix, :headers, :url_params
 
-        def add_width(width)
-            @tests[width] = Hash.new
-            @current_width = width
+        def initialize
+            @suite = TestSuite.new
+            @prefix = nil
+            @headers = {}
+            @url_params = {}
         end
 
         # Needed in case someone tries to name a test "tests"
@@ -14,12 +18,24 @@ module Kontrast
             if param
                 raise ConfigurationException.new("'tests' is not a valid name for a test.")
             end
-            return @tests
+            return @suite.tests
+        end
+
+        # API
+        # add more?
+        %i(get post).each do |http_method|
+            define_method http_method do |name, path|
+                @suite << ApiEndpointTest.new(@prefix, name, path, headers: headers.dup)
+            end
+        end
+
+        def lazy_api_endpoints(&block)
+            @suite.lazy_tests << LazyTest.new(@prefix, @headers.dup, block)
         end
 
         # Adds a given test from config to the suite
         def method_missing(name, *args)
-            @tests[@current_width][name.to_s] = args.first
+            @suite << PageTest.new(@prefix, name.to_s, args.first, url_params: @url_params)
         end
     end
-end
+end

data/lib/kontrast/test_suite.rb

@@ -0,0 +1,42 @@
+module Kontrast
+    class TestSuite
+        attr_reader :tests, :lazy_tests
+
+        def initialize
+            @tests = []
+            @lazy_tests = []
+        end
+
+        def <<(test)
+            if(!test.is_a?(Test))
+                raise TestSuiteException.new("Cannot add a #{test.class} to the test suite.")
+            end
+            @tests << test
+        end
+
+        # Binds specs to tests automatically by matching the test's name to the spec's name
+        def bind_specs
+            specs = Kontrast.get_spec_builder.specs
+            specs.each do |spec|
+                matched_tests = @tests.select { |t| t.to_s.include?(spec.name) }
+                matched_tests.each { |t| t.bind_spec(spec) }
+            end
+        end
+
+        # For rspec
+        def to_h
+            suite_hash = Hash.new
+
+            @tests.each do |test|
+                suite_hash[test.width] ||= {}
+                suite_hash[test.width][test.name] = test.path
+            end
+
+            return suite_hash
+        end
+
+        def clear!
+            @tests = []
+        end
+    end
+end

data/lib/kontrast/thumbnail_creator.rb

@@ -0,0 +1,18 @@
+module Kontrast
+    module ThumbnailCreator
+
+        def create_thumbnails(test, image_names)
+            # Load images
+            images = image_names.map do |image|
+                Magick::Image.read(File.join(Kontrast.path, test.to_s, image)).first
+            end
+
+            # Crop images
+            Workers.map(images) do |image|
+                filename = image.filename.split('/').last.split('.').first + "_thumb"
+                full_path = "#{Kontrast.path}/#{test}/#{filename}.png"
+                image.resize_to_fill(200, 200, Magick::NorthGravity).write(full_path)
+            end
+        end
+    end
+end

data/lib/kontrast/version.rb

@@ -1,3 +1,3 @@
 module Kontrast
-    VERSION = "0.2.1"
+    VERSION = "0.6.0"
 end

data/spec/api_endpoint_comparator_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe Kontrast::ApiEndpointComparator do
+    let(:app_id) { '123' }
+    let(:app_secret) { '123' }
+    let(:comparator) { Kontrast::ApiEndpointComparator.new }
+    let(:access_token_response) { {'token' => {'access_token' => '123'}} }
+    let(:test_client_connection) {
+        Faraday.new do |builder|
+            builder.adapter :test do |stub|
+                stub.post('/api/v2/oauth/token') { |env| [ 200, {}, access_token_response.to_json ]}
+                stub.get('/api/v2/screen/home') { |env| [ 200, {}, {'foo' => 'bar'}.to_json ]}
+                stub.get('/api/v2/screen/products') { |env| [ 200, {}, {}.to_json ]}
+            end
+        end
+    }
+    let(:fake_test) { double('test', to_s: 'fake_test', headers: {}, path: '/screen/home', name: 'home') }
+
+    let(:prod_client_connection) {
+        Faraday.new do |builder|
+            builder.adapter :test do |stub|
+                stub.post('/api/v2/oauth/token') { |env| [ 200, {}, access_token_response.to_json ]}
+                stub.get('/api/v2/screen/home') { |env| [ 200, {}, {'foo' => 'bar'}.to_json ]}
+                stub.get('/api/v2/screen/products') { |env| [ 200, {}, {}.to_json ]}
+            end
+        end
+    }
+
+    before do
+        Kontrast.configure {}
+        Kontrast.configuration.test_oauth_app_proc = proc { double('app', uid: '123', secret: 'abc') }
+    end
+
+    context 'text data' do
+        context 'with similar data' do
+            it "returns true" do
+                test_home_response = {'foo' => 'bar', 'nested' => {'data' => {'should' => 'work'}}}
+                allow(comparator.test_client).to receive(:fetch_token)
+                allow(comparator.test_client).to receive(:fetch).with('/screen/home', anything)
+                allow(comparator.test_client.responses).to receive(:[]).with('/screen/home').and_return(test_home_response)
+
+                prod_home_response = {'foo' => 'bar', 'nested' => {'data' => {'should' => 'work'}}}
+                allow(comparator.prod_client).to receive(:fetch_token)
+                allow(comparator.prod_client).to receive(:fetch).with('/screen/home', anything)
+                allow(comparator.prod_client.responses).to receive(:[]).with('/screen/home').and_return(prod_home_response)
+
+                expect(comparator.diff(fake_test)).to eq({images: []})
+            end
+        end
+
+        context 'with different data' do
+            it "returns the diff" do
+                test_home_response = {'foo' => 'bar'}
+                allow(comparator.test_client).to receive(:fetch_token)
+                allow(comparator.test_client).to receive(:fetch).with('/screen/home', anything)
+                allow(comparator.test_client.responses).to receive(:[]).with('/screen/home').and_return(test_home_response)
+
+                prod_home_response = {'foo' => 'baz'}
+                allow(comparator.prod_client).to receive(:fetch_token)
+                allow(comparator.prod_client).to receive(:fetch).with('/screen/home', anything).and_return(prod_home_response)
+                allow(comparator.prod_client.responses).to receive(:[]).with('/screen/home').and_return(prod_home_response)
+
+                expect(comparator.diff(fake_test)).to eq({type: 'api_endpoint', images: [], name: 'home', diff: 1})
+            end
+        end
+    end
+
+    context 'images' do
+        let(:test_home_response) {
+            {
+                'foo' => 'bar',
+                'nested' => {
+                    'data' => {
+                        'should' => 'work',
+                        'image' => image1.path,
+                    }
+                },
+                'array1' => [1, 2, 'foo', {'a' => 'b'}, image1.path],
+                'array2' => [1,2,3],
+            }
+        }
+
+        let(:prod_home_response) {
+            {
+                'foo' => 'bar',
+                'nested' => {
+                    'data' => {
+                        'should' => 'work',
+                        'image' => image2.path,
+                    }
+                },
+                'array1' => [1, 2, 'foo', {'a' => 'b'}, image2.path],
+                'array2' => [1,2,3],
+            }
+        }
+
+        before do
+            allow(comparator.test_client).to receive(:fetch_token)
+            allow(comparator.test_client).to receive(:fetch).with('/screen/home', anything)
+            allow(comparator.test_client.responses).to receive(:[]).with('/screen/home').and_return(test_home_response)
+
+            allow(comparator.prod_client).to receive(:fetch_token)
+            allow(comparator.prod_client).to receive(:fetch).with('/screen/home', anything)
+            allow(comparator.prod_client.responses).to receive(:[]).with('/screen/home').and_return(prod_home_response)
+        end
+
+        context 'with similar data' do
+            let(:image1) { File.new(File.expand_path("./spec/support/fixtures/image.jpg")) }
+            let(:image2) { File.new(File.expand_path("./spec/support/fixtures/image_clone.jpg")) }
+
+            it "returns true" do
+                expect(comparator.diff(fake_test)).to eq({images: []})
+            end
+        end
+
+        context 'with different data' do
+            let(:image1) { File.new(File.expand_path("./spec/support/fixtures/image.jpg")) }
+            let(:image2) { File.new(File.expand_path("./spec/support/fixtures/other_image.jpg")) }
+
+            it "returns false" do
+                expect(comparator.diff(fake_test)).to eq({type: 'api_endpoint', images: [{:index=>0}, {:index=>1}], name: 'home', diff: 1})
+            end
+        end
+    end
+end

data/spec/configuration_spec.rb

@@ -50,4 +50,23 @@ describe Kontrast::Configuration do
             gallery: "arg2"
         })
     end
+
+    context "workers pool size" do
+        before do
+            Kontrast.configuration = nil
+            Kontrast.configure {}
+        end
+
+        it "defaults to 5" do
+            expect(Kontrast.configuration.workers_pool_size).to eq(5)
+        end
+
+        it "can be overriden" do
+            Kontrast.configure do |config|
+                config.workers_pool_size = 10
+            end
+
+            expect(Kontrast.configuration.workers_pool_size).to eq(10)
+        end
+    end
 end