selenium-webdriver 4.0.0.alpha2 → 4.0.0.alpha3

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

@@ -77,8 +77,8 @@ module Selenium
 
           extensions.concat(@encoded_extensions)
 
-          opts = {directory: directory || layout_on_disk}
-          opts[:extensions] = extensions if extensions.any?
+          opts = {'directory' => directory || layout_on_disk}
+          opts['extensions'] = extensions if extensions.any?
           opts
         end
 

data/lib/selenium/webdriver/common.rb

@@ -64,5 +64,6 @@ require 'selenium/webdriver/common/driver_extensions/uploads_files'
 require 'selenium/webdriver/common/driver_extensions/has_addons'
 require 'selenium/webdriver/common/keys'
 require 'selenium/webdriver/common/profile_helper'
+require 'selenium/webdriver/common/options'
 require 'selenium/webdriver/common/driver'
 require 'selenium/webdriver/common/element'

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

@@ -52,6 +52,10 @@ module Selenium
             Firefox::Driver.new(opts)
           when :edge
             Edge::Driver.new(opts)
+          when :edge_chrome
+            EdgeChrome::Driver.new(opts)
+          when :edge_html
+            EdgeHtml::Driver.new(opts)
           when :remote
             Remote::Driver.new(opts)
           else
@@ -68,6 +72,7 @@ module Selenium
       #
 
       def initialize(bridge, listener: nil)
+        @service = nil
         @bridge = bridge
         @bridge = Support::EventFiringBridge.new(bridge, listener) if listener
       end
@@ -164,6 +169,8 @@ module Selenium
 
       def quit
         bridge.quit
+      ensure
+        @service&.stop
       end
 
       #

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

@@ -0,0 +1,92 @@
+# 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
+    class Options
+      attr_accessor :options
+
+      def initialize(options: nil, **opts)
+        @options = if options
+                     WebDriver.logger.deprecate(":options as keyword for initializing #{self.class}",
+                                                "custom values directly in #new constructor")
+                     opts.merge(options)
+                   else
+                     opts
+                   end
+      end
+
+      #
+      # Add a new option not yet handled by bindings.
+      #
+      # @example Leave Chrome open when chromedriver is killed
+      #   options = Selenium::WebDriver::Chrome::Options.new
+      #   options.add_option(:detach, true)
+      #
+      # @param [String, Symbol] name Name of the option
+      # @param [Boolean, String, Integer] value Value of the option
+      #
+
+      def add_option(name, value)
+        @options[name] = value
+      end
+
+      #
+      # @api private
+      #
+
+      def as_json(*)
+        options = @options.dup
+
+        opts = self.class::CAPABILITIES.each_with_object({}) do |(capability_alias, capability_name), hash|
+          capability_value = options.delete(capability_alias)
+          hash[capability_name] = capability_value unless capability_value.nil?
+        end
+        opts.merge(options)
+      end
+
+      private
+
+      def generate_as_json(value)
+        if value.respond_to?(:as_json)
+          value.as_json
+        elsif value.is_a?(Hash)
+          value.each_with_object({}) { |(key, val), hash| hash[convert_json_key(key)] = generate_as_json(val) }
+        elsif value.is_a?(Array)
+          value.map(&method(:generate_as_json))
+        elsif value.is_a?(Symbol)
+          value.to_s
+        else
+          value
+        end
+      end
+
+      def convert_json_key(key)
+        key = camel_case(key) if key.is_a?(Symbol)
+        return key if key.is_a?(String)
+
+        raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class}"
+      end
+
+      def camel_case(str)
+        str.to_s.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
+      end
+    end # Options
+  end # WebDriver
+end # Selenium

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

@@ -31,8 +31,16 @@ module Selenium
         base.extend ClassMethods
       end
 
+      def self.decoded(json)
+        JSON.parse(json).fetch('zip')
+      end
+
+      def encoded
+        Zipper.zip(layout_on_disk)
+      end
+
       def as_json(*)
-        {"zip" => Zipper.zip(layout_on_disk)}
+        {"zip" => encoded}
       end
 
       def to_json(*)
@@ -63,7 +71,7 @@ module Selenium
 
       module ClassMethods
         def from_json(json)
-          data = JSON.parse(json).fetch('zip')
+          data = decoded(json)
 
           # can't use Tempfile here since it doesn't support File::BINARY mode on 1.8
           # can't use Dir.mktmpdir(&blk) because of http://jira.codehaus.org/browse/JRUBY-4082

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

@@ -32,25 +32,46 @@ module Selenium
       class << self
         attr_reader :driver_path
 
-        def chrome(*args)
-          Chrome::Service.new(*args)
+        def chrome(**opts)
+          Chrome::Service.new(**opts)
         end
 
-        def firefox(*args)
-          Firefox::Service.new(*args)
+        def firefox(**opts)
+          binary_path = Firefox::Binary.path
+          args = opts.delete(:args)
+          case args
+          when Hash
+            args[:binary] ||= binary_path
+            opts[:args] = args
+          when Array
+            opts[:args] = ["--binary=#{binary_path}"]
+            opts[:args] += args
+          else
+            opts[:args] = ["--binary=#{binary_path}"]
+          end
+
+          Firefox::Service.new(**opts)
         end
 
-        def ie(*args)
-          IE::Service.new(*args)
+        def ie(**opts)
+          IE::Service.new(**opts)
         end
         alias_method :internet_explorer, :ie
 
-        def edge(*args)
-          Edge::Service.new(*args)
+        def edge(**opts)
+          Edge::Service.new(**opts)
         end
 
-        def safari(*args)
-          Safari::Service.new(*args)
+        def edge_chrome(**opts)
+          EdgeChrome::Service.new(**opts)
+        end
+
+        def edge_html(**opts)
+          EdgeHtml::Service.new(**opts)
+        end
+
+        def safari(**opts)
+          Safari::Service.new(**opts)
         end
 
         def driver_path=(path)
@@ -164,7 +185,10 @@ module Selenium
       def stop_server
         return if process_exited?
 
-        connect_to_server { |http| http.get('/shutdown') }
+        connect_to_server do |http|
+          headers = WebDriver::Remote::Http::Common::DEFAULT_HEADERS.dup
+          http.get('/shutdown', headers)
+        end
       end
 
       def process_running?

data/lib/selenium/webdriver/edge.rb

@@ -19,12 +19,13 @@
 
 require 'net/http'
 
-require 'selenium/webdriver/edge/driver'
-require 'selenium/webdriver/edge/options'
-
 module Selenium
   module WebDriver
-    module Edge
+    module EdgeHtml
+      autoload :Driver, 'selenium/webdriver/edge_html/driver'
+      autoload :Options, 'selenium/webdriver/edge_html/options'
+      autoload :Service, 'selenium/webdriver/edge_html/service'
+
       def self.driver_path=(path)
         WebDriver.logger.deprecate 'Selenium::WebDriver::Edge#driver_path=',
                                    'Selenium::WebDriver::Edge::Service#driver_path='
@@ -36,8 +37,25 @@ module Selenium
                                    'Selenium::WebDriver::Edge::Service#driver_path'
         Selenium::WebDriver::Edge::Service.driver_path
       end
-    end # Edge
+    end # EdgeHtml
+
+    module EdgeChrome
+      autoload :Bridge, 'selenium/webdriver/edge_chrome/bridge'
+      autoload :Driver, 'selenium/webdriver/edge_chrome/driver'
+      autoload :Profile, 'selenium/webdriver/edge_chrome/profile'
+      autoload :Options, 'selenium/webdriver/edge_chrome/options'
+      autoload :Service, 'selenium/webdriver/edge_chrome/service'
+
+      def self.path=(path)
+        Platform.assert_executable path
+        @path = path
+      end
+
+      def self.path
+        @path ||= nil
+      end
+    end # EdgeChrome
+
+    Edge = EdgeHtml # Alias EdgeHtml as Edge for now
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/edge/service'

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

@@ -0,0 +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.
+
+require 'selenium/webdriver/chrome/bridge'
+
+module Selenium
+  module WebDriver
+    module EdgeChrome
+      module Bridge
+        include Selenium::WebDriver::Chrome::Bridge
+      end # Bridge
+    end # EdgeChrome
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,38 @@
+# 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/driver'
+
+module Selenium
+  module WebDriver
+    module EdgeChrome
+
+      #
+      # Driver implementation for EdgeChrome.
+      # @api private
+      #
+
+      class Driver < Selenium::WebDriver::Chrome::Driver
+        def browser
+          :edge_chrome
+        end
+      end # Driver
+    end # Chrome
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,34 @@
+# 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/options'
+
+module Selenium
+  module WebDriver
+    module EdgeChrome
+      class Options < Selenium::WebDriver::Chrome::Options
+        private
+
+        def binary_path
+          EdgeChrome.path
+        end
+      end # Options
+    end # EdgeChrome
+  end # WebDriver
+end # Selenium

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,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.
+
+require 'selenium/webdriver/chrome/service'
+
+module Selenium
+  module WebDriver
+    module EdgeChrome
+      #
+      # @api private
+      #
+
+      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