selenium-webdriver 3.4.0 → 3.4.1

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

@@ -32,6 +32,11 @@ module Selenium
         #
 
         def save_screenshot(png_path)
+          extension = File.extname(png_path).downcase
+          if extension != '.png'
+            WebDriver.logger.warn "name used for saved screenshot does not match file type. "\
+                                  "It should end with .png extension"
+          end
           File.open(png_path, 'wb') { |f| f << screenshot_as(:png) }
         end
 

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

@@ -312,7 +312,11 @@ module Selenium
       #
 
       def as_json(*)
-        key = bridge.is_a?(Remote::W3CBridge) ? 'element-6066-11e4-a52e-4f735466cecf' : 'ELEMENT'
+        key = if bridge.dialect == :w3c
+                'element-6066-11e4-a52e-4f735466cecf'
+              else
+                'ELEMENT'
+              end
         @id.is_a?(Hash) ? @id : {key => @id}
       end
 

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

@@ -104,6 +104,16 @@ module Selenium
         end
       end
 
+      #
+      # Marks code as deprecated with replacement.
+      #
+      # @param [String] old
+      # @param [String] new
+      #
+      def deprecate(old, new)
+        warn "[DEPRECATION] #{old} is deprecated. Use #{new} instead."
+      end
+
       private
 
       def create_logger(output)

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

@@ -183,13 +183,13 @@ module Selenium
       # is obscuring the element that was requested clicked.
       #
 
-      class ElementClickIntercepted < WebDriverError; end
+      class ElementClickInterceptedError < WebDriverError; end
 
       #
       # Indicates that a command could not be completed because the element is not pointer or keyboard interactable.
       #
 
-      class ElementNotInteractable < WebDriverError; end
+      class ElementNotInteractableError < WebDriverError; end
 
       # aliased for backwards compatibility
       NoAlertPresentError       = NoSuchAlertError

data/lib/selenium/webdriver/edge.rb

@@ -19,8 +19,9 @@
 
 require 'net/http'
 
-require 'selenium/webdriver/edge/service'
 require 'selenium/webdriver/edge/bridge'
+require 'selenium/webdriver/edge/driver'
+require 'selenium/webdriver/edge/service'
 
 module Selenium
   module WebDriver

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

@@ -20,42 +20,7 @@
 module Selenium
   module WebDriver
     module Edge
-      #
-      # @api private
-      #
-
-      class Bridge < Remote::W3CBridge
-        def initialize(opts = {})
-          opts[:desired_capabilities] ||= Remote::W3CCapabilities.edge
-
-          unless opts.key?(:url)
-            driver_path = opts.delete(:driver_path) || Edge.driver_path
-            port = opts.delete(:port) || Service::DEFAULT_PORT
-
-            opts[:driver_opts] ||= {}
-            if opts.key? :service_args
-              WebDriver.logger.warn <<-DEPRECATE.gsub(/\n +| {2,}/, ' ').freeze
-            [DEPRECATION] `:service_args` is deprecated. Pass switches using `driver_opts`
-              DEPRECATE
-              opts[:driver_opts][:args] = opts.delete(:service_args)
-            end
-
-            @service = Service.new(driver_path, port, opts.delete(:driver_opts))
-            @service.host = 'localhost' if @service.host == '127.0.0.1'
-            @service.start
-            opts[:url] = @service.uri
-          end
-
-          super(opts)
-        end
-
-        def browser
-          :edge
-        end
-
-        def driver_extensions
-          [DriverExtensions::TakesScreenshot]
-        end
+      module Bridge
 
         def commands(command)
           unsupported = %i[execute_script execute_async_script submit_element double_click
@@ -64,21 +29,10 @@ module Selenium
            get_window_size set_window_size get_window_position set_window_position
            maximize_window get_alert_text accept_alert dismiss_alert]
           if unsupported.include? command
-            Remote::Bridge::COMMANDS[command]
+            Remote::OSS::Bridge::COMMANDS[command]
           else
             super
           end
-
-        end
-
-        def capabilities
-          @capabilities ||= Remote::Capabilities.edge
-        end
-
-        def quit
-          super
-        ensure
-          @service.stop if @service
         end
 
         def send_keys_to_active_element(key)
@@ -116,49 +70,6 @@ module Selenium
           execute :maximize_window, window_handle: handle
         end
 
-        def create_session(desired_capabilities)
-          resp = raw_execute :new_session, {}, {desiredCapabilities: desired_capabilities}
-          @session_id = resp['sessionId']
-          return Remote::W3CCapabilities.json_create resp['value'] if @session_id
-
-          raise Error::WebDriverError, 'no sessionId in returned payload'
-        end
-
-        #
-        # executes a command on the remote server.
-        #
-        #
-        # Returns the 'value' of the returned payload
-        #
-
-        def execute(*args)
-          result = raw_execute(*args)
-          result.payload.key?('value') ? result['value'] : result
-        end
-
-        #
-        # executes a command on the remote server.
-        #
-        # @return [WebDriver::Remote::Response]
-        #
-
-        def raw_execute(command, opts = {}, command_hash = nil)
-          verb, path = commands(command) || raise(ArgumentError, "unknown command: #{command.inspect}")
-          path = path.dup
-
-          path[':session_id'] = @session_id if path.include?(':session_id')
-
-          begin
-            opts.each do |key, value|
-              path[key.inspect] = escaper.escape(value.to_s)
-            end
-          rescue IndexError
-            raise ArgumentError, "#{opts.inspect} invalid for #{command.inspect}"
-          end
-
-          WebDriver.logger.info("-> #{verb.to_s.upcase} #{path}")
-          http.call verb, path, command_hash
-        end
       end # Bridge
     end # Edge
   end # WebDriver

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

@@ -0,0 +1,80 @@
+# 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 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
+            port = opts.delete(:port) || Service::DEFAULT_PORT
+
+            opts[:driver_opts] ||= {}
+            if opts.key? :service_args
+              WebDriver.logger.deprecate ':service_args', "driver_opts: {args: #{opts[:service_args]}}"
+              opts[:driver_opts][:args] = opts.delete(:service_args)
+            end
+
+            @service = Service.new(driver_path, port, opts.delete(: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/firefox.rb

@@ -21,15 +21,18 @@ 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/driver'
+require 'selenium/webdriver/firefox/options'
 require 'selenium/webdriver/firefox/service'
 
 module Selenium

data/lib/selenium/webdriver/firefox/driver.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 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

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

@@ -0,0 +1,81 @@
+# 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 Firefox
+      module Legacy
+
+        #
+        # Driver implementation for Firefox using legacy extension.
+        # @api private
+        #
+
+        class Driver < WebDriver::Driver
+          include DriverExtensions::TakesScreenshot
+
+          def initialize(opts = {})
+            opts[:desired_capabilities] ||= Remote::Capabilities.firefox
+
+            if opts.key? :proxy
+              WebDriver.logger.deprecate ':proxy', "Selenium::WebDriver::Remote::Capabilities.firefox(proxy: #{opts[:proxy]})"
+              opts[:desired_capabilities].proxy = opts.delete(:proxy)
+            end
+
+            unless opts.key?(:url)
+              port = opts.delete(:port) || DEFAULT_PORT
+              profile = opts.delete(:profile)
+
+              Binary.path = opts[:desired_capabilities][:firefox_binary] if opts[:desired_capabilities][:firefox_binary]
+              @launcher = Launcher.new Binary.new, port, profile
+              @launcher.launch
+              opts[:url] = @launcher.url
+            end
+
+            listener = opts.delete(:listener)
+            WebDriver.logger.info 'Skipping handshake as we know it is OSS.'
+            desired_capabilities = opts.delete(:desired_capabilities)
+            bridge = Remote::Bridge.new(opts)
+            capabilities = bridge.create_session(desired_capabilities)
+            @bridge = Remote::OSS::Bridge.new(capabilities, bridge.session_id, opts)
+
+            begin
+              super(@bridge, listener: listener)
+            rescue
+              @launcher.quit if @launcher
+              raise
+            end
+          end
+
+          def browser
+            :firefox
+          end
+
+          def quit
+            super
+            nil
+          ensure
+            @launcher.quit
+          end
+
+        end # Driver
+      end # Legacy
+    end # Firefox
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,101 @@
+# 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 Firefox
+      module Marionette
+
+        #
+        # Driver implementation for Firefox using GeckoDriver.
+        # @api private
+        #
+
+        class Driver < WebDriver::Driver
+          include DriverExtensions::HasWebStorage
+          include DriverExtensions::TakesScreenshot
+
+          def initialize(opts = {})
+            opts[:desired_capabilities] = create_capabilities(opts)
+
+            unless opts.key?(:url)
+              driver_path = opts.delete(:driver_path) || Firefox.driver_path
+              port = opts.delete(:port) || Service::DEFAULT_PORT
+
+              opts[:driver_opts] ||= {}
+              if opts.key? :service_args
+                WebDriver.logger.deprecate ':service_args', "driver_opts: {args: #{opts[:service_args]}}"
+                opts[:driver_opts][:args] = opts.delete(:service_args)
+              end
+
+              @service = Service.new(driver_path, port, opts.delete(:driver_opts))
+              @service.start
+              opts[:url] = @service.uri
+            end
+
+            listener = opts.delete(:listener)
+            WebDriver.logger.info 'Skipping handshake as we know it is W3C.'
+            desired_capabilities = opts.delete(:desired_capabilities)
+            bridge = Remote::Bridge.new(opts)
+            capabilities = bridge.create_session(desired_capabilities)
+            @bridge = Remote::W3C::Bridge.new(capabilities, bridge.session_id, opts)
+
+            super(@bridge, listener: listener)
+          end
+
+          def browser
+            :firefox
+          end
+
+          def quit
+            super
+          ensure
+            @service.stop if @service
+          end
+
+          private
+
+          def create_capabilities(opts)
+            caps = opts.delete(:desired_capabilities) { Remote::W3C::Capabilities.firefox }
+            options = opts.delete(:options) { Options.new }
+
+            firefox_options = opts.delete(:firefox_options)
+            if firefox_options
+              WebDriver.logger.deprecate ':firefox_options', 'Selenium::WebDriver::Firefox::Options'
+              firefox_options.each do |key, value|
+                options.add_option(key, value)
+              end
+            end
+
+            profile = opts.delete(:profile)
+            if profile
+              WebDriver.logger.deprecate ':profile', 'Selenium::WebDriver::Firefox::Options#profile='
+              options.profile = profile
+            end
+
+            options = options.as_json
+            caps.merge!(options) unless options.empty?
+
+            caps
+          end
+        end # Driver
+      end # Marionette
+    end # Firefox
+  end # WebDriver
+end # Selenium