integration-diff 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56099739623d94131dbb655d6f2a6fcc3b7ba644
-  data.tar.gz: a9a405856011a2e5d4750d127fc5302de202a768
+  metadata.gz: 97cfcbbd84c5a7bc1b00555ea38c2437d26303ae
+  data.tar.gz: 9337a1a04ecf3b7e95f7a92a647f5aad83d0d886
 SHA512:
-  metadata.gz: 34385079e07bedca35e2d84bc0457707ff769eb471c8182546869d19590b224bef20be92e1cfc5dc5dc1e46c571d87542d469a95922e6a99bc5765bd8e8d7445
-  data.tar.gz: f96ad96632e09ddca7597a81347cd9f37ee4222f5be9ea228331a2c9a079c2249079e1a49bd2dc41ee1f0e3e7c255d2264806f2fc52e12f70b9662120e259bcf
+  metadata.gz: d16826719150fe1768d51bb968b1a97c18ab793a08b0ce156ef12f0bded4ca0eaeef8e39cc116f648882ac3cd02ad1f9f5d8db0e04708b1d79c630782bd506d0
+  data.tar.gz: b53301ceadb3023d6f0be26ab4263bd296011e1f81bed949d4f5a18c45e657c653430994b72d5cc4377c5d2ca765d5314b94f7b64d07d3a3aa74084f64774db9

data/Readme.md

@@ -73,3 +73,13 @@ describe "Landing page" do
   end
 end
 ```
+
+### Concurrency
+
+By default, when all the screenshots are collected, and before suite ends, this
+gem will upload all the screenshots taken. `IntegrationDiff.wrap_run` is the
+method responsible for the same.
+
+However, if you want to upload screenshots as and when they are taken, this gem
+has soft dependency on `concurrent-ruby` gem. Make sure that this gem is
+**required** before capturing screenshots, and see the magic yourself :)

data/lib/integration_diff/runner.rb

@@ -1,32 +1,31 @@
 require 'time'
 require 'json'
 require 'integration_diff/run_details'
+require 'integration_diff/uploader'
+require 'integration_diff/utils'
 
 module IntegrationDiff
   class Runner
     include Capybara::DSL
 
-    DIR = 'tmp/idiff_images'.freeze
-
     def self.instance
-      @runner ||= Runner.new(IntegrationDiff.base_uri,
-                             IntegrationDiff.project_name,
+      @runner ||= Runner.new(IntegrationDiff.project_name,
                              IntegrationDiff.javascript_driver)
     end
 
-    def initialize(base_uri, project_name, javascript_driver)
-      @base_uri = base_uri
+    def initialize(project_name, javascript_driver)
       @project_name = project_name
       @javascript_driver = javascript_driver
 
+      dir = IntegrationDiff::Utils.images_dir
       Dir.mkdir('tmp') unless Dir.exist?('tmp')
-      Dir.mkdir(DIR) unless Dir.exist?(DIR)
+      Dir.mkdir(dir) unless Dir.exist?(dir)
     end
 
     # TODO: Improve error handling here for network timeouts
     def start_run
-      @identifiers = []
       draft_run
+      @uploader = IntegrationDiff::Uploader.build(@run_id)
     rescue StandardError => e
       IntegrationDiff.logger.fatal e.message
       raise e
@@ -34,9 +33,7 @@ module IntegrationDiff
 
     # TODO: Improve error handling here for network timeouts
     def wrap_run
-      @identifiers.each do |identifier|
-        upload_image(identifier)
-      end
+      @uploader.wrapup
 
       complete_run if @run_id
     rescue StandardError => e
@@ -45,9 +42,9 @@ module IntegrationDiff
     end
 
     def screenshot(identifier)
-      screenshot_name = image_file(identifier)
+      screenshot_name = IntegrationDiff::Utils.image_file(identifier)
       page.save_screenshot(screenshot_name, full: true)
-      @identifiers << identifier
+      @uploader.enqueue(identifier)
     end
 
     private
@@ -58,7 +55,7 @@ module IntegrationDiff
       details = IntegrationDiff::RunDetails.new.details
       branch = details.branch
       author = details.author
-      project = IntegrationDiff.project_name
+      project = @project_name
 
       response = connection.post('/api/v1/runs',
                                  name: run_name, project: project, group: branch,
@@ -67,28 +64,12 @@ module IntegrationDiff
       @run_id = JSON.parse(response.body)["id"]
     end
 
-    def upload_image(identifier)
-      IntegrationDiff.logger.fatal "uploading #{identifier}"
-      image_io = Faraday::UploadIO.new(image_file(identifier), 'image/png')
-      connection.post("/api/v1/runs/#{@run_id}/run_images",
-                      identifier: identifier, image: image_io)
-    end
-
     def complete_run
       connection.put("/api/v1/runs/#{@run_id}/status", status: "completed")
     end
 
-    def image_file(identifier)
-      "#{Dir.pwd}/#{DIR}/#{identifier}.png"
-    end
-
     def connection
-      @conn ||= Faraday.new(@base_uri, request: { timeout: 120, open_timeout: 120 }) do |f|
-        f.request :basic_auth, IntegrationDiff.api_key, 'X'
-        f.request :multipart
-        f.request :url_encoded
-        f.adapter :net_http
-      end
+      @connection ||= IntegrationDiff::Utils.connection
     end
   end
 end

data/lib/integration_diff/uploader.rb

@@ -0,0 +1,13 @@
+module IntegrationDiff
+  class Uploader
+    def self.build(run_id)
+      if defined?(::Concurrent)
+        require 'integration_diff/uploaders/concurrent'
+        IntegrationDiff::Uploaders::Concurrent.new(run_id)
+      else
+        require 'integration_diff/uploaders/sequential'
+        IntegrationDiff::Uploaders::Sequential.new(run_id)
+      end
+    end
+  end
+end

data/lib/integration_diff/uploaders/concurrent.rb

@@ -0,0 +1,38 @@
+require 'integration_diff/utils'
+
+module IntegrationDiff
+  module Uploaders
+    class Concurrent
+      MAX_NO_OF_THREADS = 20
+
+      def initialize(run_id)
+        @run_id = run_id
+        @pool = ::Concurrent::FixedThreadPool.new(MAX_NO_OF_THREADS)
+        @screenshots_taken = 0
+      end
+
+      def enqueue(identifier)
+        @screenshots_taken += 1
+
+        @pool.post do
+          IntegrationDiff::Utils.upload_image(@run_id, identifier)
+        end
+      end
+
+      def wrapup
+        retries = 180           # 30 mins
+
+        # if all screenshots are not uploaded, wait.
+        until @screenshots_taken == @pool.completed_task_count
+          retries -= 1
+          break if retries.zero?
+
+          sleep 10
+        end
+
+        @pool.shutdown
+        @pool.wait_for_termination
+      end
+    end
+  end
+end

data/lib/integration_diff/uploaders/sequential.rb

@@ -0,0 +1,22 @@
+require 'integration_diff/utils'
+
+module IntegrationDiff
+  module Uploaders
+    class Sequential
+      def initialize(run_id)
+        @run_id = run_id
+        @identifiers = []
+      end
+
+      def enqueue(identifier)
+        @identifiers << identifier
+      end
+
+      def wrapup
+        @identifiers.each do |identifier|
+          IntegrationDiff::Utils.upload_image(@run_id, identifier)
+        end
+      end
+    end
+  end
+end

data/lib/integration_diff/utils.rb

@@ -0,0 +1,29 @@
+module IntegrationDiff
+  module Utils
+    # http connection that will be used for uploading images
+    def self.connection
+      base_uri = IntegrationDiff.base_uri
+      Faraday.new(base_uri, request: { timeout: 120, open_timeout: 120 }) do |f|
+        f.request :basic_auth, IntegrationDiff.api_key, 'X'
+        f.request :multipart
+        f.request :url_encoded
+        f.adapter :net_http
+      end
+    end
+
+    def self.images_dir
+      'tmp/idiff_images'.freeze
+    end
+
+    def self.upload_image(run_id, identifier)
+      IntegrationDiff.logger.fatal "uploading #{identifier}"
+      image_io = Faraday::UploadIO.new(image_file(identifier), 'image/png')
+      connection.post("/api/v1/runs/#{run_id}/run_images",
+                      identifier: identifier, image: image_io)
+    end
+
+    def self.image_file(identifier)
+      "#{Dir.pwd}/#{images_dir}/#{identifier}.png"
+    end
+  end
+end

data/lib/integration_diff/version.rb

@@ -1,3 +1,3 @@
 module IntegrationDiff
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: integration-diff
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Yuva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-17 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -40,6 +40,10 @@ files:
 - lib/integration_diff/dummy_runner.rb
 - lib/integration_diff/run_details.rb
 - lib/integration_diff/runner.rb
+- lib/integration_diff/uploader.rb
+- lib/integration_diff/uploaders/concurrent.rb
+- lib/integration_diff/uploaders/sequential.rb
+- lib/integration_diff/utils.rb
 - lib/integration_diff/version.rb
 homepage: http://diff.codemancers.com
 licenses: