rainux-selenium-webdriver 0.0.17

data/firefox/src/rb/lib/selenium/webdriver/firefox/extension_connection.rb

@@ -0,0 +1,90 @@
+module Selenium
+  module WebDriver
+    module Firefox
+      class ExtensionConnection
+
+        def initialize(host, port)
+          @host = host
+          @port = port
+        end
+
+        def connect(timeout = 20)
+          Timeout.timeout(timeout) {
+            loop do
+              begin
+                return new_socket
+              rescue Errno::ECONNREFUSED, Errno::ENOTCONN, SocketError => e
+                $stderr.puts "#{self} caught #{e.message} for #{@host}:#{@port}" if $DEBUG
+                sleep 0.25
+              end
+            end
+          }
+        end
+
+        def new_socket
+          @socket = TCPSocket.new(@host, @port)
+          @socket.sync = true
+
+          @socket
+        end
+
+        def connected?
+          @socket && !@socket.closed?
+        end
+
+        def send_string(str)
+          str = <<-HTTP
+GET / HTTP/1.1
+Host: localhost
+Content-Length: #{str.length}
+
+#{str}
+HTTP
+          @socket.write str
+          @socket.flush
+        end
+
+        def quit
+          command = {'commandName' => 'quit', 'context' => ''}
+          send_string(command.to_json)
+        ensure
+          close
+        end
+
+        def close
+          @socket.close if connected?
+        end
+
+        def read_response
+          resp     = ""
+          received = ""
+
+          until resp.include?("\n\n")
+            received = @socket.recv 1
+            if received
+              resp += received
+            end
+          end
+
+          length         = Integer(resp.split(":").last.strip)
+          json_string    = ''
+          bytes_received = 0
+
+          until bytes_received == length
+            read_string = @socket.recv(length - bytes_received)
+
+            bytes_received += read_string.length
+            json_string << read_string
+          end
+
+          if json_string.empty?
+            raise Error::WebDriverError, "empty response from extension"
+          end
+
+          JSON.parse json_string
+        end
+
+      end # ExtensionConnection
+    end # Firefox
+  end # WebDriver
+end # Selenium

data/firefox/src/rb/lib/selenium/webdriver/firefox/launcher.rb

@@ -0,0 +1,155 @@
+require "fcntl"
+
+module Selenium
+  module WebDriver
+    module Firefox
+      class Launcher
+
+        attr_reader :binary, :connection
+        SOCKET_LOCK_TIMEOUT = 45
+
+
+        def initialize(binary, port = DEFAULT_PORT, profile = DEFAULT_PROFILE_NAME)
+          @binary       = binary
+          @port         = port.to_i
+
+          if profile.kind_of? Profile
+            @profile = profile
+          else
+            @profile_name = profile
+            @profile      = nil
+          end
+
+          # need to be really specific about what host to use
+          #
+          # on os x, "localhost" will resolve to 3 different addresses (see /etc/hosts)
+          # Ruby will loop over these and happily bind to the same port on each one,
+          # making it completely unusable for our purposes.
+          #
+          @host = "127.0.0.1"
+        end
+
+        def launch
+          with_lock do
+            find_free_port
+            create_profile
+            start_silent_and_wait
+            start
+            connect_until_stable
+          end
+
+          self
+        end
+
+        def with_lock
+          max_time = Time.now + SOCKET_LOCK_TIMEOUT
+          locking_port = @port - 1
+
+          until Time.now > max_time
+            begin
+              socket_lock = TCPServer.new(@host, locking_port)
+              socket_lock.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC) if defined? Fcntl::FD_CLOEXEC
+
+              yield
+              return
+            rescue SocketError, Errno::EADDRINUSE
+              sleep 0.1
+            end
+          end
+
+          raise Error::WebDriverError,
+            "Unable to bind to locking port #{locking_port} within #{SOCKET_LOCK_TIMEOUT} seconds"
+        ensure
+          socket_lock.close if socket_lock
+        end
+
+        def find_free_port
+          port = @port
+
+          until free_port?(port)
+            port += 1
+          end
+
+          @port = port
+        end
+
+        def create_profile
+          unless @profile
+            fetch_profile
+            if @profile.nil?
+              raise Error, WebDriverError, "could not find or create profile: #{profile.inspect}"
+            end
+          end
+
+          @profile.delete_extensions_cache
+
+          @profile.port = @port
+          @profile.add_webdriver_extension(true)
+          @profile.update_user_prefs
+        end
+
+        def start
+          assert_profile
+          @binary.start_with @profile
+        end
+
+        def start_silent_and_wait
+          assert_profile
+          @binary.start_with @profile, "--silent"
+          @binary.wait
+        end
+
+        def connect
+          @connection = ExtensionConnection.new(@host, @port)
+          @connection.connect(5)
+        end
+
+        def connect_until_stable
+          max_time = Time.now + 60
+
+          until Time.now >= max_time
+            begin
+              connection = ExtensionConnection.new(@host, @port)
+              connection.connect(1)
+              connection.close
+
+              connect
+              return
+            rescue Timeout::Error => e
+              puts "#{self} caught #{e.message}" if $DEBUG
+              # ok
+            end
+          end
+
+          raise Error::WebDriverError, "unable to obtain stable firefox connection"
+        end
+
+        def free_port?(port)
+          s = TCPServer.new(@host, port)
+          s.close
+          true
+        rescue SocketError, Errno::EADDRINUSE
+          false
+        end
+
+        def fetch_profile
+          existing = Profile.from_name @profile_name
+
+          unless existing
+            @binary.create_base_profile @profile_name
+            Profile.ini.refresh
+            existing = Profile.from_name @profile_name
+            raise "unable to find or create new profile" unless existing
+          end
+
+          @profile = existing
+        end
+
+        def assert_profile
+          raise "must create_profile first" if @profile.nil?
+        end
+
+      end # Launcher
+    end # Firefox
+  end # WebDriver
+end # Selenium

data/firefox/src/rb/lib/selenium/webdriver/firefox/profile.rb

@@ -0,0 +1,233 @@
+module Selenium
+  module WebDriver
+    module Firefox
+      class Profile
+
+        ANONYMOUS_PROFILE_NAME = "WEBDRIVER_ANONYMOUS_PROFILE"
+        EXTENSION_NAME         = "fxdriver@googlecode.com"
+        EM_NAMESPACE_URI       = "http://www.mozilla.org/2004/em-rdf#"
+        NO_FOCUS_LIBRARY_NAME  = "x_ignore_nofocus.so"
+
+        DEFAULT_EXTENSION_SOURCE = File.expand_path("#{WebDriver.root}/firefox/src/extension")
+
+        XPTS = [
+          ["#{WebDriver.root}/firefox/prebuilt/nsINativeEvents.xpt", "components/nsINativeEvents.xpt"],
+          ["#{WebDriver.root}/firefox/prebuilt/nsICommandProcessor.xpt", "components/nsICommandProcessor.xpt"],
+          ["#{WebDriver.root}/firefox/prebuilt/nsIResponseHandler.xpt", "components/nsIResponseHandler.xpt"],
+        ]
+
+        NATIVE_WINDOWS = ["#{WebDriver.root}/firefox/prebuilt/Win32/Release/webdriver-firefox.dll", "platform/WINNT_x86-msvc/components/webdriver-firefox.dll"]
+        NATIVE_LINUX   = [
+          ["#{WebDriver.root}/firefox/prebuilt/linux/Release/libwebdriver-firefox.so", "platform/Linux_x86-gcc3/components/libwebdriver-firefox.so"],
+          ["#{WebDriver.root}/firefox/prebuilt/linux64/Release/libwebdriver-firefox.so", "platform/Linux_x86_64-gcc3/components/libwebdriver-firefox.so"]
+        ]
+
+        NO_FOCUS = [
+          ["#{WebDriver.root}/firefox/prebuilt/linux64/Release/x_ignore_nofocus.so", "amd64/x_ignore_nofocus.so"],
+          ["#{WebDriver.root}/firefox/prebuilt/linux/Release/x_ignore_nofocus.so", "x86/x_ignore_nofocus.so"],
+        ]
+
+        SHARED = [
+          ["#{WebDriver.root}/common/src/js/extension/dommessenger.js", "content/dommessenger.js"]
+        ]
+
+        attr_reader :name, :directory
+        attr_writer :secure_ssl, :native_events, :load_no_focus_lib
+        attr_accessor :port
+
+        class << self
+
+          def ini
+            @ini ||= ProfilesIni.new
+          end
+
+          def from_name(name)
+            ini[name]
+          end
+
+        end
+
+        def initialize(directory = nil)
+          @directory = directory ? create_tmp_copy(directory) : Dir.mktmpdir("webdriver-profile")
+
+          unless File.directory? @directory
+            raise Error::WebDriverError, "Profile directory does not exist: #{@directory.inspect}"
+          end
+
+          # TODO: replace constants with options hash
+          @port              = DEFAULT_PORT
+          @extension_source  = DEFAULT_EXTENSION_SOURCE
+          @native_events     = DEFAULT_ENABLE_NATIVE_EVENTS
+          @secure_ssl        = DEFAULT_SECURE_SSL
+          @load_no_focus_lib = DEFAULT_LOAD_NO_FOCUS_LIB
+        end
+
+        def absolute_path
+          if Platform.win?
+            directory.gsub("/", "\\")
+          else
+            directory
+          end
+        end
+
+        def update_user_prefs
+          prefs = current_user_prefs.merge DEFAULT_PREFERENCES
+          prefs['webdriver_firefox_port'] = @port
+          prefs['webdriver_accept_untrusted_certs'] = 'true' unless secure_ssl?
+          prefs['webdriver_enable_native_events'] = 'true' if native_events?
+
+          write_prefs prefs
+        end
+
+        def add_webdriver_extension(force_creation = false)
+          ext_path = File.join(extensions_dir, EXTENSION_NAME)
+
+          if File.exists?(ext_path)
+            return unless force_creation
+          end
+
+          FileUtils.rm_rf ext_path
+          FileUtils.mkdir_p File.dirname(ext_path), :mode => 0700
+          FileUtils.cp_r @extension_source, ext_path
+
+          from_to = XPTS + SHARED
+
+          if native_events?
+            case Platform.os
+            when :linux
+              NATIVE_LINUX.each do |lib|
+                from_to << lib
+              end
+            when :windows
+              from_to << NATIVE_WINDOWS
+            else
+              raise Error::WebDriverError, "can't enable native events on #{Platform.os.inspect}"
+            end
+          end
+
+          if load_no_focus_lib?
+            from_to += NO_FOCUS
+            modify_link_library_path(NO_FOCUS.map { |source, dest| File.join(ext_path, File.dirname(dest)) })
+          end
+
+          from_to.each do |source, destination|
+            dest = File.join(ext_path, destination)
+            FileUtils.mkdir_p File.dirname(dest)
+            FileUtils.cp source, dest
+          end
+
+          delete_extensions_cache
+        end
+
+        # TODO: add_extension
+
+        def extensions_dir
+          @extensions_dir ||= File.join(directory, "extensions")
+        end
+
+        def user_prefs_path
+          @user_prefs_js ||= File.join(directory, "user.js")
+        end
+
+        def delete_extensions_cache
+          cache = File.join(directory, "extensions.cache")
+          FileUtils.rm_f cache if File.exist?(cache)
+        end
+
+        def modify_link_library_path(paths)
+          old_path = ENV['LD_LIBRARY_PATH']
+
+          unless [nil, ''].include?(old_path)
+            paths << old_path
+          end
+
+          ENV['LD_LIBRARY_PATH'] = paths.join(File::PATH_SEPARATOR)
+          ENV['LD_PRELOAD']      = NO_FOCUS_LIBRARY_NAME
+        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
+
+        private
+
+        def create_tmp_copy(directory)
+          tmp_directory = Dir.mktmpdir("webdriver-rb-profilecopy")
+
+          # TODO: must be a better way..
+          FileUtils.rm_rf tmp_directory
+          FileUtils.mkdir_p File.dirname(tmp_directory), :mode => 0700
+          FileUtils.cp_r directory, tmp_directory
+
+          tmp_directory
+        end
+
+
+        def current_user_prefs
+          return {} unless File.exist?(user_prefs_path)
+
+          prefs = {}
+
+          File.read(user_prefs_path).split("\n").each do |line|
+            if line =~ /user_pref\("([^"]+)"\s*,\s*(.+?)\);/
+              prefs[$1.strip] = $2.strip
+            end
+          end
+
+          prefs
+        end
+
+        def write_prefs(prefs)
+          File.open(user_prefs_path, "w") do |file|
+            prefs.each do |key, value|
+              file.puts "user_pref(#{key.inspect}, #{value});"
+            end
+          end
+        end
+
+        DEFAULT_PREFERENCES = {
+          "app.update.auto"                           => 'false',
+          "app.update.enabled"                        => 'false',
+          "browser.download.manager.showWhenStarting" => 'false',
+          "browser.EULA.override"                     => 'true',
+          "browser.EULA.3.accepted"                   => 'true',
+          "browser.link.open_external"                => '2',
+          "browser.link.open_newwindow"               => '2',
+          "browser.safebrowsing.enabled"              => 'false',
+          "browser.search.update"                     => 'false',
+          "browser.sessionstore.resume_from_crash"    => 'false',
+          "browser.shell.checkDefaultBrowser"         => 'false',
+          "browser.startup.page"                      => '0',
+          "browser.tabs.warnOnClose"                  => 'false',
+          "browser.tabs.warnOnOpen"                   => 'false',
+          "dom.disable_open_during_load"              => 'false',
+          "extensions.update.enabled"                 => 'false',
+          "extensions.update.notifyUser"              => 'false',
+          "security.warn_entering_secure"             => 'false',
+          "security.warn_submit_insecure"             => 'false',
+          "security.warn_entering_secure.show_once"   => 'false',
+          "security.warn_entering_weak"               => 'false',
+          "security.warn_entering_weak.show_once"     => 'false',
+          "security.warn_leaving_secure"              => 'false',
+          "security.warn_leaving_secure.show_once"    => 'false',
+          "security.warn_submit_insecure"             => 'false',
+          "security.warn_viewing_mixed"               => 'false',
+          "security.warn_viewing_mixed.show_once"     => 'false',
+          "signon.rememberSignons"                    => 'false',
+          "startup.homepage_welcome_url"              => '"about:blank"',
+          "javascript.options.showInConsole"          => 'true',
+          "browser.dom.window.dump.enabled"           => 'true'
+        }
+
+      end # Profile
+    end # Firefox
+  end # WebDriver
+end # Selenium