headless-squirrel 0.5.1

data/README.rdoc

@@ -0,0 +1,55 @@
+= Headless Squirrel
+
+A JavaScript test runner to run tests from the comfort of your terminal.
+
+http://github.com/Fingertips/headless-squirrel/raw/master/html/images/headless-squirrel.png
+
+== Why?
+
+Because we want to run tests in a real browser environment, in our case WebKit,
+but in the same fashion we run out other (Rails) unit tests.
+
+And we want to write the tests in a way that we can easily run them on other
+browsers as well, you know, html and js… This way we can run the tests from the
+terminal during regular development but still test on other browsers by loading
+the html/js files manually.
+
+Read more at http://superalloy.nl/2009/04/13/js-test-san.html
+
+== Install & Usage
+
+  $ sudo gem install Fingertips-headless-squirrel -s http://gems.github.com
+  $ jstest path/to/a/unit_test.html
+
+To automatically run your test see http://github.com/alloy/kicker/tree/master.
+
+== Problems?
+
+You betcha! (See the example.)
+
+But these shouldn't likely be a typical use case, I hope. So it actually works
+quite well seeing how many tests pass ;) The one that does fail has to do with
+the fact that there's no window at all. I haven't yet tried if it will simply
+work with a NSWindow. Also not sure yet why the end result says 2 failures…
+
+== Example:
+
+This is the output of the regression tests which are the Prototype unit tests:
+
+  $ ./bin/jstest test/regression/prototype/unit/*_test.html
+  ...................................................................................................................................
+  .......F...........................................................................................................................
+  ..............................................................................................
+
+    1) Failed:
+  testViewportDimensions (Unit test file | Dom | default template | 2009-04-11 15:28) [test/regression/prototype/unit/dom_test.html]:
+  Failure: NOTE: YOU MUST ALLOW JAVASCRIPT TO RESIZE YOUR WINDOW FOR THIS TEST TO PASS
+  expected: <50>, actual: <0>
+  Failure: NOTE: YOU MUST ALLOW JAVASCRIPT TO RESIZE YOUR WINDOW FOR THIS TEST TO PASS
+  expected: <50>, actual: <0>
+
+  Finished in 17.725139 seconds.
+
+  356 tests, 2246 assertions, 2 failures, 0 errors
+
+See regression_test.rdoc[http://github.com/Fingertips/headless-squirrel/blob/master/regression_test.rdoc] for more tests.

data/Rakefile

@@ -0,0 +1,27 @@
+task :default => :test
+
+desc "Run the tests"
+task :test do
+  sh "ruby -r#{Dir['test/unit/*_test.rb'].join(' -r')} -e ''"
+end
+
+# HeadlessSquirrel::Rake::Runner.new :regression do |t|
+#   t.files = Dir['test/regression/prototype/unit/*.html']
+# end
+
+desc "Run all the regression tests"
+task :ci do
+  sh "./bin/jstest #{Dir['test/regression/**/unit/*_test.html'].join(' ')}"
+end
+
+namespace :ci do
+  desc "Run the prototype regression tests"
+  task :prototype do
+    sh "./bin/jstest #{Dir['test/regression/prototype/unit/*_test.html'].join(' ')}"
+  end
+  
+  desc "Run the scriptaculous regression tests"
+  task :scriptaculous do
+    sh "./bin/jstest #{Dir['test/regression/scriptaculous/unit/*_test.html'].join(' ')}"
+  end
+end

data/bin/jstest

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'headless_squirrel'
+
+if ARGV.empty?
+  puts "Usage: #{$0} [html files]"
+else
+  HeadlessSquirrel::Runner.alloc.initWithHTMLFiles(ARGV).run
+end

data/lib/headless_squirrel.rb

@@ -0,0 +1,2 @@
+require 'headless_squirrel/test_case'
+require 'headless_squirrel/runner'

data/lib/headless_squirrel/console.rb

@@ -0,0 +1,24 @@
+# TODO: Needs converage.
+module HeadlessSquirrel
+  class Console < OSX::NSObject
+    objc_class_method 'isSelectorExcludedFromWebScript:', [:BOOL, :sel]
+    def self.isSelectorExcludedFromWebScript(selector)
+      selector != 'log:'
+    end
+    
+    objc_class_method 'webScriptNameForSelector:', [:id, :sel]
+    def self.webScriptNameForSelector(selector)
+      'log' if selector == 'log:'
+    end
+    
+    objc_method 'log:', [:void, :id]
+    def log(object)
+      puts object.description
+    end
+  end
+end
+
+# For some reason RC looks for the Console class in the OSX namespace.
+before, $VERBOSE = $VERBOSE, nil
+OSX::Console = HeadlessSquirrel::Console
+$VERBOSE = before

data/lib/headless_squirrel/runner.rb

@@ -0,0 +1,70 @@
+require 'osx/cocoa'
+
+module HeadlessSquirrel
+  class Runner < OSX::NSObject
+    attr_reader :test_cases, :queued, :did_not_pass
+    
+    def initWithHTMLFiles(html_files)
+      if init
+        @test_cases = []
+        @test_cases = html_files.map { |file| TestCase.alloc.initWithHTMLFile_delegate(file, self) }
+        @queued = @test_cases.dup
+        @did_not_pass = []
+        
+        $stdout.sync = true
+        
+        self
+      end
+    end
+    
+    def run
+      @start_time = Time.now
+      @queued.first.run
+      OSX::NSApplication.sharedApplication.run
+    end
+    
+    def tests;      sum :tests      end
+    def assertions; sum :assertions end
+    def failures;   sum :failures   end
+    def errors;     sum :errors     end
+    
+    def test_ran(test)
+      @did_not_pass << test unless test.state == :passed
+      
+      print case test.state
+      when :passed
+        '.'
+      when :failed
+        'F'
+      when :error
+        'E'
+      end
+    end
+    
+    def test_case_finished(test_case)
+      @queued.delete(test_case)
+      @queued.empty? ? finalize : @queued.first.run
+    end
+    
+    def finished?
+      @finished
+    end
+    
+    private
+    
+    def sum(attr)
+      @test_cases.inject(0) { |sum, tc| sum += tc.send(attr) }
+    end
+    
+    def finalize
+      @finished = true
+      
+      puts
+      @did_not_pass.each_with_index { |test, index| puts "\n  #{index+1}) #{test}" }
+      puts "Finished in #{Time.now - @start_time} seconds."
+      puts "\n#{tests} tests, #{assertions} assertions, #{failures} failures, #{errors} errors"
+      
+      OSX::NSApplication.sharedApplication.terminate(self)
+    end
+  end
+end

data/lib/headless_squirrel/test.rb

@@ -0,0 +1,17 @@
+module HeadlessSquirrel
+  class TestCase < OSX::NSObject
+    class Test
+      attr_reader :test_case, :name, :state, :output
+      
+      def initialize(test_case, name, state, output)
+        @test_case, @name, @state, @output = test_case, name, state, output
+      end
+      
+      def to_s
+%{#{@state.to_s.capitalize}:
+#{@name} (#{@test_case.title}) [#{@test_case.html_file}]:
+#{@output}}
+      end
+    end
+  end
+end

data/lib/headless_squirrel/test_case.rb

@@ -0,0 +1,158 @@
+require "osx/cocoa"
+OSX.require_framework 'WebKit'
+
+require 'headless_squirrel/test'
+require 'headless_squirrel/console'
+
+module HeadlessSquirrel
+  class TestCase < OSX::NSObject
+    class FileDoesNotExistError < StandardError; end
+    
+    def self.sharedWebView
+      @sharedWebView ||= OSX::WebView.alloc.init
+    end
+    
+    RESULTS_REGEXP_KEYS = [:report, :_, :tests, :assertions, :failures, :errors]
+    RESULTS_REGEXP = /((\d+) tests, )?(\d+) assertions, (\d+) failures, (\d+) errors\n?/
+    
+    STATES = %w{ passed failed error }
+    
+    attr_reader :html_file, :delegate, :title
+    attr_reader :tests, :assertions, :failures, :errors
+    
+    def initWithHTMLFile_delegate(html_file, delegate)
+      if init
+        raise FileDoesNotExistError, "The file `#{html_file}' does not exist." unless File.exist?(html_file)
+        @html_file, @delegate = html_file, delegate
+        @tests = @assertions = @failures = @errors = 0
+        @title = ''
+        self
+      end
+    end
+    
+    def run
+      webView
+    end
+    
+    def finished?
+      @finished
+    end
+    
+    def webView
+      @webView ||= load_webView
+    end
+    
+    def document
+      webView.mainFrame.DOMDocument
+    end
+    
+    def log
+      document.getElementsByClassName('logsummary').item(0) || document.getElementById('logsummary')
+    end
+    
+    def loglines
+      document.getElementsByClassName('loglines').item(0) || document.getElementById('loglines')
+    end
+    
+    # Not yet sure why the extra check for log not being nil is necessary.
+    # Might be a test only thing.
+    def webView_didFinishLoadForFrame(_, __)
+      @title = webView.mainFrameTitle.to_s
+      [log, loglines].each do |element|
+        element.addEventListener___('DOMSubtreeModified', self, true) if element
+      end
+    end
+    
+    def webView_didClearWindowObject_forFrame(_, scriptObject, __)
+      scriptObject.setValue_forKey(HeadlessSquirrel::Console.alloc.init, 'console')
+    end
+    
+    # Catches resource load errors:
+    #
+    # webView.resourceLoadDelegate = self
+    #
+    # def webView_resource_didFailLoadingWithError_fromDataSource(w,r,e,d)
+    #   message = "#{e.userInfo['NSLocalizedDescription']}: #{e.userInfo['NSErrorFailingURLStringKey']}"
+    #   @delegate.test_ran(Test.new(self, "Unable to load test case", :failed, message))
+    #   @delegate.test_case_finished(self)
+    # end
+    
+    def webView_addMessageToConsole(_, info)
+      puts format_js_log(info)
+      OSX::NSApplication.sharedApplication.terminate(self) if info['message'].to_s =~ /^[A-Z]\w+Error/
+    end
+    
+    def handleEvent(event)
+      element = event.target
+      
+      case element
+      when OSX::DOMText
+        contents = element.wholeText.to_s
+      when OSX::DOMHTMLTableCellElement, OSX::DOMHTMLDivElement
+        contents = element.innerText.to_s
+      end
+      
+      if contents
+        if result = self.class.parse_result(contents)
+          if result[:tests]
+            finalize_test_suite(result)
+          else
+            finalize_test(result)
+          end
+        end
+      end
+    end
+    
+    private
+    
+    def load_webView
+      url = OSX::NSURL.fileURLWithPath(@html_file)
+      req = OSX::NSURLRequest.requestWithURL(url)
+      webView = self.class.sharedWebView
+      webView.mainFrame.loadRequest(req)
+      webView.frameLoadDelegate = self
+      webView.setUIDelegate(self)
+      webView
+    end
+    
+    def format_js_log(info)
+      "#{info['sourceURL'][7..-1]}:#{info['lineNumber']}: #{info['message']}"
+    end
+    
+    def finalize_test(result)
+      last_line = loglines.children.item(loglines.children.length-1)
+      log_row = self.class.parse_log_row(last_line)
+      
+      @delegate.test_ran(Test.new(self, log_row[:name], log_row[:state].to_sym, result[:message]))
+    end
+    
+    def finalize_test_suite(result)
+      @finished = true
+      @tests, @assertions, @failures, @errors = result[:tests].to_i, result[:assertions].to_i, result[:failures].to_i, result[:errors].to_i
+      @delegate.test_case_finished(self)
+    end
+    
+    def self.parse_result(line)
+      if match = RESULTS_REGEXP.match(line)
+        result = Hash[*RESULTS_REGEXP_KEYS.zip(match.to_a).flatten]
+        result[:message] = line.sub(result[:report], '')
+        result
+      end
+    end
+    
+    def self.parse_log_row(row)
+      parts = []
+      0.upto(row.children.length-1) do |i|
+        parts << row.children.item(i).innerText.to_s.strip
+      end
+      
+      # Recent version of unittest.js
+      if STATES.include?(parts.first)
+        { :state => parts[0], :name => parts[1] }
+      # Older version
+      else
+        { :state => parts[1], :name => parts[0] }
+      end
+    end
+  end
+end

data/test/fixtures/a_unit_test.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>A HeadlessSquirrel Unit Test HTML File</title>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  
+  <script type="text/javascript" charset="utf-8">
+    var eventResults = {};
+    var originalElement = window.Element;
+  </script>
+  
+  <script src="../regression/prototype/unit/assets/prototype.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../regression/prototype/unit/assets/unittest.js" type="text/javascript" charset="utf-8"></script>
+  <script src="a_unit_test.js" type="text/javascript" charset="utf-8"></script>
+</head>
+<body>
+
+<div id="testlog"></div>
+
+<div id="content"></div>
+
+</body>
+</html>
+<script type="text/javascript" charset="utf-8">
+  eventResults.endOfDocument = true;
+</script>

data/test/fixtures/a_unit_test.js

@@ -0,0 +1,22 @@
+// 3 tests, 2 assertions, 1 failures, 1 errors
+
+new Test.Unit.Runner({
+  setup: function() {
+    this.content = $('content');
+    this.content.update('');
+  },
+  
+  testHelloWorldSuccess: function() {
+    this.assertEqual("", this.content.innerHTML);
+    this.content.update('Hello world!');
+    this.assertEqual("Hello world!", this.content.innerHTML);
+  },
+  
+  testHelloWorldFailure: function() {
+    this.assertEqual("Hello world!", this.content.innerHTML);
+  },
+  
+  testHelloWorldError: function() {
+    this.content.foo();
+  },
+});

data/test/fixtures/syntax_error.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>A HeadlessSquirrel Unit Test HTML File With Syntax Error</title>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  
+  <script type="text/javascript" charset="utf-8">
+    var eventResults = {};
+    var originalElement = window.Element;
+  </script>
+  
+  <script src="../regression/prototype/unit/assets/prototype.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../regression/prototype/unit/assets/unittest.js" type="text/javascript" charset="utf-8"></script>
+  <script src="syntax_error.js" type="text/javascript" charset="utf-8"></script>
+</head>
+<body>
+
+<div id="testlog"></div>
+
+<div id="content"></div>
+
+</body>
+</html>
+<script type="text/javascript" charset="utf-8">
+  eventResults.endOfDocument = true;
+</script>