browserstack-webdriver 0.0.1

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

@@ -0,0 +1,82 @@
+require 'zip'
+require 'tempfile'
+require 'find'
+
+module Selenium
+  module WebDriver
+    #
+    # @api private
+    #
+
+    module Zipper
+
+      EXTENSIONS = %w[.zip .xpi]
+
+      class << self
+
+        def unzip(path)
+          destination = Dir.mktmpdir("webdriver-unzip")
+          FileReaper << destination
+
+          Zip::File.open(path) do |zip|
+            zip.each do |entry|
+              to      = File.join(destination, entry.name)
+              dirname = File.dirname(to)
+
+              FileUtils.mkdir_p dirname unless File.exist? dirname
+              zip.extract(entry, to)
+            end
+          end
+
+          destination
+        end
+
+        def zip(path)
+          with_tmp_zip do |zip|
+            ::Find.find(path) do |file|
+              unless File.directory?(file)
+                add_zip_entry zip, file, file.sub("#{path}/", '')
+              end
+            end
+
+            zip.commit
+            File.open(zip.name, "rb") { |io| Base64.strict_encode64 io.read }
+          end
+        end
+
+        def zip_file(path)
+          with_tmp_zip do |zip|
+            add_zip_entry zip, path, File.basename(path)
+
+            zip.commit
+            File.open(zip.name, "rb") { |io| Base64.strict_encode64 io.read }
+          end
+        end
+
+        private
+
+        def with_tmp_zip(&blk)
+          # can't use Tempfile here since it doesn't support File::BINARY mode on 1.8
+          # can't use Dir.mktmpdir(&blk) because of http://jira.codehaus.org/browse/JRUBY-4082
+          tmp_dir = Dir.mktmpdir
+          zip_path = File.join(tmp_dir, "webdriver-zip")
+
+          begin
+            Zip::File.open(zip_path, Zip::File::CREATE, &blk)
+          ensure
+            FileUtils.rm_rf tmp_dir
+            FileUtils.rm_rf zip_path
+          end
+        end
+
+        def add_zip_entry(zip, file, entry_name)
+          entry = Zip::Entry.new(zip.name, entry_name)
+          entry.follow_symlinks = true
+
+          zip.add entry, file
+        end
+
+      end
+    end # Zipper
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/firefox.rb

@@ -0,0 +1,37 @@
+require 'timeout'
+require 'socket'
+require 'rexml/document'
+
+require 'selenium/webdriver/firefox/util'
+require 'selenium/webdriver/firefox/extension'
+require 'selenium/webdriver/firefox/socket_lock'
+require 'selenium/webdriver/firefox/binary'
+require 'selenium/webdriver/firefox/profiles_ini'
+require 'selenium/webdriver/firefox/profile'
+require 'selenium/webdriver/firefox/launcher'
+require 'selenium/webdriver/firefox/bridge'
+
+module Selenium
+  module WebDriver
+    module Firefox
+
+      DEFAULT_PORT                    = 7055
+      DEFAULT_ENABLE_NATIVE_EVENTS    = Platform.os == :windows
+      DEFAULT_SECURE_SSL              = false
+      DEFAULT_ASSUME_UNTRUSTED_ISSUER = true
+      DEFAULT_LOAD_NO_FOCUS_LIB       = false
+
+      def self.path=(path)
+        Binary.path = path
+      end
+
+    end
+  end
+end
+
+
+# SocketError was added in Ruby 1.8.7.
+# If it's not defined, we add it here so it can be used in rescues.
+unless defined? SocketError
+  class SocketError < IOError; end
+end

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

@@ -0,0 +1,158 @@
+module Selenium
+  module WebDriver
+    module Firefox
+
+      # @api private
+      class Binary
+
+        NO_FOCUS_LIBRARY_NAME = "x_ignore_nofocus.so"
+        NO_FOCUS_LIBRARIES    = [
+          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/amd64/#{NO_FOCUS_LIBRARY_NAME}", "amd64/#{NO_FOCUS_LIBRARY_NAME}"],
+          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/x86/#{NO_FOCUS_LIBRARY_NAME}", "x86/#{NO_FOCUS_LIBRARY_NAME}"],
+        ]
+
+        WAIT_TIMEOUT = 90
+        QUIT_TIMEOUT = 5
+
+        def start_with(profile, profile_path, *args)
+          if Platform.cygwin?
+            profile_path = Platform.cygwin_path(profile_path, :windows => true)
+          elsif Platform.windows?
+            profile_path = profile_path.gsub("/", "\\")
+          end
+
+          ENV['XRE_CONSOLE_LOG']           = profile.log_file if profile.log_file
+          ENV['XRE_PROFILE_PATH']          = profile_path
+          ENV['MOZ_NO_REMOTE']             = '1' # able to launch multiple instances
+          ENV['MOZ_CRASHREPORTER_DISABLE'] = '1' # disable breakpad
+          ENV['NO_EM_RESTART']             = '1' # prevent the binary from detaching from the console
+
+          if Platform.linux? && (profile.native_events? || profile.load_no_focus_lib?)
+            modify_link_library_path profile_path
+          end
+
+          execute(*args)
+          cope_with_mac_strangeness(args) if Platform.mac?
+        end
+
+        def quit
+          return unless @process
+          @process.poll_for_exit QUIT_TIMEOUT
+        rescue ChildProcess::TimeoutError
+          # ok, force quit
+          @process.stop QUIT_TIMEOUT
+        end
+
+        def wait
+          @process.poll_for_exit(WAIT_TIMEOUT) if @process
+        end
+
+        private
+
+        def execute(*extra_args)
+          args = [self.class.path, "-no-remote"] + extra_args
+          @process = ChildProcess.build(*args)
+          @process.io.inherit! if $DEBUG
+          @process.start
+        end
+
+        def cope_with_mac_strangeness(args)
+          sleep 0.3
+
+          if @process.crashed?
+            # ok, trying a restart
+            sleep 7
+            execute(*args)
+          end
+
+          # ensure we're ok
+          sleep 0.3
+          if @process.crashed?
+            raise Error::WebDriverError, "unable to start Firefox cleanly, args: #{args.inspect}"
+          end
+        end
+
+        def modify_link_library_path(profile_path)
+          paths = []
+
+          NO_FOCUS_LIBRARIES.each do |from, to|
+            dest = File.join(profile_path, to)
+            FileUtils.mkdir_p File.dirname(dest)
+            FileUtils.cp from, dest
+
+            paths << File.expand_path(File.dirname(dest))
+          end
+
+          paths += ENV['LD_LIBRARY_PATH'].to_s.split(File::PATH_SEPARATOR)
+
+          ENV['LD_LIBRARY_PATH'] = paths.uniq.join(File::PATH_SEPARATOR)
+          ENV['LD_PRELOAD']      = NO_FOCUS_LIBRARY_NAME
+        end
+
+        class << self
+
+          #
+          # @api private
+          #
+          # @see Firefox.path=
+          #
+
+          def path=(path)
+            Platform.assert_executable(path)
+            @path = path
+          end
+
+          def path
+            @path ||= case Platform.os
+                      when :macosx
+                        macosx_path
+                      when :windows
+                        windows_path
+                      when :linux, :unix
+                        Platform.find_binary("firefox3", "firefox2", "firefox") || "/usr/bin/firefox"
+                      else
+                        raise Error::WebDriverError, "unknown platform: #{Platform.os}"
+                      end
+
+            @path = Platform.cygwin_path(@path) if Platform.cygwin?
+
+            unless File.file?(@path.to_s)
+              raise Error::WebDriverError, "Could not find Firefox binary (os=#{Platform.os}). Make sure Firefox is installed or set the path manually with #{self}.path="
+            end
+
+            @path
+          end
+
+          private
+
+          def windows_path
+            windows_registry_path || Platform.find_in_program_files("\\Mozilla Firefox\\firefox.exe") || Platform.find_binary("firefox")
+          end
+
+          def macosx_path
+            path = "/Applications/Firefox.app/Contents/MacOS/firefox-bin"
+            path = Platform.find_binary("firefox-bin") unless File.exist?(path)
+
+            path
+          end
+
+          def windows_registry_path
+            require 'win32/registry'
+
+            lm = Win32::Registry::HKEY_LOCAL_MACHINE
+            lm.open("SOFTWARE\\Mozilla\\Mozilla Firefox") do |reg|
+              main = lm.open("SOFTWARE\\Mozilla\\Mozilla Firefox\\#{reg.keys[0]}\\Main")
+              if entry = main.find { |key, type, data| key =~ /pathtoexe/i }
+                return entry.last
+              end
+            end
+          rescue LoadError
+            # older JRuby or IronRuby does not have win32/registry
+          rescue Win32::Registry::Error
+          end
+        end # class << self
+
+      end # Binary
+    end # Firefox
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,70 @@
+module Selenium
+  module WebDriver
+    module Firefox
+
+      # @api private
+      class Bridge < Remote::Bridge
+
+        def initialize(opts = {})
+          port        = opts.delete(:port) || DEFAULT_PORT
+          profile     = opts.delete(:profile)
+          http_client = opts.delete(:http_client)
+          proxy       = opts.delete(:proxy)
+
+          caps = opts.delete(:desired_capabilities) do
+            Remote::Capabilities.firefox(:native_events => DEFAULT_ENABLE_NATIVE_EVENTS)
+          end
+
+          @launcher = create_launcher(port, profile)
+
+          unless opts.empty?
+            raise ArgumentError, "unknown option#{'s' if opts.size != 1}: #{opts.inspect}"
+          end
+
+          @launcher.launch
+
+          caps.proxy = proxy if proxy
+
+          remote_opts = {
+            :url                  => @launcher.url,
+            :desired_capabilities => caps
+          }
+
+          remote_opts.merge!(:http_client => http_client) if http_client
+
+          begin
+            super(remote_opts)
+          rescue
+            @launcher.quit
+            raise
+          end
+        end
+
+        def browser
+          :firefox
+        end
+
+        def driver_extensions
+          [
+            DriverExtensions::TakesScreenshot,
+            DriverExtensions::HasInputDevices
+          ]
+        end
+
+        def quit
+          super
+          nil
+        ensure
+          @launcher.quit
+        end
+
+        private
+
+        def create_launcher(port, profile)
+          Launcher.new Binary.new, port, profile
+        end
+
+      end # Bridge
+    end # Firefox
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,52 @@
+module Selenium
+  module WebDriver
+    module Firefox
+
+      # @api private
+      class Extension
+        def initialize(path)
+          unless File.exist?(path)
+            raise Error::WebDriverError, "could not find extension at #{path.inspect}"
+          end
+
+          @path             = path
+          @should_reap_root = false
+        end
+
+        def write_to(extensions_dir)
+          root_dir = create_root
+          ext_path = File.join extensions_dir, read_id_from_install_rdf(root_dir)
+
+          FileUtils.rm_rf ext_path
+          FileUtils.mkdir_p File.dirname(ext_path), :mode => 0700
+          FileUtils.cp_r root_dir, ext_path
+
+          FileReaper.reap(root_dir) if @should_reap_root
+        end
+
+        private
+
+        def create_root
+          if File.directory? @path
+            @path
+          else
+            unless Zipper::EXTENSIONS.include? File.extname(@path)
+              raise Error::WebDriverError, "expected #{Zipper::EXTENSIONS.join(" or ")}, got #{@path.inspect}"
+            end
+
+            @should_reap_root = true
+            Zipper.unzip(@path)
+          end
+        end
+
+        def read_id_from_install_rdf(directory)
+          rdf_path = File.join(directory, "install.rdf")
+          doc = REXML::Document.new(File.read(rdf_path))
+
+          REXML::XPath.first(doc, "//em:id").text
+        end
+
+      end # Extension
+    end # Firefox
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,106 @@
+module Selenium
+  module WebDriver
+    module Firefox
+
+      # @api private
+      class Launcher
+
+        SOCKET_LOCK_TIMEOUT       = 45
+        STABLE_CONNECTION_TIMEOUT = 60
+
+        def initialize(binary, port, profile = nil)
+          @binary = binary
+          @port   = Integer(port)
+
+          raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
+
+          if profile.kind_of? Profile
+            @profile = profile
+          else
+            @profile_name = profile
+            @profile = nil
+          end
+
+          @host = "127.0.0.1"
+        end
+
+        def url
+          "http://#{@host}:#{@port}/hub"
+        end
+
+        def launch
+          socket_lock.locked do
+            find_free_port
+            create_profile
+            start_silent_and_wait
+            start
+            connect_until_stable
+          end
+
+          self
+        end
+
+        def quit
+          @binary.quit
+          FileReaper.reap(@profile_dir) if @profile_dir
+        end
+
+        def find_free_port
+          @port = PortProber.above @port
+        end
+
+        def create_profile
+          fetch_profile unless @profile
+
+          @profile.add_webdriver_extension
+          @profile.port = @port
+
+          @profile_dir = @profile.layout_on_disk
+          FileReaper << @profile_dir
+        end
+
+        def start
+          assert_profile
+          @binary.start_with @profile, @profile_dir, "-foreground"
+        end
+
+        def start_silent_and_wait
+          assert_profile
+
+          @binary.start_with @profile, @profile_dir, "-silent"
+          @binary.wait
+        end
+
+        def connect_until_stable
+          poller = SocketPoller.new(@host, @port, STABLE_CONNECTION_TIMEOUT)
+
+          unless poller.connected?
+            @binary.quit
+            raise Error::WebDriverError, "unable to obtain stable firefox connection in #{STABLE_CONNECTION_TIMEOUT} seconds (#{@host}:#{@port})"
+          end
+        end
+
+        def fetch_profile
+          if @profile_name
+            @profile = Profile.from_name @profile_name
+
+            unless @profile
+              raise Error::WebDriverError, "unable to find profile named: #{@profile_name.inspect}"
+            end
+          else
+            @profile = Profile.new
+          end
+        end
+
+        def assert_profile
+          raise Error::WebDriverError, "must create_profile first" unless @profile && @profile_dir
+        end
+
+        def socket_lock
+          @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
+        end
+
+      end # Launcher
+    end # Firefox
+  end # WebDriver
+end # Selenium