bbq 0.0.4 → 0.1.0

data/lib/bbq/test.rb

@@ -1,33 +1,2 @@
-require 'bbq'
-require 'active_support'
-require 'test/unit'
-require 'bbq/test_user'
-require 'test/unit/assertions'
-
-module Bbq
-  class TestCase < ActiveSupport::TestCase
-    class << self
-      alias :scenario :test
-      alias :background :setup
-    end
-
-    alias :background :setup
-  end
-
-  # test/unit specific methods for test_user
-  class TestUser
-    include Test::Unit::Assertions
-
-    def see!(*args)
-      args.each do |arg|
-        assert has_content?(arg), "Expecting to see \"#{arg}\", text not found."
-      end
-    end
-
-    def not_see!(*args)
-      args.each do |arg|
-        assert has_no_content?(arg), "Found \"#{arg}\", which was unexpected."
-      end
-    end
-  end
-end
+warn "[DEPRECATION] require 'bbq/test' is deprecated. Please replace it with 'bbq/test_unit'"
+require "bbq/test_unit"

data/lib/bbq/test_client.rb

@@ -0,0 +1,94 @@
+require 'bbq/roles'
+
+module Bbq
+  class TestClient
+    class UnsupportedMethodError < StandardError; end
+
+    include Bbq::Roles
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    HTTP_METHODS = %w(get post put delete head options patch)
+
+    HTTP_METHODS.each do |method|
+      class_eval <<-RUBY
+        def #{method}(path, params = {}, headers = {})
+          response = driver.send(:#{method}, path, params, default_headers.merge(headers))
+          parsed_response = parse_response(response)
+          yield parsed_response if block_given?
+          parsed_response
+        rescue NoMethodError
+          raise UnsupportedMethodError, "Your driver does not support #{method.upcase} method"
+        end
+      RUBY
+    end
+
+    protected
+
+    def app
+      @options[:app] || Bbq.app
+    end
+
+    def default_headers
+      @options[:headers] || {}
+    end
+
+    def driver
+      @driver ||= RackTest.new(app)
+    end
+
+    def parse_response(response)
+      case response.headers["Content-Type"]
+      when /^application\/(.*\+)?json/
+        response.extend(JsonBody)
+      when /^application\/(.*\+)?x-yaml/
+        response.extend(YamlBody)
+      else
+        response
+      end
+    end
+
+    class RackTest
+      attr_accessor :app
+
+      def initialize(app)
+        self.app = app
+      end
+
+      module ConvertHeaders
+        HTTP_METHODS.each do |method|
+          class_eval <<-RUBY
+            def #{method}(path, params = {}, headers = {})
+              super(path, params, to_env_headers(headers))
+            end
+          RUBY
+        end
+
+        def to_env_headers(http_headers)
+          http_headers.map do |k, v|
+            k = k.upcase.gsub("-", "_")
+            k = "HTTP_#{k}" unless ["CONTENT_TYPE", "CONTENT_LENGTH"].include?(k)
+            { k => v }
+          end.inject(:merge)
+        end
+      end
+
+      include Rack::Test::Methods
+      include ConvertHeaders
+    end
+
+    module JsonBody
+      def body
+        @parsed_body ||= super.empty?? super : JSON.parse(super)
+      end
+    end
+
+    module YamlBody
+      def body
+        @parsed_body ||= YAML.load(super)
+      end
+    end
+  end
+end

data/lib/bbq/test_unit.rb

@@ -0,0 +1,37 @@
+require 'bbq'
+require 'bbq/session'
+require 'active_support/test_case'
+require 'test/unit'
+require 'test/unit/assertions'
+
+module Bbq
+  class TestCase < ActiveSupport::TestCase
+    class << self
+      alias :scenario :test
+      alias :background :setup
+    end
+
+    alias :background :setup
+
+    teardown do
+      Bbq::Session.pool.release
+    end
+  end
+
+  # test/unit specific methods for test_user
+  class TestUser
+    include Test::Unit::Assertions
+
+    def see!(*args)
+      args.each do |arg|
+        assert has_content?(arg), "Expecting to see \"#{arg}\", text not found."
+      end
+    end
+
+    def not_see!(*args)
+      args.each do |arg|
+        assert has_no_content?(arg), "Found \"#{arg}\", which was unexpected."
+      end
+    end
+  end
+end

data/lib/bbq/test_user.rb

@@ -1,52 +1,33 @@
+require 'bbq'
 require 'capybara/rails' if Bbq.rails?
-require 'capybara/dsl'
-require 'securerandom'
-require 'bbq/util'
+require 'bbq/session'
+require 'bbq/roles'
+require 'bbq/test_user/capybara_dsl'
 require 'bbq/test_user/eyes'
 require 'bbq/test_user/within'
 
 module Bbq
   class TestUser
-    if Bbq.rails?
-      include ActionDispatch::Routing::UrlFor
-      include Rails.application.routes.url_helpers
-      include ActionDispatch::Routing::RouteSet::MountedHelpers unless Rails.version < "3.1"
-    end
-    include Capybara::DSL
+    include Bbq::TestUser::CapybaraDsl
     include Bbq::TestUser::Eyes
     include Bbq::TestUser::Within
+    include Bbq::Roles
 
     attr_reader :options
 
     def initialize(options = {})
-      @session_name = options.delete(:session_name)
-      @current_driver = options.delete(:driver)
-      @options = options
-    end
-
-    def page
-      Capybara.using_driver(current_driver) do
-        Capybara.using_session(session_name) do
-          Capybara.current_session
-        end
-      end
+      @options = default_options.merge(options)
     end
 
-    # Discuss: Shall we freeze ?
-    def session_name
-      @session_name ||= SecureRandom.hex(8)
+    def default_options
+      {
+        :pool => Bbq::Session.pool,
+        :driver => ::Capybara.default_driver
+      }
     end
 
-    # Discuss: Shall we freeze ?
-    def current_driver
-      @current_driver
-    end
-
-    def roles(*names)
-      names.each do |name|
-        module_obj = Bbq::Util.find_module(name, self)
-        self.extend(module_obj)
-      end
+    def page
+      @page ||= options[:session] || Bbq::Session.next(:driver => options[:driver], :pool => options[:pool])
     end
   end
 end

data/lib/bbq/test_user/capybara_dsl.rb

@@ -0,0 +1,15 @@
+require 'capybara/dsl'
+
+module Bbq
+  class TestUser
+    module CapybaraDsl
+      ::Capybara::Session::DSL_METHODS.each do |method|
+        class_eval <<-RUBY, __FILE__, __LINE__+1
+          def #{method}(*args, &block)
+            page.#{method}(*args, &block)
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/bbq/version.rb

@@ -1,3 +1,3 @@
 module Bbq
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/lib/generators/bbq/install_generator.rb

@@ -1,7 +1,7 @@
 require 'bbq'
 
 module Bbq
-  class InstallGenerator < Rails::Generators::Base
+  class InstallGenerator < ::Rails::Generators::Base
     hook_for :test_framework, :aliases => "-t", :as => "bbq_install"
   end
 end

data/lib/generators/bbq/test_generator.rb

@@ -1,7 +1,7 @@
 require 'bbq'
 
 module Bbq
-  class TestGenerator < Rails::Generators::NamedBase
+  class TestGenerator < ::Rails::Generators::NamedBase
     hook_for :test_framework, :aliases => "-t", :as => "bbq_test"
   end
 end

data/lib/generators/rspec/templates/test_user.rb

@@ -1,3 +1,5 @@
+require "bbq/test_user"
+
 class TestUser < Bbq::TestUser
   # FIXME: explain here how to extend TestUser
 end

data/lib/generators/test_unit/templates/README

@@ -1,7 +1,7 @@
 
 To finish setup, place in your test/test_helper.rb the following:
 
-  require 'bbq/test'
+  require 'bbq/test_unit'
 
 Also make sure that you require there support files:
 

data/lib/generators/test_unit/templates/test_user.rb

@@ -1,3 +1,5 @@
+require "bbq/test_user"
+
 class TestUser < Bbq::TestUser
   # FIXME: explain here how to extend TestUser
 end

data/test/dummy/app/controllers/home_controller.rb

@@ -1,3 +1,5 @@
+Mime::Type.register "application/vnd.magic+json; version=2", :vnd_json_v2
+
 class HomeController < ApplicationController
   before_filter :authenticate_user!, :only => :index
 
@@ -11,4 +13,13 @@ class HomeController < ApplicationController
 
   def ponycorns
   end
+
+  def rainbow
+    @rainbow = { "wonderful" => true, "colors" => 7 }
+    respond_to do |format|
+      format.json { render :json => @rainbow }
+      format.vnd_json_v2 { render :json => @rainbow }
+      format.yaml { render :text => @rainbow.to_yaml }
+    end
+  end
 end

data/test/dummy/config/routes.rb

@@ -4,4 +4,5 @@ Dummy::Application.routes.draw do
 
   match "/miracle" => "home#miracle"
   match "/ponycorns" => "home#ponycorns"
+  match "/rainbow" => "home#rainbow"
 end

data/test/support/driver_factory.rb

@@ -0,0 +1,46 @@
+class DriverFactory
+
+  attr_reader :drivers_count
+
+  def initialize(log_path)
+    @log = File.open(log_path, 'w')
+    @drivers = []
+  end
+
+  def get_driver(app)
+    @log.puts "Driver created"
+    driver = TestDriver.new(app)
+    @drivers << driver
+    driver
+  end
+
+  def drivers_clean?
+    @drivers.all?(&:clean?)
+  end
+
+  def drivers_count
+    @drivers.size
+  end
+
+  class TestDriver
+
+    def initialize(app)
+      @app   = app
+      @clean = true
+    end
+
+    def visit(path)
+      @clean = false
+    end
+
+    def reset!
+      @clean = true
+    end
+
+    def clean?
+      @clean
+    end
+
+  end
+
+end

data/test/unit/bbq_rspec_test.rb

@@ -3,83 +3,221 @@ require 'test_helper'
 class BbqRspecTest < Test::Unit::TestCase
   include CommandHelper
 
+  def setup
+    @log_path = 'test/dummy/log/test_driver.log'
+  end
+
   def test_dsl
     create_file 'test/dummy/spec/acceptance/dsl_spec.rb', <<-RSPEC
-      require 'spec_helper'
-      require 'bbq/rspec'
-
-      feature 'dsl' do
-        background do
-          @a = 1
-        end
-
-        scenario 'valid' do
-          @a.should == 1
-        end
-      end
+require 'spec_helper'
+require 'bbq/rspec'
+
+feature 'dsl' do
+  background do
+    @a = 1
+  end
+
+  scenario 'valid' do
+    @a.should == 1
+  end
+end
     RSPEC
 
-    run_cmd 'rspec -Itest/dummy/spec test/dummy/spec/acceptance/dsl_spec.rb'
+    run_cmd 'bundle exec rspec -Itest/dummy/spec test/dummy/spec/acceptance/dsl_spec.rb'
     assert_match /1 example, 0 failures/, output
   end
 
   def test_capybara_matchers
     create_file 'test/dummy/spec/acceptance/capybara_matchers_spec.rb', <<-RSPEC
-      require 'spec_helper'
-      require 'bbq/rspec'
-
-      feature 'capybara matchers' do
-        scenario 'should see welcome text' do
-          user = Bbq::TestUser.new
-          user.visit "/miracle"
-          user.page.should have_content("MIRACLE")
-          user.should have_no_content("BBQ")
-        end
-      end
+require 'spec_helper'
+require 'bbq/rspec'
+require 'bbq/test_user'
+
+feature 'capybara matchers' do
+  scenario 'should see welcome text' do
+    user = Bbq::TestUser.new
+    user.visit "/miracle"
+    user.page.should have_content("MIRACLE")
+    user.should have_no_content("BBQ")
+  end
+end
     RSPEC
 
-    run_cmd 'rspec -Itest/dummy/spec test/dummy/spec/acceptance/capybara_matchers_spec.rb'
+    run_cmd 'bundle exec rspec -Itest/dummy/spec test/dummy/spec/acceptance/capybara_matchers_spec.rb'
     assert_match /1 example, 0 failures/, output
   end
 
   def test_bbq_matchers
     create_file 'test/dummy/spec/acceptance/bbq_matchers_spec.rb', <<-RSPEC
-      require 'spec_helper'
-      require 'bbq/rspec'
-
-      feature 'bbq matchers' do
-        scenario 'should see welcome text' do
-          user = Bbq::TestUser.new
-          user.visit "/miracle"
-          user.should see("MIRACLE")
-          user.should not_see("BBQ")
-        end
-      end
+require 'spec_helper'
+require 'bbq/rspec'
+require 'bbq/test_user'
+
+feature 'bbq matchers' do
+  scenario 'should see welcome text' do
+    user = Bbq::TestUser.new
+    user.visit "/miracle"
+    expect { user.should see("MIRACLE") }.to_not raise_error(RSpec::Expectations::ExpectationNotMetError)
+    expect { user.should_not see("MIRACLE") }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /expected not to see MIRACLE in/)
+    expect { user.should_not see("BBQ") }.to_not raise_error(RSpec::Expectations::ExpectationNotMetError)
+    expect { user.should see("BBQ") }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /expected to see BBQ in/)
+  end
+
+  scenario 'should allow to chain matcher with within scope' do
+    user = Bbq::TestUser.new
+    user.visit '/ponycorns'
+
+    expect { user.should see('Pink').within('#unicorns') }.to_not raise_error(RSpec::Expectations::ExpectationNotMetError)
+    expect { user.should_not see('Pink').within('#unicorns') }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /expected not to see Pink in Pink/)
+    expect { user.should_not see('Violet').within('#unicorns') }.to_not raise_error(RSpec::Expectations::ExpectationNotMetError)
+    expect { user.should see('Violet').within('#unicorns') }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /expected to see Violet in Pink/)
+  end
+end
     RSPEC
 
-    run_cmd 'rspec -Itest/dummy/spec test/dummy/spec/acceptance/bbq_matchers_spec.rb'
-    assert_match /1 example, 0 failures/, output
+    run_cmd 'bundle exec rspec -Itest/dummy/spec test/dummy/spec/acceptance/bbq_matchers_spec.rb'
+    assert_match /2 examples, 0 failures/, output
   end
 
   def test_implicit_user_eyes
     create_file 'test/dummy/spec/acceptance/implicit_user_eyes_spec.rb', <<-RSPEC
-      require 'spec_helper'
-      require 'bbq/rspec'
-
-      feature 'implicit user eyes' do
-        scenario 'should see welcome text' do
-          user = Bbq::TestUser.new
-          user.visit "/miracle"
-          user.see!("MIRACLE")
-          user.not_see!("BBQ")
-
-          lambda { user.see!("BBQ") }.should raise_error
-          lambda { user.not_see!("MIRACLE") }.should raise_error
-        end
-      end
+require 'spec_helper'
+require 'bbq/rspec'
+require 'bbq/test_user'
+
+feature 'implicit user eyes' do
+  scenario 'should see welcome text' do
+    user = Bbq::TestUser.new
+    user.visit "/miracle"
+    user.see!("MIRACLE")
+    user.not_see!("BBQ")
+
+    expect { user.see!("BBQ") }.to raise_error
+    expect { user.not_see!("MIRACLE") }.to raise_error
+  end
+
+  scenario 'should work with within option' do
+    user = Bbq::TestUser.new
+    user.visit '/ponycorns'
+    user.see! 'Pink', :within => '#unicorns'
+    user.not_see! 'Violet', :within => '#unicorns'
+
+    expect { user.see! 'Violet', :within => '#unicorns' }.to raise_error
+    expect { user.not_see! 'Pink', :within => '#unicorns' }.to raise_error
+  end
+end
     RSPEC
 
-    run_cmd 'rspec -Itest/dummy/spec test/dummy/spec/acceptance/implicit_user_eyes_spec.rb'
+    run_cmd 'bundle exec rspec -Itest/dummy/spec test/dummy/spec/acceptance/implicit_user_eyes_spec.rb'
+    assert_match /2 examples, 0 failures/, output
+  end
+
+  def test_api_client
+    create_file 'test/dummy/spec/acceptance/api_spec.rb', <<-RSPEC
+require 'spec_helper'
+require 'bbq/rspec'
+require 'bbq/test_client'
+
+feature 'application API' do
+  scenario 'client fetches the rainbow as JSON' do
+    client = Bbq::TestClient.new(:headers => { 'Accept' => 'application/json' })
+    client.get "/rainbow" do |response|
+      response.status.should == 200
+      response.headers["Content-Type"].should match "application/json"
+      response.body["colors"].should == 7
+      response.body["wonderful"].should == true
+    end
+  end
+end
+    RSPEC
+
+    run_cmd 'bundle exec rspec -Itest/dummy/spec test/dummy/spec/acceptance/api_spec.rb'
     assert_match /1 example, 0 failures/, output
   end
+
+  def test_session_pool
+    create_file 'test/dummy/spec/acceptance/session_pool_spec.rb', <<-RSPEC
+require 'spec_helper'
+require 'bbq/rspec'
+require 'bbq/test_user'
+require 'driver_factory'
+
+Factory = DriverFactory.new('#{@log_path}')
+Capybara.register_driver :bbq do |app|
+  Factory.get_driver(app)
+end
+Capybara.default_driver = :bbq
+
+feature 'session pool' do
+  scenario 'alice visits page' do
+    Factory.drivers_clean?.should be_true
+    alice = Bbq::TestUser.new
+    alice.visit "/miracle"
+    Factory.drivers_clean?.should be_false
+  end
+
+  scenario 'both alice and bob visit page' do
+    Factory.drivers_clean?.should be_true
+    alice = Bbq::TestUser.new
+    bob   = Bbq::TestUser.new
+    alice.visit "/miracle"
+    bob.visit "/miracle"
+    Factory.drivers_clean?.should be_false
+  end
+
+  scenario 'bob visits page' do
+    Factory.drivers_clean?.should be_true
+    bob  = Bbq::TestUser.new
+    bob.visit "/miracle"
+    Factory.drivers_clean?.should be_false
+  end
+end
+    RSPEC
+
+    run_cmd 'bundle exec rspec -Itest/dummy/spec -Itest/support test/dummy/spec/acceptance/session_pool_spec.rb'
+    assert_match /3 examples, 0 failures/, output
+    drivers_created = File.readlines(@log_path).size
+    assert_equal 2, drivers_created
+  end
+
+  def test_without_session_pool
+    create_file 'test/dummy/spec/acceptance/without_session_pool_spec.rb', <<-RSPEC
+require 'spec_helper'
+require 'bbq/test'
+require 'bbq/test_user'
+require 'driver_factory'
+
+Factory = DriverFactory.new('#{@log_path}')
+Capybara.register_driver :bbq do |app|
+  Factory.get_driver(app)
+end
+Capybara.default_driver = :bbq
+
+feature 'without session pool' do
+  scenario 'alice visits page' do
+    alice = Bbq::TestUser.new(:pool => false)
+    alice.visit "/miracle"
+  end
+
+  scenario 'both alice and bob visit page' do
+    alice  = Bbq::TestUser.new(:pool => false)
+    bob    = Bbq::TestUser.new(:pool => false)
+
+    alice.visit "/miracle"
+    bob.visit "/miracle"
+  end
+
+  scenario 'bob visits page' do
+    bob  = Bbq::TestUser.new(:pool => false)
+    bob.visit "/miracle"
+  end
+
+end
+    RSPEC
+
+    run_cmd 'bundle exec rspec -Itest/dummy/spec -Itest/support test/dummy/spec/acceptance/without_session_pool_spec.rb'
+    assert_match /3 examples, 0 failures/, output
+    drivers_created = File.readlines(@log_path).size
+    assert_equal 4, drivers_created
+  end
 end