selenium-webdriver 2.40.0.rc1 → 2.40.0.rc2

data/CHANGES

@@ -1,3 +1,12 @@
+2.40.0 (???)
+============
+
+* Fix bug where FileReaper would not reap files added in a child process
+* Document AbstractEventListener (#5994)
+* Safari:
+  * Add Safari::Options + clean up Safari extension handling (#6382)
+  * Add support for user extensions (#6815)
+
 2.39.0 (2013-12-17)
 ===================
 

data/lib/selenium/webdriver/safari.rb

@@ -41,6 +41,7 @@ end
 
 require 'selenium/webdriver/safari/browser'
 require 'selenium/webdriver/safari/server'
-require 'selenium/webdriver/safari/extension'
+require 'selenium/webdriver/safari/extensions'
+require 'selenium/webdriver/safari/options'
 require 'selenium/webdriver/safari/bridge'
 

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

@@ -6,19 +6,17 @@ module Selenium
         COMMAND_TIMEOUT = 60
 
         def initialize(opts = {})
-          port              = Integer(opts[:port] || PortProber.random)
-          timeout           = Integer(opts[:timeout] || COMMAND_TIMEOUT)
-          custom_data_dir   = opts[:custom_data_dir]
-          install_extension = opts.fetch(:install_extension) { true }
+          command_timeout = Integer(opts[:timeout] || COMMAND_TIMEOUT)
+          safari_options  = opts.delete(:options) || Safari::Options.new(opts)
+          capabilities    = merge_capabilities(opts, safari_options)
 
           @command_id ||= 0
 
-          if install_extension
-            @extension = Extension.new(:custom_data_dir => custom_data_dir)
-            @extension.install
-          end
+          @extensions = Extensions.new(safari_options)
+          @extensions.install
 
-          @server = Server.new(port, timeout)
+          # TODO: handle safari_opts['cleanSession']
+          @server = Server.new(safari_options.port, command_timeout)
           @server.start
 
           @safari = Browser.new
@@ -26,7 +24,7 @@ module Selenium
 
           @server.wait_for_connection
 
-          super(:desired_capabilities => :safari)
+          super(desired_capabilities: capabilities)
         end
 
         def quit
@@ -34,7 +32,7 @@ module Selenium
 
           @server.stop
           @safari.stop
-          @extension && @extension.uninstall
+          @extensions && @extensions.uninstall
         end
 
         def driver_extensions
@@ -75,8 +73,8 @@ module Selenium
             raise Error.for_code(status_code), response['value']['message']
           end
 
-          if raw['id'] != @command_id.to_s
-            raise Error::WebDriverError, "response id does not match command id"
+          if raw['id'].to_s != @command_id.to_s
+            raise Error::WebDriverError, "response id does not match command id: #{raw['id']} != #{@command_id}"
           end
 
           response
@@ -103,6 +101,18 @@ module Selenium
           path
         end
 
+        def merge_capabilities(opts, safari_options)
+          caps  = safari_options.to_capabilities
+          other = opts[:desired_capabilities]
+
+          if other
+            other = opts[:desired_capabilities].as_json
+            caps['safari.options'].merge!(other.delete('safari.options') || {})
+            caps.merge!(other)
+          end
+
+          caps
+        end
       end
 
     end

data/lib/selenium/webdriver/safari/extensions.rb

@@ -0,0 +1,168 @@
+module Selenium
+  module WebDriver
+    module Safari
+      #
+      # @api private
+      #
+
+      class Extensions
+
+        PLIST = <<-XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+          <plist version="1.0">
+          <dict>
+            <key>Available Updates</key>
+            <dict>
+              <key>Last Update Check Time</key>
+              <real>370125644.75941497</real>
+              <key>Updates List</key>
+              <array/>
+            </dict>
+            <key>Installed Extensions</key>
+            <array>
+              %s
+            </array>
+            <key>Version</key>
+            <integer>1</integer>
+          </dict>
+          </plist>
+        XML
+
+        PLIST_EXTENSION_LINE = <<-XML
+          <dict>
+            <key>Added Non-Default Toolbar Items</key>
+            <array/>
+            <key>Archive File Name</key>
+            <string>%s.safariextz</string>
+            <key>Bundle Directory Name</key>
+            <string>%s.safariextension</string>
+            <key>Enabled</key>
+            <true/>
+            <key>Hidden Bars</key>
+            <array/>
+            <key>Removed Default Toolbar Items</key>
+            <array/>
+          </dict>
+        XML
+
+        def initialize(opts = {})
+          @data_dir   = opts.data_dir || safari_data_dir
+          @skip       = opts.skip_extension_installation?
+          @extensions = opts.extensions
+          @backup     = Backup.new
+          @installed  = false
+        end
+
+        def install
+          return if @installed
+          installed_extensions = []
+
+          if install_directory.exist?
+            @backup.backup install_directory
+          end
+
+          install_directory.mkpath
+
+          unless @skip
+            extension_destination.rmtree if extension_destination.exist?
+            FileUtils.cp extension_source.to_s, extension_destination.to_s
+
+            installed_extensions << extension_destination
+          end
+
+          @extensions.each do |extension|
+            target = install_directory.join(extension.basename)
+
+            if extension.expand_path == target.expand_path
+              @backup.backup(target)
+            else
+              FileUtils.cp extension, target
+            end
+
+            installed_extensions << target
+          end
+
+          plist_destination.open('w') do |io|
+            extension_lines = installed_extensions.map do |ext|
+              name = ext.basename('.safariextz').to_s
+              PLIST_EXTENSION_LINE % [name, name]
+            end
+            io << PLIST % extension_lines.join("\n")
+          end
+
+          Platform.exit_hook { uninstall }
+          @installed = true
+        end
+
+        def uninstall
+          return unless @installed
+
+          install_directory.rmtree if install_directory.exist?
+          @backup.restore_all
+        ensure
+          @installed = false
+        end
+
+        def extension_source
+          Safari.resource_path.join('SafariDriver.safariextz')
+        end
+
+        def extension_destination
+          install_directory.join('WebDriver.safariextz')
+        end
+
+        def plist_destination
+          install_directory.join('Extensions.plist')
+        end
+
+        def install_directory
+          @install_directory ||= (
+            data_dir = Pathname.new(@data_dir || safari_data_dir)
+
+            unless data_dir.exist? && data_dir.directory?
+              raise Errno::ENOENT, "Safari data directory not found at #{data_dir.to_s}"
+            end
+
+            data_dir.join('Extensions')
+          )
+        end
+
+        def safari_data_dir
+          current = Platform.os
+
+          case current
+          when :macosx
+            Pathname.new(Platform.home).join('Library/Safari')
+          when :windows
+            Pathname.new(ENV['APPDATA']).join('Apple Computer/Safari')
+          else
+            raise Error::WebDriverError, "unsupported platform: #{current}"
+          end
+        end
+
+        class Backup
+          def initialize
+            @dir     = Pathname.new(Dir.mktmpdir('webdriver-safari-backups'))
+            @backups = {}
+
+            FileReaper << @dir.to_s
+          end
+
+          def backup(file)
+            src = file
+            dst = @dir.join(file.basename).to_s
+
+            FileUtils.cp_r src.to_s, dst.to_s
+            @backups[src] = dst
+          end
+
+          def restore_all
+            @backups.each {|src, dst| FileUtils.cp_r dst.to_s, src.to_s }
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+module Selenium
+  module WebDriver
+    module Safari
+      class Options
+        attr_accessor :port, :data_dir, :skip_extension_installation
+        attr_reader :extensions
+
+        def initialize(opts = {})
+          @extensions = []
+          extract_options(opts)
+        end
+
+        def add_extension(ext)
+          @extensions << verify_safari_extension(ext)
+        end
+
+        def clean_session?
+          !!@clean_session
+        end
+
+        def skip_extension_installation?
+          !!@skip_extension_installation
+        end
+
+        def to_capabilities
+          caps = Remote::Capabilities.safari
+          caps.merge!('safari.options' => as_json)
+
+          caps
+        end
+
+        def as_json
+          {
+            'port'                      => port,
+            'dataDir'                   => data_dir,
+            'cleanSession'              => clean_session?,
+            'extensions'                => extensions_as_json,
+            'skipExtensionInstallation' => skip_extension_installation?
+          }
+        end
+
+        private
+
+        def extensions_as_json
+          @extensions.map do |path|
+            {'filename' => path.basename, 'contents' => Base64.strict_encode64(path.read) }
+          end
+        end
+
+        def extract_options(opts)
+          @port          = Integer(opts[:port] || PortProber.random)
+          @data_dir      = opts[:custom_data_dir] || opts[:data_dir]
+          @clean_session = opts[:clean_session]
+
+          Array(opts[:extensions]).each { |ext| add_extension(ext) }
+
+          if opts.key?(:install_extension)
+            @skip_extension_installation = !opts[:install_extension]
+          elsif opts.key?(:skip_extension_installation)
+            @skip_extension_installation = opts[:skip_extension_installation]
+          else
+            @skip_extension_installation = false
+          end
+        end
+
+        def verify_safari_extension(path)
+          pn = Pathname.new(path)
+
+          unless pn.file? && pn.extname == '.safariextz'
+            raise ArgumentError, "invalid Safari extension path: #{path}"
+          end
+
+          pn
+        end
+
+      end
+    end
+  end
+end

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

@@ -2,6 +2,31 @@ module Selenium
   module WebDriver
     module Support
 
+      #
+      # Subclass and override methods from this class
+      # to implement your own event listener.
+      #
+      # @example
+      #
+      #   class NavigationListener < Selenium::WebDriver::Support::AbstractEventListener
+      #     def initialize(log)
+      #       @log = log
+      #     end
+      #
+      #     def before_navigate_to(url, driver)
+      #       @log.info "navigating to #{url}"
+      #     end
+      #
+      #     def after_navigate_to(url, driver)
+      #       @log.info "done navigating to #{url}"
+      #     end
+      #   end
+      #
+      #   listener = NavigationListener.new(logger)
+      #   driver = Selenium::WebDriver.for :firefox, :listener => listener
+      #
+      #
+
       class AbstractEventListener
         def before_navigate_to(url, driver) end
         def after_navigate_to(url, driver) end

metadata

@@ -2,7 +2,7 @@
 name: selenium-webdriver
 version: !ruby/object:Gem::Version 
   prerelease: 7
-  version: 2.40.0.rc1
+  version: 2.40.0.rc2
 platform: ruby
 authors: 
   - Jari Bakken
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-01-27 00:00:00 +01:00
+date: 2014-02-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -217,7 +217,8 @@ files:
   - lib/selenium/webdriver/remote/http/persistent.rb
   - lib/selenium/webdriver/safari/bridge.rb
   - lib/selenium/webdriver/safari/browser.rb
-  - lib/selenium/webdriver/safari/extension.rb
+  - lib/selenium/webdriver/safari/extensions.rb
+  - lib/selenium/webdriver/safari/options.rb
   - lib/selenium/webdriver/safari/server.rb
   - lib/selenium/webdriver/safari/resources/client.js
   - lib/selenium/webdriver/safari/resources/SafariDriver.safariextz

data/lib/selenium/webdriver/safari/extension.rb

@@ -1,121 +0,0 @@
-module Selenium
-  module WebDriver
-    module Safari
-      class Extension
-
-        PLIST = <<-XML
-          <?xml version="1.0" encoding="UTF-8"?>
-          <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-          <plist version="1.0">
-          <dict>
-            <key>Available Updates</key>
-            <dict>
-              <key>Last Update Check Time</key>
-              <real>370125644.75941497</real>
-              <key>Updates List</key>
-              <array/>
-            </dict>
-            <key>Installed Extensions</key>
-            <array>
-              <dict>
-                <key>Added Non-Default Toolbar Items</key>
-                <array/>
-                <key>Archive File Name</key>
-                <string>WebDriver.safariextz</string>
-                <key>Bundle Directory Name</key>
-                <string>WebDriver.safariextension</string>
-                <key>Enabled</key>
-                <true/>
-                <key>Hidden Bars</key>
-                <array/>
-                <key>Removed Default Toolbar Items</key>
-                <array/>
-              </dict>
-            </array>
-            <key>Version</key>
-            <integer>1</integer>
-          </dict>
-          </plist>
-        XML
-
-        def initialize(opts = {})
-          @custom_data_dir = opts[:custom_data_dir]
-          @installed       = false
-        end
-
-        def install
-          return if @installed
-
-          if install_directory.exist?
-            backup_directory.rmtree if backup_directory.exist?
-            FileUtils.mv install_directory.to_s, backup_directory.to_s
-          end
-
-          install_directory.mkpath
-
-          extension_destination.rmtree if extension_destination.exist?
-          FileUtils.cp extension_source.to_s, extension_destination.to_s
-
-          plist_destination.open('w') { |io| io << PLIST }
-
-          at_exit { uninstall }
-          @installed = true
-        end
-
-        def uninstall
-          return unless @installed
-
-          install_directory.rmtree if install_directory.exist?
-
-          if backup_directory.exist?
-            FileUtils.mv backup_directory.to_s, install_directory.to_s
-          end
-        ensure
-          @installed = false
-        end
-
-        def extension_source
-          Safari.resource_path.join('SafariDriver.safariextz')
-        end
-
-        def extension_destination
-          install_directory.join('WebDriver.safariextz')
-        end
-
-        def backup_directory
-          Pathname.new("#{install_directory.to_s}.bak")
-        end
-
-        def plist_destination
-          install_directory.join('Extensions.plist')
-        end
-
-        def install_directory
-          @install_directory ||= (
-            data_dir = Pathname.new(@custom_data_dir || safari_data_dir)
-
-            unless data_dir.exist? && data_dir.directory?
-              raise Errno::ENOENT, "Safari data directory not found at #{data_dir.to_s}"
-            end
-
-            data_dir.join('Extensions')
-          )
-        end
-
-        def safari_data_dir
-          current = Platform.os
-
-          case current
-          when :macosx
-            Pathname.new(Platform.home).join('Library/Safari')
-          when :windows
-            Pathname.new(ENV['APPDATA']).join('Apple Computer/Safari')
-          else
-            raise Error::WebDriverError, "unsupported platform: #{current}"
-          end
-        end
-
-      end
-    end
-  end
-end