pivotal-screw-unit 0.4.0

data/vendor/js-test-core/CHANGES

@@ -0,0 +1,25 @@
+- Added support for custom suite files
+- Added dependency on Erector
+- Better error messages
+- Changed dependency from Selenium to selenium-client
+
+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
+
+0.1.0
+- Initial Release extracted from JsTestCore.
+- Added JsTestCore::WebRoot.dispatch_specs and .dispatch_strategy
+- Extracted JsTestCore::Resources::Specs::SpecDir
+- Extracted JsTestCore::Resources::Specs::SpecFile
+- No longer depending on Guid. The child libraries are responsible for obtaining the Selenium session_id from the client by using top.runOptions.getSessionId().

data/vendor/js-test-core/README

@@ -0,0 +1,12 @@
+= JsTestCore
+The JsTestCore library is the core javascript test server library used by several JS Test server libraries.
+
+To hook up your own JS Test framework:
+  * You will need to call either JsTestCore::Resources::WebRoot.dispatch_specs or JsTestCore::Resources::WebRoot.dispatch_tests
+    depending if you are serving specs or tests.
+  * Set JsTestCore.core_path to the directory of the client side test framework (javascript files)
+  * Override JsTestCore::Resources::Specs::SpecFile#get or JsTestCore::Resources::Specs::TestFile#get
+  * Override JsTestCore::Resources::Specs::SpecDir#get or JsTestCore::Resources::Specs::TestDir#get
+
+NOTE: The current version of JsTestCore does not yet support tests. Support will be added soon.
+      I just wanted the test stuff to be in the docs to establish the current architectural direction.

data/vendor/js-test-core/Rakefile

@@ -0,0 +1,73 @@
+require "rake"
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc "Runs the Rspec suite"
+task(:default) do
+  run_suite
+end
+
+desc "Runs the Rspec suite"
+task(:spec) do
+  run_suite
+end
+
+desc "Copies the trunk to a tag with the name of the current release"
+task(:tag_release) do
+  tag_release
+end
+
+def run_suite
+  dir = File.dirname(__FILE__)
+  system("ruby #{dir}/spec/spec_suite.rb") || raise("Example Suite failed")
+end
+
+PKG_NAME = "js_test_core"
+PKG_VERSION = "0.2.0"
+PKG_FILES = FileList[
+  '[A-Z]*',
+  '*.rb',
+  'lib/**/*.rb',
+  'core/**',
+  'bin/**',
+  'spec/**/*.rb'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "The JsTestCore library is the core javascript test server library used by several JS Test server libraries."
+  s.test_files = "spec/spec_suite.rb"
+  s.description = s.summary
+
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = [ "README", "CHANGES" ]
+  s.rdoc_options = ["--main", "README", "--inline-source", "--line-numbers"]
+
+  s.test_files = Dir.glob('spec/*_spec.rb')
+  s.require_path = 'lib'
+  s.author = "Brian Takita"
+  s.email = "brian@pivotallabs.com"
+  s.homepage = "http://pivotallabs.com"
+  s.rubyforge_project = "pivotalrb"
+  s.add_dependency('Selenium')
+  s.add_dependency('thin', '=0.8.1')
+  s.add_dependency('erector')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+def tag_release
+  dashed_version = PKG_VERSION.gsub('.', '-')
+  svn_user = "#{ENV["SVN_USER"]}@" || ""
+  `svn cp svn+ssh://#{svn_user}rubyforge.org/var/svn/pivotalrb/js_test_core/trunk svn+ssh://#{svn_user}rubyforge.org/var/svn/pivotalrb/js_test_core/tags/REL-#{dashed_version} -m 'Version #{PKG_VERSION}'`
+end

data/vendor/js-test-core/lib/js_test_core/client.rb

@@ -0,0 +1,129 @@
+module JsTestCore
+  class Client
+    class ClientException < Exception
+    end
+
+    class InvalidStatusResponse < ClientException
+    end
+
+    class SessionNotFound < ClientException
+    end
+
+    class << self
+      def run(parameters={})
+        new(parameters).run
+      end
+
+      def run_argv(argv)
+        params = {}
+        parser = OptionParser.new do |o|
+          o.banner = "JsTestCore Runner"
+          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
+
+          o.on('-p', '--selenium_port=SELENIUM_PORT', "The port of the Selenium Server relative to where this file is executed") do |port|
+            params[:selenium_port] = port
+          end
+
+          o.on('-u', '--spec_url=SPEC_URL', "The url of the js spec server, relative to the browsers running via the Selenium Server") do |spec_url|
+            params[:spec_url] = spec_url
+          end
+
+          o.on('-t', '--timeout=TIMEOUT', "The timeout limit of the test run") do |timeout|
+            params[:timeout] = Integer(timeout)
+          end
+
+          o.on_tail
+        end
+        parser.order!(argv)
+        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
+      if parameters[:timeout]
+        Timeout.timeout(parameters[:timeout]) {do_run}
+      else
+        do_run
+      end
+    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 do_run
+      Net::HTTP.start(DEFAULT_HOST, DEFAULT_PORT) do |@http|
+        start_runner
+        wait_for_session_to_finish
+      end
+      report_result
+    end
+
+    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/vendor/js-test-core/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/vendor/js-test-core/lib/js_test_core/extensions.rb

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

data/vendor/js-test-core/lib/js_test_core/rack/commonlogger.rb

@@ -0,0 +1,5 @@
+Rack::CommonLogger.class_eval do
+  def empty?
+    @body.empty?
+  end
+end

data/vendor/js-test-core/lib/js_test_core/rack.rb

@@ -0,0 +1,2 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/rack/commonlogger"

data/vendor/js-test-core/lib/js_test_core/rails_server.rb

@@ -0,0 +1,22 @@
+module JsTestCore
+  class RailsServer < Server
+    class << self
+      def run(rails_root, server_options = {})
+        server_options[:Host] ||= DEFAULT_HOST
+        server_options[:Port] ||= DEFAULT_PORT
+        Server.instance = new(rails_root, server_options[:Host], server_options[:Port])
+        Server.instance.run server_options
+      end
+    end
+
+    def initialize(rails_root, host=DEFAULT_HOST, port=DEFAULT_PORT)
+      super(
+        "#{rails_root}/spec/javascripts",
+        "#{rails_root}/public/javascripts",
+        "#{rails_root}/public",
+        host,
+        port
+      )
+    end
+  end
+end

data/vendor/js-test-core/lib/js_test_core/representations/spec.html.rb

@@ -0,0 +1,23 @@
+module JsTestCore
+  module Representations
+    class Spec < Page
+      protected
+      def title_text
+        "Js Test Core Suite"
+      end
+
+      def head_content
+        spec_script_elements
+      end
+
+      def spec_script_elements
+        spec_files.each do |file|
+          script :type => "text/javascript", :src => file.relative_path
+        end
+      end
+      
+      def body_content
+      end
+    end
+  end
+end

data/vendor/js-test-core/lib/js_test_core/representations.rb

@@ -0,0 +1,9 @@
+dir = File.dirname(__FILE__)
+
+module JsTestCore
+  module Representations
+    include ThinRest::Representations
+  end
+end
+
+require "#{dir}/representations/spec.html"

data/vendor/js-test-core/lib/js_test_core/resources/dir.rb

@@ -0,0 +1,67 @@
+module JsTestCore
+  module Resources
+    class Dir < File
+      route ANY do |env, name|
+        if file = file(name)
+          file
+        elsif subdir = subdir(name)
+          subdir
+        else
+          Resources::ResourceNotFound.new(env.merge(:name => name))
+        end
+      end
+
+      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(env.merge(
+            :absolute_path => absolute_globbed_path,
+            :relative_path => relative_globbed_path
+          ))
+        end
+      end
+
+      protected
+      def determine_child_paths(name)
+        absolute_child_path = "#{absolute_path}/#{name}"
+        relative_child_path = "#{relative_path}/#{name}"
+        [absolute_child_path, relative_child_path]
+      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(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(env.merge(
+            :absolute_path => absolute_dir_path,
+            :relative_path => relative_dir_path
+          ))
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/vendor/js-test-core/lib/js_test_core/resources/file.rb

@@ -0,0 +1,42 @@
+module JsTestCore
+  module Resources
+    class File < Resource
+      MIME_TYPES = {
+        '.html' => 'text/html',
+        '.htm' => 'text/html',
+        '.js' => 'text/javascript',
+        '.css' => 'text/css',
+        '.png' => 'image/png',
+        '.jpg' => 'image/jpeg',
+        '.jpeg' => 'image/jpeg',
+        '.gif' => 'image/gif',
+        }
+
+      property :absolute_path, :relative_path
+
+      def get
+        extension = ::File.extname(absolute_path)
+        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
+      end
+      
+      def ==(other)
+        return false unless other.class == self.class
+        absolute_path == other.absolute_path && relative_path == other.relative_path
+      end
+    end
+  end
+end

data/vendor/js-test-core/lib/js_test_core/resources/runner.rb

@@ -0,0 +1,107 @@
+module JsTestCore
+  module Resources
+    class Runner < Resources::Resource
+      class Collection < Resources::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::Client::Driver.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

data/vendor/js-test-core/lib/js_test_core/resources/session.rb

@@ -0,0 +1,44 @@
+module JsTestCore
+  module Resources
+    class Session < Resources::Resource
+      class Collection < Resources::Resource
+        route ANY do |env, id|
+          Session.new(env.merge(:id => id))
+        end
+      end
+
+      RUNNING = 'running'
+      SUCCESSFUL_COMPLETION = 'success'
+      FAILURE_COMPLETION = 'failure'
+
+      property :id
+
+      def get
+        runner = Runner.find(id)
+        if runner
+          connection.send_head
+          if runner.running?
+            connection.send_body("status=#{RUNNING}")
+          else
+            if runner.successful?
+              connection.send_body("status=#{SUCCESSFUL_COMPLETION}")
+            else
+              connection.send_body("status=#{FAILURE_COMPLETION}&reason=#{runner.session_run_result}")
+            end
+          end
+        else
+          connection.send_head(404)
+          connection.send_body("")
+        end
+      end
+
+      route 'finish' do |env, name|
+        SessionFinish.new(env.merge(:session => self))
+      end
+
+      def associated_with_a_runner?
+        id.to_s != ""
+      end
+    end
+  end
+end

data/vendor/js-test-core/lib/js_test_core/resources/session_finish.rb

@@ -0,0 +1,17 @@
+module JsTestCore
+  module Resources
+    class SessionFinish < Resources::Resource
+      property :session
+      
+      def post
+        if session.associated_with_a_runner?
+          Runner.finalize(session.id, rack_request['text'])
+        else
+          STDOUT.puts rack_request['text']
+        end
+        connection.send_head
+        connection.send_body("")
+      end
+    end
+  end
+end

data/vendor/js-test-core/lib/js_test_core/resources/specs/spec.rb

@@ -0,0 +1,32 @@
+module JsTestCore
+  module Resources
+    module Specs
+      module Spec
+        class << self
+          def spec_representation_class
+            @spec_representation_class ||= JsTestCore::Representations::Spec
+          end
+          attr_writer :spec_representation_class
+        end
+
+        def get_generated_spec
+          connection.terminate_after_sending do
+            connection.send_head(
+              200,
+              'Content-Type' => "text/html",
+              'Last-Modified' => ::File.mtime(absolute_path).rfc822
+            )
+
+            body = render_spec
+            connection.send_data("Content-Length: #{body.length}\r\n\r\n")
+            connection.send_data(body)
+          end
+        end
+
+        def render_spec
+          Spec.spec_representation_class.new(self, :spec_files => spec_files).to_s
+        end
+      end
+    end
+  end
+end

data/vendor/js-test-core/lib/js_test_core/resources/specs/spec_dir.rb

@@ -0,0 +1,50 @@
+module JsTestCore
+  module Resources
+    module Specs
+      class SpecDir < ::JsTestCore::Resources::Dir
+        include Spec
+
+        def get
+          if ::File.file?(absolute_path)
+            super
+          else
+            get_generated_spec
+          end
+        end
+        
+        def spec_files
+          glob("/**/*_spec.js")
+        end
+
+        route ANY do |env, name|
+          if result = (file(name) || subdir(name) || spec_file(name))
+            result
+          else
+            base_path = "#{relative_path}/#{name}"
+            raise "No file or directory found at #{base_path} or spec found at #{base_path}.js."
+          end
+        end
+
+        protected
+
+        def subdir(name)
+          absolute_path, relative_path = determine_child_paths(name)
+          if ::File.directory?(absolute_path)
+            SpecDir.new(env.merge(:absolute_path => absolute_path, :relative_path => relative_path))
+          else
+            nil
+          end
+        end
+
+        def spec_file(name)
+          absolute_path, relative_path = determine_child_paths("#{name}.js")
+          if ::File.exists?(absolute_path) && !::File.directory?(absolute_path)
+            SpecFile.new(env.merge(:absolute_path => absolute_path, :relative_path => relative_path))
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end