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

data/lib/selenium/webdriver/firefox/extension.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
@@ -25,12 +25,10 @@ module Selenium
       #
 
       class Extension
-        NAMESPACE = 'http://www.mozilla.org/2004/em-rdf#'.freeze
+        NAMESPACE = 'http://www.mozilla.org/2004/em-rdf#'
 
         def initialize(path)
-          unless File.exist?(path)
-            raise Error::WebDriverError, "could not find extension at #{path.inspect}"
-          end
+          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.exist?(path)
 
           @path             = path
           @should_reap_root = false
@@ -38,10 +36,10 @@ module Selenium
 
         def write_to(extensions_dir)
           root_dir = create_root
-          ext_path = File.join extensions_dir, read_id_from_install_rdf(root_dir)
+          ext_path = File.join extensions_dir, read_id(root_dir)
 
           FileUtils.rm_rf ext_path
-          FileUtils.mkdir_p File.dirname(ext_path), mode: 0700
+          FileUtils.mkdir_p File.dirname(ext_path), mode: 0o700
           FileUtils.cp_r root_dir, ext_path
 
           FileReaper.reap(root_dir) if @should_reap_root
@@ -62,8 +60,14 @@ module Selenium
           end
         end
 
+        def read_id(directory)
+          read_id_from_install_rdf(directory) || read_id_from_manifest_json(directory)
+        end
+
         def read_id_from_install_rdf(directory)
           rdf_path = File.join(directory, 'install.rdf')
+          return unless File.exist?(rdf_path)
+
           doc = REXML::Document.new(File.read(rdf_path))
           namespace = doc.root.namespaces.key(NAMESPACE)
 
@@ -77,6 +81,22 @@ module Selenium
 
           raise Error::WebDriverError, "cannot locate extension id in #{rdf_path}"
         end
+
+        def read_id_from_manifest_json(directory)
+          manifest_path = File.join(directory, 'manifest.json')
+          return unless File.exist?(manifest_path)
+
+          manifest = JSON.parse(File.read(manifest_path))
+          applications_gecko_id(manifest) || name_and_version(manifest)
+        end
+
+        def applications_gecko_id(manifest)
+          manifest.dig('applications', 'gecko', 'id')&.strip
+        end
+
+        def name_and_version(manifest)
+          [manifest['name'].delete(' '), manifest['version']].join('@')
+        end
       end # Extension
     end # Firefox
   end # WebDriver

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

@@ -0,0 +1,162 @@
+# 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 Firefox
+      class Options < WebDriver::Options
+        KEY = 'moz:firefoxOptions'
+
+        # see: https://firefox-source-docs.mozilla.org/testing/geckodriver/Capabilities.html
+        CAPABILITIES = {binary: 'binary',
+                        args: 'args',
+                        profile: 'profile',
+                        log: 'log',
+                        prefs: 'prefs'}.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, only for W3C-capable versions of Firefox.
+        #
+        # @example
+        #   options = Selenium::WebDriver::Firefox::Options.new(args: ['--host=127.0.0.1'])
+        #   driver = Selenium::WebDriver.for :firefox, options: options
+        #
+        # @param [Hash] opts the pre-defined options to create the Firefox::Options with
+        # @option opts [String] :binary Path to the Firefox executable to use
+        # @option opts [Array<String>] :args List of command-line arguments to use when starting geckodriver
+        # @option opts [Profile, String] :profile Encoded profile string or Profile instance
+        # @option opts [String, Symbol] :log_level Log level for geckodriver
+        # @option opts [Hash] :prefs A hash with each entry consisting of the key of the preference and its value
+        # @option opts [Hash] :options A hash for raw options
+        #
+
+        def initialize(log_level: nil, **opts)
+          super(opts)
+
+          @options[:log] ||= {level: log_level} if log_level
+          process_profile(@options[:profile]) if @options.key?(:profile)
+        end
+
+        #
+        # Add a command-line argument to use when starting Firefox.
+        #
+        # @example Start geckodriver on a specific host
+        #   options = Selenium::WebDriver::Firefox::Options.new
+        #   options.add_argument('--host=127.0.0.1')
+        #
+        # @param [String] arg The command-line argument to add
+        #
+
+        def add_argument(arg)
+          @options[:args] ||= []
+          @options[:args] << arg
+        end
+
+        #
+        # Add a preference that is only applied to the user profile in use.
+        #
+        # @example Set the default homepage
+        #   options = Selenium::WebDriver::Firefox::Options.new
+        #   options.add_preference('browser.startup.homepage', 'http://www.seleniumhq.com/')
+        #
+        # @param [String] name Key of the preference
+        # @param [Boolean, String, Integer] value Value of the preference
+        #
+
+        def add_preference(name, value)
+          @options[:prefs] ||= {}
+          @options[:prefs][name] = value
+        end
+
+        #
+        # Run Firefox in headless mode.
+        #
+        # @example Enable headless mode
+        #   options = Selenium::WebDriver::Firefox::Options.new
+        #   options.headless!
+        #
+
+        def headless!
+          add_argument '-headless'
+        end
+
+        #
+        # Sets Firefox profile.
+        #
+        # @example Set the custom profile
+        #   profile = Selenium::WebDriver::Firefox::Profile.new
+        #   options = Selenium::WebDriver::Firefox::Options.new
+        #   options.profile = profile
+        #
+        # @example Use existing profile
+        #   options = Selenium::WebDriver::Firefox::Options.new
+        #   options.profile = 'myprofile'
+        #
+        # @param [Profile, String] profile Profile to be used
+        #
+
+        undef profile=
+        def profile=(profile)
+          process_profile(profile)
+        end
+
+        def log_level
+          @options.dig(:log, :level)
+        end
+
+        def log_level=(level)
+          @options[:log] = {level: level}
+        end
+
+        #
+        # @api private
+        #
+
+        def as_json(*)
+          options = super
+          options['binary'] ||= Firefox.path if Firefox.path
+
+          {KEY => generate_as_json(options)}
+        end
+
+        private
+
+        def process_profile(profile)
+          @options[:profile] = if profile.nil?
+                                 nil
+                               elsif profile.is_a? Profile
+                                 profile
+                               else
+                                 Profile.from_name(profile)
+                               end
+        end
+      end # Options
+    end # Firefox
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/firefox/profile.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
@@ -23,18 +23,10 @@ module Selenium
       class Profile
         include ProfileHelper
 
-        VALID_PREFERENCE_TYPES   = [TrueClass, FalseClass, Integer, Float, String].freeze
-        WEBDRIVER_EXTENSION_PATH = File.expand_path("#{WebDriver.root}/selenium/webdriver/firefox/extension/webdriver.xpi")
-        WEBDRIVER_PREFS          = {
-          native_events: 'webdriver_enable_native_events',
-          untrusted_certs: 'webdriver_accept_untrusted_certs',
-          untrusted_issuer: 'webdriver_assume_untrusted_issuer',
-          port: 'webdriver_firefox_port',
-          log_file: 'webdriver.log.file'
-        }.freeze
+        VALID_PREFERENCE_TYPES = [TrueClass, FalseClass, Integer, Float, String].freeze
 
         attr_reader   :name, :log_file
-        attr_writer   :secure_ssl, :native_events, :load_no_focus_lib
+        attr_writer   :secure_ssl, :load_no_focus_lib
 
         class << self
           def ini
@@ -42,13 +34,14 @@ module Selenium
           end
 
           def from_name(name)
-            ini[name]
+            profile = ini[name]
+            return profile if profile
+
+            raise Error::WebDriverError, "unable to find profile named: #{name.inspect}"
           end
 
-          def default_preferences
-            @default_preferences ||= JSON.parse(
-              File.read(File.expand_path("#{WebDriver.root}/selenium/webdriver/firefox/extension/prefs.json"))
-            ).freeze
+          def decoded(json)
+            JSON.parse(json)
           end
         end
 
@@ -67,25 +60,7 @@ module Selenium
         def initialize(model = nil)
           @model = verify_model(model)
 
-          model_prefs = read_model_prefs
-
-          if model_prefs.empty?
-            @native_events     = DEFAULT_ENABLE_NATIVE_EVENTS
-            @secure_ssl        = DEFAULT_SECURE_SSL
-            @untrusted_issuer  = DEFAULT_ASSUME_UNTRUSTED_ISSUER
-            @load_no_focus_lib = DEFAULT_LOAD_NO_FOCUS_LIB
-
-            @additional_prefs  = {}
-          else
-            # TODO: clean this up
-            @native_events     = model_prefs.delete(WEBDRIVER_PREFS[:native_events]) == 'true'
-            @secure_ssl        = model_prefs.delete(WEBDRIVER_PREFS[:untrusted_certs]) != 'true'
-            @untrusted_issuer  = model_prefs.delete(WEBDRIVER_PREFS[:untrusted_issuer]) == 'true'
-            # not stored in profile atm, so will always be false.
-            @load_no_focus_lib = model_prefs.delete(WEBDRIVER_PREFS[:load_no_focus_lib]) == 'true'
-            @additional_prefs  = model_prefs
-          end
-
+          @additional_prefs = read_model_prefs
           @extensions = {}
         end
 
@@ -113,7 +88,7 @@ module Selenium
             raise TypeError, "expected one of #{VALID_PREFERENCE_TYPES.inspect}, got #{value.inspect}:#{value.class}"
           end
 
-          if value.is_a?(String) && Util.stringified?(value)
+          if value.is_a?(String) && stringified?(value)
             raise ArgumentError, "preference values must be plain strings: #{key.inspect} => #{value.inspect}"
           end
 
@@ -129,11 +104,6 @@ module Selenium
           self[WEBDRIVER_PREFS[:log_file]] = file
         end
 
-        def add_webdriver_extension
-          return if @extensions.key?(:webdriver)
-          add_extension(WEBDRIVER_EXTENSION_PATH, :webdriver)
-        end
-
         #
         # Add the extension (directory, .zip or .xpi) at the given path to the profile.
         #
@@ -142,30 +112,8 @@ module Selenium
           @extensions[name] = Extension.new(path)
         end
 
-        def native_events?
-          @native_events == true
-        end
-
-        def load_no_focus_lib?
-          @load_no_focus_lib == true
-        end
-
-        def secure_ssl?
-          @secure_ssl == true
-        end
-
-        def assume_untrusted_certificate_issuer?
-          @untrusted_issuer == true
-        end
-
-        def assume_untrusted_certificate_issuer=(bool)
-          @untrusted_issuer = bool
-        end
-
         def proxy=(proxy)
-          unless proxy.is_a? Proxy
-            raise TypeError, "expected #{Proxy.name}, got #{proxy.inspect}:#{proxy.class}"
-          end
+          raise TypeError, "expected #{Proxy.name}, got #{proxy.inspect}:#{proxy.class}" unless proxy.is_a? Proxy
 
           case proxy.type
           when :manual
@@ -176,11 +124,7 @@ module Selenium
             set_manual_proxy_preference 'ssl', proxy.ssl
             set_manual_proxy_preference 'socks', proxy.socks
 
-            self['network.proxy.no_proxies_on'] = if proxy.no_proxy
-                                                    proxy.no_proxy
-                                                  else
-                                                    ''
-                                                  end
+            self['network.proxy.no_proxies_on'] = proxy.no_proxy || ''
           when :pac
             self['network.proxy.type'] = 2
             self['network.proxy.autoconfig_url'] = proxy.pac
@@ -189,10 +133,10 @@ module Selenium
           else
             raise ArgumentError, "unsupported proxy type #{proxy.type}"
           end
-
-          proxy
         end
 
+        alias_method :as_json, :encoded
+
         private
 
         def set_manual_proxy_preference(key, value)
@@ -208,7 +152,7 @@ module Selenium
           destination = File.join(directory, 'extensions')
 
           @extensions.each do |name, extension|
-            p extension: name if $DEBUG
+            WebDriver.logger.debug({extenstion: name}.inspect)
             extension.write_to(destination)
           end
         end
@@ -235,15 +179,7 @@ module Selenium
 
         def update_user_prefs_in(directory)
           path = File.join(directory, 'user.js')
-          prefs = read_user_prefs(path)
-
-          prefs.merge! self.class.default_preferences.fetch 'mutable'
-          prefs.merge! @additional_prefs
-          prefs.merge! self.class.default_preferences.fetch 'frozen'
-
-          prefs[WEBDRIVER_PREFS[:untrusted_certs]]  = !secure_ssl?
-          prefs[WEBDRIVER_PREFS[:native_events]]    = native_events?
-          prefs[WEBDRIVER_PREFS[:untrusted_issuer]] = assume_untrusted_certificate_issuer?
+          prefs = read_user_prefs(path).merge(@additional_prefs)
 
           # If the user sets the home page, we should also start up there
           prefs['startup.homepage_welcome_url'] = prefs['browser.startup.homepage']
@@ -257,6 +193,7 @@ module Selenium
 
           File.read(path).split("\n").each do |line|
             next unless line =~ /user_pref\("([^"]+)"\s*,\s*(.+?)\);/
+
             key = Regexp.last_match(1).strip
             value = Regexp.last_match(2).strip
 
@@ -274,6 +211,10 @@ module Selenium
             end
           end
         end
+
+        def stringified?(str)
+          /^".*"$/.match?(str)
+        end
       end # Profile
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/firefox/profiles_ini.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
@@ -57,15 +57,15 @@ module Selenium
               is_relative = Regexp.last_match(1).strip == '1'
             when /^Path=(.+)$/
               path = Regexp.last_match(1).strip
+              p = path_for(name, is_relative, path)
+              @profile_paths[name] = p if p
             end
           end
-
-          p = path_for(name, is_relative, path)
-          @profile_paths[name] = p if p
         end
 
         def path_for(name, is_relative, path)
           return unless [name, path].any?
+
           is_relative ? File.join(Util.app_data_path, path) : path
         end
       end # ProfilesIni