selenium-webdriver 3.0.0.beta4.0 → 4.0.0.alpha5

data/lib/selenium/webdriver/edge_chrome/profile.rb

@@ -0,0 +1,33 @@
+# 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.
+
+require 'selenium/webdriver/chrome/profile'
+
+module Selenium
+  module WebDriver
+    module EdgeChrome
+      #
+      # @private
+      #
+
+      class Profile < Selenium::WebDriver::Chrome::Profile
+      end # Profile
+    end # EdgeChrome
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,36 @@
+# 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.
+
+require 'selenium/webdriver/chrome/service'
+
+module Selenium
+  module WebDriver
+    module EdgeChrome
+      class Service < Selenium::WebDriver::Chrome::Service
+        DEFAULT_PORT = 9515
+        EXECUTABLE = 'msedgedriver'
+        MISSING_TEXT = <<~ERROR
+          Unable to find msedgedriver. Please download the server from
+          https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ and place it somewhere on your PATH.
+        ERROR
+        SHUTDOWN_SUPPORTED = true
+      end # Service
+    end # EdgeChrome
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,39 @@
+# 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 EdgeHtml
+
+      #
+      # Driver implementation for Microsoft Edge.
+      # @api private
+      #
+
+      class Driver < WebDriver::Driver
+        include DriverExtensions::HasWebStorage
+        include DriverExtensions::TakesScreenshot
+
+        def browser
+          :edge
+        end
+      end # Driver
+    end # EdgeHtml
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/edge_html/options.rb

@@ -0,0 +1,91 @@
+# 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 EdgeHtml
+      class Options < WebDriver::Options
+        # see https://docs.microsoft.com/en-us/microsoft-edge/webdriver#capabilities
+        CAPABILITIES = {in_private: 'ms:inPrivate',
+                        extension_paths: 'ms:extensionPaths',
+                        start_page: 'ms:startPage'}.freeze
+
+        CAPABILITIES.each_key do |key|
+          define_method key do
+            @options[key]
+          end
+
+          define_method "#{key}=" do |value|
+            @options[key] = value
+          end
+        end
+
+        #
+        # Create a new Options instance for Edge.
+        #
+        # @example
+        #   options = Selenium::WebDriver::Edge::Options.new(in_private: true)
+        #   driver = Selenium::WebDriver.for :edge, options: options
+        #
+        # @param [Hash] opts the pre-defined options to create the Edge::Options with
+        # @option opts [Boolean] :in_private Start in private mode. Default is false
+        # @option opts [Array<String>] :extension_paths A list of full paths to extensions to install on startup
+        # @option opts [String] :start_page Default page to start with
+        #
+        # @see https://docs.microsoft.com/en-us/microsoft-edge/webdriver
+        #
+
+        def initialize(**opts)
+          super
+          @options[:extensions]&.each(&method(:validate_extension))
+        end
+
+        #
+        # Add an extension by local path.
+        #
+        # @example
+        #   options = Selenium::WebDriver::Edge::Options.new
+        #   options.add_extension_path('C:\path\to\extension')
+        #
+        # @param [String] path The local path to the extension folder
+        #
+
+        def add_extension_path(path)
+          validate_extension(path)
+          @options[:extension_paths] ||= []
+          @options[:extension_paths] << path
+        end
+
+        #
+        # @api private
+        #
+
+        def as_json(*)
+          generate_as_json(super)
+        end
+
+        private
+
+        def validate_extension(path)
+          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.directory?(path)
+        end
+      end # Options
+    end # EdgeHtml
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,47 @@
+# 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 EdgeHtml
+      class Service < WebDriver::Service
+        DEFAULT_PORT = 17556
+        EXECUTABLE = 'MicrosoftWebDriver'
+        MISSING_TEXT = <<~ERROR
+          Unable to find MicrosoftWebDriver. Please install it following instructions
+          at https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/.
+        ERROR
+        SHUTDOWN_SUPPORTED = false
+
+        private
+
+        # Note: This processing is deprecated
+        def extract_service_args(driver_opts)
+          driver_args = super
+          driver_opts = driver_opts.dup
+          driver_args << "--host=#{driver_opts[:host]}" if driver_opts.key? :host
+          driver_args << "--package=#{driver_opts[:package]}" if driver_opts.key? :package
+          driver_args << "--silent" if driver_opts[:silent] == true
+          driver_args << "--verbose" if driver_opts[:verbose] == true
+          driver_args
+        end
+      end # Service
+    end # EdgeHtml
+  end # WebDriver
+end # Service

data/lib/selenium/webdriver/firefox.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -21,49 +21,44 @@ require 'timeout'
 require 'socket'
 require 'rexml/document'
 
-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/service'
-
 module Selenium
   module WebDriver
     module Firefox
+      autoload :Extension, 'selenium/webdriver/firefox/extension'
+      autoload :ProfilesIni, 'selenium/webdriver/firefox/profiles_ini'
+      autoload :Profile, 'selenium/webdriver/firefox/profile'
+      autoload :Bridge, 'selenium/webdriver/firefox/bridge'
+      autoload :Driver, 'selenium/webdriver/firefox/driver'
+      autoload :Options, 'selenium/webdriver/firefox/options'
+      autoload :Service, 'selenium/webdriver/firefox/service'
+
       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
 
-      MISSING_TEXT = <<-ERROR.tr("\n", '').freeze
-        Unable to find Mozilla geckodriver. Please download the server from
-        https://github.com/mozilla/geckodriver/releases and place it
-        somewhere on your PATH. More info at https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver.
-      ERROR
-
       def self.driver_path=(path)
-        Platform.assert_executable path
-        @driver_path = path
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path=',
+                                   'Selenium::WebDriver::Firefox::Service#driver_path=',
+                                   id: :driver_path
+        Selenium::WebDriver::Firefox::Service.driver_path = path
       end
 
       def self.driver_path
-        @driver_path ||= begin
-          path = Platform.find_binary('geckodriver*')
-          raise Error::WebDriverError, MISSING_TEXT unless path
-          Platform.assert_executable path
-
-          path
-        end
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path',
+                                   'Selenium::WebDriver::Firefox::Service#driver_path',
+                                   id: :driver_path
+        Selenium::WebDriver::Firefox::Service.driver_path
       end
 
       def self.path=(path)
-        Binary.path = path
+        Platform.assert_executable path
+        @path = path
+      end
+
+      def self.path
+        @path ||= nil
       end
     end # Firefox
   end # WebDriver

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

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -20,51 +20,27 @@
 module Selenium
   module WebDriver
     module Firefox
-      # @api private
-      class Bridge < Remote::Bridge
-        def initialize(opts = {})
-          port = opts.delete(:port) || DEFAULT_PORT
-          profile = opts.delete(:profile)
+      module Bridge
 
-          @launcher = create_launcher(port, profile)
-          @launcher.launch
-          opts[:url] = @launcher.url
+        COMMANDS = {
+          install_addon: [:post, 'session/:session_id/moz/addon/install'],
+          uninstall_addon: [:post, 'session/:session_id/moz/addon/uninstall']
+        }.freeze
 
-          caps = opts[:desired_capabilities] ||= Remote::Capabilities.firefox
-          caps.proxy = opts.delete(:proxy) if opts.key?(:proxy)
-          Binary.path = caps[:firefox_binary] if caps[:firefox_binary]
-
-          begin
-            super(opts)
-          rescue
-            @launcher.quit
-            raise
-          end
+        def commands(command)
+          COMMANDS[command] || super
         end
 
-        def browser
-          :firefox
+        def install_addon(path, temporary)
+          payload = {path: path}
+          payload[:temporary] = temporary unless temporary.nil?
+          execute :install_addon, {}, payload
         end
 
-        def driver_extensions
-          [
-            DriverExtensions::TakesScreenshot,
-            DriverExtensions::HasInputDevices
-          ]
+        def uninstall_addon(id)
+          execute :uninstall_addon, {}, {id: id}
         end
 
-        def quit
-          super
-          nil
-        ensure
-          @launcher.quit
-        end
-
-        private
-
-        def create_launcher(port, profile)
-          Launcher.new Binary.new, port, profile
-        end
       end # Bridge
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/firefox/{util.rb → driver.rb}

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -20,27 +20,21 @@
 module Selenium
   module WebDriver
     module Firefox
+
+      #
+      # Driver implementation for Firefox using GeckoDriver.
       # @api private
-      module Util
-        module_function
+      #
 
-        def app_data_path
-          case Platform.os
-          when :windows
-            "#{ENV['APPDATA']}\\Mozilla\\Firefox"
-          when :macosx
-            "#{Platform.home}/Library/Application Support/Firefox"
-          when :unix, :linux
-            "#{Platform.home}/.mozilla/firefox"
-          else
-            raise "Unknown os: #{Platform.os}"
-          end
-        end
+      class Driver < WebDriver::Driver
+        include DriverExtensions::HasAddons
+        include DriverExtensions::HasWebStorage
+        include DriverExtensions::TakesScreenshot
 
-        def stringified?(str)
-          str =~ /^".*"$/
+        def browser
+          :firefox
         end
-      end # Util
+      end # Driver
     end # Firefox
   end # WebDriver
 end # Selenium