selenium-webdriver 3.142.7 → 4.16.0

data/lib/selenium/webdriver/support/guards/guard.rb

@@ -0,0 +1,90 @@
+# 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 Support
+      class Guards
+        #
+        # Guard derived from RSpec example metadata.
+        # @api private
+        #
+
+        class Guard
+          attr_reader :guarded, :type, :messages, :reason
+
+          def initialize(guarded, type, guards = nil)
+            @guarded = guarded
+            @tracker = guards&.bug_tracker || ''
+            @messages = guards&.messages || {}
+            @messages[:unknown] = 'TODO: Investigate why this is failing and file a bug report'
+            @type = type
+
+            @reason = @guarded.delete(:reason)
+          end
+
+          def message
+            details = case @reason
+                      when Integer
+                        "Bug Filed: #{@tracker}/#{@reason}"
+                      when Symbol
+                        @messages[@reason]
+                      when String
+                        @reason
+                      else
+                        'no reason given'
+                      end
+
+            case @type
+            when :exclude
+              "Test skipped because it breaks test run; #{details}"
+            when :flaky
+              "Test skipped because it is unreliable in this configuration; #{details}"
+            when :exclusive
+              "Test does not apply to this configuration; #{details}"
+            else
+              "Test guarded; #{details}"
+            end
+          end
+
+          # Bug is present on all configurations specified
+          def except?
+            @type == :except
+          end
+
+          # Bug is present on all configurations not specified
+          def only?
+            @type == :only
+          end
+
+          # Bug is present on all configurations specified, but test can not be run because it breaks other tests,
+          # or it is flaky and unreliable
+          def exclude?
+            @type == :exclude || @type == :flaky
+          end
+
+          # Test only applies to configurations specified
+          def exclusive?
+            @type == :exclusive
+          end
+        end # Guard
+      end # Guards
+    end # Support
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/{firefox/marionette/bridge.rb → support/guards/guard_condition.rb}

@@ -19,31 +19,32 @@
 
 module Selenium
   module WebDriver
-    module Firefox
-      module Marionette
-        module Bridge
+    module Support
+      class Guards
+        #
+        # Guard derived from RSpec example metadata.
+        # @api private
+        #
 
-          COMMANDS = {
-            install_addon: [:post, 'session/:session_id/moz/addon/install'],
-            uninstall_addon: [:post, 'session/:session_id/moz/addon/uninstall']
-          }.freeze
+        class GuardCondition
+          attr_accessor :name, :execution
 
-          def commands(command)
-            COMMANDS[command] || super
+          def initialize(name, condition = nil, &blk)
+            @name = name
+            @execution = if blk
+                           proc(&blk)
+                         else
+                           proc { |guarded| guarded.include?(condition) }
+                         end
           end
 
-          def install_addon(path, temporary)
-            payload = {path: path}
-            payload[:temporary] = temporary unless temporary.nil?
-            execute :install_addon, {}, payload
-          end
+          def satisfied?(guard)
+            list = Array(guard.guarded[@name])
 
-          def uninstall_addon(id)
-            execute :uninstall_addon, {}, {id: id}
+            list.empty? || @execution.call(list)
           end
-
-        end # Bridge
-      end # Marionette
-    end # Firefox
+        end # GuardCondition
+      end # Guards
+    end # Support
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/support/guards.rb

@@ -0,0 +1,95 @@
+# 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_relative 'guards/guard_condition'
+require_relative 'guards/guard'
+
+module Selenium
+  module WebDriver
+    module Support
+      class Guards
+        GUARD_TYPES = %i[except only exclude exclusive flaky].freeze
+
+        attr_reader :messages
+        attr_accessor :bug_tracker
+
+        def initialize(example, bug_tracker: '', conditions: nil)
+          @example = example
+          @bug_tracker = bug_tracker
+          @guard_conditions = conditions || []
+          @guards = collect_example_guards
+          @messages = {}
+        end
+
+        def add_condition(name, condition = nil, &blk)
+          @guard_conditions << GuardCondition.new(name, condition, &blk)
+        end
+
+        def add_message(name, message)
+          @messages[name] = message
+        end
+
+        def disposition
+          if !skipping_guard.nil?
+            [:skip, skipping_guard.message]
+          elsif !pending_guard.nil? && ENV.fetch('SKIP_PENDING', nil)
+            [:skip, pending_guard.message]
+          elsif !pending_guard.nil?
+            [:pending, pending_guard.message]
+          end
+        end
+
+        def satisfied?(guard)
+          @guard_conditions.all? { |condition| condition.satisfied?(guard) }
+        end
+
+        private
+
+        def collect_example_guards
+          guards = []
+
+          GUARD_TYPES.each do |guard_type|
+            example_group = @example.metadata[:example_group]
+            example_guards = [@example.metadata[guard_type], example_group[guard_type]]
+            while example_group[:parent_example_group]
+              example_group = example_group[:parent_example_group]
+              example_guards << example_group[guard_type]
+            end
+
+            example_guards.flatten.uniq.compact.each do |example_guard|
+              guards << Guard.new(example_guard, guard_type, self)
+            end
+          end
+
+          guards
+        end
+
+        def skipping_guard
+          @guards.select(&:exclusive?).find { |guard| !satisfied?(guard) } ||
+            @guards.select(&:exclude?).find { |guard| satisfied?(guard) }
+        end
+
+        def pending_guard
+          @guards.select(&:except?).find { |guard| satisfied?(guard) } ||
+            @guards.select(&:only?).find { |guard| !satisfied?(guard) }
+        end
+      end # Guards
+    end # Support
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/support/relative_locator.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 Support
+      #
+      # @api private
+      #
+
+      class RelativeLocator
+        KEYS = %w[above below left right near distance].freeze
+
+        def initialize(locator)
+          @filters, @root = locator.partition { |how, _| KEYS.include?(how) }.map(&:to_h)
+        end
+
+        def as_json
+          {
+            relative: {
+              root: @root,
+              filters: @filters.map do |kind, filter|
+                {
+                  kind: kind,
+                  args: [filter]
+                }
+              end
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/selenium/webdriver/support/select.rb

@@ -31,7 +31,7 @@ module Selenium
           raise ArgumentError, "unexpected tag name #{tag_name.inspect}" unless tag_name.casecmp('select').zero?
 
           @element = element
-          @multi = ![nil, 'false'].include?(element.attribute(:multiple))
+          @multi = ![nil, 'false'].include?(element.dom_attribute(:multiple))
         end
 
         #
@@ -86,7 +86,7 @@ module Selenium
         #
         #     <option value="foo">Bar</option>
         #
-        # When slecting by :value, selects all options that have a value matching the argument. That is, when given "foo" this
+        # When selecting by :value, selects all options that have a value matching the argument. That is, when given "foo" this
         # would select an option like:
         #
         #     <option value="foo">Bar</option>
@@ -215,6 +215,8 @@ module Selenium
         end
 
         def select_option(option)
+          raise Error::UnsupportedOperationError, 'You may not select a disabled option' unless option.enabled?
+
           option.click unless option.selected?
         end
 
@@ -242,7 +244,7 @@ module Selenium
           xpath = ".//option[normalize-space(.) = #{Escaper.escape text}]"
           opts = @element.find_elements(xpath: xpath)
 
-          return opts unless opts.empty? && text =~ /\s+/
+          return opts unless opts.empty? && /\s+/.match?(text)
 
           longest_word = text.split(/\s+/).max_by(&:length)
           if longest_word.empty?
@@ -258,7 +260,7 @@ module Selenium
         end
 
         def find_by_index(index)
-          options.select { |option| option.attribute(:index) == index.to_s }
+          options.select { |option| option.property(:index) == index }
         end
 
         def find_by_value(value)

data/lib/selenium/webdriver/support.rb

@@ -23,3 +23,4 @@ require 'selenium/webdriver/support/block_event_listener'
 require 'selenium/webdriver/support/escaper'
 require 'selenium/webdriver/support/select'
 require 'selenium/webdriver/support/color'
+require 'selenium/webdriver/support/relative_locator'

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '3.142.7'
+    VERSION = '4.16.0'
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver.rb

@@ -17,15 +17,16 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'childprocess'
 require 'tmpdir'
 require 'fileutils'
 require 'date'
 require 'json'
 require 'set'
+require 'uri'
+require 'net/http'
 
-require 'selenium/webdriver/common'
 require 'selenium/webdriver/atoms'
+require 'selenium/webdriver/common'
 require 'selenium/webdriver/version'
 
 module Selenium
@@ -33,16 +34,17 @@ module Selenium
     Point     = Struct.new(:x, :y)
     Dimension = Struct.new(:width, :height)
     Rectangle = Struct.new(:x, :y, :width, :height)
-    Location  = Struct.new(:latitude, :longitude, :altitude)
 
-    autoload :Chrome,    'selenium/webdriver/chrome'
-    autoload :Edge,      'selenium/webdriver/edge'
-    autoload :Firefox,   'selenium/webdriver/firefox'
-    autoload :IE,        'selenium/webdriver/ie'
-    autoload :PhantomJS, 'selenium/webdriver/phantomjs'
-    autoload :Remote,    'selenium/webdriver/remote'
-    autoload :Safari,    'selenium/webdriver/safari'
-    autoload :Support,   'selenium/webdriver/support'
+    autoload :BiDi,       'selenium/webdriver/bidi'
+    autoload :Chromium,   'selenium/webdriver/chromium'
+    autoload :Chrome,     'selenium/webdriver/chrome'
+    autoload :DevTools,   'selenium/webdriver/devtools'
+    autoload :Edge,       'selenium/webdriver/edge'
+    autoload :Firefox,    'selenium/webdriver/firefox'
+    autoload :IE,         'selenium/webdriver/ie'
+    autoload :Remote,     'selenium/webdriver/remote'
+    autoload :Safari,     'selenium/webdriver/safari'
+    autoload :Support,    'selenium/webdriver/support'
 
     # @api private
 
@@ -54,10 +56,10 @@ module Selenium
     # Create a new Driver instance with the correct bridge for the given browser
     #
     # @overload for(browser)
-    #   @param [:ie, :internet_explorer, :edge, :remote, :chrome, :firefox, :ff, :phantomjs, :safari] browser The browser to
+    #   @param [:ie, :internet_explorer, :edge, :remote, :chrome, :firefox, :ff, :safari] browser The browser to
     #     create the driver for
     # @overload for(browser, opts)
-    #   @param [:ie, :internet_explorer, :edge, :remote, :chrome, :firefox, :ff, :phantomjs, :safari] browser The browser to
+    #   @param [:ie, :internet_explorer, :edge, :remote, :chrome, :firefox, :ff, :safari] browser The browser to
     #     create the driver for
     #   @param [Hash] opts Options passed to Driver.new
     #
@@ -68,14 +70,13 @@ module Selenium
     # @see Selenium::WebDriver::IE::Driver
     # @see Selenium::WebDriver::Edge::Driver
     # @see Selenium::WebDriver::Chrome::Driver
-    # @see Selenium::WebDriver::PhantomJS::Driver
     # @see Selenium::WebDriver::Safari::Driver
     #
     # @example
     #
     #   WebDriver.for :firefox, profile: 'some-profile'
     #   WebDriver.for :firefox, profile: Profile.new
-    #   WebDriver.for :remote,  url: "http://localhost:4444/wd/hub", desired_capabilities: caps
+    #   WebDriver.for :remote,  url: "http://localhost:4444/wd/hub", capabilities: caps
     #
     # One special argument is not passed on to the bridges, :listener.
     # You can pass a listener for this option to get notified of WebDriver events.
@@ -94,8 +95,9 @@ module Selenium
     # @return [Logger]
     #
 
-    def self.logger
-      @logger ||= WebDriver::Logger.new
+    def self.logger(**opts)
+      level = $DEBUG || ENV.key?('DEBUG') ? :debug : :info
+      @logger ||= WebDriver::Logger.new('Selenium', default_level: level, **opts)
     end
   end # WebDriver
 end # Selenium

data/selenium-webdriver.gemspec

@@ -11,37 +11,55 @@ Gem::Specification.new do |s|
   s.version = Selenium::WebDriver::VERSION
 
   s.authors = ['Alex Rodionov', 'Titus Fortner', 'Thomas Walpole']
-  s.email = ['p0deje@gmail.com', 'titusfortner@gmail.com', 'twalpole@gmail.com']
+  s.email = %w[p0deje@gmail.com titusfortner@gmail.com twalpole@gmail.com]
 
-  s.summary = 'The next generation developer focused tool for automated testing of webapps'
-  s.description = 'WebDriver is a tool for writing automated tests of websites. ' \
-                  'It aims to mimic the behaviour of a real user, ' \
-                  'and as such interacts with the HTML of the application.'
+  s.summary = 'Selenium is a browser automation tool for automated testing of webapps and more'
+  s.description = <<-DESCRIPTION
+    Selenium implements the W3C WebDriver protocol to automate popular browsers.
+    It aims to mimic the behaviour of a real user as it interacts with the application's HTML.
+    It's primarily intended for web application testing, but any web-based task can automated.
+  DESCRIPTION
 
   s.license = 'Apache-2.0'
-  s.homepage = 'https://github.com/SeleniumHQ/selenium'
+  s.homepage = 'https://selenium.dev'
   s.metadata = {
-    'changelog_uri' => 'https://github.com/SeleniumHQ/selenium/blob/master/rb/CHANGES',
-    'source_code_uri' => 'https://github.com/SeleniumHQ/selenium/tree/master/rb'
+    'changelog_uri' => 'https://github.com/SeleniumHQ/selenium/blob/trunk/rb/CHANGES',
+    'github_repo' => 'ssh://github.com/SeleniumHQ/selenium',
+    'source_code_uri' => 'https://github.com/SeleniumHQ/selenium/tree/trunk/rb',
+    'rubygems_mfa_required' => 'true'
   }
 
   s.required_rubygems_version = Gem::Requirement.new('> 1.3.1') if s.respond_to? :required_rubygems_version=
-  s.required_ruby_version = Gem::Requirement.new('>= 2.3')
+  s.required_ruby_version = Gem::Requirement.new('>= 3.0')
 
-  s.files = Dir[root + '/**/*'].reject { |e| e =~ /ruby\.iml|build\.desc/ }.map { |e| e.sub(root + '/', '') }
+  s.files = [
+    'CHANGES',
+    'LICENSE',
+    'NOTICE',
+    'Gemfile',
+    'README.md',
+    'selenium-webdriver.gemspec',
+    'lib/selenium-webdriver.rb',
+    'lib/selenium/server.rb',
+    'lib/selenium/webdriver.rb'
+  ]
+  s.files += Dir['bin/**/*']
+  s.files += Dir['lib/selenium/webdriver/**/*']
+
+  s.bindir = 'bin'
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'childprocess', ['>= 0.5', '< 4.0']
-  s.add_runtime_dependency 'rubyzip', ['>= 1.2.2']
+  s.add_runtime_dependency 'rexml', ['~> 3.2', '>= 3.2.5']
+  s.add_runtime_dependency 'rubyzip', ['>= 1.2.2', '< 3.0']
+  s.add_runtime_dependency 'websocket', ['~> 1.0']
 
-  # childprocess requires ffi on windows but doesn't declare it in its dependencies
-  s.add_development_dependency 'ffi'
   s.add_development_dependency 'rack', ['~> 2.0']
-  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rake', ['~> 13.0']
   s.add_development_dependency 'rspec', ['~> 3.0']
-  s.add_development_dependency 'rubocop', ['~> 0.67.0']
-  s.add_development_dependency 'rubocop-performance'
-  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'rubocop', ['~> 1.42']
+  s.add_development_dependency 'rubocop-performance', ['~> 1.15']
+  s.add_development_dependency 'rubocop-rspec', ['~> 2.16']
   s.add_development_dependency 'webmock', ['~> 3.5']
+  s.add_development_dependency 'webrick', ['~> 1.7']
   s.add_development_dependency 'yard', ['~> 0.9.11']
 end