selenium-webdriver 2.53.4 → 3.8.0

data/lib/selenium/webdriver/edge/driver.rb

@@ -0,0 +1,73 @@
+# 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 Edge
+
+      #
+      # Driver implementation for Microsoft Edge.
+      # @api private
+      #
+
+      class Driver < WebDriver::Driver
+        include DriverExtensions::TakesScreenshot
+
+        def initialize(opts = {})
+          opts[:desired_capabilities] ||= Remote::W3C::Capabilities.edge
+
+          unless opts.key?(:url)
+            driver_path = opts.delete(:driver_path) || Edge.driver_path
+            driver_opts = opts.delete(:driver_opts) || {}
+            port = opts.delete(:port) || Service::DEFAULT_PORT
+
+            @service = Service.new(driver_path, port, driver_opts)
+            @service.host = 'localhost' if @service.host == '127.0.0.1'
+            @service.start
+            opts[:url] = @service.uri
+          end
+
+          listener = opts.delete(:listener)
+
+          # Edge is mostly using W3C dialect, but a request to
+          # create session responds with OSS-like body,
+          # so we need to force W3C implementation.
+          desired_capabilities = opts.delete(:desired_capabilities)
+          bridge = Remote::Bridge.new(opts)
+          capabilities = bridge.create_session(desired_capabilities)
+
+          WebDriver.logger.info 'Forcing W3C dialect.'
+          @bridge = Remote::W3C::Bridge.new(capabilities, bridge.session_id, opts)
+          @bridge.extend Edge::Bridge
+
+          super(@bridge, listener: listener)
+        end
+
+        def browser
+          :edge
+        end
+
+        def quit
+          super
+        ensure
+          @service.stop if @service
+        end
+
+      end # Driver
+    end # Edge
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/edge/service.rb

@@ -1,5 +1,3 @@
-# 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
@@ -20,104 +18,37 @@
 module Selenium
   module WebDriver
     module Edge
-
       #
       # @api private
       #
 
-      class Service
-        START_TIMEOUT       = 20
-        SOCKET_LOCK_TIMEOUT = 45
-        STOP_TIMEOUT        = 5
-        DEFAULT_PORT        = 17556
-        MISSING_TEXT        = "Unable to find MicrosoftWebDriver. Please download the server from https://www.microsoft.com/en-us/download/details.aspx?id=48212. More info at https://github.com/SeleniumHQ/selenium/wiki/MicrosoftWebDriver."
-
-        def self.executable_path
-          @executable_path ||= (
-            path = Platform.find_binary "MicrosoftWebDriver"
-            path or raise Error::WebDriverError, MISSING_TEXT
-            Platform.assert_executable path
-
-            path
-          )
-        end
-
-        def self.executable_path=(path)
-          Platform.assert_executable path
-          @executable_path = path
-        end
-
-        def self.default_service(*extra_args)
-          new executable_path, DEFAULT_PORT, *extra_args
-        end
-
-        def initialize(executable_path, port, *extra_args)
-          @executable_path = executable_path
-          @host            = Platform.localhost
-          @port            = Integer(port)
-
-          raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
-
-          @extra_args = extra_args
-        end
-
-        def start
-          Platform.exit_hook { stop } # make sure we don't leave the server running
+      class Service < WebDriver::Service
+        DEFAULT_PORT = 17556
+        @executable = 'MicrosoftWebDriver'.freeze
+        @missing_text = <<-ERROR.gsub(/\n +| {2,}/, ' ').freeze
+          Unable to find MicrosoftWebDriver. Please download the server from
+          https://www.microsoft.com/en-us/download/details.aspx?id=48212 and place it somewhere on your PATH.
+          More info at https://github.com/SeleniumHQ/selenium/wiki/MicrosoftWebDriver.
+        ERROR
 
-          socket_lock.locked do
-            find_free_port
-            start_process
-            connect_until_stable
-          end
-        end
-
-        def stop
-          return if @process.nil? || @process.exited?
-
-          Net::HTTP.start(@host, @port) do |http|
-            http.open_timeout = STOP_TIMEOUT / 2
-            http.read_timeout = STOP_TIMEOUT / 2
-
-            http.head("/shutdown")
-          end
-        ensure
-          stop_process
-        end
-
-        def uri
-          URI.parse "http://#{@host}:#{@port}"
-        end
-
-        def find_free_port
-          @port = PortProber.above @port
-        end
+        private
 
         def start_process
-          server_command = [@executable_path, "--port=#{@port}", *@extra_args]
-          @process       = ChildProcess.build(*server_command)
-
-          @process.io.inherit! if $DEBUG == true
+          @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
           @process.start
         end
 
-        def stop_process
-          @process.poll_for_exit STOP_TIMEOUT
-        rescue ChildProcess::TimeoutError
-          @process.stop STOP_TIMEOUT
+        def cannot_connect_error_text
+          "unable to connect to MicrosoftWebDriver #{@host}:#{@port}"
         end
 
-        def connect_until_stable
-          socket_poller = SocketPoller.new @host, @port, START_TIMEOUT
-
-          unless socket_poller.connected?
-            raise Error::WebDriverError, "unable to connect to MicrosoftWebDriver #{@host}:#{@port}"
-          end
+        def extract_service_args(driver_opts)
+          driver_args = super
+          driver_args << "–host=#{driver_opts[:host]}" if driver_opts.key? :host
+          driver_args << "–package=#{driver_opts[:package]}" if driver_opts.key? :package
+          driver_args << "-verbose" if driver_opts[:verbose] == true
+          driver_args
         end
-
-        def socket_lock
-          @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
-        end
-
       end # Service
     end # Edge
   end # WebDriver

data/lib/selenium/webdriver/firefox.rb

@@ -1,5 +1,3 @@
-# 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
@@ -21,31 +19,42 @@ require 'timeout'
 require 'socket'
 require 'rexml/document'
 
+require 'selenium/webdriver/firefox/driver'
+
 require 'selenium/webdriver/firefox/util'
 require 'selenium/webdriver/firefox/extension'
 require 'selenium/webdriver/firefox/binary'
 require 'selenium/webdriver/firefox/profiles_ini'
 require 'selenium/webdriver/firefox/profile'
 require 'selenium/webdriver/firefox/launcher'
-require 'selenium/webdriver/firefox/bridge'
-require 'selenium/webdriver/firefox/w3c_bridge'
-require 'selenium/webdriver/firefox/binary'
+require 'selenium/webdriver/firefox/legacy/driver'
+
+require 'selenium/webdriver/firefox/marionette/bridge'
+require 'selenium/webdriver/firefox/marionette/driver'
+require 'selenium/webdriver/firefox/options'
 require 'selenium/webdriver/firefox/service'
 
 module Selenium
   module WebDriver
     module Firefox
-
-      DEFAULT_PORT                    = 7055
-      DEFAULT_ENABLE_NATIVE_EVENTS    = Platform.os == :windows
-      DEFAULT_SECURE_SSL              = false
+      DEFAULT_PORT = 7055
+      DEFAULT_ENABLE_NATIVE_EVENTS = Platform.os == :windows
+      DEFAULT_SECURE_SSL = false
       DEFAULT_ASSUME_UNTRUSTED_ISSUER = true
-      DEFAULT_LOAD_NO_FOCUS_LIB       = false
+      DEFAULT_LOAD_NO_FOCUS_LIB = false
+
+      def self.driver_path=(path)
+        Platform.assert_executable path
+        @driver_path = path
+      end
+
+      def self.driver_path
+        @driver_path ||= nil
+      end
 
       def self.path=(path)
         Binary.path = path
       end
-
     end # Firefox
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/firefox/binary.rb

@@ -1,5 +1,3 @@
-# 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
@@ -20,38 +18,37 @@
 module Selenium
   module WebDriver
     module Firefox
-
       # @api private
       class Binary
-
-        NO_FOCUS_LIBRARY_NAME = "x_ignore_nofocus.so"
-        NO_FOCUS_LIBRARIES    = [
-          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/amd64/#{NO_FOCUS_LIBRARY_NAME}", "amd64/#{NO_FOCUS_LIBRARY_NAME}"],
-          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/x86/#{NO_FOCUS_LIBRARY_NAME}", "x86/#{NO_FOCUS_LIBRARY_NAME}"],
-        ]
+        NO_FOCUS_LIBRARY_NAME = 'x_ignore_nofocus.so'.freeze
+        NO_FOCUS_LIBRARIES = [
+          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/amd64/#{NO_FOCUS_LIBRARY_NAME}",
+           "amd64/#{NO_FOCUS_LIBRARY_NAME}"],
+          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/x86/#{NO_FOCUS_LIBRARY_NAME}",
+           "x86/#{NO_FOCUS_LIBRARY_NAME}"]
+        ].freeze
 
         WAIT_TIMEOUT = 90
         QUIT_TIMEOUT = 5
 
         def start_with(profile, profile_path, *args)
           if Platform.cygwin?
-            profile_path = Platform.cygwin_path(profile_path, :windows => true)
+            profile_path = Platform.cygwin_path(profile_path, windows: true)
           elsif Platform.windows?
-            profile_path = profile_path.gsub("/", "\\")
+            profile_path = profile_path.tr('/', '\\')
           end
 
-          ENV['XRE_CONSOLE_LOG']           = profile.log_file if profile.log_file
-          ENV['XRE_PROFILE_PATH']          = profile_path
-          ENV['MOZ_NO_REMOTE']             = '1' # able to launch multiple instances
+          ENV['XRE_CONSOLE_LOG'] = profile.log_file if profile.log_file
+          ENV['XRE_PROFILE_PATH'] = profile_path
+          ENV['MOZ_NO_REMOTE'] = '1' # able to launch multiple instances
           ENV['MOZ_CRASHREPORTER_DISABLE'] = '1' # disable breakpad
-          ENV['NO_EM_RESTART']             = '1' # prevent the binary from detaching from the console
+          ENV['NO_EM_RESTART'] = '1' # prevent the binary from detaching from the console
 
           if Platform.linux? && (profile.native_events? || profile.load_no_focus_lib?)
             modify_link_library_path profile_path
           end
 
           execute(*args)
-          cope_with_mac_strangeness(args) if Platform.mac?
         end
 
         def quit
@@ -76,26 +73,12 @@ module Selenium
         private
 
         def execute(*extra_args)
-          args = [self.class.path, "-no-remote"] + extra_args
+          args = [self.class.path, '-no-remote'] + extra_args
           @process = ChildProcess.build(*args)
-          @process.io.inherit! if $DEBUG
-          @process.start
-        end
-
-        def cope_with_mac_strangeness(args)
-          sleep 0.3
+          WebDriver.logger.debug("Executing Process #{args}")
 
-          if @process.crashed?
-            # ok, trying a restart
-            sleep 7
-            execute(*args)
-          end
-
-          # ensure we're ok
-          sleep 0.3
-          if @process.crashed?
-            raise Error::WebDriverError, "unable to start Firefox cleanly, args: #{args.inspect}"
-          end
+          @process.io.stdout = @process.io.stderr = WebDriver.logger.io if WebDriver.logger.debug?
+          @process.start
         end
 
         def modify_link_library_path(profile_path)
@@ -112,11 +95,10 @@ module Selenium
           paths += ENV['LD_LIBRARY_PATH'].to_s.split(File::PATH_SEPARATOR)
 
           ENV['LD_LIBRARY_PATH'] = paths.uniq.join(File::PATH_SEPARATOR)
-          ENV['LD_PRELOAD']      = NO_FOCUS_LIBRARY_NAME
+          ENV['LD_PRELOAD'] = NO_FOCUS_LIBRARY_NAME
         end
 
         class << self
-
           #
           # @api private
           #
@@ -139,7 +121,7 @@ module Selenium
                       when :windows
                         windows_path
                       when :linux, :unix
-                        Platform.find_binary("firefox3", "firefox2", "firefox") || "/usr/bin/firefox"
+                        Platform.find_binary('firefox3', 'firefox2', 'firefox') || '/usr/bin/firefox'
                       else
                         raise Error::WebDriverError, "unknown platform: #{Platform.os}"
                       end
@@ -147,7 +129,9 @@ module Selenium
             @path = Platform.cygwin_path(@path) if Platform.cygwin?
 
             unless File.file?(@path.to_s)
-              raise Error::WebDriverError, "Could not find Firefox binary (os=#{Platform.os}). Make sure Firefox is installed or set the path manually with #{self}.path="
+              error = "Could not find Firefox binary (os=#{Platform.os}). "
+              error << "Make sure Firefox is installed or set the path manually with #{self}.path="
+              raise Error::WebDriverError, error
             end
 
             @path
@@ -155,27 +139,29 @@ module Selenium
 
           def version
             @version = case Platform.os
-                         when :macosx
-                           `#{path} -v`.strip[/[^\s]*$/][/^\d+/].to_i
-                         when :windows
-                           `\"#{path}\" -v | more`.strip[/[^\s]*$/][/^\d+/].to_i
-                         when :linux
-                           `#{path} -v`.strip[/[^\s]*$/][/^\d+/].to_i
-                         else
-                           0
-                         end
+                       when :macosx
+                         `#{path} -v`.strip[/[^\s]*$/][/^\d+/].to_i
+                       when :windows
+                         `\"#{path}\" -v | more`.strip[/[^\s]*$/][/^\d+/].to_i
+                       when :linux
+                         `#{path} -v`.strip[/[^\s]*$/][/^\d+/].to_i
+                       else
+                         0
+                       end
           end
 
           private
 
           def windows_path
-            windows_registry_path || Platform.find_in_program_files("\\Mozilla Firefox\\firefox.exe") || Platform.find_binary("firefox")
+            windows_registry_path ||
+              Platform.find_in_program_files('\\Mozilla Firefox\\firefox.exe') ||
+              Platform.find_binary('firefox')
           end
 
           def macosx_path
-            path = "/Applications/Firefox.app/Contents/MacOS/firefox-bin"
-            path = File.expand_path("~/Applications/Firefox.app/Contents/MacOS/firefox-bin") unless File.exist?(path)
-            path = Platform.find_binary("firefox-bin") unless File.exist?(path)
+            path = '/Applications/Firefox.app/Contents/MacOS/firefox-bin'
+            path = File.expand_path('~/Applications/Firefox.app/Contents/MacOS/firefox-bin') unless File.exist?(path)
+            path = Platform.find_binary('firefox-bin') unless File.exist?(path)
 
             path
           end
@@ -184,18 +170,16 @@ module Selenium
             require 'win32/registry'
 
             lm = Win32::Registry::HKEY_LOCAL_MACHINE
-            lm.open("SOFTWARE\\Mozilla\\Mozilla Firefox") do |reg|
+            lm.open('SOFTWARE\\Mozilla\\Mozilla Firefox') do |reg|
               main = lm.open("SOFTWARE\\Mozilla\\Mozilla Firefox\\#{reg.keys[0]}\\Main")
-              if entry = main.find { |key, type, data| key =~ /pathtoexe/i }
-                return entry.last
-              end
+              entry = main.find { |key, _type, _data| key =~ /pathtoexe/i }
+              return entry.last if entry
             end
           rescue LoadError
             # older JRuby or IronRuby does not have win32/registry
           rescue Win32::Registry::Error
           end
         end # class << self
-
       end # Binary
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/firefox/driver.rb

@@ -0,0 +1,48 @@
+# 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 Firefox
+      module Driver
+        class << self
+
+          #
+          # Instantiates correct Firefox driver implementation
+          # @return [Marionette::Driver, Legacy::Driver]
+          #
+
+          def new(**opts)
+            if marionette?(opts)
+              Firefox::Marionette::Driver.new(opts)
+            else
+              Firefox::Legacy::Driver.new(opts)
+            end
+          end
+
+          private
+
+          def marionette?(opts)
+            opts.delete(:marionette) != false &&
+              (!opts[:desired_capabilities] || opts[:desired_capabilities][:marionette] != false)
+          end
+        end
+
+      end # Driver
+    end # Firefox
+  end # WebDriver
+end # Selenium