js_spec 0.2.0 → 0.2.1

data/CHANGES

@@ -1,3 +1,10 @@
+0.2.1
+- Using thin 0.8.1
+- Fixed server crashing on exception issue.
+- Add div id=js_spec_content into the body of the runner html.
+- Fixed timeout issues by immediately sending the head of the response.
+- Better error message when selenium server is not running
+
 0.2.0
 - Using Thin as the server
 - Using Selenium to run the browsers

data/README

@@ -11,13 +11,22 @@ To install the gem, run:
 
 To install the plugin, run:
   script/plugin install svn://rubyforge.org/var/svn/pivotalrb/js_spec/trunk
+  script/generate js_spec
 
 The Rails plugin gives you generators when using JsSpec in a Rails environment.
 
 == Using JsSpec
-js_spec_server /path/to/your/javascript/spec/files /path/to/your/javascript/implementation/files
+First you need to start your JsSpec server.
 
-Open your browser to http://localhost:8080/specs or run selenium and then run js_spec
+If you are using js_spec_server as a Rails plugin, you can simply run:
+  script/js_spec_server
+
+If you are using the js_spec gem, you can run:
+  js_spec_server /path/to/your/javascript/spec/files /path/to/your/javascript/implementation/files
+
+Once the server is started, there are two possibly ways to run your js spec:
+  * Open your browser to http://localhost:8080/specs
+  * Start the Selenium server by running `selenium` from the command line, then running `js_spec` from the command line
 
 == JsSpec on CI
 JS spec uses the Selenium gem to automatically control browsers on different machines.

data/Rakefile

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

data/core/JSSpecExtensions.js

@@ -33,7 +33,9 @@ Spec.register = function(spec_constructor) {
   }
 }
 
-Spec.reset = function() {}
+Spec.reset = function() {
+  document.getElementById('js_spec_content').innerHTML = "";
+}
 
 var Assets = {
   require: function(path_from_javascripts, onload) {

data/lib/js_spec/guid.rb

@@ -0,0 +1,153 @@
+#
+# Guid - Ruby library for portable GUID/UUID generation.
+#
+# Copyright (c) 2004 David Garamond <davegaramond at icqmail com>
+#
+# This library is free software; you can redistribute it and/or modify it
+# under the same terms as Ruby itself.
+#
+
+if RUBY_PLATFORM =~ /[^r]win/i &&
+  module Guid_Win32_
+    require 'Win32API'
+
+    PROV_RSA_FULL       = 1
+    CRYPT_VERIFYCONTEXT = 0xF0000000
+    FORMAT_MESSAGE_IGNORE_INSERTS  = 0x00000200
+    FORMAT_MESSAGE_FROM_SYSTEM     = 0x00001000
+
+    CryptAcquireContext = Win32API.new("advapi32", "CryptAcquireContext",
+                                       'PPPII', 'L')
+    CryptGenRandom = Win32API.new("advapi32", "CryptGenRandom",
+                                  'LIP', 'L')
+    CryptReleaseContext = Win32API.new("advapi32", "CryptReleaseContext",
+                                       'LI', 'L')
+    GetLastError = Win32API.new("kernel32", "GetLastError", '', 'L')
+    FormatMessageA = Win32API.new("kernel32", "FormatMessageA",
+                                  'LPLLPLPPPPPPPP', 'L')
+
+    def lastErrorMessage
+      code = GetLastError.call
+      msg = "\0" * 1024
+      len = FormatMessageA.call(FORMAT_MESSAGE_IGNORE_INSERTS +
+                                FORMAT_MESSAGE_FROM_SYSTEM, 0,
+                                code, 0, msg, 1024, nil, nil,
+                                nil, nil, nil, nil, nil, nil)
+      msg[0, len].tr("\r", '').chomp
+    end
+
+    def initialize
+      hProvStr = " " * 4
+      if CryptAcquireContext.call(hProvStr, nil, nil, PROV_RSA_FULL,
+                                  CRYPT_VERIFYCONTEXT) == 0
+        raise SystemCallError, "CryptAcquireContext failed: #{lastErrorMessage}"
+      end
+      hProv, = hProvStr.unpack('L')
+      @bytes = " " * 16
+      if CryptGenRandom.call(hProv, 16, @bytes) == 0
+        raise SystemCallError, "CryptGenRandom failed: #{lastErrorMessage}"
+      end
+      if CryptReleaseContext.call(hProv, 0) == 0
+        raise SystemCallError, "CryptReleaseContext failed: #{lastErrorMessage}"
+      end
+    end
+  end
+end
+
+module Guid_Unix_
+  @@random_device = nil
+
+  def initialize
+    if !@@random_device
+      if File.exists? "/dev/urandom"
+        @@random_device = File.open "/dev/urandom", "r"
+      elsif File.exists? "/dev/random"
+        @@random_device = File.open "/dev/random", "r"
+      else
+        raise RuntimeError, "Can't find random device"
+      end
+    end
+
+    @bytes = @@random_device.read(16)
+  end
+end
+
+class Guid
+  if RUBY_PLATFORM =~ /[^r]win/
+    include Guid_Win32_
+  else
+    include Guid_Unix_
+  end
+
+  def hexdigest
+    @bytes.unpack("h*")[0]
+  end
+
+  def to_s
+    @bytes.unpack("h8 h4 h4 h4 h12").join "-"
+  end
+
+  def inspect
+    to_s
+  end
+
+  def raw
+    @bytes
+  end
+
+  def self.from_s(s)
+    raise ArgumentError, "Invalid GUID hexstring" unless
+      s =~ /\A[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}\z/i
+    guid = Guid.allocate
+    guid.instance_eval { @bytes = [s.gsub(/[^0-9a-f]+/i, '')].pack "h*" }
+    guid
+  end
+
+  def self.from_raw(bytes)
+    raise ArgumentError, "Invalid GUID raw bytes, length must be 16 bytes" unless
+      bytes.length == 16
+    guid = Guid.allocate
+    guid.instance_eval { @bytes = bytes }
+    guid
+  end
+
+  def ==(other)
+    @bytes == other.raw
+  end
+end
+
+if __FILE__ == $0
+  require 'test/unit'
+
+  class GuidTest < Test::Unit::TestCase
+    def test_new
+      g = Guid.new
+
+      # different representations of guid: hexdigest, hex+dashes, raw bytes
+      assert_equal(0, g.to_s =~ /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/)
+      assert_equal(16, g.raw.length)
+      assert_equal(0, g.hexdigest =~ /\A[0-9a-f]{32}\z/)
+      assert_equal(g.hexdigest, g.to_s.gsub(/-/, ''))
+
+      # must be different each time we produce (this is just a simple test)
+      g2 = Guid.new
+      assert_equal(true, g != g2)
+      assert_equal(true, g.to_s != g2.to_s)
+      assert_equal(true, g.raw != g2.raw)
+      assert_equal(true, g.hexdigest != g2.hexdigest)
+      assert_equal(1000, (1..1000).select { |i| g != Guid.new }.length)
+    end
+
+    def test_from_s
+      g = Guid.new
+      g2 = Guid.from_s(g.to_s)
+      assert_equal(g, g2)
+    end
+
+    def test_from_raw
+      g = Guid.new
+      g2 = Guid.from_raw(g.raw)
+      assert_equal(g, g2)
+    end
+  end
+end

data/lib/js_spec/rack/commonlogger.rb

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

data/lib/js_spec/rack.rb

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

data/lib/js_spec/resources/runners/firefox_runner.rb

@@ -25,7 +25,7 @@ module JsSpec
           profile_base = "#{::Dir.tmpdir}/js_spec/firefox"
           mkdir_p profile_base
           @profile_dir = "#{profile_base}/#{Time.now.to_i}"
-          @guid = UUID.new
+          @guid = Guid.new.to_s
           @request = request
           @response = response
           @connection = Server.connection
@@ -35,25 +35,29 @@ module JsSpec
           FirefoxRunner.register_instance self
           spec_url = (request && request['spec_url']) ? request['spec_url'] : spec_suite_url
           parsed_spec_url = URI.parse(spec_url)
+          selenium_port = (request['selenium_port'] || 4444).to_i
           @driver = Selenium::SeleniumDriver.new(
             request['selenium_host'] || 'localhost',
-            (request['selenium_port'] || 4444).to_i,
+            selenium_port,
             '*firefox',
             "#{parsed_spec_url.scheme}://#{parsed_spec_url.host}:#{parsed_spec_url.port}"
           )
-          driver.start
+          begin
+            driver.start
+          rescue Errno::ECONNREFUSED => e
+            raise Errno::ECONNREFUSED, "Cannot connect to Selenium Server on port #{selenium_port}. To start the selenium server, run `selenium`."
+          end
           Thread.start do
             url = "#{spec_url}?guid=#{guid}"
             driver.open(url)
           end
-          response.status = nil
+          response.status = 200
         end
 
         def finalize(text)
           driver.stop
-          response.status = 200
           response.body = text
-          connection.send_response(*response.finish)
+          connection.send_body(response)
         end
 
         protected

data/lib/js_spec/resources/spec_runner.rb

@@ -24,7 +24,9 @@ module JsSpec
           JSSpec.guid = '#{guid}';
         </script>
         </head>
-        <body></body>
+        <body>
+        <div id="js_spec_content"></div>
+        </body>
         </html>
         HTML
         response.body = html.gsub(/^        /, "")

data/lib/js_spec/resources.rb

@@ -0,0 +1,11 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/resources/runners"
+require "#{dir}/resources/runners/firefox_runner"
+require "#{dir}/resources/spec_runner"
+require "#{dir}/resources/spec_file_runner"
+require "#{dir}/resources/spec_dir_runner"
+require "#{dir}/resources/file"
+require "#{dir}/resources/dir"
+require "#{dir}/resources/web_root"
+require "#{dir}/resources/suite"
+require "#{dir}/resources/suite_finish"

data/lib/js_spec/server.rb

@@ -33,11 +33,10 @@ module JsSpec
     end
 
     def run(options)
-      ::Thin::Server.start(
-        ::Thin::Backends::JsSpecServer.new(options[:Host], options[:Port]),
-        options[:Port],
-        self
-      )
+      server = ::Thin::Server.new(options[:Host], options[:Port], self)
+      server.backend = ::Thin::Backends::JsSpecServer.new(options[:Host], options[:Port])
+      server.backend.server = server
+      server.start!
     end
 
     def call(env)

data/lib/js_spec/thin/js_spec_connection.rb

@@ -6,25 +6,23 @@ module Thin
 
       env = @request.env
       env['js_spec.connection'] = self
-      status, headers, body = @app.call(env)
-      unless status.to_i == 0
-        send_response(status, headers, body)
+      @response.status, @response.headers, @response.body = @app.call(env)
+      send_data @response.head
+      unless @response.body.empty?
+        send_body @response.body
       end
-    rescue
-      handle_error
+    rescue Exception => e
+      handle_error e
     end
 
-    def send_response(status, headers, body)
-      @response.status, @response.headers, @response.body = status, headers, body
-      @response.persistent! if @request.persistent?
-      @response.each do |chunk|
-        trace { chunk }
+    def send_body(rack_response)
+      rack_response.each do |chunk|
         send_data chunk
       end
       # If no more request on that same connection, we close it.
       close_connection_after_writing unless persistent?
-    rescue
-      handle_error
+    rescue Exception => e
+      handle_error e
     ensure
       @request.close  rescue nil
       @response.close rescue nil
@@ -34,8 +32,9 @@ module Thin
       post_init if persistent?
     end
 
-    def handle_error
-      log "!! Unexpected error while processing request: #{$!.message}"
+    def handle_error(error)
+      log "!! Unexpected error while processing request: #{error.message}"
+      log error.backtrace
       log_error
       close_connection rescue nil
     end

data/lib/js_spec/thin.rb

@@ -0,0 +1,3 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/thin/js_spec_connection"
+require "#{dir}/thin/backends/js_spec_server"

data/lib/js_spec.rb

@@ -1,34 +1,27 @@
 require "rubygems"
+gem "eventmachine", "0.10.0"
+gem "thin", "0.8.0"
+
 require "thin"
 require "fileutils"
 require "tmpdir"
 require "timeout"
-require "uuid"
 require "cgi"
 require "net/http"
 require "selenium"
 require "optparse"
 
 dir = File.dirname(__FILE__)
-require "#{dir}/js_spec/thin/js_spec_connection"
-require "#{dir}/js_spec/thin/backends/js_spec_server"
-require "#{dir}/js_spec/rack/response"
-require "#{dir}/js_spec/resources/runners"
-require "#{dir}/js_spec/resources/runners/firefox_runner"
+require "#{dir}/js_spec/guid"
+require "#{dir}/js_spec/thin"
+require "#{dir}/js_spec/rack"
+require "#{dir}/js_spec/resources"
 
 require "#{dir}/js_spec/client"
 require "#{dir}/js_spec/server"
 require "#{dir}/js_spec/rails_server"
-require "#{dir}/js_spec/resources/spec_runner"
-require "#{dir}/js_spec/resources/spec_file_runner"
-require "#{dir}/js_spec/resources/spec_dir_runner"
-require "#{dir}/js_spec/resources/file"
-require "#{dir}/js_spec/resources/dir"
-require "#{dir}/js_spec/resources/web_root"
-require "#{dir}/js_spec/resources/suite"
-require "#{dir}/js_spec/resources/suite_finish"
 
 module JsSpec
-  DEFAULT_HOST = "127.0.0.1"
+  DEFAULT_HOST = "0.0.0.0"
   DEFAULT_PORT = 8080  
 end

data/spec/unit/js_spec/resources/runners/firefox_runner_spec.rb

@@ -8,7 +8,7 @@ module JsSpec
       before do
         Thread.current[:connection] = connection
         @driver = "Selenium Driver"
-        stub(Selenium::SeleniumDriver).new('localhost', 4444, '*firefox', 'http://127.0.0.1:8080') do
+        stub(Selenium::SeleniumDriver).new('localhost', 4444, '*firefox', 'http://0.0.0.0:8080') do
           driver
         end
       end
@@ -29,7 +29,7 @@ module JsSpec
           dont_allow(EventMachine).close_connection
           runner.post(request, response)
 
-          response.should_not be_ready
+          response.body.should be_empty
         end
         
         describe "when a selenium_host parameter is passed into the request" do
@@ -40,7 +40,7 @@ module JsSpec
           end
 
           it "starts the Selenium Driver with the passed in selenium_host" do
-            mock(Selenium::SeleniumDriver).new('another-machine', 4444, '*firefox', 'http://127.0.0.1:8080') do
+            mock(Selenium::SeleniumDriver).new('another-machine', 4444, '*firefox', 'http://0.0.0.0:8080') do
               driver
             end
             runner.post(request, response)
@@ -55,7 +55,7 @@ module JsSpec
           end
 
           it "starts the Selenium Driver from localhost" do
-            mock(Selenium::SeleniumDriver).new('localhost', 4444, '*firefox', 'http://127.0.0.1:8080') do
+            mock(Selenium::SeleniumDriver).new('localhost', 4444, '*firefox', 'http://0.0.0.0:8080') do
               driver
             end
             runner.post(request, response)
@@ -70,7 +70,7 @@ module JsSpec
           end
 
           it "starts the Selenium Driver with the passed in selenium_port" do
-            mock(Selenium::SeleniumDriver).new('localhost', 4000, '*firefox', 'http://127.0.0.1:8080') do
+            mock(Selenium::SeleniumDriver).new('localhost', 4000, '*firefox', 'http://0.0.0.0:8080') do
               driver
             end
             runner.post(request, response)
@@ -85,7 +85,7 @@ module JsSpec
           end
 
           it "starts the Selenium Driver from localhost" do
-            mock(Selenium::SeleniumDriver).new('localhost', 4444, '*firefox', 'http://127.0.0.1:8080') do
+            mock(Selenium::SeleniumDriver).new('localhost', 4444, '*firefox', 'http://0.0.0.0:8080') do
               driver
             end
             runner.post(request, response)
@@ -111,14 +111,14 @@ module JsSpec
         describe "when a spec_url is not passed into the request" do
           before do
             request['spec_url'].should be_nil
-            mock(Selenium::SeleniumDriver).new('localhost', 4444, '*firefox', 'http://127.0.0.1:8080') do
+            mock(Selenium::SeleniumDriver).new('localhost', 4444, '*firefox', 'http://0.0.0.0:8080') do
               driver
             end
           end
 
           it "uses Selenium to run the entire spec suite in Firefox" do
             mock(driver).start
-            mock(driver).open("http://127.0.0.1:8080/specs?guid=#{runner.guid}")
+            mock(driver).open("http://0.0.0.0:8080/specs?guid=#{runner.guid}")
 
             runner.post(request, response)
           end

data/spec/unit/js_spec/resources/spec_dir_runner_spec.rb

@@ -40,7 +40,7 @@ module JsSpec
           doc.at("link[@href='/core/JSSpec.css']").should exist
           doc.at("script[@src='/core/JSSpec.js']").should exist
           doc.at("script[@src='/core/JSSpecExtensions.js']").should exist
-          doc.at("body").inner_html.should be_empty
+          doc.at("body/#js_spec_content").should_not be_nil
         end
       end
     end

data/spec/unit/thin/js_spec_connection_spec.rb

@@ -14,35 +14,49 @@ module Thin
         end
       end
 
-      describe "when the response code is not 0" do
-        attr_reader :somedir_resource
-        before do
-          mock(app = Object.new).call(is_a(Hash)) do
-            [200, {}, 'The Body']
+      describe "and the call is successful" do
+        describe "and the body is not empty" do
+          attr_reader :somedir_resource
+          before do
+            mock(app = Object.new).call(is_a(Hash)) do
+              [200, {}, 'The Body']
+            end
+            connection.app = app
+          end
+
+          it "sends the response to the socket and closes the connection" do
+            mock(connection).close_connection_after_writing
+            connection.receive_data "GET /specs HTTP/1.1\r\nHost: _\r\n\r\n"
+            result.should include("The Body")
           end
-          connection.app = app
         end
 
-        it "sends the response to the socket and closes the connection" do
-          mock(connection).close_connection_after_writing
-          connection.receive_data "GET /specs HTTP/1.1\r\nHost: _\r\n\r\n"
-          result.should include("The Body")
+        describe "and the body is empty" do
+          attr_reader :somedir_resource
+          before do
+            mock(app = Object.new).call(is_a(Hash)) do
+              [200, {}, []]
+            end
+            connection.app = app
+          end
+
+          it "keeps the connection open" do
+            dont_allow(connection).close_connection_after_writing
+            connection.receive_data "GET /specs HTTP/1.1\r\nHost: _\r\n\r\n"
+          end
         end
       end
 
-      describe "when the response code is 0" do
-        attr_reader :somedir_resource
-        before do
+      describe "and the call raises an error" do
+        it "logs the error and closes the connection" do
           mock(app = Object.new).call(is_a(Hash)) do
-            [0, {}, 'The Body']
+            raise "An Error"
           end
           connection.app = app
-        end
+          mock(connection).log(anything).at_least(1)
+          mock(connection).close_connection
 
-        it "does not send data to the socket and keeps it open" do
-          dont_allow(connection).close_connection_after_writing
           connection.receive_data "GET /specs HTTP/1.1\r\nHost: _\r\n\r\n"
-          result.should_not include("The Body")
         end
       end
     end

data/spec/unit/unit_spec_helper.rb

@@ -53,7 +53,7 @@ module Spec::Example::ExampleMethods
     stub(EventMachine).send_data do
       raise "Calls to EventMachine.send_data must be mocked or stubbed"
     end
-    @connection = Thin::JsSpecConnection.new(UUID.new)
+    @connection = Thin::JsSpecConnection.new(Guid.new)
     stub(EventMachine).send_data {raise "EventMachine.send_data must be handled"}
     stub(EventMachine).close_connection {raise "EventMachine.close_connection must be handled"}
     @server = JsSpec::Server.instance

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: js_spec
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Brian Takita & Nathan Sobo
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-05 00:00:00 -07:00
+date: 2008-04-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,13 +54,13 @@ files:
 - CHANGES
 - README
 - init.rb
+- lib/js_spec/rack.rb
 - lib/js_spec/thin/backends/js_spec_server.rb
 - lib/js_spec/thin/js_spec_connection.rb
-- lib/js_spec/rack/response.rb
+- lib/js_spec/rack/commonlogger.rb
 - lib/js_spec/resources/spec_file_runner.rb
 - lib/js_spec/resources/spec_runner.rb
 - lib/js_spec/resources/dir.rb
-- lib/js_spec/resources/runners/firefox1_runner.rb
 - lib/js_spec/resources/runners/firefox_runner.rb
 - lib/js_spec/resources/suite_finish.rb
 - lib/js_spec/resources/spec_dir_runner.rb
@@ -69,6 +69,9 @@ files:
 - lib/js_spec/resources/suite.rb
 - lib/js_spec/resources/runners.rb
 - lib/js_spec/rails_server.rb
+- lib/js_spec/resources.rb
+- lib/js_spec/thin.rb
+- lib/js_spec/guid.rb
 - lib/js_spec/server.rb
 - lib/js_spec/client.rb
 - lib/js_spec.rb
@@ -89,7 +92,6 @@ files:
 - spec/integration/integration_spec.rb
 - spec/integration_suite.rb
 - spec/unit/thin/js_spec_connection_spec.rb
-- spec/unit/rack/response_spec.rb
 - spec/unit/js_spec/resources/spec_file_runner_spec.rb
 - spec/unit/js_spec/resources/file_spec.rb
 - spec/unit/js_spec/resources/spec_dir_runner_spec.rb

data/lib/js_spec/rack/response.rb

@@ -1,5 +0,0 @@
-Rack::Response.class_eval do
-  def ready?
-    status ? true : false
-  end
-end

data/lib/js_spec/resources/runners/firefox1_runner.rb

@@ -1,8 +0,0 @@
-module JsSpec
-  module Resources
-    class Runners
-      class Firefox1Runner < FirefoxRunner
-      end
-    end
-  end
-end

data/spec/unit/rack/response_spec.rb

@@ -1,30 +0,0 @@
-require File.expand_path("#{File.dirname(__FILE__)}/../unit_spec_helper")
-
-module Rack
-  describe Response do
-    describe "#ready?" do
-      attr_reader :response
-      describe "when there is a status" do
-        before do
-          @response = Response.new
-          @response.status.should_not be_nil
-        end
-
-        it "returns true" do
-          response.should be_ready
-        end
-      end
-
-      describe "when there is no status" do
-        before do
-          @response = Response.new
-          response.status = nil
-        end
-
-        it "returns true" do
-          response.should_not be_ready
-        end
-      end
-    end
-  end
-end