unobtainium 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32ec07edb9ef9b7a1794e3660a6dbaedec57054f
-  data.tar.gz: 36ec4332fb3921acb4e3b723b4fe0f208bc839e6
+  metadata.gz: c48a4bbdaf69ce31be6eb42f8a10bd4af462fafb
+  data.tar.gz: f4f811e06460e1a124769e97dadb0d79de82ba93
 SHA512:
-  metadata.gz: 140e9dbdc8f5f83d4ff607ffd9fe5381652f710e3a9cf6036ef278daa3da8c792c450883b701395680094997983bd880ee5dc5eb5d0403fd2f690da05b311d13
-  data.tar.gz: 5f6dcef3056e6110c49a6b3fba2913641f43a1c4a15895c5802edf3af8569e6be0ec0f2a66b01a88694937d450b6650683981f456f39d400447ac77e914fdf8e
+  metadata.gz: 2582d432e5fc1c6d35cacee66c8eb71ec87437313f1ab3f8706dd457d4925ccb07cac952e535bba1898eb8e1e6b9cb1becaf3e90f2ab36d78c1a2d33e97ab575
+  data.tar.gz: 9e610ebc5b157cb7828a4be8f7208687b8df5acb2ebd7ee9f023173132dd3a0c4d285d1eaf725ea8f2b13ca6c7c2b0c41c71aec11fca49a41082303081ba8e0b

data/.travis.yml

@@ -5,7 +5,7 @@ rvm:
   - 2.2
 script:
   - bundle exec rake
-  - bundle exec codeclimate-test-reporter
+  - bundle exec codeclimate-test-reporter || true
 addons:
   code_climate:
     repo_token: 5dcf014e3a26ded8ffe8ff8bc70f98d49523e4851613123d8359035d44937953

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    unobtainium (0.8.1)
-      collapsium (~> 0.6)
+    unobtainium (0.9.0)
+      collapsium (~> 0.8)
       collapsium-config (~> 0.4)
       ptools (~> 1.3)
       sys-proctable (~> 1.1)
@@ -10,11 +10,11 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    appium_lib (8.0.2)
+    appium_lib (8.1.0)
       awesome_print (~> 1.6)
       json (~> 1.8)
       nokogiri (~> 1.6.6)
-      selenium-webdriver (~> 2.49)
+      selenium-webdriver (~> 2.50)
       tomlrb (~> 1.1)
     archive-zip (0.7.0)
       io-like (~> 0.3.0)
@@ -26,10 +26,11 @@ GEM
     chromedriver-helper (1.0.0)
       archive-zip (~> 0.7.0)
       nokogiri (~> 1.6)
-    codeclimate-test-reporter (1.0.1)
-    collapsium (0.6.1)
-    collapsium-config (0.4.0)
-      collapsium (~> 0.6)
+    codeclimate-test-reporter (1.0.3)
+      simplecov
+    collapsium (0.8.0)
+    collapsium-config (0.4.3)
+      collapsium (~> 0.7)
     cucumber (2.4.0)
       builder (>= 2.1.2)
       cucumber-core (~> 1.5.0)
@@ -52,7 +53,7 @@ GEM
     multi_test (0.1.2)
     nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
-    parser (2.3.1.4)
+    parser (2.3.2.0)
       ast (~> 2.2)
     phantomjs (2.1.1.0)
     powerpack (0.1.1)

data/lib/unobtainium/driver.rb

@@ -243,7 +243,12 @@ module Unobtainium
       driver_klass.ensure_preconditions(@label, @options)
 
       # Great, instanciate!
-      @impl = driver_klass.create(@label, @options)
+      opts = nil
+      if not @options.nil?
+        opts = @options.dup
+        opts.delete('unobtainium_instance_id')
+      end
+      @impl = driver_klass.create(@label, opts)
 
       # Now also extend this implementation with all the modues that match
       @@modules.each do |klass, _|

data/lib/unobtainium/drivers/appium.rb

@@ -68,9 +68,7 @@ module Unobtainium
               return driver.send(meth.to_s, *args, &block)
             end
           end
-          # :nocov:
           return super
-          # :nocov:
         end
       end
 
@@ -119,13 +117,14 @@ module Unobtainium
 
           # Merge 'caps' and 'desired_capabilities', letting the former win
           options[:caps] =
-            ::Collapsium::UberHash.new(options[:desired_capabilities])
+            ::Collapsium::UberHash.new(options['desired_capabilities'])
+                                  .recursive_merge(options[:desired_capabilities])
                                   .recursive_merge(options[:caps])
           options.delete(:desired_capabilities)
           options.delete('desired_capabilities')
 
           # The label specifies the platform, if no other platform is given.
-          if options['caps.platformName']
+          if not options['caps.platformName']
             options['caps.platformName'] = normalized.to_s
           end
 
@@ -144,12 +143,14 @@ module Unobtainium
           # some information
           options = supplement_browser(options)
 
-          return label, options
+          return normalized, options
         end
 
         ##
         # Create and return a driver instance
         def create(_, options)
+          # :nocov:
+
           # Determine compatibility option
           compat = options.fetch(:webdriver_compatibility, true)
           options.delete(:webdriver_compatibility)
@@ -158,6 +159,7 @@ module Unobtainium
           driver = ::Appium::Driver.new(options)
           result = DriverProxy.new(driver, compat)
           return result
+          # :nocov:
         end
 
         private
@@ -176,7 +178,7 @@ module Unobtainium
           platform = options['caps.platformName'].to_s.downcase.to_sym
 
           # If we have supplement data matching the platform and browser, great!
-          data = BROWSER_MATCHES[platform][browser]
+          data = (BROWSER_MATCHES[platform] || {})[browser]
           if data.nil?
             return options
           end

data/lib/unobtainium/drivers/phantom.rb

@@ -7,10 +7,13 @@
 # All rights reserved.
 #
 
+require 'collapsium'
+
 require_relative './selenium'
 require_relative '../support/util'
 require_relative '../support/port_scanner'
 require_relative '../support/runner'
+require_relative '../support/identifiers'
 require_relative '../runtime'
 
 module Unobtainium
@@ -24,7 +27,7 @@ module Unobtainium
     class Phantom < Selenium
       # Recognized labels for matching the driver
       LABELS = {
-        phantomjs: [:headless,],
+        phantomjs: [:headless, :phantom],
       }.freeze
 
       # Port scanning ranges (can also be arrays or single port numbers.
@@ -43,6 +46,7 @@ module Unobtainium
       class << self
         include ::Unobtainium::Support::Utility
         include ::Unobtainium::Support::PortScanner
+        include ::Unobtainium::Support::Identifiers
 
         ##
         # Ensure that the driver's preconditions are fulfilled.
@@ -62,40 +66,56 @@ module Unobtainium
         def resolve_options(label, options)
           label, options = super
 
-          if not options[:phantomjs].nil? and not options['phantomjs'].nil?
-            raise ArgumentError, "Use either of 'phantomjs' or :phantomjs as "\
-                "option keys, not both!"
-          end
-          if not options[:phantomjs].nil?
-            options['phantomjs'] = options[:phantomjs]
-            options.delete(:phantomjs)
-          end
+          options = ::Collapsium::UberHash.new(options)
 
-          # Provide defaults for webdriver host and port. We find a free port
-          # here, so there's a possibility it'll get used before we run the
-          # server in #create. However, for the purpose of resolving options
-          # that's necessary. So we'll just live with this until it becomes a
-          # problem.
-          defaults = {
-            "phantomjs" => {
-              "host" => "localhost",
-              "port" => nil,
-            },
-          }
-          options = defaults.merge(options)
+          # If a URL is already provided, we should respect this.
+          merge_url(options)
+
+          # Provide defaults for webdriver host and port.
+          merge_defaults(options)
+
+          # At this point, the :phantomjs field is canonical in that it will
+          # be used to generate a :port and :url if necessary. That means we
+          # can use it to create a stable ID, too.
+          # This also implies that the :url field is pointless and should not
+          # be part of the ID; it will be generated again later on.
+          options.delete(:url)
+
+          # We need to figure out what we have to do based on detecting whether
+          # a port or some other option changed (or nothing did!)
+          fix_ports(label, options)
 
-          if options['phantomjs']['port'].nil?
-            ports = scan(options['phantomjs']['host'], *PORT_RANGES,
-                         for: :available, amount: :first)
-            if ports.empty?
-              raise "Could not find an available port for the PhantomJS server!"
+          # We find a free port here, so there's a possibility it'll get used
+          # before we run the server in #create. However, for the purpose of
+          # resolving options that's necessary. So we'll just live with this
+          # until it becomes a problem.
+          if options['phantomjs.generated_port'].nil?
+            if options['phantomjs.port'].nil?
+              ports = scan(options['phantomjs.host'], *PORT_RANGES,
+                           for: :available, amount: :first)
+              if ports.empty?
+                raise "Could not find an available port for the PhantomJS server!"
+              end
+              options['phantomjs.generated_port'] = ports[0]
+            else
+              options['phantomjs.generated_port'] = options['phantomjs.port']
             end
-            options['phantomjs']['port'] = ports[0]
           end
 
-          # Now override connection options for Selenium
-          options[:url] = "http://#{options['phantomjs']['host']}:"\
-              "#{options['phantomjs']['port']}"
+          # Now we can't just use new_id because we might have found a new
+          # port in the meantime. We'll have to generate yet another ID, and
+          # use that.
+          # Now before calculating this new ID, we'll run the options through
+          # the super method again. This is to ensure that all keys have the
+          # expected class *before* we perform this calculation.
+          new_id = identifier('driver', label, options)
+          options['unobtainium_instance_id'] = new_id
+
+          # Now we can generate the :url field for Selenium's benefit; it's
+          # just a copy of the canonical options.
+          options[:url] = "#{options['phantomjs.scheme']}://"\
+              "#{options['phantomjs.host']}:"\
+              "#{options['phantomjs.generated_port']}"
 
           return label, options
         end
@@ -103,9 +123,11 @@ module Unobtainium
         ##
         # Create and return a driver instance
         def create(_, options)
+          # :nocov:
+
           # Extract PhantomJS options
-          host = options['phantomjs']['host']
-          port = options['phantomjs']['port']
+          host = options['phantomjs.host']
+          port = options['phantomjs.port'] || options['phantomjs.generated_port']
           opts = options.dup
           opts.delete('phantomjs')
 
@@ -138,6 +160,100 @@ module Unobtainium
           # Run Selenium against server
           driver = ::Selenium::WebDriver.for(:remote, opts)
           return driver
+
+          # :nocov:
+        end
+
+        private
+
+        def merge_url(options)
+          if not options[:url]
+            return
+          end
+
+          require 'uri'
+          parsed = URI.parse(options[:url])
+          parsed_port = parsed.port.to_i
+          from_parsed = {
+            phantomjs: {
+              scheme: parsed.scheme,
+              host: parsed.host,
+              port: nil,
+            },
+          }
+
+          # Very special case: if the parsed port matches the generated port,
+          # and the port is nil, we want to keep it that way for deduplication
+          # purposes. See `#fix_ports` for how this interacts.
+          port = options['phantomjs.port']
+          generated_port = options['phantomjs.generated_port']
+          if not (parsed_port == generated_port and port.nil?)
+            from_parsed[:phantomjs][:port] = parsed_port
+          end
+
+          options.recursive_merge!(from_parsed, false)
+        end
+
+        def merge_defaults(options)
+          defaults = {
+            phantomjs: {
+              scheme: 'http',
+              host: 'localhost',
+              port: nil,
+              generated_port: nil,
+            },
+          }
+          options.recursive_merge!(defaults, false)
+        end
+
+        def fix_ports(label, options)
+          # Let's keep the old ID around and generate a new one, largely as
+          # a checksum of the options.
+          old_id = options.delete('unobtainium_instance_id')
+          new_id = identifier('driver', label, options)
+
+          # If the IDs don't match, it means some options changed. This may be
+          # the port or another option:
+          # #1 If IDs are the same and port is the same as generated port, we
+          #    need not do anything.
+          # #2 If IDs are the same and the ports differ, we have reached an
+          #    undefined state. This should be impossible.
+          # #3 If IDs differ and the ports are the same, some other option was
+          #    changed. We need to generate a new port and new ID (and warn about
+          #    this).
+          # #4 If IDs differ and ports differ, a new port was set. We need to
+          #    proceed with the new port and generate a new ID.
+          port = options['phantomjs.port']
+          generated_port = options['phantomjs.generated_port']
+
+          if old_id == new_id and port == generated_port
+            # #1 above, nothing to do.
+          elsif old_id == new_id and port != generated_port
+            # :nocov:
+            # #2 above, raise hell
+            if not port.nil?
+              raise "This can't happen; the instance ID (checksum) is the same, "\
+                "but the input differed: #{port} <-> #{generated_port}"
+            end
+            # :nocov:
+          elsif old_id != new_id and port == generated_port
+            # #3 above; nuke the ports and warn.
+            if not port.nil? and not generated_port.nil?
+              warn "Rejecting port #{port} and generating new port because "\
+                "options changed."
+            end
+            options['phantomjs.port'] = nil
+            options['phantomjs.generated_port'] = nil
+          elsif old_id != new_id and port != generated_port
+            # #4 above
+            options['phantomjs.generated_port'] = nil
+          else
+            # :nocov:
+            # Unreachable
+            raise "This can't happen; we have four cases and handle each of "\
+              "them. This line is unreachable. Please check the logic."
+            # :nocov:
+          end
         end
       end # class << self
     end # class PhantomJS

data/lib/unobtainium/drivers/selenium.rb

@@ -64,7 +64,8 @@ module Unobtainium
 
           # Merge 'caps' and 'desired_capabilities', letting the latter win
           options[:desired_capabilities] =
-            ::Collapsium::UberHash.new(options[:caps])
+            ::Collapsium::UberHash.new(options['caps'])
+                                  .recursive_merge(options[:caps])
                                   .recursive_merge(options[:desired_capabilities])
           options.delete(:caps)
           options.delete('caps')
@@ -82,8 +83,10 @@ module Unobtainium
         ##
         # Create and return a driver instance
         def create(label, options)
+          # :nocov:
           driver = ::Selenium::WebDriver.for(normalize_label(label), options)
           return driver
+          # :nocov:
         end
 
         private

data/lib/unobtainium/support/identifiers.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+#
+# unobtainium
+# https://github.com/jfinkhaeuser/unobtainium
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium contributors.
+# All rights reserved.
+#
+module Unobtainium
+  # @api private
+  # Contains support code
+  module Support
+    # Contains code for dealing with instance identifiers.
+    module Identifiers
+      # Given a label and a set of options, generate a unique identifier
+      # string.
+      def identifier(scope, label, options = nil)
+        digest = { label: label, options: options }
+        require 'digest/sha1'
+        digest = Digest::SHA1.hexdigest(digest.to_s)
+        return "#{scope}-#{digest}"
+      end
+    end # module Identifiers
+  end # module Support
+end # module Unobtainium

data/lib/unobtainium/support/port_scanner.rb

@@ -30,6 +30,12 @@ module Unobtainium
     # A port scanner for finding a free port for running e.g. a selenium
     # or appium server.
     module PortScanner
+      # Retry a port this many times before failing
+      MAX_RETRIES = 5
+
+      # Delay each retry by this many seconds before trying again
+      RETRY_DELAY = 0.5
+
       ##
       # Returns true if the port is open on the host, false otherwise.
       # @param host [String] host name or IP address
@@ -175,14 +181,20 @@ module Unobtainium
         sock = Socket.new(domain, :STREAM)
 
         connected = false
+        tries = MAX_RETRIES
         loop do
           begin
             sock.connect_nonblock(addr)
           rescue Errno::EINPROGRESS
-            if not IO.select(nil, [sock], nil, 1)
-              # Timed out, retry?
-              next
+            tries -= 1
+            if tries <= 0
+              # That's it, we've got enough.
+              break
             end
+
+            # The result of select doesn't matter. What matters is that we wait
+            # for sock to become usable, or for the timeout to occur.
+            IO.select([sock], [sock], nil, RETRY_DELAY)
           rescue Errno::EISCONN
             connected = true
             break

data/lib/unobtainium/version.rb

@@ -8,5 +8,5 @@
 #
 module Unobtainium
   # The current release version
-  VERSION = "0.8.1".freeze
+  VERSION = "0.9.0".freeze
 end

data/lib/unobtainium/world.rb

@@ -12,6 +12,7 @@ require 'collapsium-config'
 
 require 'unobtainium/driver'
 require 'unobtainium/runtime'
+require 'unobtainium/support/identifiers'
 
 module Unobtainium
   ##
@@ -63,6 +64,8 @@ module Unobtainium
     end # module ClassMethods
     extend ClassMethods
 
+    include ::Unobtainium::Support::Identifiers
+
     ##
     # (see Driver#create)
     #
@@ -93,6 +96,7 @@ module Unobtainium
             next
           end
           label = base.gsub(/^\.drivers\./, '')
+          break
         end
 
         # Unfortunately, the "base" key may not be recognized by the drivers,
@@ -108,10 +112,10 @@ module Unobtainium
 
       # Create a key for the label and options. This should always
       # return the same key for the same label and options.
-      key = { label: label, options: options }
-      require 'digest/sha1'
-      key = Digest::SHA1.hexdigest(key.to_s)
-      key = "driver-#{key}"
+      key = options['unobtainum_instance_id']
+      if key.nil?
+        key = identifier('driver', label, options)
+      end
 
       # Only create a driver with this exact configuration once. Unfortunately
       # We'll have to bind the destructor to whatever configuration exists at

data/spec/data/driverconfig.yml

@@ -7,6 +7,11 @@
 #
 # so the order in this file has to be mock -> branch2 -> branch1 -> leaf
 ---
+global:
+  global_opt: 'set'
+
+driver: leaf
+
 drivers:
   mock:
     mockoption: 42
@@ -16,11 +21,13 @@ drivers:
   branch1:
     extends: mock
     branch1option: foo
+  branch3:
+    extends: .global
+    branch3option: baz
   leaf:
-    extends: branch2
+    extends: .global, branch2
     leafoption: baz
     branch1option: override
   base_does_not_exist:
     extends: nonexistent_base
     some: value
-driver: leaf

data/spec/driver_spec.rb

@@ -34,7 +34,10 @@ end # module FakeModule
 
 describe ::Unobtainium::Driver do
   before :each do
-    ::Unobtainium::Driver.register_implementation(MockDriver, "mock_driver.rb")
+    ::Unobtainium::Driver.register_implementation(MockDriver,
+                                                  "mock_driver.rb")
+    ::Unobtainium::Driver.register_implementation(OptionResolvingMockDriver,
+                                                  "mock_driver.rb")
   end
 
   describe "driver registration" do
@@ -101,6 +104,32 @@ describe ::Unobtainium::Driver do
       drv = ::Unobtainium::Driver.create(:mock, foo: 42)
       expect(drv.passed_options).to eql foo: 42
     end
+
+    context "option resolution" do
+      it "provides defaults" do
+        drv = ::Unobtainium::Driver.create(:option_resolving)
+        expect(drv.options).to include(:foo)
+        expect(drv.options[:foo]).to eql 42
+      end
+
+      it "overrides when appropriate" do
+        drv = ::Unobtainium::Driver.create(:option_resolving, foo: 123)
+        expect(drv.options).to include(:foo)
+        expect(drv.options[:foo]).to eql 42
+      end
+
+      it "does not override always" do
+        drv = ::Unobtainium::Driver.create(:option_resolving, foo: 456)
+        expect(drv.options).to include(:foo)
+        expect(drv.options[:foo]).to eql 456
+      end
+
+      it "sets an instance ID" do
+        drv = ::Unobtainium::Driver.create(:option_resolving)
+        expect(drv.options).to include('unobtainium_instance_id')
+        expect(drv.options['unobtainium_instance_id']).to eql 'FIXED'
+      end
+    end
   end
 
   describe 'modules' do