selenium-webdriver 2.45.0 → 3.142.7

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

@@ -1,6 +1,24 @@
+# frozen_string_literal: true
+
+# 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
-
     #
     # The main class through which you control the browser.
     #
@@ -14,7 +32,6 @@ module Selenium
       include SearchContext
 
       class << self
-
         #
         # @api private
         #
@@ -24,34 +41,24 @@ module Selenium
         #
 
         def for(browser, opts = {})
-          listener = opts.delete(:listener)
-
-          bridge = case browser
-                   when :firefox, :ff
-                     Firefox::Bridge.new(opts)
-                   when :remote
-                     Remote::Bridge.new(opts)
-                   when :ie, :internet_explorer
-                     IE::Bridge.new(opts)
-                   when :chrome
-                     Chrome::Bridge.new(opts)
-                   when :android
-                     Android::Bridge.new(opts)
-                   when :iphone
-                     IPhone::Bridge.new(opts)
-                   when :opera
-                     Opera::Bridge.new(opts)
-                   when :phantomjs
-                     PhantomJS::Bridge.new(opts)
-                   when :safari
-                     Safari::Bridge.new(opts)
-                   else
-                     raise ArgumentError, "unknown driver: #{browser.inspect}"
-                   end
-
-          bridge = Support::EventFiringBridge.new(bridge, listener) if listener
-
-          new(bridge)
+          case browser
+          when :chrome
+            Chrome::Driver.new(opts)
+          when :internet_explorer, :ie
+            IE::Driver.new(opts)
+          when :safari
+            Safari::Driver.new(opts)
+          when :phantomjs
+            PhantomJS::Driver.new(opts)
+          when :firefox, :ff
+            Firefox::Driver.new(opts)
+          when :edge
+            Edge::Driver.new(opts)
+          when :remote
+            Remote::Driver.new(opts)
+          else
+            raise ArgumentError, "unknown driver: #{browser.inspect}"
+          end
         end
       end
 
@@ -62,17 +69,13 @@ module Selenium
       # @api private
       #
 
-      def initialize(bridge)
+      def initialize(bridge, listener: nil)
         @bridge = bridge
-
-        # TODO: refactor this away
-        unless bridge.driver_extensions.empty?
-          extend(*bridge.driver_extensions)
-        end
+        @bridge = Support::EventFiringBridge.new(bridge, listener) if listener
       end
 
       def inspect
-        '#<%s:0x%x browser=%s>' % [self.class, hash*2, bridge.browser.inspect]
+        format '#<%<class>s:0x%<hash>x browser=%<browser>s>', class: self.class, hash: hash * 2, browser: bridge.browser.inspect
       end
 
       #
@@ -94,12 +97,29 @@ module Selenium
       end
 
       #
-      # @return [Options]
-      # @see Options
+      # @return [Manager]
+      # @see Manager
       #
 
       def manage
-        @manage ||= WebDriver::Options.new(bridge)
+        bridge.manage
+      end
+
+      #
+      # @return [ActionBuilder, W3CActionBuilder]
+      # @see ActionBuilder, W3CActionBuilder
+      #
+
+      def action
+        bridge.action
+      end
+
+      def mouse
+        bridge.mouse
+      end
+
+      def keyboard
+        bridge.keyboard
       end
 
       #
@@ -117,7 +137,7 @@ module Selenium
       #
 
       def current_url
-        bridge.getCurrentUrl
+        bridge.url
       end
 
       #
@@ -127,7 +147,7 @@ module Selenium
       #
 
       def title
-        bridge.getTitle
+        bridge.title
       end
 
       #
@@ -137,7 +157,7 @@ module Selenium
       #
 
       def page_source
-        bridge.getPageSource
+        bridge.page_source
       end
 
       #
@@ -164,7 +184,7 @@ module Selenium
       #
 
       def window_handles
-        bridge.getWindowHandles
+        bridge.window_handles
       end
 
       #
@@ -174,7 +194,7 @@ module Selenium
       #
 
       def window_handle
-        bridge.getCurrentWindowHandle
+        bridge.window_handle
       end
 
       #
@@ -182,7 +202,7 @@ module Selenium
       #
       # @param [String] script
       #   JavaScript source to execute
-      # @param [WebDriver::Element,Integer, Float, Boolean, NilClass, String, Array] *args
+      # @param [WebDriver::Element, Integer, Float, Boolean, NilClass, String, Array] args
       #   Arguments will be available in the given script in the 'arguments' pseudo-array.
       #
       # @return [WebDriver::Element,Integer,Float,Boolean,NilClass,String,Array]
@@ -190,7 +210,7 @@ module Selenium
       #
 
       def execute_script(script, *args)
-        bridge.executeScript(script, *args)
+        bridge.execute_script(script, *args)
       end
 
       # Execute an asynchronous piece of JavaScript in the context of the
@@ -201,28 +221,27 @@ module Selenium
       # executed function as the last argument.
       #
       # @param [String] script
-      #   JavaSCript source to execute
-      # @param [WebDriver::Element,Integer, Float, Boolean, NilClass, String, Array] *args
+      #   JavaScript source to execute
+      # @param [WebDriver::Element,Integer, Float, Boolean, NilClass, String, Array] args
       #   Arguments to the script. May be empty.
       #
       # @return [WebDriver::Element,Integer,Float,Boolean,NilClass,String,Array]
       #
 
       def execute_async_script(script, *args)
-        bridge.executeAsyncScript(script, *args)
+        bridge.execute_async_script(script, *args)
       end
 
-
       #-------------------------------- sugar  --------------------------------
 
       #
-      #   driver.first(:id, 'foo')
+      #   driver.first(id: 'foo')
       #
 
       alias_method :first, :find_element
 
       #
-      #   driver.all(:class, 'bar') #=> [#<WebDriver::Element:0x1011c3b88, ...]
+      #   driver.all(class: 'bar') #=> [#<WebDriver::Element:0x1011c3b88, ...]
       #
 
       alias_method :all, :find_elements
@@ -236,7 +255,7 @@ module Selenium
       # Get the first element matching the given selector. If given a
       # String or Symbol, it will be used as the id of the element.
       #
-      # @param  [String,Hash] id or selector
+      # @param  [String,Hash] sel id or selector
       # @return [WebDriver::Element]
       #
       # Examples:
@@ -246,9 +265,7 @@ module Selenium
       #
 
       def [](sel)
-        if sel.kind_of?(String) || sel.kind_of?(Symbol)
-          sel = { :id => sel }
-        end
+        sel = {id: sel} if sel.is_a?(String) || sel.is_a?(Symbol)
 
         find_element sel
       end
@@ -266,16 +283,26 @@ module Selenium
       # @see SearchContext
       #
 
-      def ref
-        nil
-      end
+      def ref; end
 
       private
 
-      def bridge
-        @bridge
-      end
+      attr_reader :bridge
+
+      def service_url(opts)
+        @service = opts.delete(:service)
+        %i[driver_opts driver_path port].each do |key|
+          next unless opts.key? key
 
+          WebDriver.logger.deprecate(":#{key}", ':service with an instance of Selenium::WebDriver::Service')
+        end
+        @service ||= Service.send(browser,
+                                  args: opts.delete(:driver_opts),
+                                  path: opts.delete(:driver_path),
+                                  port: opts.delete(:port))
+        @service.start
+        @service.uri
+      end
     end # Driver
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/downloads_files.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# 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 DriverExtensions
+      module DownloadsFiles
+
+        #
+        # Sets download path for Chromium.
+        #
+        # @param [String] path
+        #
+
+        def download_path=(path)
+          params = {
+            'cmd' => 'Page.setDownloadBehavior',
+            'params' => {
+              'behavior' => 'allow',
+              'downloadPath' => path
+            }
+          }
+          @bridge.send_command(params)
+        end
+
+      end # DownloadsFiles
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_addons.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# 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 DriverExtensions
+      module HasAddons
+
+        #
+        # Installs addon.
+        #
+        # @param [String] path Full path to addon file
+        # @param [Boolean] temporary
+        # @return [String] identifier of installed addon
+        #
+
+        def install_addon(path, temporary = nil)
+          @bridge.install_addon(path, temporary)
+        end
+
+        #
+        # Uninstalls addon.
+        #
+        # @param [String] id Identifier of installed addon
+        #
+
+        def uninstall_addon(id)
+          @bridge.uninstall_addon(id)
+        end
+
+      end # HasAddons
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_debugger.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# 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 DriverExtensions
+      module HasDebugger
+
+        #
+        # Attaches debugger to session.
+        #
+        # @example
+        #   driver.attach_debugger
+        #   driver.execute_script('debugger')
+        #
+        # @return [Hash]
+        #
+
+        def attach_debugger
+          @bridge.attach_debugger
+        end
+
+      end # HasDebugger
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_location.rb

@@ -1,25 +1,40 @@
+# frozen_string_literal: true
+
+# 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 DriverExtensions
-
       module HasLocation
         def location
-          @bridge.getLocation
+          @bridge.location
         end
 
         def location=(loc)
-          unless loc.kind_of?(Location)
-            raise TypeError, "expected #{Location}, got #{loc.inspect}:#{loc.class}"
-          end
+          raise TypeError, "expected #{Location}, got #{loc.inspect}:#{loc.class}" unless loc.is_a?(Location)
 
-          @bridge.setLocation loc.latitude, loc.longitude, loc.altitude
+          @bridge.set_location loc.latitude, loc.longitude, loc.altitude
         end
 
         def set_location(lat, lon, alt)
           self.location = Location.new(Float(lat), Float(lon), Float(alt))
         end
-      end
-
-    end
-  end
-end
+      end # HasLocation
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_network_conditions.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# 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 DriverExtensions
+      module HasNetworkConditions
+
+        #
+        # Returns network conditions.
+        #
+        # @return [Hash]
+        #
+
+        def network_conditions
+          @bridge.network_conditions
+        end
+
+        #
+        # Sets network conditions
+        #
+        # @param [Hash] conditions
+        # @option conditions [Integer] :latency
+        # @option conditions [Integer] :throughput
+        # @option conditions [Boolean] :offline
+        #
+
+        def network_conditions=(conditions)
+          @bridge.network_conditions = conditions
+        end
+
+      end # HasNetworkConditions
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_network_connection.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# 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 DriverExtensions
+      module HasNetworkConnection
+        def network_connection_type
+          connection_value = @bridge.network_connection
+
+          connection_type = values_to_type[connection_value]
+
+          # In case the connection type is not recognized return the
+          # connection value.
+          connection_type || connection_value
+        end
+
+        def network_connection_type=(connection_type)
+          raise ArgumentError, 'Invalid connection type' unless valid_type? connection_type
+
+          connection_value = type_to_values[connection_type]
+
+          @bridge.network_connection = connection_value
+        end
+
+        private
+
+        def type_to_values
+          {airplane_mode: 1, wifi: 2, data: 4, all: 6, none: 0}
+        end
+
+        def values_to_type
+          type_to_values.invert
+        end
+
+        def valid_type?(type)
+          type_to_values.key? type
+        end
+      end # HasNetworkConnection
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_permissions.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# 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 DriverExtensions
+      module HasPermissions
+
+        #
+        # Returns permissions.
+        #
+        # @return [Hash]
+        #
+
+        def permissions
+          @bridge.permissions
+        end
+
+        #
+        # Sets permissions.
+        #
+        # @example
+        #   driver.permissions = {'getUserMedia' => true}
+        #
+        # @param [Hash<Symbol, Boolean>] permissions
+        #
+
+        def permissions=(permissions)
+          @bridge.permissions = permissions
+        end
+
+      end # HasPermissions
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_remote_status.rb

@@ -1,13 +1,30 @@
+# frozen_string_literal: true
+
+# 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 DriverExtensions
       module HasRemoteStatus
-
         def remote_status
           @bridge.status
         end
-
-      end
-    end
-  end
-end
+      end # HasRemoteStatus
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium