rb - add support for Apple's new safari driver

Author: titusfortner

rb/.rubocop.yml

@@ -38,35 +38,35 @@ Style/FileName:
 Style/MutableConstant:
   Exclude:
     - 'lib/selenium/webdriver/common/socket_poller.rb'
-    - 'lib/selenium/webdriver/remote/bridge.rb'
+    - 'lib/selenium/webdriver/remote/legacy_bridge.rb'
     - 'lib/selenium/webdriver/remote/w3c_bridge.rb'
 
 # TODO: Refactor Chrome::Bridge#create_capabilities
 Metrics/PerceivedComplexity:
   Max: 11
   Exclude:
-    - 'lib/selenium/webdriver/chrome/bridge.rb'
+    - 'lib/selenium/webdriver/chrome/legacy_bridge.rb'
 
 Metrics/CyclomaticComplexity:
   Max: 9
   Exclude:
-    - 'lib/selenium/webdriver/chrome/bridge.rb'
+    - 'lib/selenium/webdriver/chrome/legacy_bridge.rb'
     - 'lib/selenium/webdriver/common/driver.rb'
     - 'spec/integration/selenium/webdriver/spec_support/test_environment.rb'
 
 Metrics/ClassLength:
   Max: 140
   Exclude:
     - 'lib/selenium/webdriver/firefox/profile.rb'
-    - 'lib/selenium/webdriver/remote/bridge.rb'
+    - 'lib/selenium/webdriver/remote/legacy_bridge.rb'
     - 'lib/selenium/webdriver/remote/capabilities.rb'
     - 'lib/selenium/webdriver/remote/w3c_bridge.rb'
     - 'spec/integration/selenium/webdriver/spec_support/test_environment.rb'
 
 Metrics/AbcSize:
   Max: 33
   Exclude:
-    - 'lib/selenium/webdriver/chrome/bridge.rb'
+    - 'lib/selenium/webdriver/chrome/legacy_bridge.rb'
     - 'lib/selenium/webdriver/support/color.rb'
 
 Metrics/LineLength:
@@ -80,4 +80,4 @@ Metrics/ModuleLength:
 Metrics/MethodLength:
   Max: 33
   Exclude:
-    - 'lib/selenium/webdriver/chrome/bridge.rb'
+    - 'lib/selenium/webdriver/chrome/legacy_bridge.rb'

rb/CHANGES

@@ -15,6 +15,9 @@ Firefox:
   * Rename wires to geckodriver
   * Change default usage from FirefoxDriver to geckodriver
 
+Safari:
+  * Initial support for Apple's Safari Driver in Sierra (issue #2475)
+
 2.53.0 (2016-03-15)
 ===================
 

rb/lib/selenium/webdriver/common/driver.rb

@@ -69,7 +69,11 @@ def for(browser, opts = {})
                    when :phantomjs
                      PhantomJS::Bridge.new(opts)
                    when :safari
-                     Safari::Bridge.new(opts)
+                     if Safari::LegacyBridge.legacy?
+                       Safari::LegacyBridge.new(opts)
+                     else
+                       Safari::AppleBridge.new(opts)
+                     end
                    else
                      raise ArgumentError, "unknown driver: #{browser.inspect}"
                    end

rb/lib/selenium/webdriver/safari.rb

@@ -57,6 +57,15 @@ def path
         def resource_path
           @resource_path ||= Pathname.new(File.expand_path('../safari/resources', __FILE__))
         end
+
+        def driver_path=(path)
+          Platform.assert_executable path
+          @driver_path = path
+        end
+
+        def driver_path
+          @driver_path || '/usr/bin/safaridriver'
+        end
       end
     end # Safari
   end # WebDriver
@@ -65,4 +74,6 @@ def resource_path
 require 'selenium/webdriver/safari/browser'
 require 'selenium/webdriver/safari/server'
 require 'selenium/webdriver/safari/options'
-require 'selenium/webdriver/safari/bridge'
+require 'selenium/webdriver/safari/legacy_bridge'
+require 'selenium/webdriver/safari/apple_bridge'
+require 'selenium/webdriver/safari/service'

rb/lib/selenium/webdriver/safari/apple_bridge.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+#
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module Safari
+      # @api private
+      class AppleBridge < Remote::Bridge
+        def initialize(opts = {})
+          opts[:desired_capabilities] ||= Remote::Capabilities.safari
+
+          @service = Service.new(Safari.driver_path, Service::DEFAULT_PORT, *extract_service_args(opts))
+          @service.start
+
+          opts[:url] = @service.uri
+
+          super
+        end
+
+        def quit
+          super
+        ensure
+          @service.stop if @service
+        end
+
+        private
+
+        def extract_service_args(opts)
+          service_log_path = opts.delete(:service_log_path)
+          service_log_path ? ["--log-path=#{service_log_path}"] : []
+        end
+      end # AppleBridge
+    end # Safari
+  end # WebDriver
+end # Selenium

rb/lib/selenium/webdriver/safari/bridge.rb renamed to rb/lib/selenium/webdriver/safari/legacy_bridge.rb

@@ -20,9 +20,14 @@
 module Selenium
   module WebDriver
     module Safari
-      class Bridge < Remote::Bridge
+      # @api private
+      class LegacyBridge < Remote::Bridge
         COMMAND_TIMEOUT = 60
 
+        def self.legacy?
+          !File.exist?(Safari.driver_path)
+        end
+
         def initialize(opts = {})
           command_timeout = Integer(opts[:timeout] || COMMAND_TIMEOUT)
           safari_options  = opts.delete(:options) || Safari::Options.new(opts)

rb/lib/selenium/webdriver/safari/service.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+#
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module Safari
+      #
+      # @api private
+      #
+
+      class Service < WebDriver::Service
+        DEFAULT_PORT = 7050
+
+        private
+
+        def start_process
+          server_command = [@executable_path, "--port=#{@port}", *@extra_args]
+          @process       = ChildProcess.build(*server_command)
+
+          @process.io.inherit! if $DEBUG
+          @process.start
+        end
+
+        def stop_server
+          connect_to_server { |http| http.head('/shutdown') }
+        end
+
+        def cannot_connect_error_text
+          "unable to connect to safaridriver #{@host}:#{@port}"
+        end
+      end # Service
+    end # Safari
+  end # WebDriver
+end # Selenium