kontrast 0.2.1

data/lib/kontrast/runner.rb

@@ -0,0 +1,141 @@
+require "yaml"
+require "net/http"
+
+module Kontrast
+    class Runner
+        def initialize
+        end
+
+        def run
+            # Make sure the local server is running
+            wait_for_server
+
+            # Assign nodes
+            if Kontrast.configuration.run_parallel
+                total_nodes = Kontrast.configuration.total_nodes
+                current_node = Kontrast.configuration.current_node
+            else
+                # Override the config for local use
+                total_nodes = 1
+                current_node = 0
+            end
+
+            # Assign tests and run them
+            to_run = split_run(total_nodes, current_node)
+            parallel_run(to_run, current_node)
+        end
+
+        # Given the total number of nodes and the index of the current node,
+        # we determine which tests the current node will run
+        def split_run(total_nodes, current_node)
+            all_tests = Kontrast.test_suite.tests
+            tests_to_run = Hash.new
+
+            index = 0
+            all_tests.each do |width, pages|
+                next if pages.nil?
+                tests_to_run[width] = {}
+                pages.each do |name, path|
+                    if index % total_nodes == current_node
+                        tests_to_run[width][name] = path
+                    end
+                    index += 1
+                end
+            end
+
+            return tests_to_run
+        end
+
+        # Runs tests, handles all image operations, creates manifest for current node
+        def parallel_run(tests, current_node)
+            # Load test handlers
+            @selenium_handler = SeleniumHandler.new
+            @image_handler = ImageHandler.new
+
+            begin
+                # Run per-page tasks
+                tests.each do |width, pages|
+                    next if pages.nil?
+                    pages.each do |name, path|
+                        print "Processing #{name} @ #{width}... "
+
+                        # Run the browser and take screenshots
+                        @selenium_handler.run_comparison(width, path, name)
+
+                        # Crop images
+                        print "Cropping... "
+                        @image_handler.crop_images(width, name)
+
+                        # Compare images
+                        print "Diffing... "
+                        @image_handler.diff_images(width, name)
+
+                        # Create thumbnails for gallery
+                        print "Creating thumbnails... "
+                        @image_handler.create_thumbnails(width, name)
+
+                        # Upload to S3
+                        if Kontrast.configuration.run_parallel
+                            print "Uploading... "
+                            @image_handler.upload_images(width, name)
+                        end
+
+                        puts "\n", ("=" * 85)
+                    end
+                end
+
+                # Log diffs
+                puts @image_handler.diffs
+
+                # Create manifest
+                puts "Creating manifest..."
+                if Kontrast.configuration.run_parallel
+                    @image_handler.create_manifest(current_node, Kontrast.configuration.remote_path)
+                else
+                    @image_handler.create_manifest(current_node)
+                end
+            ensure
+                @selenium_handler.cleanup
+            end
+        end
+
+        private
+            def wait_for_server
+                # Test server
+                tries = 30
+                uri = URI(Kontrast.configuration.test_domain)
+                begin
+                    Net::HTTP.get(uri)
+                rescue Errno::ECONNREFUSED => e
+                    tries -= 1
+                    if tries > 0
+                        puts "Waiting for test server..."
+                        sleep 2
+                        retry
+                    else
+                        raise RunnerException.new("Could not reach the test server at '#{uri}'.")
+                    end
+                rescue Exception => e
+                    raise RunnerException.new("An unexpected error occured while trying to reach the test server at '#{uri}': #{e.inspect}")
+                end
+
+                # Production server
+                tries = 30
+                uri = URI(Kontrast.configuration.production_domain)
+                begin
+                    Net::HTTP.get(uri)
+                rescue Errno::ECONNREFUSED => e
+                    tries -= 1
+                    if tries > 0
+                        puts "Waiting for production server..."
+                        sleep 2
+                        retry
+                    else
+                        raise RunnerException.new("Could not reach the production server at '#{uri}'.")
+                    end
+                rescue Exception => e
+                    raise RunnerException.new("An unexpected error occured while trying to reach the production server at '#{uri}': #{e.inspect}")
+                end
+            end
+    end
+end

data/lib/kontrast/selenium_handler.rb

@@ -0,0 +1,84 @@
+require "selenium-webdriver"
+require "workers"
+
+module Kontrast
+    class SeleniumHandler
+        def initialize
+            @path = Kontrast.path
+
+            # Configure profile
+            driver_name = Kontrast.configuration.browser_driver
+            profile = Selenium::WebDriver.const_get(driver_name.capitalize)::Profile.new
+            Kontrast.configuration.browser_profile.each do |option, value|
+                profile[option] = value
+            end
+
+            # Get drivers with profile
+            @test_driver = {
+                name: "test",
+                driver: Selenium::WebDriver.for(driver_name.to_sym, profile: profile)
+            }
+            @production_driver = {
+                name: "production",
+                driver: Selenium::WebDriver.for(driver_name.to_sym, profile: profile)
+            }
+        end
+
+        def cleanup
+            # Make sure windows are closed
+            Workers.map([@test_driver, @production_driver]) do |driver|
+                driver[:driver].quit
+            end
+        end
+
+        def run_comparison(width, path, name)
+            # Create folder for this test
+            current_output = FileUtils.mkdir_p("#{@path}/#{width}_#{name}").join('')
+
+            # Open test host tabs
+            navigate(path)
+
+            # Resize to given width and total height
+            resize(width)
+
+            # Take screenshot
+            begin
+                Kontrast.configuration.before_screenshot(@test_driver[:driver], @production_driver[:driver], { width: width, name: name })
+                screenshot(current_output)
+            ensure
+                Kontrast.configuration.after_screenshot(@test_driver[:driver], @production_driver[:driver], { width: width, name: name })
+            end
+        end
+
+        private
+            def navigate(path)
+                # Get domains
+                test_host = Kontrast.configuration.test_domain
+                production_host = Kontrast.configuration.production_domain
+
+                Workers.map([@test_driver, @production_driver]) do |driver|
+                    if driver[:name] == "test"
+                        driver[:driver].navigate.to("#{test_host}#{path}")
+                    elsif driver[:name] == "production"
+                        driver[:driver].navigate.to("#{production_host}#{path}")
+                    end
+                end
+            end
+
+            def resize(width)
+                Workers.map([@test_driver, @production_driver]) do |driver|
+                    driver[:driver].manage.window.resize_to(width, driver[:driver].manage.window.size.height)
+                end
+            end
+
+            def screenshot(output_path)
+                Workers.map([@test_driver, @production_driver]) do |driver|
+                    if driver[:name] == "test"
+                        driver[:driver].save_screenshot("#{output_path}/test.png")
+                    elsif driver[:name] == "production"
+                        driver[:driver].save_screenshot("#{output_path}/production.png")
+                    end
+                end
+            end
+    end
+end

data/lib/kontrast/test_builder.rb

@@ -0,0 +1,25 @@
+module Kontrast
+    class TestBuilder
+        def initialize
+            @tests = Hash.new
+        end
+
+        def add_width(width)
+            @tests[width] = Hash.new
+            @current_width = width
+        end
+
+        # Needed in case someone tries to name a test "tests"
+        def tests(param = nil)
+            if param
+                raise ConfigurationException.new("'tests' is not a valid name for a test.")
+            end
+            return @tests
+        end
+
+        # Adds a given test from config to the suite
+        def method_missing(name, *args)
+            @tests[@current_width][name.to_s] = args.first
+        end
+    end
+end

data/lib/kontrast/version.rb

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

data/spec/configuration_spec.rb

@@ -0,0 +1,53 @@
+describe Kontrast::Configuration do
+    it "can set basic options" do
+        Kontrast.configure do |config|
+            config.test_domain = "http://google.com"
+        end
+        expect(Kontrast.configuration.test_domain).to eql "http://google.com"
+    end
+
+    it "cannot set options that don't exist" do
+        expect {
+            Kontrast.configure do |config|
+                config.foo = "bar"
+            end
+        }.to raise_error(NoMethodError)
+    end
+
+    it "sets defaults" do
+        # Set up a config block with no options
+        Kontrast.configure do |config|
+        end
+
+        # Check that we have some defaults
+        expect(Kontrast.configuration.browser_driver).to eql "firefox"
+        expect(Kontrast.configuration.run_parallel).to eql false
+        expect(Kontrast.configuration.distortion_metric).to eql "MeanAbsoluteErrorMetric"
+    end
+
+    it "sets up and runs blocks" do
+        Kontrast.configure do |config|
+            config.before_run do
+                x = 1
+                x += 1
+                # Implicit return of x
+            end
+        end
+        expect(Kontrast.configuration.before_run).to eql 2
+    end
+
+    it "passes data to some blocks" do
+        Kontrast.configure do |config|
+            config.after_gallery do |diffs, gallery|
+                {
+                    diffs: diffs,
+                    gallery: gallery
+                }
+            end
+        end
+        expect(Kontrast.configuration.after_gallery("arg1", "arg2")).to eql({
+            diffs: "arg1",
+            gallery: "arg2"
+        })
+    end
+end

data/spec/gallery_creator_spec.rb

@@ -0,0 +1,105 @@
+describe Kontrast::GalleryCreator do
+    before :all do
+        Kontrast.configure do |config|
+        end
+    end
+
+    before :each do
+        @image_handler = Kontrast::ImageHandler.new
+        @gallery_creator = Kontrast::GalleryCreator.new(@image_handler.path)
+    end
+
+    it "can parse manifests" do
+        # Create fake manifests
+        manifest_1 = {
+            files: ["1280_home/diff.png", "1280_home/diff_thumb.png", "1280_home/production.png", "1280_home/production_thumb.png", "1280_home/test.png", "1280_home/test_thumb.png"],
+            diffs: {
+                "1280_home" => {
+                    width: 1280,
+                    name: "home",
+                    diff: 0.1337
+                }
+            }
+        }
+
+        manifest_2 = {
+            files: ["320_home/production.png", "320_home/production_thumb.png", "320_home/test.png", "320_home/test_thumb.png", "320_home/diff.png", "320_home/diff_thumb.png"],
+            diffs: {}
+        }
+
+        File.open("#{@image_handler.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|
+            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")
+
+        # Parse
+        parsed_manifests = @gallery_creator.parse_manifests(manifests)
+
+        expect(parsed_manifests[:diffs]).to eql({
+            "1280_home" => {
+                "width" => 1280,
+                "name" => "home",
+                "diff" => 0.1337
+            }
+        })
+
+        expect(parsed_manifests[:files]).to include("1280_home/diff.png",
+                   "1280_home/diff_thumb.png",
+                   "1280_home/production.png",
+                   "1280_home/production_thumb.png",
+                   "1280_home/test.png",
+                   "1280_home/test_thumb.png",
+                   "320_home/production.png",
+                   "320_home/production_thumb.png",
+                   "320_home/test.png",
+                   "320_home/test_thumb.png",
+                   "320_home/diff.png",
+                   "320_home/diff_thumb.png")
+    end
+
+    it "can create the gallery hash" do
+        files = ["1280_home/diff.png",
+                   "1280_home/diff_thumb.png",
+                   "1280_home/production.png",
+                   "1280_home/production_thumb.png",
+                   "1280_home/test.png",
+                   "1280_home/test_thumb.png",
+                   "320_home/production.png",
+                   "320_home/production_thumb.png",
+                   "320_home/test.png",
+                   "320_home/test_thumb.png",
+                   "320_home/diff.png",
+                   "320_home/diff_thumb.png"]
+        diffs = {
+            "1280_home" => {
+                "width" => 1280,
+                "name" => "home",
+                "diff" => 0.1337
+            }
+        }
+
+        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}]
+                    }
+                },
+            "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}]
+                    }
+            }
+        })
+    end
+end

data/spec/image_handler_spec.rb

@@ -0,0 +1,52 @@
+describe Kontrast::ImageHandler do
+    before :all do
+        Kontrast.configure do |config|
+            # Set up some tests
+            config.pages(1280) do |page|
+                page.home "/"
+                page.products "/"
+            end
+            config.pages(320) do |page|
+                page.home "/"
+                page.products "/"
+            end
+        end
+    end
+
+    before :each do
+        @image_handler = Kontrast::ImageHandler.new
+    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
+        end
+
+        # Create a diff
+        @image_handler.diffs["1280_home"] = {
+            width: 1280,
+            name: "home",
+            diff: 0.1337
+        }
+
+        # Create the manifest
+        contents = @image_handler.create_manifest(0)
+
+        # Expectations
+        expect(contents[:diffs]).to eql({
+            "1280_home" => {
+                :width => 1280,
+                :name=> "home" ,
+                :diff => 0.1337
+            }
+        })
+
+        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