kontrast 0.2.1 → 0.6.0

data/lib/kontrast/api_client.rb

@@ -0,0 +1,56 @@
+require 'faraday'
+
+module Kontrast
+    class ApiClient
+
+        attr_reader :responses, :env
+        attr_writer :headers
+
+        def initialize(env, host, app_id, app_secret, headers: {})
+            @env = env
+            @host = host
+            @app_id = app_id
+            @app_secret = app_secret
+            @connection = nil
+            @responses = {}
+            @headers = headers
+        end
+
+        def fetch(path, save_file: false, folder_name: "")
+            response = connection.get(path) do |req|
+                req.headers['Authorization'] = "Bearer #{token}"
+                req.headers.merge!(@headers)
+            end
+            data = JSON.parse(response.body)
+            if save_file
+                open(File.join(Kontrast.path, folder_name, "#{@env}.json"), 'wb') do |file|
+                    file << JSON.pretty_generate(data)
+                end
+            end
+            @responses[path] = data
+            return data
+        end
+
+        def token
+            return @token || fetch_token
+        end
+
+        def fetch_token
+            return @token if !@token.nil? && @token != ''
+
+            response = connection.post(Kontrast.configuration.oauth_token_url, {
+                grant_type: 'client_credentials',
+                client_id: @app_id,
+                client_secret: @app_secret,
+            })
+            @token = Kontrast.configuration.oauth_token_from_response.call(response.body)
+        end
+
+        def connection
+            @connection ||= Faraday.new(url: @host) do |faraday|
+                faraday.request :url_encoded
+                faraday.adapter Faraday.default_adapter
+            end
+        end
+    end
+end

data/lib/kontrast/api_endpoint_comparator.rb

@@ -0,0 +1,126 @@
+require "workers"
+require "kontrast/api_client"
+
+module Kontrast
+    class ApiEndpointComparator
+        attr_reader :diffs, :prod_client, :test_client
+
+        def initialize
+
+            @prod_client = Kontrast::ApiClient.new(
+                'production',
+                Kontrast.configuration.production_domain,
+                Kontrast.configuration.production_oauth_app_uid,
+                Kontrast.configuration.production_oauth_app_secret,
+            )
+
+            test_oauth_app = Kontrast.configuration.test_oauth_app_proc.call
+            @test_client = Kontrast::ApiClient.new(
+                'test',
+                Kontrast.configuration.test_domain,
+                test_oauth_app.uid,
+                test_oauth_app.secret,
+            )
+
+            @image_index = 0
+
+            @result = {}
+
+            # This is where failed diffs will be stored
+            @diffs = {}
+        end
+
+        def diff(test)
+            @image_index = 0
+            @prod_client.headers = test.headers
+            @test_client.headers = test.headers
+
+            # Create the folder
+            FileUtils.mkdir_p(File.join(Kontrast.path, test.to_s))
+
+            Workers.map([@test_client, @prod_client]) do |client|
+                client.fetch(test.path, save_file: true, folder_name: test.to_s)
+            end
+
+            @diffs[test.to_s] = {images: []}
+            if !compare(@prod_client.responses[test.path], @test_client.responses[test.path], test)
+                @diffs[test.to_s].merge!({
+                    type: 'api_endpoint',
+                    name: test.name,
+                    diff: 1,
+                })
+            else
+                # Clear the diff
+                @diffs.delete test.to_s
+            end
+        end
+
+        def compare(prod_data, test_data, test, key: nil)
+
+            if prod_data == test_data
+                return true
+            elsif is_image_string?(prod_data, key)
+                # If it's an image, we need to compare both files
+                if compare_images(prod_data, test_data, test)
+                    return true
+                else
+                    diff_details = { index: @image_index - 1 }
+                    @diffs[test.to_s][:images] << diff_details
+                    return false
+                end
+            elsif prod_data.is_a?(Hash)
+                return false if prod_data.keys != test_data.keys
+
+                return prod_data.map do |key, value|
+                    compare(prod_data[key], test_data[key], test, key: key)
+                end.all?
+            elsif prod_data.is_a?(Array) # Make it more generic?
+                return false if prod_data.length != test_data.length
+
+                return prod_data.map.with_index do |value, i|
+                    compare(prod_data[i], test_data[i], test)
+                end.all?
+            else
+                return false
+            end
+        end
+
+        def is_image_string?(image_string, key)
+            # Either a URL or a local path
+            if !key.nil? && key != ''
+                return key.match(/(image|url)/) && image_string.is_a?(String)
+            else
+                return image_string.is_a?(String) && image_string.match(/^(http|\/)/)
+            end
+        end
+
+        def compare_images(prod_image, test_image, test)
+            images = [
+                {'env' => 'production', 'image' => prod_image},
+                {'env' => 'test', 'image' => test_image},
+            ]
+            files = Workers.map(images) do |image|
+                load_image_file(image['image'], test, image['env'])
+            end
+
+            image_helper = Kontrast::ImageHelper.new(files[0].path, files[1].path)
+
+            diff = image_helper.compare(test.to_s, "diff_#{@image_index}.png")
+
+            @image_index += 1
+            return diff == 0
+        end
+
+        def load_image_file(image, test, prefix)
+            if image.start_with?('http')
+                extension = image.split('.')[-1]
+                file_name = "#{prefix}_#{@image_index}.#{extension}"
+                open(File.join(Kontrast.path, test.to_s, file_name), 'wb') do |file|
+                    file << open(image).read
+                end
+            else
+                File.new(image)
+            end
+        end
+    end
+end

data/lib/kontrast/api_endpoint_runner.rb

@@ -0,0 +1,99 @@
+module Kontrast
+    class ApiEndpointRunner
+        include ImageUploader
+        include ThumbnailCreator
+
+        attr_accessor :diffs
+
+        def initialize
+            @api_diff_comparator = ApiEndpointComparator.new
+            @diffs = {}
+        end
+
+        def run(total_nodes, current_node)
+            # Assign tests and run them
+            suite = split_run(total_nodes, current_node)
+            parallel_run(suite, 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)
+            test_suite = Kontrast.api_endpoint_test_suite
+            if test_suite.nil?
+                return []
+            end
+
+            # Load lazy tests
+            # Some tests are lazy loaded from the initializer
+            # In that case, we stored a block instead of adding a test to the
+            # suite when reading the initializer
+            # We need to execute the block, this will add the test to the suite
+            # This is needed for tests that are dynamically defined: like,
+            # get all the product pages in the DB and create a test for each
+            # one.
+            test_suite.lazy_tests.each do |lazy_test|
+                Kontrast.api_endpoint_test_builder.prefix = lazy_test.prefix
+                Kontrast.api_endpoint_test_builder.headers = lazy_test.headers
+                lazy_test.block.call(Kontrast.api_endpoint_test_builder)
+            end
+            tests_to_run = []
+
+            index = 0
+            test_suite.tests.each do |test|
+                if index % total_nodes == current_node
+                    tests_to_run << test
+                end
+                index += 1
+            end
+
+            return tests_to_run
+        end
+
+        # Runs tests
+        def parallel_run(suite, current_node)
+
+            # Run per-page tasks
+            suite.each do |test|
+                begin
+                    print "Processing #{test.name} @ #{test.prefix}... "
+
+                    # Download the json file
+                    # Create the diff hash, there
+                    @api_diff_comparator.diff(test)
+
+                    # Create thumbnails for gallery
+                    print "Creating thumbnails... "
+                    images = Dir.entries(File.join(Kontrast.path, test.to_s)).reject { |file_name|
+                        ['.', '..'].include?(file_name) || file_name.include?('.json')
+                    }
+
+                    create_thumbnails(test, images)
+
+                    # Upload to S3
+                    if Kontrast.configuration.run_parallel
+                        print "Uploading... "
+                        upload_images(test)
+                    end
+
+                    puts "\n", ("=" * 85)
+                rescue Net::ReadTimeout => e
+                    puts "Test timed out. Message: #{e.inspect}"
+                    if Kontrast.configuration.fail_build
+                        raise e
+                    end
+                rescue StandardError => e
+                    puts "Exception: #{e.inspect}"
+                    puts e.backtrace.inspect
+                    if Kontrast.configuration.fail_build
+                        raise e
+                    end
+                end
+            end
+        ensure
+            # We need the diff at the runner level to create the manifest
+            @diffs = @api_diff_comparator.diffs
+        end
+
+    end
+end

data/lib/kontrast/api_endpoint_test.rb

@@ -0,0 +1,8 @@
+module Kontrast
+    class ApiEndpointTest < Test
+        # We need this class because we want each type of test to have its own
+        # class.
+        # This one doesn't need anything that is not already in the parent Test
+        # class, but PageTest does.
+    end
+end

data/lib/kontrast/configuration.rb

@@ -1,14 +1,26 @@
 module Kontrast
     class << self
-        attr_accessor :configuration, :test_suite
+        attr_accessor :configuration, :page_builder, :api_endpoint_builder
 
         def configure
             self.configuration ||= Configuration.new
             yield(configuration)
         end
 
-        def tests
-            self.test_suite ||= TestBuilder.new
+        def page_test_builder
+            self.page_builder ||= TestBuilder.new
+        end
+
+        def api_endpoint_test_builder
+            self.api_endpoint_builder ||= TestBuilder.new
+        end
+
+        def page_test_suite
+            self.page_builder ? self.page_builder.suite : nil
+        end
+
+        def api_endpoint_test_suite
+            self.api_endpoint_builder ? self.api_endpoint_builder.suite : nil
         end
     end
 
@@ -20,6 +32,10 @@ module Kontrast
         attr_accessor :test_domain, :production_domain
         attr_accessor :browser_driver, :browser_profile
         attr_accessor :fail_build
+        attr_accessor :workers_pool_size
+        attr_accessor :production_oauth_app_uid, :production_oauth_app_secret,
+          :test_oauth_app_uid, :test_oauth_app_secret, :oauth_token_url,
+          :oauth_token_from_response, :test_oauth_app_proc
 
         def initialize
             # Set defaults
@@ -40,7 +56,7 @@ module Kontrast
         def validate
             # Check that Kontrast has everything it needs to proceed
             check_nil_vars(["test_domain", "production_domain"])
-            if Kontrast.test_suite.nil?
+            if Kontrast.page_test_suite.nil? && Kontrast.api_endpoint_test_suite.nil?
                 raise ConfigurationException.new("Kontrast has no tests to run.")
             end
 
@@ -56,12 +72,21 @@ module Kontrast
             end
         end
 
-        def pages(width)
+        def pages(width, url_params = {})
             if !block_given?
                 raise ConfigurationException.new("You must pass a block to the pages config option.")
             end
-            Kontrast.tests.add_width(width)
-            yield(Kontrast.tests)
+            Kontrast.page_test_builder.prefix = width
+            Kontrast.page_test_builder.url_params = url_params
+            yield(Kontrast.page_test_builder)
+        end
+
+        def api_endpoints(group_name)
+            if !block_given?
+                raise ConfigurationException.new("You must pass a block to the api_endpoints config option.")
+            end
+            Kontrast.api_endpoint_test_builder.prefix = group_name
+            yield(Kontrast.api_endpoint_test_builder)
         end
 
         def before_run(&block)
@@ -112,6 +137,10 @@ module Kontrast
             end
         end
 
+        def workers_pool_size
+            @workers_pool_size || 5
+        end
+
         private
             def check_nil_vars(vars)
                 vars.each do |var|

data/lib/kontrast/exceptions.rb

@@ -2,4 +2,5 @@ module Kontrast
     class ConfigurationException < Exception; end
     class GalleryException < Exception; end
     class RunnerException < Exception; end
-end
+    class TestSuiteException < Exception; end
+end

data/lib/kontrast/gallery/template.erb

@@ -2,11 +2,18 @@
 <html lang="en">
     <head>
         <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
+        <script type="text/javascript" src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
+        <script type="text/javascript" src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
         <style type="text/css">
             .short-screenshot {
                 height: 200px;
                 width: 200px;
             }
+            #diffs {
+                position: fixed;
+                z-index: 1;
+                margin-left: 33%;
+            }
         </style>
     </head>
     <body>
@@ -19,10 +26,10 @@
                     <div class="panel">
                         <div class="panel-heading">Screenshots:</div>
                         <ul class="list-group list-group-flush">
-                            <% directories.keys.sort.each do |size| %>
-                                <li class="list-group-item"><strong><%=size%></strong></li>
-                                <% directories[size].keys.each do |name| %>
-                                    <li class="list-group-item"><a href="#<%= "#{size}_#{name}" %>"><%=name%></a></li>
+                            <% groups.sort.each do |group| %>
+                                <li class="list-group-item"><strong><%=group%></strong></li>
+                                <% without_diffs[group].keys.each do |name| %>
+                                    <li class="list-group-item"><a href="#<%= "#{group}_#{name}" %>-nondiff"><%=name%></a></li>
                                 <% end %>
                             <% end %>
                         </ul>
@@ -31,12 +38,12 @@
                 <div class="col-lg-10">
                     <% if diffs.any? %>
                         <div class="row">
-                            <div class="alert alert-warning" role="alert">
+                            <div id="diffs" class="alert alert-warning" role="alert">
                                 Tests with diffs:
                                 <ul>
                                     <% diffs.each do |test, diff| %>
                                         <li>
-                                            <a href="#<%= test %>"><%= test %></a>
+                                            <a href="#<%= test %>-diff"><%= test %></a>
                                         </li>
                                     <% end %>
                                 </ul>
@@ -44,25 +51,149 @@
                         </div>
                     <% end %>
 
-                    <% directories.keys.sort.each do |size| %>
+                    <h1>Diffs</h1>
+                    <% with_diffs.keys.sort.each do |group| %>
+                        <div class="row">
+                            <a name="<%= group %>"></a>
+                            <h2><%= group %></h2>
+                        </div>
+
+                        <% with_diffs[group].each do |test_name, variants| %>
+                            <div id="<%= "#{group}_#{test_name}" %>-diff" class="row">
+                                <div class="row">
+                                    <h2><%= test_name %></h2>
+
+                                    <% if variants.first[:type] == 'page' %>
+                                        <% variants.each do |variant| %>
+                                            <div class="col-lg-3">
+                                                <a href="<%=variant[:image]%>">
+                                                    <img class="short-screenshot img-thumbnail" src="<%=variant[:thumb]%>">
+                                                </a>
+                                                <p class="text-center"><%=variant[:domain]%></p>
+                                                <% if variant[:diff_amt] %>
+                                                    <p class="text-center text-muted"><%=variant[:diff_amt]%></p>
+                                                <% end %>
+                                            </div>
+                                        <% end %>
+                                    <% elsif variants.first[:type] == 'api_endpoint' %>
+                                        <% variants.each do |variant| %>
+                                            <div class="col-lg-3">
+                                                <% if variant[:domain] == 'diff' %>
+                                                    <a>
+                                                        <img class="short-screenshot img-thumbnail" src="http://dummyimage.com/200x200/?text=N/A">
+                                                    </a>
+                                                <% else %>
+                                                    <a href="<%=variant[:file]%>">
+                                                        <img class="short-screenshot img-thumbnail" src="http://dummyimage.com/200x200/?text=JSON">
+                                                    </a>
+                                                <% end %>
+                                                <p class="text-center"><%=variant[:domain]%></p>
+                                            </div>
+                                          <% end %>
+                                    <% end %>
+                                </div>
+                                <% if variants.first[:type] == 'api_endpoint' && variants.first[:images].any? %>
+                                    <h3>Images</h3>
+                                    <% div_id = ["images", test_name, SecureRandom.hex(6)].join('-') %>
+                                    <a class="btn btn-primary" role="button" data-toggle="collapse" href="#<%= div_id %>">
+                                        Expand / Collapse
+                                    </a>
+                                    <div class="collapse" id="<%= div_id %>">
+                                        <% variants.first[:images].each_with_index do |image, i| %>
+                                            <div class="row">
+                                                <% second_image = variants[1][:images][i] %>
+                                                <% diff_image = variants[-1][:images][i] %>
+                                                <div class="col-lg-3">
+                                                    <a href="<%= image[:image] %>">
+                                                        <img class="short-screenshot img-thumbnail" src="<%=image[:thumb]%>">
+                                                    </a>
+                                                </div>
+                                                <div class="col-lg-3">
+                                                    <a href="<%=second_image[:image]%>">
+                                                        <img class="short-screenshot img-thumbnail" src="<%=second_image[:thumb]%>">
+                                                    </a>
+                                                </div>
+                                                <div class="col-lg-3">
+                                                    <a href="<%=diff_image[:image]%>">
+                                                        <img class="short-screenshot img-thumbnail" src="<%=diff_image[:thumb]%>">
+                                                    </a>
+                                                </div>
+                                            </div>
+                                        <% end %>
+                                    </div>
+                                <% end %>
+                            </div>
+                        <% end %>
+                    <% end %>
+
+                    <h1>Non-diffs</h1>
+                    <% without_diffs.keys.sort.each do |group| %>
                         <div class="row">
-                            <a name="<%= size %>"></a>
-                            <h2><%= size %></h2>
+                            <a name="<%= group %>"></a>
+                            <h2><%= group %></h2>
                         </div>
 
-                        <% directories[size].each do |comparison| %>
-                            <div id="<%= "#{size}_#{comparison.first}" %>" class="row">
+                        <% without_diffs[group].each do |test_name, variants| %>
+                            <div id="<%= "#{group}_#{test_name}" %>-nondiff" class="row">
                                 <div class="row">
-                                    <h2><%= comparison.first %></h2>
+                                    <h2><%= test_name %></h2>
+
+                                    <% if variants.first[:type] == 'page' %>
+                                        <% variants.each do |variant| %>
+                                            <div class="col-lg-3">
+                                                <a href="<%=variant[:image]%>">
+                                                    <img class="short-screenshot img-thumbnail" src="<%=variant[:thumb]%>">
+                                                </a>
+                                                <p class="text-center"><%=variant[:domain]%></p>
+                                                <% if variant[:diff_amt] %>
+                                                    <p class="text-center text-muted"><%=variant[:diff_amt]%></p>
+                                                <% end %>
+                                            </div>
+                                        <% end %>
+                                    <% elsif variants.first[:type] == 'api_endpoint' %>
+                                        <% variants.each do |variant| %>
+                                            <div class="col-lg-3">
+                                                <% if variant[:domain] == 'diff' %>
+                                                    <a href="<%=variant[:file]%>">
+                                                        <img class="short-screenshot img-thumbnail" src="http://dummyimage.com/200x200/?text=N/A">
+                                                    </a>
+                                                <% else %>
+                                                    <a href="<%=variant[:file]%>">
+                                                        <img class="short-screenshot img-thumbnail" src="http://dummyimage.com/200x200/?text=JSON">
+                                                    </a>
+                                                <% end %>
+                                                <p class="text-center"><%=variant[:domain]%></p>
+                                            </div>
+                                          <% end %>
+                                    <% end %>
                                 </div>
-                                <% comparison.last[:variants].each do |file| %>
-                                    <div class="col-lg-3">
-                                        <a href="<%=file[:image]%>">
-                                            <img class="short-screenshot img-thumbnail" src="<%=file[:thumb]%>">
-                                        </a>
-                                        <p class="text-center"><%=file[:domain]%></p>
-                                        <% if file[:diff_amt] %>
-                                            <p class="text-center text-muted"><%=file[:diff_amt]%></p>
+
+                                <% if variants.first[:type] == 'api_endpoint' && variants.first[:images].any? %>
+                                    <% div_id = ["images", test_name, SecureRandom.hex(6)].join('-') %>
+                                    <a class="btn btn-primary" role="button" data-toggle="collapse" href="#<%= div_id %>">
+                                        Expand / Collapse
+                                    </a>
+                                    <div class="collapse" id="<%= div_id %>">
+                                        <% variants.first[:images].each_with_index do |image, i| %>
+                                            <div class="row">
+                                                <% second_image = variants[1][:images][i] %>
+                                                <% diff_image = variants[-1][:images][i] %>
+                                                <div class="col-lg-3">
+                                                    <a href="<%= image[:image] %>">
+                                                        <img class="short-screenshot img-thumbnail" src="<%=image[:thumb]%>">
+                                                    </a>
+                                                </div>
+                                                <div class="col-lg-3">
+                                                    <a href="<%=second_image[:image]%>">
+                                                        <img class="short-screenshot img-thumbnail" src="<%=second_image[:thumb]%>">
+                                                    </a>
+                                                </div>
+                                                <div class="col-lg-3">
+                                                    <a href="<%=diff_image[:image]%>">
+                                                        <img class="short-screenshot img-thumbnail" src="<%=diff_image[:thumb]%>">
+                                                    </a>
+                                                </div>
+                                            </div>
                                         <% end %>
                                     </div>
                                 <% end %>
@@ -73,4 +204,4 @@
             </div>
         </div>
     </body>
-</html>
+</html>