testingbot 0.0.9 → 0.1.0

data/lib/testingbot/cucumber.rb

@@ -1,30 +1,35 @@
 require 'testingbot/config'
+require 'testingbot/capybara'
+require 'testingbot/api'
 
 if defined?(Cucumber)
-	After do |scenario|
-    client_key = TestingBot.get_config[:client_key]
-    client_secret = TestingBot.get_config[:client_secret]
-    
-	  if Capybara.drivers.include?(:testingbot) && !TestingBot.get_config[:client_key].nil?
-	    begin
-        session_id = page.driver.browser.instance_variable_get("@bridge").instance_variable_get("@session_id")
-          
-        params = {
-            "session_id" => session_id,
-            "client_key" => client_key,
-            "client_secret" => client_secret,
-            "status_message" => (scenario.failed? ? scenario.exception.message : ""),
-            "success" => !scenario.failed?,
-            "name" => scenario.title,
-            "kind" => 2
-        }
-        
-        url = URI.parse('http://testingbot.com/hq')
-        http = Net::HTTP.new(url.host, url.port)
-        response = http.post(url.path, params.map { |k, v| "#{k.to_s}=#{v}" }.join("&"))
-      rescue Exception => e
-        p "Could not determine sessionID, can not send results to TestingBot.com #{e.message}"
-      end
-	  end
-	end
+    Before('@selenium') do
+        ::Capybara.current_driver = :testingbot
+    end
+
+    After('@selenium') do |scenario|
+        if !TestingBot.get_config[:client_key].nil?
+            begin
+                driver = ::Capybara.current_session.driver
+                if driver.browser.respond_to?(:session_id)
+                    session_id = driver.browser.session_id
+                else
+                    session_id = driver.browser.instance_variable_get("@bridge").instance_variable_get("@session_id")
+                end
+
+                api = TestingBot::Api.new
+                params = {
+                    "session_id" => session_id,
+                    "status_message" => (scenario.failed? ? scenario.exception.message : ""),
+                    "success" => !scenario.failed? ? 1 : 0,
+                    "name" => scenario.title,
+                    "kind" => 2
+                }
+
+                data = api.update_test(session_id, params)
+            rescue Exception => e
+                p "Could not determine sessionID, can not send results to TestingBot.com #{e.message}"
+            end
+        end
+    end
 end

data/lib/testingbot/hooks.rb

@@ -0,0 +1,255 @@
+# rspec 1
+if defined?(Spec) && defined?(Spec::VERSION::MAJOR) && Spec::VERSION::MAJOR == 1
+  require "selenium/rspec/spec_helper"
+  Spec::Runner.configure do |config|
+    config.before(:suite) do
+      if TestingBot.get_config[:require_tunnel]
+        @@tunnel = TestingBot::Tunnel.new(TestingBot.get_config[:tunnel_options] || {})
+        @@tunnel.start
+      end
+    end
+
+    config.after(:suite) do
+      @@tunnel.stop if defined? @@tunnel
+    end
+
+    config.prepend_after(:each) do
+      client_key = TestingBot.get_config[:client_key]
+      client_secret = TestingBot.get_config[:client_secret]
+      
+      if !client_key.nil?
+        
+        session_id = nil
+        
+        if !@selenium_driver.nil?
+          session_id = @selenium_driver.session_id_backup
+        elsif defined?(Capybara)
+          begin
+            if page.driver.browser.respond_to?(:session_id)
+              session_id = page.driver.browser.session_id
+            else
+              session_id = page.driver.browser.instance_variable_get("@bridge").instance_variable_get("@session_id")
+            end
+          rescue Exception => e
+            puts "Could not determine sessionID, can not send results to TestingBot.com #{e.message}"
+          end
+        end
+        
+        if !session_id.nil?
+          api = TestingBot::Api.new
+          params = {
+            "session_id" => session_id,
+            "status_message" => @execution_error,
+            "success" => !actual_failure? ? 1 : 0,
+            "name" => description.to_s,
+            "kind" => 2
+          }
+
+          data = api.update_test(session_id, params)
+
+          if ENV['JENKINS_HOME'] && (TestingBot.get_config[:jenkins_output] == true)
+            puts "TestingBotSessionID=" + session_id
+          end
+        end
+      else
+          puts "Can't post test results to TestingBot since I could not a .testingbot file in your home-directory."
+      end
+    end
+  end
+end
+
+# rspec 2
+begin
+  require 'rspec'
+
+  ::RSpec.configuration.before :suite do
+    if TestingBot.get_config[:require_tunnel]
+      @@tunnel = TestingBot::Tunnel.new(TestingBot.get_config[:tunnel_options] || {})
+      @@tunnel.start
+    end
+  end
+
+  module TestingBot
+    module RSpecInclude
+      attr_reader :selenium_driver
+      alias_method :page, :selenium_driver
+
+      def self.included(base)
+        base.around do |test|
+          if TestingBot.get_config.desired_capabilities.instance_of?(Array)
+            TestingBot.get_config.desired_capabilities.each do |browser|
+              @selenium_driver = TestingBot::SeleniumWebdriver.new({ :desired_capabilities => browser })
+              begin
+                test.run
+              ensure
+                @selenium_driver.stop
+              end
+            end
+          else
+            @selenium_driver = TestingBot::SeleniumWebdriver.new({ :desired_capabilities => TestingBot.get_config.desired_capabilities })
+            begin
+              test.run
+            ensure
+              @selenium_driver.stop
+            end
+          end
+        end
+      end
+    end  
+
+    module RSpecIncludeLegacy
+      attr_reader :selenium_driver
+      alias_method :page, :selenium_driver
+
+      def self.included(base)
+        base.around do |test|
+          if TestingBot.get_config.desired_capabilities.instance_of?(Array)
+            TestingBot.get_config.desired_capabilities.each do |browser|
+              @selenium_driver = ::Selenium::Client::Driver.new(:browser => browser[:browserName], :url => TestingBot.get_config[:browserUrl])
+              @selenium_driver.start_new_browser_session(browser)
+              begin
+                test.run
+              ensure
+                @selenium_driver.stop
+              end
+            end
+          else
+            @selenium_driver = ::Selenium::Client::Driver.new(:browser => browser[:browserName], :url => TestingBot.get_config[:browserUrl])
+            @selenium_driver.start_new_browser_session(TestingBot.get_config.desired_capabilities)
+            begin
+              test.run
+            ensure
+              @selenium_driver.stop
+            end
+          end
+        end
+      end
+    end  
+  end
+
+  ::RSpec.configuration.include(TestingBot::RSpecIncludeLegacy, :multibrowserRC => true)
+  ::RSpec.configuration.include(TestingBot::RSpecInclude, :multibrowser => true)
+
+  ::RSpec.configuration.after :suite do
+    @@tunnel.stop if defined? @@tunnel
+  end
+  
+  ::RSpec.configuration.after :each do
+    client_key = TestingBot.get_config[:client_key]
+    client_secret = TestingBot.get_config[:client_secret]
+    
+    if !client_key.nil?
+      test_name = ""
+      if example.metadata && example.metadata[:example_group]
+        if example.metadata[:example_group][:description_args]
+          test_name = example.metadata[:example_group][:description_args].join(" ")
+        end
+        
+        if example.metadata[:description_args]
+          test_name = test_name + " it " + example.metadata[:description_args].join(" ")
+        end
+      end
+      
+      status_message = ""
+      status_message = example.exception.to_s if !example.exception.nil?
+      
+      session_id = nil
+
+      if !@selenium_driver.nil?
+        session_id = @selenium_driver.session_id
+      elsif defined? page
+        begin
+          if page.driver.browser.respond_to?(:session_id)
+            session_id = page.driver.browser.session_id
+          else
+            session_id = page.driver.browser.instance_variable_get("@bridge").instance_variable_get("@session_id")
+          end
+        rescue Exception => e
+          p "Could not determine sessionID, can not send results to TestingBot.com #{e.message}"
+        end
+      end
+      
+      if !session_id.nil?
+        if ENV['JENKINS_HOME'] && (TestingBot.get_config[:jenkins_output] == true)
+          puts "TestingBotSessionID=" + session_id
+        end
+        api = TestingBot::Api.new
+        params = {
+            "session_id" => session_id,
+            "status_message" => status_message,
+            "success" => example.exception.nil? ? 1 : 0,
+            "name" => test_name,
+            "kind" => 2
+        }
+
+        data = api.update_test(session_id, params)
+      end
+    else
+      puts "Can't post test results to TestingBot since I could not a .testingbot file in your home-directory."
+    end
+  end
+rescue LoadError
+end
+
+module TestingBot
+  module SeleniumForTestUnit
+    attr_accessor :exception
+    attr_reader :browser
+    
+    def run(*args, &blk)
+      if TestingBot.get_config.desired_capabilities.instance_of?(Array)
+        TestingBot.get_config.desired_capabilities.each do |browser|
+          @browser = ::Selenium::Client::Driver.new(:browser => browser[:browserName], :url => TestingBot.get_config[:browserUrl])
+          @browser.start_new_browser_session(browser)
+          super(*args, &blk)
+          @browser.stop
+        end
+      else
+        super(*args, &blk)
+      end
+    end
+
+    def teardown
+      api = TestingBot::Api.new
+      params = {
+          "session_id" => browser.session_id,
+          "status_message" => @exception || "",
+          "success" => passed? ? 1 : 0,
+          "name" => self.to_s,
+          "kind" => 2
+      }
+
+      data = api.update_test(browser.session_id, params)
+
+      if ENV['JENKINS_HOME'] && (TestingBot.get_config[:jenkins_output] == true)
+        puts "TestingBotSessionID=" + browser.session_id
+      end
+      super
+    end
+    
+    def handle_exception(e)
+      @exception = e.to_s
+      handle_exception_old(e)
+    end
+
+    alias :handle_exception_old :handle_exception
+  end
+end
+
+begin
+  require 'test/unit/testcase'
+  module TestingBot
+    class TestCase < Test::Unit::TestCase
+      include SeleniumForTestUnit
+    end
+  end
+rescue LoadError
+end
+
+if defined?(ActiveSupport::TestCase)
+  module TestingBot
+    class RailsTestCase < ::ActiveSupport::TestCase
+      include SeleniumForTestUnit
+    end
+  end
+end

data/lib/testingbot/selenium.rb

@@ -0,0 +1,122 @@
+# we create our own Selenium classes here to extend them with user credentials and config
+
+require 'selenium/client'
+require 'selenium/webdriver'
+require 'selenium/webdriver/remote/http/persistent'
+
+module TestingBot
+
+  class SeleniumWebdriver
+
+    attr_reader :config, :driver
+    attr_accessor :session_id_backup
+
+    def initialize(options = {})
+      @options = TestingBot::get_config.options
+      @options = @options.merge(options)
+
+      http_client = ::Selenium::WebDriver::Remote::Http::Persistent.new
+      http_client.timeout = 400
+      @driver = ::Selenium::WebDriver.for(:remote, :url => "http://#{@options[:client_key]}:#{@options[:client_secret]}@#{@options[:host]}:#{@options[:port]}/wd/hub", :desired_capabilities => @options[:desired_capabilities], :http_client => http_client)
+      http_client.timeout = 120
+    end
+
+    def method_missing(meth, *args)
+      @driver.send(meth, *args)
+    end
+
+    def session_id
+      @driver.send(:bridge).session_id
+    end
+
+    def stop
+      @session_id_backup = session_id
+      @driver.quit
+    end
+  end
+end
+
+# if selenium RC, add testingbot credentials to request
+if defined?(Selenium) && defined?(Selenium::Client) && defined?(Selenium::Client::Protocol)
+  module Selenium
+    module Client
+      module Protocol
+          # add custom parameters for testingbot.com
+          def http_request_for_testingbot(verb, args)
+            data = http_request_for_original(verb, args)
+            data << "&client_key=#{TestingBot.get_config[:client_key]}&client_secret=#{TestingBot.get_config[:client_secret]}" unless TestingBot.get_config[:client_key].nil?
+          end
+
+          begin
+           alias http_request_for_original http_request_for
+           alias http_request_for http_request_for_testingbot
+         rescue
+         end
+      end
+    end
+  end
+end
+
+if defined?(Selenium) && defined?(Selenium::Client) && defined?(Selenium::Client::Base)
+  module Selenium
+    module Client
+      module Base
+        DEFAULT_OPTIONS = {
+          :screenshot => true
+        }
+        
+        alias :close_current_browser_session_old :close_current_browser_session
+        alias :start_new_browser_session_old :start_new_browser_session
+        alias :initialize_old :initialize
+        
+        attr_accessor :options
+        attr_accessor :session_id_backup
+        attr_accessor :extra
+        attr_accessor :platform
+        attr_accessor :version
+
+        attr_reader :config
+        
+        def initialize(*args)
+          @config = TestingBot::get_config
+          @options = @config[:options] || {}
+          
+          if args[0].kind_of?(Hash)
+            options = args[0]
+            @platform = options[:platform] || "WINDOWS"
+            @version  = options[:version]  if options[:version]
+          end
+          
+          @options = DEFAULT_OPTIONS
+          initialize_old(*args)
+          @host = options[:host] || @config[:host]
+          @port = options[:port] || @config[:port]
+        end
+        
+        def close_current_browser_session
+          @session_id_backup = @session_id
+          close_current_browser_session_old
+        end
+
+        def session_id
+          @session_id || @session_id_backup || ""
+        end
+        
+        def start_new_browser_session(options={})
+          options = @options.merge options
+          options[:platform] = @platform
+          options[:version] = @version unless @version.nil?
+          start_new_browser_session_old(options)
+        end
+        
+        def extra=(str)
+          @extra = str
+        end
+        
+        def options=(opts = {})
+          @options = @options.merge opts
+        end
+      end
+    end
+  end
+end

data/lib/testingbot/tunnel.rb

@@ -1,16 +1,104 @@
 module TestingBot
-  module Tunnel
-    def self.start_tunnel(host, port, localport = 80)
-      @@pid = fork do
-        exec "ssh -gNR #{port}:localhost:#{localport} #{host}"
+  class Tunnel
+    TIMEOUT_SECONDS = 70
+
+    @@running = false
+
+    attr_reader :options, :config, :process, :available, :connected, :errors
+
+    def initialize(opts = {})
+      @available = false
+      @errors = []
+      @config = TestingBot.get_config
+      @options = default_options
+      @options = @options.merge(opts)
+
+      raise ArgumentError, "Please make sure you have put the .testingbot file in the your user directory, or set the environment variables TESTINGBOT_CLIENTKEY AND TESTINGBOT_CLIENTSECRET" if @config[:client_key].nil? || @config[:client_secret].nil?
+    end
+
+    def start
+      return if @@running == true
+
+      @@running = true
+
+      @config.require_tunnel
+      p "Starting the TestingBot Tunnel" if @options[:verbose] == true
+      @process = IO.popen("exec java -jar #{get_jar_path} #{@options[:client_key] || @config[:client_key]} #{@options[:client_secret] || @config[:client_secret]} #{extra_options} 2>&1")
+      at_exit do
+        @@running = false
+        # make sure we kill the tunnel
+        Process.kill("INT", @process.pid) if @available == true
       end
+
+      Thread.new do 
+        while (line = @process.gets)
+          if line =~ /^You may start your tests/
+            @available = true
+          end
+
+          if line =~ /Exception/ || line =~ /error/
+            @errors << line
+          end
+
+          p line if @options[:verbose] == true
+        end
+      end
+
+      poll_ready
+
+      p "You are now ready to start your test" if @options[:verbose] == true
+    end
+
+    def is_connected?
+      @available
     end
 
-    def self.stop_tunnel
-      if @@pid
-        Process.kill "TERM", @@pid
-        Process.wait @@pid
+    def errors
+      @errors || []
+    end
+
+    def stop
+      raise "Can't stop tunnel, it has not been started yet" if @process.nil?
+      p "Stopping TestingBot Tunnel" if @options[:verbose] == true
+
+      kill
+    end
+
+    def kill
+      @@running = false
+      @available = false
+      Process.kill("INT", @process.pid)
+      Process.wait
+    end
+
+    def extra_options
+      extra = @options[:options] || []
+      extra.join(" ")
+    end
+
+    private
+
+    def default_options
+      {
+        :verbose => true
+      }
+    end
+
+    def get_jar_path
+      file = File.expand_path(File.dirname(__FILE__) + '/../../vendor/Testingbot-Tunnel.jar')
+      raise RuntimeException, "Could not find TestingBot-Tunnel.jar in vendor directory" unless File.exists?(file)
+
+      file
+    end
+
+    def poll_ready
+      seconds = 0
+      while ((@available == false) && (seconds < TIMEOUT_SECONDS) && @errors.empty?)
+        sleep 1
+        seconds = seconds + 1
       end
+
+      raise "Could not start Tunnel after #{TIMEOUT_SECONDS} seconds" if !is_connected? && @errors.empty?
     end
   end
 end