zfben_hanoi 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in zfben_hanoi.gemspec
+gemspec
+
+gem 'rspec'
+gem 'mocha'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 - 2010 Luca Guidi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# Automated jQuery tests with QUnit
+
+## Installation
+
+    (sudo) gem install zfben_hanoi
+  
+## Crash Course
+
+    zfben_hanoi         # prepare the target directory
+    rake test:js  # run the tests
+
+## How To Use
+
+Prepare the target directory, you can use **one** of the following options:
+
+    hanoi
+    hanoi .
+    hanoi /path/to/project
+
+You need a valid [Rake](http://rake.rubyforge.org/) installation to run your tests:
+
+    rake test:js
+
+You can specify to run the test against one or more browsers:
+
+    rake test:js BROWSERS=firefox,ie,safari
+
+You can specify to run only certain tests:
+
+    rake test:js TESTS=path/to/first_test.js,path/to/second_test.js
+
+You can combine both `BROWSERS` and `TESTS` configurations.
+
+## Structure
+
+The `zfben_hanoi` executable will create the following structure:
+
+    Rakefile
+    test/
+      javascript/
+        assets/
+          jquery.js
+          testrunner.js
+          testsuite.css
+        example_test.js
+        fixtures/
+          example_fixtures.html
+        templates/
+          test_case.erb
+
+* `Rakefile` creates a fresh Rake file, **you have to edit** it according to your setup
+* `test` Hanoi creates it if missing, otherwise will choose between existing `test` or `spec` paths
+* `javascript` is the root directory of your tests
+* `assets` contains the [jQuery](http://jquery.com) and [QUnit](http://docs.jquery.com/QUnit) source file and a css.
+  Place your assets in this directory, it's mapped as root path `/`.
+* `example_test.js` is a sample of a real test case.
+* `templates` contains the template file for your tests. You shouldn't edit it, if you don't know the risk.
+* `fixtures` contains all the HTML fixtures, each file will be injected into the proper case.
+
+By convention, your `test/javascript` folder **should reflect** the structure of your source directory,
+appending the `_test.js` suffix to each test case and the `_fixtures.html` to each fixture file.
+
+Example:
+  
+    src/
+      directory_a/
+        directory_b/
+          file_3.js
+        file_2.js
+      file_1.js
+    test/
+      javascript/
+        directory_a/
+          directory_b/
+            file_3_test.js
+          file_2_test.js
+        file_1_test.js
+        fixtures/
+          directory_a/
+            directory_b/
+              file_3_fixtures.html
+          file_1_fixtures.html
+
+You have probably noticed that `file_2_fixtures.html` is missing, this because **fixtures are optional**.
+
+## Browsers & Platforms
+
+### Platforms:
+
+* Linux
+
+### Browsers:
+
+* Chrome (Mac OS X and Windows)
+* Firefox
+
+## Repository
+
+    git clone git://github.com/benz303/zfben_hanoi.git
+
+## Copyright
+
+(c) [http://zfben.com](http://zfben.com), released under the MIT license
+
+From [https://github.com/jodosha/hanoi](https://github.com/jodosha/hanoi)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+  t.rspec_opts = %w(-fs --color)
+end

data/bin/hanoi

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+path = ARGV[0] || Dir.pwd
+raise "Unknown path '#{path}'" unless File.directory?(path)
+templates_path = File.expand_path(File.dirname(__FILE__) + "/../templates")
+
+# Rakefile
+File.open(File.join(path, "Rakefile"), "a") { |f| f.write(File.readlines(File.join(templates_path, "fresh_rakefile")))}
+
+# JavaScript test directory
+name = File.directory?(File.join(path, "spec")) ? "spec" : "test"
+path = File.join(path, name, "javascript")
+FileUtils.mkdir_p path
+
+# Assets
+FileUtils.cp_r File.join(templates_path, "assets"), File.join(path)
+
+# Template
+FileUtils.mkdir_p File.join(path, "templates")
+FileUtils.cp File.join(templates_path, "test_case.erb"), File.join(path, "templates")
+
+# Samples
+FileUtils.mkdir_p File.join(path, "fixtures")
+FileUtils.cp File.join(templates_path, "example_fixtures.html"), File.join(path, "fixtures")
+FileUtils.cp File.join(templates_path, "example_test.js"), path

data/lib/hanoi/browser.rb

@@ -0,0 +1,65 @@
+class Browser
+  def supported?; true; end
+  def setup; end
+  def teardown; end
+
+  def host
+    require 'rbconfig'
+    Config::CONFIG['host']
+  end
+
+  def macos?
+    host.include?('darwin')
+  end
+
+  def windows?
+    /mswin|mingw/.match host
+  end
+
+  def linux?
+    host.include?('linux')
+  end
+
+  def installed?
+    if linux?
+      Kernel.system "which #{name}"
+    else
+      File.exist? path
+    end
+  end
+
+  def runnable?
+    supported? && installed?
+  end
+
+  def visit(url)
+    if macos?
+      system("open -g -a #{path} '#{url}'")
+    elsif windows?
+      system("#{path} #{url}")
+    elsif linux?
+      system("#{name} #{url}")
+    end
+  end
+
+  def name
+    n = self.class.name.split('::').last
+    linux? ? n.downcase : n
+  end
+
+  def escaped_name
+    name.gsub(' ', '\ ')
+  end
+
+  def path
+    if macos?
+      File.expand_path("/Applications/#{escaped_name}.app")
+    else
+      @path
+    end
+  end
+
+  def to_s
+    name
+  end  
+end

data/lib/hanoi/browsers/chrome.rb

@@ -0,0 +1,35 @@
+class Chrome < Browser
+  def initialize(path = nil)
+    @path = path || File.join(
+      ENV['UserPath'] || ENV['UserProfile'] || "C:/Documents and Settings/Administrator",
+      "AppData",
+      "Local",
+      "Google",
+      "Chrome",
+      "Application",
+      "chrome.exe"
+    )
+  end
+
+  def supported?
+    windows? || macos?
+  end
+
+  def installed?
+    if macos?
+      File.exist?("/Applications/#{name}.app")
+    else
+      super
+    end
+  end
+
+  def name
+    "Google Chrome"
+  end
+
+  def teardown
+    if macos?
+      system("killall #{escaped_name}")
+    end
+  end
+end

data/lib/hanoi/browsers/firefox.rb

@@ -0,0 +1,11 @@
+class Firefox < Browser
+  def initialize(path = File.join(ENV['ProgramFiles'] || 'c:\Program Files', '\Mozilla Firefox\firefox.exe'))
+    @path = path
+  end
+
+  def teardown
+    if macos?
+      system("killall firefox-bin")
+    end
+  end
+end

data/lib/hanoi/browsers/internet_explorer.rb

@@ -0,0 +1,26 @@
+class InternetExplorer < Browser
+  def setup
+    require 'win32ole' if windows?
+  end
+
+  def supported?
+    windows?
+  end
+
+  def runnable?
+    supported?
+  end
+
+  def visit(url)
+    if windows?
+      ie = WIN32OLE.new('InternetExplorer.Application')
+      ie.visible = true
+      ie.Navigate(url)
+      sleep 0.01 while ie.Busy || ie.ReadyState != 4
+    end
+  end
+
+  def name
+    "Internet Explorer"
+  end
+end

data/lib/hanoi/browsers/konqueror.rb

@@ -0,0 +1,29 @@
+class Konqueror < Browser
+  @@config_dir = File.join((ENV['HOME'] || ''), '.kde', 'share', 'config')
+  @@global_config = File.join(@@config_dir, 'kdeglobals')
+  @@konqueror_config = File.join(@@config_dir, 'konquerorrc')
+
+  def supported?
+    linux?
+  end
+
+  # Forces KDE's default browser to be Konqueror during the tests, and forces
+  # Konqueror to open external URL requests in new tabs instead of a new
+  # window.
+  def setup
+    cd @@config_dir, :verbose => false do
+      copy @@global_config, "#{@@global_config}.bak", :preserve => true, :verbose => false
+      copy @@konqueror_config, "#{@@konqueror_config}.bak", :preserve => true, :verbose => false
+      # Too lazy to write it in Ruby...  Is sed dependency so bad?
+      system "sed -ri /^BrowserApplication=/d  '#{@@global_config}'"
+      system "sed -ri /^KonquerorTabforExternalURL=/s:false:true: '#{@@konqueror_config}'"
+    end
+  end
+
+  def teardown
+    cd @@config_dir, :verbose => false do
+      copy "#{@@global_config}.bak", @@global_config, :preserve => true, :verbose => false
+      copy "#{@@konqueror_config}.bak", @@konqueror_config, :preserve => true, :verbose => false
+    end
+  end
+end

data/lib/hanoi/browsers/opera.rb

@@ -0,0 +1,17 @@
+class Opera < Browser
+  def initialize(path = 'c:\Program Files\Opera\Opera.exe')
+    @path = path
+  end
+  
+  def setup
+    if windows?
+      puts %{
+        MAJOR ANNOYANCE on Windows.
+        You have to shut down Opera manually after each test
+        for the script to proceed.
+        Any suggestions on fixing this is GREATLY appreciated!
+        Thank you for your understanding.
+      }
+    end
+  end
+end

data/lib/hanoi/browsers/safari.rb

@@ -0,0 +1,5 @@
+class Safari < Webkit
+  def initialize(path = File.join(ENV['ProgramFiles'] || 'c:\Program Files', '\Safari\Safari.exe'))
+    @path = path
+  end
+end

data/lib/hanoi/browsers/webkit.rb

@@ -0,0 +1,35 @@
+class Webkit < Browser
+  def initialize(path = File.join(ENV['WEBKIT_HOME'] || ENV['ProgramFiles'] || 'C:\Program Files', 'Webkit', 'webkit.exe'))
+    @path = path
+  end
+
+  def supported?
+    macos? || windows?
+  end
+
+  def setup
+    applescript(%(tell application "#{name}" to make new document)) if macos?
+  end
+
+  def visit(url)
+    if macos?
+      applescript(%(tell application "#{name}" to set URL of front document to "#{url}"))
+    elsif windows?
+      system("#{path} #{url}")
+    end
+  end
+
+  def teardown
+    #applescript('tell application "Safari" to close front document')
+
+    if macos?
+      system("killall #{escaped_name}")
+    end
+  end
+
+  private
+    def applescript(script)
+      raise "Can't run AppleScript on #{host}" unless macos?
+      system "osascript -e '#{script}' 2>&1 >/dev/null"
+    end
+end

data/lib/hanoi/javascript_test_task.rb

@@ -0,0 +1,202 @@
+class JavaScriptTestTask < ::Rake::TaskLib
+  BROWSERS = %w( chrome safari firefox ie konqueror opera webkit ).freeze
+  attr_reader :sources_directory
+
+  def initialize(name = :test)
+    @name = name
+    @tests = []
+    @browsers = []
+
+    @queue = Queue.new
+
+    @server = WEBrick::HTTPServer.new(:Port => 4711) # TODO: make port configurable
+    @server.mount_proc("/results") do |req, res|
+      @queue.push(req)
+      res.body = "OK"
+    end
+    @server.mount("/response", BasicServlet)
+    @server.mount("/slow", SlowServlet)
+    @server.mount("/down", DownServlet)
+    @server.mount("/inspect", InspectionServlet)
+    yield self if block_given?
+    define
+  end
+
+  def define
+    task @name do
+      trap("INT") { @server.shutdown; exit }
+      t = Thread.new { @server.start }
+
+      # run all combinations of browsers and tests
+      @browsers.each do |browser|
+        if browser.runnable?
+          t0 = Time.now
+          @test_suite_results = TestSuiteResults.new
+
+          browser.setup
+          puts "\nStarted tests in #{browser}."
+
+          @tests.each do |test|
+            browser.visit(get_url(test))
+            results = TestResults.new(@queue.pop.query, test[:url])
+            print results
+            @test_suite_results << results
+          end
+
+          print "\nFinished in #{Time.now - t0} seconds."
+          print @test_suite_results
+          browser.teardown
+        else
+          puts "\nSkipping #{browser}, not supported on this OS or not installed."
+        end
+      end
+
+      destroy_temp_directory
+      @server.shutdown
+      t.join
+
+      exit 1 if @test_suite_results.failure? || @test_suite_results.error?
+    end
+  end
+
+  def get_url(test)
+    params = "resultsURL=http://localhost:4711/results&t=" + ("%.6f" % Time.now.to_f)
+    params << "&tests=#{test[:testcases]}" unless test[:testcases] == :all
+    "http://localhost:4711#{test[:url]}?#{params}"
+  end
+
+  def setup(sources_directory, test_cases, browsers)
+    @sources_directory = sources_directory
+    test_cases = setup_tests(test_cases)
+    run_test_cases(test_cases)
+    setup_mount_paths
+    setup_browsers(browsers)
+  end
+
+  def mount(path, dir = nil)
+    dir = current_directory + path unless dir
+
+    # don't cache anything in our tests
+    @server.mount(path, NonCachingFileHandler, dir)
+  end
+
+  # test should be specified as a hash of the form
+  # {:url => "url", :testcases => "testFoo,testBar"}.
+  # specifying :testcases is optional
+  def run(url, testcases = :all)
+    @tests << { :url => url, :testcases => testcases }
+  end
+
+  def browser(browser)
+    browser =
+      case(browser)
+        when :chrome
+          Chrome.new
+        when :firefox
+          Firefox.new
+        when :safari
+          Safari.new
+        when :ie
+          InternetExplorer.new
+        when :konqueror
+          Konqueror.new
+        when :opera
+          Opera.new
+        when :webkit
+          Webkit.new
+        else
+          browser
+      end
+
+    @browsers << browser
+  end
+
+  protected
+    def setup_tests(test_cases)
+      create_temp_directory
+      test_cases ||= Dir["#{test_directory}/**/*_test.js"] + Dir["#{test_directory}/**/*_spec.js"]
+      test_cases.map do |test_case|
+        test_case = TestCase.new(test_case, test_directory)
+        unless test_case.exist?
+          destroy_temp_directory
+          raise "Test case not found: '#{test_case.path}'"
+        end
+        test_case.create_temp_directory
+        write_template test_case
+        test_case
+      end
+    end
+
+    def setup_mount_paths
+      mount "/",            assets_directory
+      mount "/test",        temp_directory
+      mount "/javascripts", sources_directory
+    end
+
+    def setup_browsers(browsers)
+      BROWSERS.each do |browser|
+        browser(browser.to_sym) unless browsers && !browsers.include?(browser)
+      end
+    end
+
+    def run_test_cases(test_cases)
+      test_cases.each { |test_case| run test_case.url }
+    end
+
+    def test_directory
+      @test_directory ||= begin
+        directory = File.directory?(File.expand_path(current_directory + "/test")) ? "test" : "spec"
+        directory << "/javascript"
+        unless File.directory?(directory)
+raise <<-END
+Can't find JavaScript test directory in '#{current_directory}'.
+Please make sure at least one of them exist:
+\t'#{current_directory}/test/javascript'
+\t'#{current_directory}/spec/javascript'\n
+END
+        end
+        directory
+      end
+    end
+
+    def template
+      @template ||= begin
+        path = File.expand_path(test_directory + "/templates/test_case.erb")
+        raise "Can't find the Javascript test template: '#{path}'" unless File.exist?(path)
+        ERB.new(File.new(path).read)
+      end
+    end
+
+    def write_template(test_case)
+      # instance var is needed by ERb binding.
+      @test_case = test_case
+      template_path = "#{test_case.temp_directory}/#{test_case.name}.html"
+      File.open(template_path, 'w') { |f| f.write(template.result(binding)) }
+    end
+
+    def current_directory
+      @current_directory ||= Dir.pwd
+    end
+
+    def create_temp_directory
+      FileUtils.mkdir_p temp_directory
+    end
+
+    def destroy_temp_directory
+      FileUtils.rm_rf(temp_directory) rescue nil
+    end
+
+    def temp_directory
+      @temp_directory ||= test_directory + "/tmp"
+    end
+
+    def assets_directory
+      @assets_directory ||= begin
+        path = File.expand_path(current_directory + "/test/javascript/assets")
+        return path if File.directory?(path)
+        path = File.expand_path(current_directory + "/spec/javascript/assets")
+        return path if File.directory?(path)
+        raise "Cannot find:\n\t#{File.expand_path(current_directory + "/test/javascript/assets")} or\n\t#{File.expand_path(current_directory + "/spec/javascript/assets")}"
+      end
+    end
+end