selenium-webdriver 2.45.0 → 3.142.7

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

@@ -1,13 +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.
+
 module Selenium
   module WebDriver
-
     #
     # @api private
     # @see ActionBuilder
     #
 
     class Mouse
-
       def initialize(bridge)
         @bridge = bridge
       end
@@ -19,22 +36,22 @@ module Selenium
 
       def double_click(element = nil)
         move_if_needed element
-        @bridge.doubleClick
+        @bridge.double_click
       end
 
       def context_click(element = nil)
         move_if_needed element
-        @bridge.contextClick
+        @bridge.context_click
       end
 
       def down(element = nil)
         move_if_needed element
-        @bridge.mouseDown
+        @bridge.mouse_down
       end
 
       def up(element = nil)
         move_if_needed element
-        @bridge.mouseUp
+        @bridge.mouse_up
       end
 
       #
@@ -49,11 +66,11 @@ module Selenium
       def move_to(element, right_by = nil, down_by = nil)
         assert_element element
 
-        @bridge.mouseMoveTo element.ref, right_by, down_by
+        @bridge.mouse_move_to element.ref, right_by, down_by
       end
 
       def move_by(right_by, down_by)
-        @bridge.mouseMoveTo nil, Integer(right_by), Integer(down_by)
+        @bridge.mouse_move_to nil, Integer(right_by), Integer(down_by)
       end
 
       private
@@ -63,10 +80,10 @@ module Selenium
       end
 
       def assert_element(element)
-        unless element.kind_of? Element
-          raise TypeError, "expected #{Element}, got #{element.inspect}:#{element.class}"
-        end
+        return if element.is_a? Element
+
+        raise TypeError, "expected #{Element}, got #{element.inspect}:#{element.class}"
       end
     end # Mouse
   end # WebDriver
-end  # Selenium
+end # Selenium

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

@@ -1,7 +1,25 @@
+# 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 Navigation
-
       def initialize(bridge)
         @bridge = bridge
       end
@@ -19,7 +37,7 @@ module Selenium
       #
 
       def back
-        @bridge.goBack
+        @bridge.go_back
       end
 
       #
@@ -27,7 +45,7 @@ module Selenium
       #
 
       def forward
-        @bridge.goForward
+        @bridge.go_forward
       end
 
       #
@@ -37,7 +55,6 @@ module Selenium
       def refresh
         @bridge.refresh
       end
-
     end # Navigation
   end # WebDriver
 end # Selenium

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

@@ -1,136 +1,53 @@
+# 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
-
-      #
-      # @api private
-      #
-
-      def initialize(bridge)
-        @bridge = bridge
-      end
-
-      #
-      # Add a cookie to the browser
-      #
-      # @param [Hash] opts the options to create a cookie with.
-      # @option opts [String] :name A name
-      # @option opts [String] :value A value
-      # @option opts [String] :path ('/') A path
-      # @option opts [String] :secure (false) A boolean
-      # @option opts [Time,DateTime,Numeric,nil] :expires (nil) Expiry date, either as a Time, DateTime, or seconds since epoch.
-      #
-      # @raise [ArgumentError] if :name or :value is not specified
-      #
-
-      def add_cookie(opts = {})
-        raise ArgumentError, "name is required" unless opts[:name]
-        raise ArgumentError, "value is required" unless opts[:value]
-
-        opts[:path] ||= "/"
-        opts[:secure] ||= false
-
-        if obj = opts.delete(:expires)
-          opts[:expiry] = seconds_from(obj)
+    module Common
+      class Options
+        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)
 
-        @bridge.addCookie opts
-      end
-
-      #
-      # Get the cookie with the given name
-      #
-      # @param [String] name the name of the cookie
-      # @return [Hash, nil] the cookie, or nil if it wasn't found.
-      #
-
-      def cookie_named(name)
-        all_cookies.find { |c| c[:name] == name }
-      end
-
-      #
-      # Delete the cookie with the given name
-      #
-      # @param [String] name the name of the cookie to delete
-      #
-
-      def delete_cookie(name)
-        @bridge.deleteCookie name
-      end
-
-      #
-      # Delete all cookies
-      #
-
-      def delete_all_cookies
-        @bridge.deleteAllCookies
-      end
-
-      #
-      # Get all cookies
-      #
-      # @return [Array<Hash>] list of cookies
-      #
-
-      def all_cookies
-        @bridge.getAllCookies.map do |cookie|
-          {
-            :name    => cookie["name"],
-            :value   => cookie["value"],
-            :path    => cookie["path"],
-            :domain  => cookie["domain"] && strip_port(cookie["domain"]),
-            :expires => cookie["expiry"] && datetime_at(cookie['expiry']),
-            :secure  => cookie["secure"]
-          }
+          raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class}"
         end
-      end
-
-      def timeouts
-        @timeouts ||= Timeouts.new(@bridge)
-      end
-
-      #
-      # @api beta This API may be changed or removed in a future release.
-      #
-
-      def logs
-        @logs ||= Logs.new(@bridge)
-      end
-
-      #
-      # @api beta This API may be changed or removed in a future release.
-      #
 
-      def window
-        @window ||= Window.new(@bridge)
-      end
-
-      private
-
-      SECONDS_PER_DAY = 86_400.0
-
-      def datetime_at(int)
-        DateTime.civil(1970) + (int / SECONDS_PER_DAY)
-      end
-
-      def seconds_from(obj)
-        case obj
-        when Time
-          obj.to_f
-        when DateTime
-          (obj - DateTime.civil(1970)) * SECONDS_PER_DAY
-        when Numeric
-          obj
-        else
-          raise ArgumentError, "invalid value for expiration date: #{obj.inspect}"
+        def camel_case(str)
+          str.to_s.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
         end
-      end
-
-      def strip_port(str)
-        str.split(":", 2).first
-      end
-
-    end # Options
+      end # Options
+    end # Common
   end # WebDriver
 end # Selenium

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

@@ -1,75 +1,83 @@
+# 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 'rbconfig'
 require 'socket'
 
 module Selenium
   module WebDriver
-
     # @api private
     module Platform
-
       module_function
 
       def home
-        # jruby has an issue with ENV['HOME'] on Windows
-        @home ||= jruby? ? ENV_JAVA['user.home'] : ENV['HOME']
+        @home ||= Dir.home
       end
 
       def engine
-        @engine ||= (
-          if defined? RUBY_ENGINE
-            RUBY_ENGINE.to_sym
-          else
-            :ruby
-          end
-        )
+        @engine ||= RUBY_ENGINE.to_sym
       end
 
       def os
-        @os ||= (
-          host_os = RbConfig::CONFIG['host_os']
-          case host_os
-          when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-            :windows
-          when /darwin|mac os/
-            :macosx
-          when /linux/
-            :linux
-          when /solaris|bsd/
-            :unix
-          else
-            raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
-          end
-        )
+        host_os = RbConfig::CONFIG['host_os']
+        @os ||= case host_os
+                when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                  :windows
+                when /darwin|mac os/
+                  :macosx
+                when /linux/
+                  :linux
+                when /solaris|bsd/
+                  :unix
+                else
+                  raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
+                end
+      end
+
+      def ci
+        if ENV['TRAVIS']
+          :travis
+        elsif ENV['JENKINS']
+          :jenkins
+        elsif ENV['APPVEYOR']
+          :appveyor
+        end
       end
 
       def bitsize
-        @bitsize ||= (
-          if defined?(FFI::Platform::ADDRESS_SIZE)
-            FFI::Platform::ADDRESS_SIZE
-          elsif defined?(FFI)
-            FFI.type_size(:pointer) == 4 ? 32 : 64
-          elsif jruby?
-            Integer(ENV_JAVA['sun.arch.data.model'])
-          else
-            1.size == 4 ? 32 : 64
-          end
-        )
+        @bitsize ||= if defined?(FFI::Platform::ADDRESS_SIZE)
+                       FFI::Platform::ADDRESS_SIZE
+                     elsif defined?(FFI)
+                       FFI.type_size(:pointer) == 4 ? 32 : 64
+                     elsif jruby?
+                       Integer(ENV_JAVA['sun.arch.data.model'])
+                     else
+                       1.size == 4 ? 32 : 64
+                     end
       end
 
       def jruby?
         engine == :jruby
       end
 
-      def ironruby?
-        engine == :ironruby
-      end
-
-      def ruby187?
-        !!(RUBY_VERSION =~ /^1\.8\.7/)
-      end
-
-      def ruby19?
-        !!(RUBY_VERSION =~ /^1\.9/)
+      def ruby_version
+        RUBY_VERSION
       end
 
       def windows?
@@ -84,65 +92,78 @@ module Selenium
         os == :linux
       end
 
+      def wsl?
+        return false unless linux?
+
+        File.read('/proc/version').include?('Microsoft')
+      end
+
       def cygwin?
-        !!(RUBY_PLATFORM =~ /cygwin/)
+        RUBY_PLATFORM =~ /cygwin/
+        !Regexp.last_match.nil?
       end
 
       def null_device
-        @null_device ||= (
-          if defined?(File::NULL)
-            File::NULL
-          else
-            Platform.windows? ? 'NUL' : '/dev/null'
-          end
-        )
+        File::NULL
       end
 
       def wrap_in_quotes_if_necessary(str)
-        windows? && !cygwin? ? %{"#{str}"} : str
+        windows? && !cygwin? ? %("#{str}") : str
       end
 
-      def cygwin_path(path, opts = {})
+      def cygwin_path(path, **opts)
         flags = []
-        opts.each { |k,v| flags << "--#{k}" if v }
+        opts.each { |k, v| flags << "--#{k}" if v }
 
         `cygpath #{flags.join ' '} "#{path}"`.strip
       end
 
+      def unix_path(path)
+        path.tr(File::ALT_SEPARATOR, File::SEPARATOR)
+      end
+
+      def windows_path(path)
+        path.tr(File::SEPARATOR, File::ALT_SEPARATOR)
+      end
+
       def make_writable(file)
-        File.chmod 0766, file
+        File.chmod 0o766, file
       end
 
       def assert_file(path)
-        unless File.file? path
-          raise Error::WebDriverError, "not a file: #{path.inspect}"
-        end
+        return if File.file? path
+
+        raise Error::WebDriverError, "not a file: #{path.inspect}"
       end
 
       def assert_executable(path)
         assert_file(path)
 
-        unless File.executable? path
-          raise Error::WebDriverError, "not executable: #{path.inspect}"
-        end
+        return if File.executable? path
+
+        raise Error::WebDriverError, "not executable: #{path.inspect}"
       end
 
-      def exit_hook(&blk)
+      def exit_hook
         pid = Process.pid
 
-        at_exit do
-          yield if Process.pid == pid
-        end
+        at_exit { yield if Process.pid == pid }
       end
 
       def find_binary(*binary_names)
         paths = ENV['PATH'].split(File::PATH_SEPARATOR)
-        binary_names.map! { |n| "#{n}.exe" } if windows?
+
+        if windows?
+          binary_names.map! { |n| "#{n}.exe" }
+          binary_names.dup.each { |n| binary_names << n.gsub('exe', 'bat') }
+        end
 
         binary_names.each do |binary_name|
           paths.each do |path|
-            exe = File.join(path, binary_name)
-            return exe if File.executable?(exe)
+            full_path = File.join(path, binary_name)
+            full_path = unix_path(full_path) if windows?
+            exe = Dir.glob(full_path).find { |f| File.executable?(f) }
+            return exe if exe
           end
         end
 
@@ -151,8 +172,9 @@ module Selenium
 
       def find_in_program_files(*binary_names)
         paths = [
-          ENV['PROGRAMFILES'] || "\\Program Files",
-          ENV['ProgramFiles(x86)'] || "\\Program Files (x86)"
+          ENV['PROGRAMFILES'] || '\\Program Files',
+          ENV['ProgramFiles(x86)'] || '\\Program Files (x86)',
+          ENV['ProgramW6432'] || '\\Program Files'
         ]
 
         paths.each do |root|
@@ -166,13 +188,11 @@ module Selenium
       end
 
       def localhost
-        info = Socket.getaddrinfo "localhost", 80, Socket::AF_INET, Socket::SOCK_STREAM
+        info = Socket.getaddrinfo 'localhost', 80, Socket::AF_INET, Socket::SOCK_STREAM
 
-        if info.empty?
-          raise Error::WebDriverError, "unable to translate 'localhost' for TCP + IPv4"
-        end
+        return info[0][3] unless info.empty?
 
-        info[0][3]
+        raise Error::WebDriverError, "unable to translate 'localhost' for TCP + IPv4"
       end
 
       def ip
@@ -192,27 +212,11 @@ module Selenium
       end
 
       def interfaces
-        interfaces = Socket.getaddrinfo("localhost", 8080).map { |e| e[3] }
-        interfaces += ["0.0.0.0", Platform.ip]
+        interfaces = Socket.getaddrinfo('localhost', 8080).map { |e| e[3] }
+        interfaces += ['0.0.0.0', Platform.ip]
 
         interfaces.compact.uniq
       end
-
     end # Platform
   end # WebDriver
 end # Selenium
-
-if __FILE__ == $0
-  p :engine      => Selenium::WebDriver::Platform.engine,
-    :os          => Selenium::WebDriver::Platform.os,
-    :ruby187?    => Selenium::WebDriver::Platform.ruby187?,
-    :ruby19?     => Selenium::WebDriver::Platform.ruby19?,
-    :jruby?      => Selenium::WebDriver::Platform.jruby?,
-    :windows?    => Selenium::WebDriver::Platform.windows?,
-    :home        => Selenium::WebDriver::Platform.home,
-    :bitsize     => Selenium::WebDriver::Platform.bitsize,
-    :localhost   => Selenium::WebDriver::Platform.localhost,
-    :ip          => Selenium::WebDriver::Platform.ip,
-    :interfaces  => Selenium::WebDriver::Platform.interfaces,
-    :null_device => Selenium::WebDriver::Platform.null_device
-end

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

@@ -1,3 +1,22 @@
+# 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 PortProber
@@ -6,28 +25,17 @@ module Selenium
         port
       end
 
-      def self.random
-        # TODO: Avoid this
-        #
-        # (a) should pick a port that's guaranteed to be free on all interfaces
-        # (b) should pick a random port outside the ephemeral port range
-        #
-        server = TCPServer.new(Platform.localhost, 0)
-        port   = server.addr[1]
-        server.close
-
-        port
-      end
-
-      IGNORED_ERRORS = [Errno::EADDRNOTAVAIL]
-      IGNORED_ERRORS << Errno::EBADF if Platform.cygwin?
+      IGNORED_ERRORS = [Errno::EADDRNOTAVAIL, Errno::EAFNOSUPPORT].tap { |arr|
+        arr << Errno::EBADF if Platform.cygwin?
+        arr << Errno::EACCES if Platform.windows?
+      }.freeze
 
       def self.free?(port)
         Platform.interfaces.each do |host|
           begin
             TCPServer.new(host, port).close
           rescue *IGNORED_ERRORS => ex
-            $stderr.puts "port prober could not bind to #{host}:#{port} (#{ex.message})" if $DEBUG
+            WebDriver.logger.debug("port prober could not bind to #{host}:#{port} (#{ex.message})")
             # ignored - some machines appear unable to bind to some of their interfaces
           end
         end
@@ -36,7 +44,6 @@ module Selenium
       rescue SocketError, Errno::EADDRINUSE
         false
       end
-
     end # PortProber
   end # WebDriver
 end # Selenium