kookaburra 0.23.0 → 0.23.1

data/.rvmrc

@@ -1,2 +1,4 @@
+rvm use ruby-1.9.3@kookaburra --create --install
+rvm use ruby-1.9.2@kookaburra --create --install
 rvm use ree-1.8.7@kookaburra --create --install
-bundle check
+rvm use ruby-1.8.7@kookaburra --create --install

data/Gemfile

@@ -12,7 +12,6 @@ group :development do
   gem 'yard'
   gem 'redcarpet', '~> 1.0' # used to format documentation
   gem 'jeweler'
-  gem 'rcov'
   gem 'reek'
   gem 'sinatra'
 end

data/Gemfile.lock

@@ -1,9 +1,10 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.2.2)
+    activesupport (3.2.3)
       i18n (~> 0.6)
       multi_json (~> 1.0)
+    addressable (2.2.7)
     capybara (1.1.2)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
@@ -22,10 +23,12 @@ GEM
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.6.5)
-    mime-types (1.17.2)
-    multi_json (1.1.0)
-    nokogiri (1.5.0)
+    json (1.6.6)
+    libwebsocket (0.1.3)
+      addressable
+    mime-types (1.18)
+    multi_json (1.2.0)
+    nokogiri (1.5.2)
     patron (0.4.18)
     rack (1.4.1)
     rack-protection (1.2.0)
@@ -33,7 +36,6 @@ GEM
     rack-test (0.6.1)
       rack (>= 1.0)
     rake (0.9.2.2)
-    rcov (1.0.0)
     rdoc (3.12)
       json (~> 1.4)
     redcarpet (1.17.2)
@@ -41,23 +43,24 @@ GEM
       ruby2ruby (~> 1.2)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
     ruby2ruby (1.3.1)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
     ruby_parser (2.3.1)
       sexp_processor (~> 3.0)
-    rubyzip (0.9.6.1)
-    selenium-webdriver (2.20.0)
+    rubyzip (0.9.7)
+    selenium-webdriver (2.21.0)
       childprocess (>= 0.2.5)
       ffi (~> 1.0)
+      libwebsocket (~> 0.1.3)
       multi_json (~> 1.0)
       rubyzip
     sexp_processor (3.1.0)
@@ -79,7 +82,6 @@ DEPENDENCIES
   i18n
   jeweler
   patron
-  rcov
   redcarpet (~> 1.0)
   reek
   rspec

data/README.markdown

@@ -28,27 +28,58 @@ as well as which driver to use for running the tests (currently only tested with
 Kookaburra is designed to run tests agains a remote web server (although that
 server could be running on the same machine, it doesn't need to be), and it is
 the responsibility of the test implementation to ensure that the server is
-running. Take a look at Kookaburra's own integration specs for one example of
-how to achieve this for a [Rack-based] [Rack] application. (Note that you cannot
-easily start the application server in a separate thread. Because Ruby uses
-green threads, the HTTP library used in the APIDriver will block while making
-its requests and prevent the application server thread from responding.)
+running. 
 
 The fact that Kookaburra runs against a remote server means that *it is not
 limited to testing only Ruby web applications*. As long as your application
 exposes a web-service API for use by the GivenDriver and an HTML user interface
 for use by the UIDriver, you can use Kookaburra to test it. Also, as long as
 you're careful with both your application and test designs, you're not limited
-to running your tests only in an isolated testing environment; you could run the
-same test suite you use for development against your production systems and even
-repurpose your Kookaburra-based tests for load-testing and similar applications.
+to running your tests only in an isolated testing environment; you could run
+the same test suite you use for development against your staging or production
+systems.
+
+### Testing an Application Running Locally ###
+
+The fact that Kookaburra is designed to support running tests against a remote
+server does not, of course, mean that the application cannot be running locally.
+It is possible to have your test suite manage the process of starting and
+stopping your server for you. Examples of how to do so with a Rack application
+are presented below, but you should be able to take the same basic approach with
+other types of application servers.
+
+Although Capybara is capable of starting a Rack application server on its own,
+the default setup only starts the server up on-demand when you call a method
+that requires the browser to interact with the web application. Because the
+APIDriver layer does not use Capybara, it is necessary to manage the server
+process on your own. Otherwise the server would not be guaranteed to be running
+when you call the APIDriver methods (particularly as these often appear in
+"Given" statements that are run before you start interacting with the web
+browser.)
+
+Keep in mind that, even if your server is capable of being started up in another
+thread within the same Ruby process that is executing your test suite, you will
+want to avoid doing so unless you are using a Ruby interpreter that supports
+native threads. Otherwise, when the APIDriver makes an HTTP call to your
+application's API, it will block while waiting for a response, thus preventing
+your application from being able to respond to that request and resulting in a
+timeout error in your tests.
 
 ### RSpec ###
 
-For [RSpec] [RSpec] integration tests, just add the following to
-`spec/support/kookaburra_setup.rb`:
+The following examples depict how you might configure RSpec to run tests against
+an already running application server (e.g. a remote staging site) and a Rack
+application server that is managed by the test suite.
+
+#### Testing an already running server ####
+
+If you are running your tests against an already running server, you can simply
+add the following to `spec/support/kookaburra_setup.rb`:
 
     require 'kookaburra/test_helpers'
+
+    # Change these to the files that define your custom GivenDriver and UIDriver
+    # implementations.
     require 'my_app/kookaburra/given_driver'
     require 'my_app/kookaburra/ui_driver'
 
@@ -58,21 +89,95 @@ For [RSpec] [RSpec] integration tests, just add the following to
       c.given_driver_class = MyApp::Kookaburra::GivenDriver
       c.ui_driver_class = MyApp::Kookaburra::UIDriver
       c.app_host = 'http://my_app.example.com:1234'
-      c.browser = Capybara
+      c.browser = Capybara::Session.new(:selenium)
       c.server_error_detection { |browser|
         browser.has_css?('head title', :text => 'Internal Server Error')
       }
     end
 
     RSpec.configure do |c|
+      # Makes the #k, #given and #ui methods available to your specs
+      # (See section on test implementation below)
       c.include(Kookaburra::TestHelpers, :type => :request)
     end
 
+#### Managing startup and shutdown of a Rack application server ####
+
+While developing, it can be helpful to run your integration specs against a
+locally-running server that is managed by your test suite. The setup is similar
+to that in the previous section, but it adds before and after hooks to launch
+and shut down a Rack application server. Just add the following to
+`spec/support/kookaburra_setup.rb`:
+
+    require 'kookaburra/test_helpers'
+    require 'thwait'
+
+    # Change these to the files that define your custom GivenDriver and UIDriver
+    # implementations.
+    require 'my_app/kookaburra/given_driver'
+    require 'my_app/kookaburra/ui_driver'
+
+    APP_PORT = ENV['APP_PORT'] || 3009
+
+    # c.app_host below should be set to whatever the root URL of your running
+    # application is.
+    Kookaburra.configure do |c|
+      c.given_driver_class = MyApp::Kookaburra::GivenDriver
+      c.ui_driver_class = MyApp::Kookaburra::UIDriver
+      c.app_host = 'http://localhost:%d' % APP_PORT
+      c.browser = Capybara::Session.new(:selenium)
+      c.server_error_detection { |browser|
+        browser.has_css?('head title', :text => 'Internal Server Error')
+      }
+    end
+
+    RSpec.configure do |c|
+      c.include(Kookaburra::TestHelpers, :type => :request)
+
+      # Start the application server prior to running a group of integration
+      # specs. `MyApplication` below should be replaced with the object that
+      # implements the Rack `#call` interface for your application. For a Rails
+      # app, this would be along the lines of `MyAppName::Application`.
+      c.before(:all, :type => :request) do
+        # Run the server process in a forked process, and get a handle on that
+        # process, so that it can be shut down after the tests run.
+        @rack_server_pid = fork do
+          Capybara.server_port = APP_PORT
+          Capybara::Server.new(MyApplication).boot
+
+          # This ensures that this forked process keeps running, because the
+          # actual server is started in a thread by Capybara.
+          ThreadsWait.all_waits(Thread.list)
+        end
+
+        # Give the server a chance to start up in the forked process. You may
+        # need to adjust this depending on how long your application takes to
+        # start up.
+        sleep 1
+      end
+
+      # After the tests run, kill the server process. 
+      c.after(:all, :type => :request) do
+        Process.kill(9, @rack_server_pid)
+        Process.wait
+      end
+    end
+
 ### Cucumber ###
 
-For [Cucumber] [Cucumber], add the following to `features/support/kookaburra_setup.rb`:
+The following examples depict how you might configure [Cucumber] [Cucumber] to
+run tests against an already running application server (e.g. a remote staging
+site) and a Rack application server that is managed by the test suite.
+
+#### Testing an already running server ####
+
+If you are running your tests against an already running server, you can simply
+add the following to `features/support/kookaburra_setup.rb`:
 
     require 'kookaburra/test_helpers'
+
+    # Change these to the files that define your custom GivenDriver and UIDriver
+    # implementations.
     require 'my_app/kookaburra/given_driver'
     require 'my_app/kookaburra/ui_driver'
 
@@ -82,7 +187,7 @@ For [Cucumber] [Cucumber], add the following to `features/support/kookaburra_set
       c.given_driver_class = MyApp::Kookaburra::GivenDriver
       c.ui_driver_class = MyApp::Kookaburra::UIDriver
       c.app_host = 'http://my_app.example.com:1234'
-      c.browser = Capybara
+      c.browser = Capybara::Session.new(:selenium)
       c.server_error_detection { |browser|
         browser.has_css?('head title', :text => 'Internal Server Error')
       }
@@ -90,8 +195,63 @@ For [Cucumber] [Cucumber], add the following to `features/support/kookaburra_set
 
     World(Kookaburra::TestHelpers)
 
-This will cause the #k, #given and #ui methods will be available in your
-Cucumber step definitions.
+#### Managing startup and shutdown of a Rack application server ####
+
+While developing, it can be helpful to run your acceptance tests against a
+locally-running server that is managed by your test suite. The setup is similar
+to that in the previous section, but it adds before and after hooks to launch
+and shut down a Rack application server. Just add the following to
+`features/support/kookaburra_setup.rb`:
+
+    require 'kookaburra/test_helpers'
+    require 'thwait'
+
+    # Change these to the files that define your custom GivenDriver and UIDriver
+    # implementations.
+    require 'my_app/kookaburra/given_driver'
+    require 'my_app/kookaburra/ui_driver'
+
+    APP_PORT = ENV['APP_PORT'] || 3009
+
+    # c.app_host below should be set to whatever the root URL of your running
+    # application is.
+    Kookaburra.configure do |c|
+      c.given_driver_class = MyApp::Kookaburra::GivenDriver
+      c.ui_driver_class = MyApp::Kookaburra::UIDriver
+      c.app_host = 'http://localhost:%d' % APP_PORT
+      c.browser = Capybara::Session.new(:selenium)
+      c.server_error_detection { |browser|
+        browser.has_css?('head title', :text => 'Internal Server Error')
+      }
+    end
+
+    World(Kookaburra::TestHelpers)
+
+    # Start the application server prior to running a group of integration
+    # specs. `MyApplication` below should be replaced with the object that
+    # implements the Rack `#call` interface for your application. For a Rails
+    # app, this would be along the lines of `MyAppName::Application`.
+    # Runs the server process in a forked process, and get a handle on that
+    # process, so that it can be shut down after the tests run.
+    @rack_server_pid = fork do
+      Capybara.server_port = APP_PORT
+      Capybara::Server.new(MyApplication).boot
+
+      # This ensures that this forked process keeps running, because the
+      # actual server is started in a thread by Capybara.
+      ThreadsWait.all_waits(Thread.list)
+    end
+
+    # Give the server a chance to start up in the forked process. You may
+    # need to adjust this depending on how long your application takes to
+    # start up.
+    sleep 1
+
+    # After the tests run, kill the server process. 
+    at_exit do
+      Process.kill(9, @rack_server_pid)
+      Process.wait
+    end
 
 ## Defining Your Testing DSL ##
 

data/Rakefile

@@ -32,12 +32,6 @@ task :default => :spec
 desc 'Run specs'
 RSpec::Core::RakeTask.new
 
-desc "Generate code coverage"
-RSpec::Core::RakeTask.new(:coverage) do |t|
-  t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec']
-end
-
 require 'reek/rake/task'
 Reek::Rake::Task.new do |t|
   t.fail_on_error = true
@@ -47,3 +41,13 @@ end
 
 require 'yard'
 YARD::Rake::YardocTask.new
+
+desc "Run rake on all supported rubies"
+task :all_rubies do
+  rubies = %w[ruby-1.9.3 ruby-1.9.2 ree-1.8.7 ruby-1.8.7]
+  rubies.each do |ruby_version|
+    puts "Testing with #{ruby_version}"
+    system "rvm #{ruby_version}@kookaburra do rake" \
+      or raise "Failed to run rake with #{ruby_version}!"
+  end
+end

data/VERSION

@@ -1 +1 @@
-0.23.0
+0.23.1

data/kookaburra.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "kookaburra"
-  s.version = "0.23.0"
+  s.version = "0.23.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Wilger", "Sam Livingston-Gray", "Ravi Gadad"]
-  s.date = "2012-04-02"
+  s.date = "2012-04-13"
   s.description = "Cucumber + Capybara = Kookaburra? It made sense at the time."
   s.email = "johnwilger@gmail.com"
   s.extra_rdoc_files = [
@@ -59,7 +59,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/projectdx/kookaburra"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.17"
+  s.rubygems_version = "1.8.21"
   s.summary = "WindowDriver testing pattern for Ruby apps"
 
   if s.respond_to? :specification_version then
@@ -74,7 +74,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<redcarpet>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<reek>, [">= 0"])
       s.add_development_dependency(%q<sinatra>, [">= 0"])
     else
@@ -86,7 +85,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<redcarpet>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<reek>, [">= 0"])
       s.add_dependency(%q<sinatra>, [">= 0"])
     end
@@ -99,7 +97,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<redcarpet>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<reek>, [">= 0"])
     s.add_dependency(%q<sinatra>, [">= 0"])
   end

data/spec/integration/test_a_rack_application_spec.rb

@@ -1,12 +1,16 @@
 require 'kookaburra/test_helpers'
 require 'kookaburra/json_api_driver'
 require 'capybara'
+require 'thwait'
 
 # These are required for the Rack app used for testing
 require 'sinatra/base'
 require 'active_support/json'
 require 'active_support/hash_with_indifferent_access'
 
+# The server port that the application server will attach to
+APP_PORT = ENV['APP_PORT'] || 3009
+
 describe "testing a Rack application with Kookaburra" do
   describe "with an HTML interface" do
     describe "with a JSON API" do
@@ -299,15 +303,10 @@ describe "testing a Rack application with Kookaburra" do
       end
 
       before(:all) do
-        @rack_server_port = 3339
         @rack_server_pid = fork do
-          Rack::Server.start(
-            :app => JsonApiApp.new,
-            :server => :webrick,
-            :Host => '127.0.0.1',
-            :Port => @rack_server_port,
-            :environment => 'production'
-          )
+          Capybara.server_port = APP_PORT
+          Capybara::Server.new(JsonApiApp.new).boot
+          ThreadsWait.all_waits(Thread.list)
         end
         sleep 1 # Give the server a chance to start up.
       end
@@ -321,7 +320,7 @@ describe "testing a Rack application with Kookaburra" do
         Kookaburra.configure do |c|
           c.ui_driver_class = MyUIDriver
           c.given_driver_class = MyGivenDriver
-          c.app_host = 'http://127.0.0.1:%d' % @rack_server_port
+          c.app_host = 'http://127.0.0.1:%d' % APP_PORT
           c.browser = Capybara::Session.new(:selenium)
           c.server_error_detection do |browser|
             browser.has_css?('head title', :text => 'Internal Server Error')

data/spec/kookaburra/mental_model_matcher_spec.rb

@@ -26,7 +26,10 @@ module MentalModelMatcherMacros
     end
 
     def from_line
-      '(line %d)' % caller(2).first.split(':').last
+      #puts '#' * 80
+      #puts "it is: '#{caller(2).first.split(':').inspect}'"
+      #puts '#' * 81
+      '(line %d)' % caller(2).first.split(':')[1]
     end
 
     def it_complains_about_missing(missing, options)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kookaburra
 version: !ruby/object:Gem::Version 
-  hash: 67
+  hash: 65
   prerelease: 
   segments: 
   - 0
   - 23
-  - 0
-  version: 0.23.0
+  - 1
+  version: 0.23.1
 platform: ruby
 authors: 
 - John Wilger
@@ -17,10 +17,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-02 00:00:00 Z
+date: 2012-04-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -33,8 +32,8 @@ dependencies:
         version: "0"
   version_requirements: *id001
   name: i18n
-- !ruby/object:Gem::Dependency 
   prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -48,8 +47,8 @@ dependencies:
         version: "3.0"
   version_requirements: *id002
   name: activesupport
-- !ruby/object:Gem::Dependency 
   prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :runtime
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -62,8 +61,8 @@ dependencies:
         version: "0"
   version_requirements: *id003
   name: patron
-- !ruby/object:Gem::Dependency 
   prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :development
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -76,8 +75,8 @@ dependencies:
         version: "0"
   version_requirements: *id004
   name: rspec
-- !ruby/object:Gem::Dependency 
   prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :development
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -90,8 +89,8 @@ dependencies:
         version: "0"
   version_requirements: *id005
   name: capybara
-- !ruby/object:Gem::Dependency 
   prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :development
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -104,8 +103,8 @@ dependencies:
         version: "0"
   version_requirements: *id006
   name: yard
-- !ruby/object:Gem::Dependency 
   prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :development
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
@@ -119,8 +118,8 @@ dependencies:
         version: "1.0"
   version_requirements: *id007
   name: redcarpet
-- !ruby/object:Gem::Dependency 
   prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :development
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
@@ -133,8 +132,8 @@ dependencies:
         version: "0"
   version_requirements: *id008
   name: jeweler
-- !ruby/object:Gem::Dependency 
   prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :development
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
@@ -146,9 +145,9 @@ dependencies:
         - 0
         version: "0"
   version_requirements: *id009
-  name: rcov
-- !ruby/object:Gem::Dependency 
+  name: reek
   prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :development
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
@@ -160,21 +159,8 @@ dependencies:
         - 0
         version: "0"
   version_requirements: *id010
-  name: reek
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  requirement: &id011 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id011
   name: sinatra
+  prerelease: false
 description: Cucumber + Capybara = Kookaburra? It made sense at the time.
 email: johnwilger@gmail.com
 executables: []
@@ -252,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: WindowDriver testing pattern for Ruby apps