kontrast 0.2.1 → 0.6.0

data/lib/kontrast/image_handler.rb

@@ -1,119 +0,0 @@
-require "RMagick"
-require "workers"
-
-module Kontrast
-    class ImageHandler
-        include Magick
-        attr_reader :diffs, :path
-
-        def initialize
-            @path = Kontrast.path
-
-            # This is where failed diffs will be stored
-            @diffs = {}
-        end
-
-        # In order for images to be diff'ed, they need to have the same dimensions
-        def crop_images(width, name)
-            # Load images
-            test_image = Image.read("#{@path}/#{width}_#{name}/test.png").first
-            production_image = Image.read("#{@path}/#{width}_#{name}/production.png").first
-
-            # Let's not do anything if the images are already the same size
-            return if test_image.rows == production_image.rows
-
-            # Get max height of both images
-            max_height = [test_image.rows, production_image.rows].max
-
-            # Crop
-            Workers.map([test_image, production_image]) do |image|
-                image.extent(width, max_height).write(image.filename)
-            end
-        end
-
-        # Uses the compare_channel function to highlight the differences between two images
-        # Docs: http://www.imagemagick.org/RMagick/doc/image1.html#compare_channel
-        def diff_images(width, name)
-            # Load images
-            test_image = Image.read("#{@path}/#{width}_#{name}/test.png").first
-            production_image = Image.read("#{@path}/#{width}_#{name}/production.png").first
-
-            # Compare and save diff
-            diff = test_image.compare_channel(production_image, Magick.const_get(Kontrast.configuration.distortion_metric)) do |options|
-                options.highlight_color = Kontrast.configuration.highlight_color
-                options.lowlight_color = Kontrast.configuration.lowlight_color
-            end
-            diff.first.write("#{@path}/#{width}_#{name}/diff.png")
-
-            # If the images are different, let the class know about it so that it gets added to the manifest
-            if diff.last > 0
-                @diffs["#{width}_#{name}"] = {
-                    width: width,
-                    name: name,
-                    diff: diff.last
-                }
-            end
-        end
-
-        # For the gallery. Not sure if this is really necessary.
-        def create_thumbnails(width, name)
-            # Load images
-            test_image = Image.read("#{@path}/#{width}_#{name}/test.png").first
-            production_image = Image.read("#{@path}/#{width}_#{name}/production.png").first
-            diff_image = Image.read("#{@path}/#{width}_#{name}/diff.png").first
-
-            # Crop images
-            Workers.map([test_image, production_image, diff_image]) do |image|
-                filename = image.filename.split('/').last.split('.').first + "_thumb"
-                image.resize_to_fill(200, 200, NorthGravity).write("#{@path}/#{width}_#{name}/#{filename}.png")
-            end
-        end
-
-        # We upload the images per test
-        def upload_images(width, name)
-            Workers.map(Dir.entries("#{@path}/#{width}_#{name}")) do |file|
-                next if ['.', '..'].include?(file)
-                Kontrast.fog.directories.get(Kontrast.configuration.aws_bucket).files.create(
-                    key: "#{Kontrast.configuration.remote_path}/#{width}_#{name}/#{file}",
-                    body: File.open("#{@path}/#{width}_#{name}/#{file}"),
-                    public: true
-                )
-            end
-        end
-
-        # The manifest is a per-node .json file that is used to create the gallery
-        # without having to download all assets from S3 to the test environment
-        def create_manifest(current_node, build = nil)
-            # Set up structure
-            manifest = {
-                diffs: @diffs,
-                files: []
-            }
-
-            # Dump directories
-            Dir.foreach(@path) do |subdir|
-                next if ['.', '..'].include?(subdir)
-                next if subdir.index('manifest_')
-                Dir.foreach("#{@path}/#{subdir}") do |img|
-                    next if ['.', '..'].include?(img)
-                    manifest[:files] << "#{subdir}/#{img}"
-                end
-            end
-
-            if Kontrast.configuration.run_parallel
-                # Upload manifest
-                Kontrast.fog.directories.get(Kontrast.configuration.aws_bucket).files.create(
-                    key: "#{build}/manifest_#{current_node}.json",
-                    body: manifest.to_json
-                )
-            else
-                # Write manifest
-                File.open("#{@path}/manifest_#{current_node}.json", 'w') do |outf|
-                    outf.write(manifest.to_json)
-                end
-            end
-
-            return manifest
-        end
-    end
-end

data/lib/kontrast/runner.rb

@@ -1,141 +0,0 @@
-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/spec/runner_spec.rb

@@ -1,37 +0,0 @@
-describe Kontrast::Runner 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
-        @runner = Kontrast::Runner.new
-    end
-
-    describe "split_run" do
-        it "return all tests when there is only one node" do
-            expect(@runner.split_run(1, 0)).to eql(Kontrast.test_suite.tests)
-        end
-
-        it "returns a subset of the tests when there are multiple nodes" do
-            tests = @runner.split_run(4, 0)
-
-            expect(tests).not_to eql Kontrast.test_suite.tests
-            expect(tests).to eql({
-                1280 => {
-                    "home" => "/"
-                },
-                320 => {}
-            })
-        end
-    end
-end