js_test_core 0.1.1 → 0.2.0

data/CHANGES

@@ -1,3 +1,14 @@
+0.2.0
+- Renamed Suite to Session to follow Selenium conventions
+- Renamed SuiteFinish to SessionFinish to follow Selenium conventions
+- Added /session, which uses the session_id cookie to derive the current session.
+- Added /session/finished to be used to simplify client/server interactions.
+- Remove File caching because it doesn't cause a noticable performance benefit over a local network and because it sometimes doesn't write over stale files.
+- Client accepts selenium_browser_start_command parameter, which allows the user to parameterize the selenium_browser_start_command
+- Added support for running specs in Internet Explorer via POST /runners/iexplore
+- Resource file download performance improvements via caching and chunked sending
+- Fixed false positive bug when Client connection times out
+
 0.1.1
 - SuiteFinish#post immediately closes the connection
 

data/Rakefile

@@ -26,7 +26,7 @@ def run_suite
 end
 
 PKG_NAME = "js_test_core"
-PKG_VERSION = "0.1.1"
+PKG_VERSION = "0.2.0"
 PKG_FILES = FileList[
   '[A-Z]*',
   '*.rb',

data/lib/js_test_core.rb

@@ -1,7 +1,14 @@
 require "rubygems"
 gem "thin", ">=0.8.0"
 
-require "thin"
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift File.expand_path("#{dir}/../vendor/thin-rest/lib")
+require "thin_rest"
+
+# This causes errors to be printed to STDOUT.
+Thin::Logging.silent = false
+Thin::Logging.debug = true
+
 require "fileutils"
 require "tmpdir"
 require "timeout"
@@ -10,13 +17,14 @@ require "net/http"
 require "selenium"
 require "optparse"
 
-dir = File.dirname(__FILE__)
+require "#{dir}/js_test_core/extensions"
 require "#{dir}/js_test_core/thin"
 require "#{dir}/js_test_core/rack"
 require "#{dir}/js_test_core/resources"
 require "#{dir}/js_test_core/selenium"
 
 require "#{dir}/js_test_core/client"
+require "#{dir}/js_test_core/selenium_server_configuration"
 require "#{dir}/js_test_core/server"
 require "#{dir}/js_test_core/rails_server"
 

data/lib/js_test_core/client.rb

@@ -1,24 +1,17 @@
 module JsTestCore
   class Client
-    class << self
-      def run(params={})
-        data = []
-        data << "selenium_host=#{CGI.escape(params[:selenium_host] || 'localhost')}"
-        data << "selenium_port=#{CGI.escape((params[:selenium_port] || 4444).to_s)}"
-        data << "spec_url=#{CGI.escape(params[:spec_url])}" if params[:spec_url]
-        response = Net::HTTP.start(DEFAULT_HOST, DEFAULT_PORT) do |http|
-          http.post('/runners/firefox', data.join("&"))
-        end
+    class ClientException < Exception
+    end
 
-        body = response.body
-        if body.empty?
-          puts "SUCCESS"
-          return true
-        else
-          puts "FAILURE"
-          puts body
-          return false
-        end
+    class InvalidStatusResponse < ClientException
+    end
+
+    class SessionNotFound < ClientException
+    end
+
+    class << self
+      def run(parameters={})
+        new(parameters).run
       end
 
       def run_argv(argv)
@@ -28,6 +21,10 @@ module JsTestCore
           o.banner << "\nUsage: #{$0} [options] [-- untouched arguments]"
 
           o.on
+          o.on('-s', '--selenium_browser_start_command=selenium_browser_start_command', "The Selenium server command to start the browser. See http://selenium-rc.openqa.org/") do |selenium_browser_start_command|
+            params[:selenium_browser_start_command] = selenium_browser_start_command
+          end
+
           o.on('-h', '--selenium_host=SELENIUM_HOST', "The host name of the Selenium Server relative to where this file is executed") do |host|
             params[:selenium_host] = host
           end
@@ -46,5 +43,75 @@ module JsTestCore
         run params
       end
     end
+
+    attr_reader :parameters, :query_string, :http, :session_start_response, :last_poll_status, :last_poll_reason, :last_poll
+    def initialize(parameters)
+      @parameters = parameters
+      @query_string = SeleniumServerConfiguration.query_string_from(parameters)
+    end
+
+    def run
+      Net::HTTP.start(DEFAULT_HOST, DEFAULT_PORT) do |@http|
+        start_runner
+        wait_for_session_to_finish
+      end
+      report_result
+    end
+
+    def parts_from_query(query)
+      query.split('&').inject({}) do |acc, key_value_pair|
+        key, value = key_value_pair.split('=')
+        acc[key] = value
+        acc
+      end
+    end
+    
+    protected
+    def start_runner
+      @session_start_response = http.post('/runners', query_string)
+    end
+
+    def wait_for_session_to_finish
+      while session_not_completed?
+        poll
+        sleep 0.25
+      end
+    end
+
+    def report_result
+      case last_poll_status
+      when Resources::Session::SUCCESSFUL_COMPLETION
+        STDOUT.puts "SUCCESS"
+        true
+      when Resources::Session::FAILURE_COMPLETION
+        STDOUT.puts "FAILURE"
+        STDOUT.puts last_poll_reason
+        false
+      else
+        raise InvalidStatusResponse, "Invalid Status: #{last_poll_status}"
+      end
+    end
+
+    def session_not_completed?
+      last_poll_status.nil? || last_poll_status == Resources::Session::RUNNING
+    end
+
+    def poll
+      @last_poll = http.get("/sessions/#{session_id}")
+      ensure_session_exists!
+      parts = parts_from_query(last_poll.body)
+      @last_poll_status = parts['status']
+      @last_poll_reason = parts['reason']
+    end
+
+    def ensure_session_exists!
+      if (400..499).include?(Integer(last_poll.code))
+        raise SessionNotFound, "Could not find session with id #{session_id}"
+      end
+    end
+
+    def session_id
+      @session_id ||= parts_from_query(session_start_response.body)['session_id']
+    end
   end
 end

data/lib/js_test_core/extensions.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/extensions/*.rb"].each do |file|
+  require file
+end

data/lib/js_test_core/extensions/time.rb

@@ -0,0 +1,6 @@
+require "time"
+class Time
+  def rfc822
+    strftime("%a, %d %b %Y %k:%M:%S %Z")
+  end  
+end

data/lib/js_test_core/resources.rb

@@ -1,10 +1,10 @@
 dir = File.dirname(__FILE__)
-require "#{dir}/resources/runners"
-require "#{dir}/resources/runners/firefox_runner"
+require "#{dir}/resources/runner"
 require "#{dir}/resources/file"
 require "#{dir}/resources/dir"
+require "#{dir}/resources/file_not_found"
 require "#{dir}/resources/specs/spec_file"
 require "#{dir}/resources/specs/spec_dir"
 require "#{dir}/resources/web_root"
-require "#{dir}/resources/suite"
-require "#{dir}/resources/suite_finish"
+require "#{dir}/resources/session"
+require "#{dir}/resources/session_finish"

data/lib/js_test_core/resources/dir.rb

@@ -1,25 +1,32 @@
 module JsTestCore
   module Resources
     class Dir < File
-      def locate(name)
+      route ANY do |env, name|
         if file = file(name)
           file
         elsif subdir = subdir(name)
           subdir
         else
-          raise "No file or directory found at #{relative_path}/#{name}."
+          FileNotFound.new(env.merge(:name => name))
         end
       end
 
-      def get(request, response)
-
+      def get
+        connection.send_head
+        connection.send_body(::Dir.glob("#{absolute_path}/*").inject("") do |html, file|
+          file_basename = ::File.basename(file)
+          html << %Q|<a href="#{file_basename}">#{file_basename}</a>\n|
+        end)
       end
 
       def glob(pattern)
         expanded_pattern = absolute_path + pattern
         ::Dir.glob(expanded_pattern).map do |absolute_globbed_path|
           relative_globbed_path = absolute_globbed_path.gsub(absolute_path, relative_path)
-          File.new(absolute_globbed_path, relative_globbed_path)
+          File.new(env.merge(
+            :absolute_path => absolute_globbed_path,
+            :relative_path => relative_globbed_path
+          ))
         end
       end
 
@@ -31,18 +38,26 @@ module JsTestCore
       end
 
       def file(name)
+        # N.B. Absolute_path and relative_path are methods. Do not shadow.
         absolute_file_path, relative_file_path = determine_child_paths(name)
         if ::File.exists?(absolute_file_path) && !::File.directory?(absolute_file_path)
-          Resources::File.new(absolute_file_path, relative_file_path)
+          Resources::File.new(env.merge(
+            :absolute_path => absolute_file_path,
+            :relative_path => relative_file_path
+          ))
         else
           nil
         end
       end
 
       def subdir(name)
+        # N.B. Absolute_path and relative_path are methods. Do not shadow.
         absolute_dir_path, relative_dir_path = determine_child_paths(name)
         if ::File.directory?(absolute_dir_path)
-          Resources::Dir.new(absolute_dir_path, relative_dir_path)
+          Resources::Dir.new(env.merge(
+            :absolute_path => absolute_dir_path,
+            :relative_path => relative_dir_path
+          ))
         else
           nil
         end

data/lib/js_test_core/resources/file.rb

@@ -1,6 +1,6 @@
 module JsTestCore
   module Resources
-    class File
+    class File < ThinRest::Resource
       MIME_TYPES = {
         '.js' => 'text/javascript',
         '.css' => 'text/css',
@@ -8,25 +8,33 @@ module JsTestCore
         '.jpg' => 'image/jpeg',
         '.jpeg' => 'image/jpeg',
         '.gif' => 'image/gif',
-      }
+        }
 
-      attr_reader :absolute_path, :relative_path
+      property :absolute_path, :relative_path
 
-      def initialize(absolute_path, relative_path)
-        @absolute_path = absolute_path
-        @relative_path = relative_path
-      end
-
-      def get(request, response)
+      def get
         extension = ::File.extname(absolute_path)
-        response.headers['Content-Type'] = MIME_TYPES[extension] || 'text/html'
-        response.body = ::File.read(absolute_path)
-      end
+        content_type = MIME_TYPES[extension] || 'text/html'
+
+        connection.terminate_after_sending do
+          connection.send_head(
+            200,
+              'Content-Type' => content_type,
+              'Last-Modified' => ::File.mtime(absolute_path).rfc822,
+              'Content-Length' => ::File.size(absolute_path)
+          )
+          ::File.open(absolute_path) do |file|
+            while !file.eof?
+              connection.send_data(file.read(1024))
+            end
+          end
+        end
 
-      def ==(other)
-        return false unless other.class == self.class
-        absolute_path == other.absolute_path && relative_path == other.relative_path
+        def ==(other)
+          return false unless other.class == self.class
+          absolute_path == other.absolute_path && relative_path == other.relative_path
+        end
       end
     end
   end
-end
+end

data/lib/js_test_core/resources/file_not_found.rb

@@ -0,0 +1,11 @@
+module JsTestCore
+  module Resources
+    class FileNotFound < ThinRest::Resource
+      property :name
+      def get
+        connection.send_head(404)
+        connection.send_body("")
+      end
+    end
+  end
+end

data/lib/js_test_core/resources/runner.rb

@@ -0,0 +1,107 @@
+module JsTestCore
+  module Resources
+    class Runner < ThinRest::Resource
+      class Collection < ThinRest::Resource
+        property :selenium_browser_start_command
+        route 'firefox' do |env, name|
+          self.selenium_browser_start_command = "*firefox"
+          self
+        end
+        route 'iexplore' do |env, name|
+          self.selenium_browser_start_command = "*iexplore"
+          self
+        end
+
+        def after_initialize
+          super
+          self.selenium_browser_start_command = rack_request['selenium_browser_start_command']
+        end
+
+        def post
+          spec_url = rack_request['spec_url'].to_s == "" ? full_spec_suite_url : rack_request['spec_url']
+          parsed_spec_url = URI.parse(spec_url)
+          selenium_host = rack_request['selenium_host'].to_s == "" ? 'localhost' : rack_request['selenium_host'].to_s
+          selenium_port = rack_request['selenium_port'].to_s == "" ? 4444 : Integer(rack_request['selenium_port'])
+          http_address = "#{parsed_spec_url.scheme}://#{parsed_spec_url.host}:#{parsed_spec_url.port}"
+          driver = Selenium::SeleniumDriver.new(
+            selenium_host,
+            selenium_port,
+            selenium_browser_start_command,
+            http_address
+          )
+          begin
+            driver.start
+          rescue Errno::ECONNREFUSED => e
+            raise Errno::ECONNREFUSED, "Cannot connect to Selenium Server at #{http_address}. To start the selenium server, run `selenium`."
+          end
+          runner = Runner.new(:driver => driver)
+          Runner.register(runner)
+          Thread.start do
+            driver.open("/")
+            driver.create_cookie("session_id=#{runner.session_id}")
+            driver.open(parsed_spec_url.path)
+          end
+          connection.send_head
+          connection.send_body("session_id=#{runner.session_id}")
+        end
+
+        protected
+        def full_spec_suite_url
+          "#{Server.root_url}/specs"
+        end
+      end
+
+      class << self
+        def find(id)
+          instances[id.to_s]
+        end
+
+        def finalize(session_id, text)
+          if runner = find(session_id)
+            runner.finalize(text)
+          end
+        end
+
+        def register(runner)
+          instances[runner.session_id] = runner
+        end
+
+        protected
+        def instances
+          @instances ||= {}
+        end
+      end
+
+      include FileUtils
+      property :driver
+      attr_reader :profile_dir, :session_run_result
+
+      def after_initialize
+        profile_base = "#{::Dir.tmpdir}/js_test_core/#{self.class.name}"
+        mkdir_p profile_base
+        @profile_dir = "#{profile_base}/#{Time.now.to_i}"
+      end
+
+      def finalize(session_run_result)
+        driver.stop
+        @session_run_result = session_run_result.to_s
+      end
+
+      def running?
+        driver.session_started?
+      end
+
+      def successful?
+        !running? && session_run_result.empty?
+      end
+
+      def failed?
+        !running? && !successful?
+      end
+
+      def session_id
+        driver.session_id
+      end
+    end
+  end
+end