kontrast 0.2.1 → 0.6.0

data/spec/gallery_creator_spec.rb

@@ -5,8 +5,8 @@ describe Kontrast::GalleryCreator do
     end
 
     before :each do
-        @image_handler = Kontrast::ImageHandler.new
-        @gallery_creator = Kontrast::GalleryCreator.new(@image_handler.path)
+        @page_comparator = Kontrast::PageComparator.new
+        @gallery_creator = Kontrast::GalleryCreator.new(@page_comparator.path)
     end
 
     it "can parse manifests" do
@@ -27,16 +27,16 @@ describe Kontrast::GalleryCreator do
             diffs: {}
         }
 
-        File.open("#{@image_handler.path}/manifest_0.json", 'w') do |outf|
+        File.open("#{@page_comparator.path}/manifest_0.json", 'w') do |outf|
             outf.write(manifest_1.to_json)
         end
-        File.open("#{@image_handler.path}/manifest_1.json", 'w') do |outf|
+        File.open("#{@page_comparator.path}/manifest_1.json", 'w') do |outf|
             outf.write(manifest_2.to_json)
         end
 
         # Test get_manifests while we're at it
         manifests = @gallery_creator.get_manifests
-        expect(manifests).to include(@image_handler.path + "/manifest_0.json", @image_handler.path + "/manifest_1.json")
+        expect(manifests).to include(@page_comparator.path + "/manifest_0.json", @page_comparator.path + "/manifest_1.json")
 
         # Parse
         parsed_manifests = @gallery_creator.parse_manifests(manifests)
@@ -84,22 +84,28 @@ describe Kontrast::GalleryCreator do
             }
         }
 
-        dirs = @gallery_creator.parse_directories(files, diffs)
-        expect(dirs).to eql({
-            "1280" => {
-                "home" => {
-                    :variants => [{:image=>"../1280_home/test.png", :thumb=>"../1280_home/test_thumb.png", :domain=>"test"},
-                                {:image=>"../1280_home/production.png", :thumb=>"../1280_home/production_thumb.png", :domain=>"production"},
-                                {:image=>"../1280_home/diff.png", :thumb=>"../1280_home/diff_thumb.png", :domain=>"diff", :diff_amt=>0.1337}]
-                    }
-                },
+
+        groups, without_diffs, with_diffs = @gallery_creator.parse_directories(files, diffs)
+
+        expect(groups).to eq(['1280', '320'])
+        expect(without_diffs).to eql({
             "320" => {
-                "home" => {
-                    :variants => [{:image=>"../320_home/test.png", :thumb=>"../320_home/test_thumb.png", :domain=>"test"},
-                                {:image=>"../320_home/production.png", :thumb=>"../320_home/production_thumb.png", :domain=>"production"},
-                                {:image=>"../320_home/diff.png", :thumb=>"../320_home/diff_thumb.png", :domain=>"diff", :diff_amt=>0}]
-                    }
-            }
+                "home" => [
+                  {:image=>"../320_home/test.png", :thumb=>"../320_home/test_thumb.png", :domain=>"test", :type=>'page'},
+                  {:image=>"../320_home/production.png", :thumb=>"../320_home/production_thumb.png", :domain=>"production", :type=>'page'},
+                  {:image=>"../320_home/diff.png", :thumb=>"../320_home/diff_thumb.png", :domain=>"diff", :type=>'page'},
+                ],
+            },
+        })
+
+        expect(with_diffs).to eql({
+            "1280" => {
+                "home" => [
+                  {:image=>"../1280_home/test.png", :thumb=>"../1280_home/test_thumb.png", :domain=>"test", :type=>'page'},
+                  {:image=>"../1280_home/production.png", :thumb=>"../1280_home/production_thumb.png", :domain=>"production", :type=>'page'},
+                  {:image=>"../1280_home/diff.png", :thumb=>"../1280_home/diff_thumb.png", :domain=>"diff", :diff_amt=>0.1337, :type=>'page'}
+                ],
+            },
         })
     end
 end

data/spec/{image_handler_spec.rb → global_runner_spec.rb}

@@ -1,4 +1,4 @@
-describe Kontrast::ImageHandler do
+describe Kontrast::GlobalRunner do
     before :all do
         Kontrast.configure do |config|
             # Set up some tests
@@ -11,32 +11,37 @@ describe Kontrast::ImageHandler do
                 page.products "/"
             end
         end
+
+        Kontrast.configuration.test_oauth_app_proc = proc { double('app', uid: '123', secret: 'abc') }
     end
 
     before :each do
-        @image_handler = Kontrast::ImageHandler.new
+        @page_comparator = Kontrast::PageComparator.new
+
+        @page_runner = Kontrast::PageRunner.new
+        @page_runner.instance_variable_set("@page_comparator", @page_comparator)
+
+        @runner = Kontrast::GlobalRunner.new
+        @runner.instance_variable_set("@page_runner", @page_runner)
     end
 
     it "can create a manifest for the current node" do
         # Create some files
-        Kontrast.test_suite.tests.each do |size, tests|
-            tests.each do |name, path|
-                test_name = "#{size}_#{name}"
-                path = FileUtils.mkdir_p(@image_handler.path + "/#{test_name}").join('')
-                Dir.chdir(path)
-                FileUtils.touch("diff_thumb.png")
-            end
+        Kontrast.page_test_suite.tests.each do |test|
+            test_name = "#{test.width}_#{test.name}"
+            path = FileUtils.mkdir_p(@page_comparator.path + "/#{test_name}").join('')
+            FileUtils.touch(File.join(path, 'diff_thumb.png'))
         end
 
         # Create a diff
-        @image_handler.diffs["1280_home"] = {
+        @page_runner.diffs["1280_home"] = {
             width: 1280,
             name: "home",
             diff: 0.1337
         }
 
         # Create the manifest
-        contents = @image_handler.create_manifest(0)
+        contents = @runner.create_manifest
 
         # Expectations
         expect(contents[:diffs]).to eql({
@@ -49,4 +54,4 @@ describe Kontrast::ImageHandler do
 
         expect(contents[:files]).to include("1280_home/diff_thumb.png", "1280_products/diff_thumb.png", "320_home/diff_thumb.png", "320_products/diff_thumb.png")
     end
-end
+end

data/spec/page_comparator_spec.rb

@@ -0,0 +1,31 @@
+describe Kontrast::PageComparator do
+    before :all do
+        Kontrast.configure {}
+    end
+
+    let(:page_comparator) { Kontrast::PageComparator.new }
+    let(:img1_path) { File.expand_path("./spec/support/fixtures/img1.jpg") }
+    let(:img2_path) { File.expand_path("./spec/support/fixtures/img2.jpg") }
+    let(:test) { double("Test", width: 1280, name: 'fake_test', to_s: '1280') }
+
+    before do
+        allow(page_comparator).to receive(:test_image_path).with(anything).and_return(img1_path)
+        allow(page_comparator).to receive(:production_image_path).with(anything).and_return(img2_path)
+    end
+
+    it "can diff images" do
+
+        page_comparator.diff(test)
+
+        # The diff might be different on other systems
+        diff = page_comparator.diffs['1280'].delete(:diff)
+        expect(page_comparator.diffs).to eq({
+            '1280' => {
+                type: 'page',
+                width: 1280,
+                name: 'fake_test',
+            }
+        })
+        expect(diff).to be_within(0.0001).of(0.1985086492134394)
+    end
+end

data/spec/page_runner_spec.rb

@@ -0,0 +1,45 @@
+describe Kontrast::PageRunner do
+    before :all do
+        Kontrast.configure do |config|
+            # Set up some tests
+            config.pages(1280) do |page|
+                page.home "/"
+                page.products "/products"
+            end
+            config.pages(320) do |page|
+                page.home "/"
+                page.products "/products"
+            end
+        end
+    end
+
+    before :each do
+        @page_runner = Kontrast::PageRunner.new
+    end
+
+    describe "split_run" do
+        it "return all tests when there is only one node" do
+            suite = Kontrast::TestSuite.new
+            @page_runner.split_run(1, 0).each { |t| suite << t }
+            expect(suite.to_h).to eql(Kontrast.page_test_suite.to_h)
+        end
+
+        it "returns a subset of the tests when there are multiple nodes" do
+            # Expect no split to be complete but all splits should combine into the total suite
+            collector_hash = Hash.new
+            (0..3).each do |i|
+                tests = @page_runner.split_run(4, i)
+                suite = Kontrast::TestSuite.new
+                tests.each { |t| suite << t }
+                expect(suite.to_h).to_not eql(Kontrast.page_test_suite.to_h)
+
+                suite.tests.each do |test|
+                    collector_hash[test.width] ||= {}
+                    collector_hash[test.width][test.name] = test.path
+                end
+            end
+
+            expect(collector_hash).to eql(Kontrast.page_test_suite.to_h)
+        end
+    end
+end

data/spec/spec_builder_spec.rb

@@ -0,0 +1,32 @@
+describe Kontrast::SpecBuilder do
+    before :each do
+        # Reset the spec suite
+        Kontrast.get_spec_builder.clear!
+    end
+
+    context "with a spec description" do
+        before :each do
+            Kontrast.describe("test_spec") do |spec|
+                spec.before_screenshot do |test_driver, production_driver, test|
+                    "before! #{test_driver} #{production_driver} #{test}"
+                end
+                spec.after_screenshot do |test_driver, production_driver, test|
+                    "after! #{test_driver} #{production_driver} #{test}"
+                end
+            end
+        end
+
+        it "can build a spec" do
+            expect(Kontrast.get_spec_builder.specs.length).to eql 1
+            expect(Kontrast.get_spec_builder.specs.first.name).to eql "test_spec"
+        end
+
+        it "can run the spec's callbacks along with arguments" do
+            before_response = Kontrast.get_spec_builder.specs.first.before_screenshot(1, 2, 3)
+            expect(before_response).to eql("before! 1 2 3")
+
+            after_response = Kontrast.get_spec_builder.specs.first.after_screenshot(1, 2, 3)
+            expect(after_response).to eql("after! 1 2 3")
+        end
+    end
+end

data/spec/test_builder_spec.rb

@@ -1,7 +1,9 @@
 describe Kontrast::TestBuilder do
     before :each do
         # Reset the test suite
-        Kontrast.test_suite = nil
+        if !Kontrast.page_test_suite.nil?
+            Kontrast.page_test_suite.clear!
+        end
     end
 
     it "can build a test suite" do
@@ -15,7 +17,8 @@ describe Kontrast::TestBuilder do
                 page.other_stuff = "/other-stuff"
             end
         end
-        expect(Kontrast.test_suite.tests).to eql({
+
+        expect(Kontrast.page_test_suite.to_h).to eql({
             1280 => {
                 "home" => "/",
                 "products" => "/products"
@@ -33,7 +36,7 @@ describe Kontrast::TestBuilder do
                 page.home "/"
             end
         end
-        expect(Kontrast.test_suite.tests).to eql({
+        expect(Kontrast.page_test_suite.to_h).to eql({
             1280 => {
                 "home" => "/"
             }

data/spec/test_spec.rb

@@ -0,0 +1,53 @@
+describe Kontrast::Test do
+    before :each do
+        # Reset specs & tests
+        Kontrast.get_spec_builder.clear!
+        if !Kontrast.page_test_suite.nil?
+            Kontrast.page_test_suite.clear!
+        end
+
+        # Add a spec and a test
+        Kontrast.describe("test") do |spec|
+            spec.before_screenshot do |test_driver, production_driver, test|
+                "before! #{test_driver} #{production_driver} #{test}"
+            end
+        end
+        Kontrast.configure do |config|
+            config.pages(1280) do |page|
+                page.test "/"
+            end
+        end
+        Kontrast.page_test_suite.bind_specs
+    end
+
+    it "can run a spec's callback" do
+        test = Kontrast.page_test_suite.tests.first
+        expect(test.run_callback(:before_screenshot, 1, 2, 3)).to eql("before! 1 2 3")
+    end
+
+    it "doesn't run a callback if it doesn't exist" do
+        test = Kontrast.page_test_suite.tests.first
+        expect { test.run_callback(:foo, 1) }.to raise_error(NoMethodError)
+    end
+
+    context "with a URI query" do
+        before :each do
+            Kontrast.configure do |config|
+                config.pages(1280, global_key: "global_value") do |page|
+                    page.simple_path_test "/about"
+                    page.complex_path_test "/about?key=value"
+                end
+            end
+        end
+
+        it "can build a path with global URL params only" do
+            test = Kontrast.page_test_suite.tests.find { |t| t.name == "simple_path_test" }
+            expect(test.path).to eql "/about?global_key=global_value"
+        end
+
+        it "can build a path with global and local URL params" do
+            test = Kontrast.page_test_suite.tests.find { |t| t.name == "complex_path_test" }
+            expect(test.path).to eql "/about?global_key=global_value&key=value"
+        end
+    end
+end

data/spec/test_suite_spec.rb

@@ -0,0 +1,56 @@
+describe Kontrast::TestSuite do
+    context "with a spec description and a test suite" do
+        before :each do
+            # Reset tests & specs
+            Kontrast.get_spec_builder.clear!
+            if !Kontrast.page_test_suite.nil?
+                Kontrast.page_test_suite.clear!
+            end
+
+            Kontrast.describe("test") do |spec|
+                spec.before_screenshot do |test_driver, production_driver, test|
+                    puts "before"
+                end
+                spec.after_screenshot do |test_driver, production_driver, test|
+                    puts "after"
+                end
+            end
+
+            Kontrast.configure do |config|
+                config.pages(1280) do |page|
+                    page.test "/"
+                    page.something_else "/foo"
+                end
+                config.pages(320) do |page|
+                    page.test "/"
+                end
+            end
+        end
+
+        it "can bind specs to tests" do
+            test_320 = Kontrast.page_test_suite.tests.find { |t| t.width == 320 }
+            test_1280 = Kontrast.page_test_suite.tests.find { |t| t.width == 1280 }
+            test_foo = Kontrast.page_test_suite.tests.find { |t| t.name == "something_else" }
+
+            Kontrast.page_test_suite.bind_specs
+
+            test_spec = Kontrast.get_spec_builder.specs.first
+            expect(test_320.spec).to eql(test_spec)
+            expect(test_1280.spec).to eql(test_spec)
+            expect(test_foo.spec).to be_nil
+        end
+    end
+
+    it "can add new tests to the suite" do
+        suite = Kontrast::TestSuite.new
+        t = Kontrast::Test.new(1280, "foo", "/")
+        suite << t
+        expect(suite.tests).to include(t)
+    end
+
+    it "can't add non-tests to the suite" do
+        suite = Kontrast::TestSuite.new
+        t = "foo"
+        expect { suite << t }.to raise_error(Kontrast::TestSuiteException)
+    end
+end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: kontrast
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Ilya Rubnich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-24 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: workers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
@@ -123,19 +123,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.13.2
 - !ruby/object:Gem::Dependency
-  name: fog
+  name: fog-aws
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: Kontrast is a testing tool that lets you build a frontend test suite
   to run against your test and production websites. It uses Selenium to take screenshots
   and ImageMagick to compare them. Kontrast then produces a detailed gallery of its
@@ -152,22 +180,45 @@ files:
 - Rakefile
 - bin/kontrast
 - lib/kontrast.rb
+- lib/kontrast/api_client.rb
+- lib/kontrast/api_endpoint_comparator.rb
+- lib/kontrast/api_endpoint_runner.rb
+- lib/kontrast/api_endpoint_test.rb
 - lib/kontrast/config/template.rb
 - lib/kontrast/configuration.rb
 - lib/kontrast/exceptions.rb
 - lib/kontrast/gallery/template.erb
 - lib/kontrast/gallery_creator.rb
-- lib/kontrast/image_handler.rb
-- lib/kontrast/runner.rb
+- lib/kontrast/global_runner.rb
+- lib/kontrast/image_helper.rb
+- lib/kontrast/image_uploader.rb
+- lib/kontrast/page_comparator.rb
+- lib/kontrast/page_runner.rb
+- lib/kontrast/page_test.rb
 - lib/kontrast/selenium_handler.rb
+- lib/kontrast/spec.rb
+- lib/kontrast/spec_builder.rb
+- lib/kontrast/test.rb
 - lib/kontrast/test_builder.rb
+- lib/kontrast/test_suite.rb
+- lib/kontrast/thumbnail_creator.rb
 - lib/kontrast/version.rb
+- spec/api_endpoint_comparator_spec.rb
 - spec/configuration_spec.rb
 - spec/gallery_creator_spec.rb
-- spec/image_handler_spec.rb
-- spec/runner_spec.rb
+- spec/global_runner_spec.rb
+- spec/page_comparator_spec.rb
+- spec/page_runner_spec.rb
+- spec/spec_builder_spec.rb
 - spec/spec_helper.rb
+- spec/support/fixtures/image.jpg
+- spec/support/fixtures/image_clone.jpg
+- spec/support/fixtures/img1.jpg
+- spec/support/fixtures/img2.jpg
+- spec/support/fixtures/other_image.jpg
 - spec/test_builder_spec.rb
+- spec/test_spec.rb
+- spec/test_suite_spec.rb
 homepage: https://github.com/harrystech/kontrast
 licenses:
 - MIT
@@ -178,25 +229,35 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: An automated testing tool for comparing visual differences between two versions
   of a website.
 test_files:
+- spec/api_endpoint_comparator_spec.rb
 - spec/configuration_spec.rb
 - spec/gallery_creator_spec.rb
-- spec/image_handler_spec.rb
-- spec/runner_spec.rb
+- spec/global_runner_spec.rb
+- spec/page_comparator_spec.rb
+- spec/page_runner_spec.rb
+- spec/spec_builder_spec.rb
 - spec/spec_helper.rb
+- spec/support/fixtures/image.jpg
+- spec/support/fixtures/image_clone.jpg
+- spec/support/fixtures/img1.jpg
+- spec/support/fixtures/img2.jpg
+- spec/support/fixtures/other_image.jpg
 - spec/test_builder_spec.rb
+- spec/test_spec.rb
+- spec/test_suite_spec.rb