Flipper 1.0

data/README

@@ -0,0 +1,77 @@
+
+= Flipper
+
+  "Switch your database on the fly"
+
+
+== Introduction
+
+When doing integration and acceptance testing you typically need to:
+
+* Change and manage application state.
+* Guarantee test case isolation, even for those that change the application state.
+ 
+9 times out of 10, all you need to do to achieve this for a Rails application is:
+
+* Have direct access to the database.
+* Ensure that tests running in parallel access a different database schema.
+
+So if you are driving your tests at the HTTP layer (e.g. Selenium tests) you could use a
+single Mongrel cluster to run a lot of tests in parallel, a long as you can change your
+database on the fly for each HTTP requests. This is what Flipper does.
+
+== Status
+
+The current status is quite good. Flipper is currently used on a daily basis on commercial projects.
+
+
+== Installation
+
+The easiest way to install is via RubyGems. On the command line enter:
+
+  > gem install flipper
+
+== Usage
+
+To use flipper just include the <code>Flipper</code> module and add a before filter in <code>application.rb</code>:
+
+  class ApplicationController < ActionController::Base
+    include Flipper
+
+    before_filter :switch_database
+ 
+    ...
+  end
+
+== License
+
+The collection PER COLLECTION is licensed as follows:
+
+  Ruby Facets
+  Copyright (c) 2004-2006 Thomas Sawyer
+
+  Distributed under the terms of the Ruby license.
+
+The Ruby license is a dual license that also provides for use of the GPL.
+Complete texts of both licenses accompany this document (see doc/COPYING).
+
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+Acknowledgments and Copyrights for particular snippets of borrowed code
+are given in their respective source. All licenses are either compatible
+with the Ruby license (namely the GPL) or the original author has given
+permission for inclusion of their code under such lincense.
+
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the flipper plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the flipper plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Flipper'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Gem::manage_gems
+
+specification = Gem::Specification.new do |s|
+	s.name   = "Flipper"
+  s.summary = "Switch your Rails database on the fly for each HTTP request. Useful for integration and acceptance testing (test isolation & state management)."
+	s.version = "1.0"
+	s.author = 'Philippe Hanrigou & Dan Manges'
+	s.description = s.summary
+	s.email = 'flipper-developer@rubyforge.org'
+  s.homepage = 'http://flipper.rubyforge.org'
+  s.rubyforge_project = 'flipper'
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README']
+  s.rdoc_options << '--title' << 'Flipper' << '--main' << 'README' << '--line-numbers'
+                         
+  s.autorequire = 'flipper'
+  s.files = FileList['{lib,test}/**/*.rb', '[A-Z]*$', 'Rakefile'].to_a
+	s.test_file = "test/all_tests.rb"
+end
+
+Rake::GemPackageTask.new(specification) do |package|
+	 package.need_zip = false
+	 package.need_tar = false
+end

data/lib/flipper.rb

@@ -0,0 +1,37 @@
+# 
+# Include this module in your Rails controller to change database schema on each HTTP request:
+#
+#  class ApplicationController < ActionController::Base
+#    include Flipper
+#
+#    before_filter :switch_database  # if RAILS_ENV == "selenium"
+#
+#    ...
+#  end
+module Flipper
+  
+  #
+  # Switch current database based on <code>flipper_db_config</code> HTTP parameter, if any,
+  # and store database configuration in session.
+  #
+  # If there is no <code>flipper_db_config</code> parameter, switch to the database configuration
+  # stored in session.
+  #
+  # If anything goes wrong while switching database, attempts to rollback to the previous database configuration
+  # before raising an exception.
+  def switch_database
+    database_configuration = params[:flipper_db_config] || session[:flipper_db_config]
+    return unless database_configuration
+    
+    prior_configuration = ActiveRecord::Base.connection.instance_variable_get(:@config)
+    ActiveRecord::Base.clear_active_connections!
+    begin
+      ActiveRecord::Base.establish_connection database_configuration
+      session[:flipper_db_config] = database_configuration
+    rescue => ex
+      ActiveRecord::Base.establish_connection prior_configuration
+      raise
+    end
+  end
+  
+end

data/test/all_tests.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname __FILE__}/*_test.rb"].each { |test_case| require test_case }

data/test/flipper_test.rb

@@ -0,0 +1,78 @@
+require "rubygems"
+require "dust"
+require "mocha"
+require 'test/unit'
+
+unless defined?(ActiveRecord)
+  module ActiveRecord
+    class Base; end
+  end
+end
+
+require File.dirname(__FILE__) + "/../lib/flipper"
+
+unit_tests do
+  
+  def setup
+    @controller = Class.new { include Flipper }.new
+  end
+  
+  test "controller establishes new db connection and clears active connection when receiving database_connection from params" do
+    @controller.stubs(:session).returns({})
+    @controller.stubs(:params).returns(:flipper_db_config => :connection_hash)
+    ActiveRecord::Base.stubs(:connection).returns(stub_everything)
+    ActiveRecord::Base.expects(:clear_active_connections!)
+    ActiveRecord::Base.expects(:establish_connection).with(:connection_hash)
+    @controller.send(:switch_database)
+  end
+
+  test "controller establishes new db connection and clears active connection when receiving database_connection from session" do
+    @controller.stubs(:session).returns(:flipper_db_config => :connection_hash)
+    @controller.stubs(:params).returns(:flipper_db_config => nil)
+    ActiveRecord::Base.stubs(:connection).returns(stub_everything)
+    ActiveRecord::Base.expects(:clear_active_connections!)
+    ActiveRecord::Base.expects(:establish_connection).with(:connection_hash)
+    @controller.send(:switch_database)
+  end
+  
+  test "controller checks for database configuration in params before session" do
+    @controller.stubs(:session).returns(:flipper_db_config => :session_connection_hash)
+    @controller.stubs(:params).returns(:flipper_db_config => :params_connection_hash)
+    ActiveRecord::Base.stubs(:connection).returns(stub_everything)
+    ActiveRecord::Base.expects(:clear_active_connections!)
+    ActiveRecord::Base.expects(:establish_connection).with(:params_connection_hash)
+    @controller.send(:switch_database)
+  end
+
+  test "controller does not establish a new db connection nor clears active connection when there is no database_connection neither in params nor in session" do
+    @controller.stubs(:session).returns({})
+    @controller.stubs(:params).returns(:flipper_db_config => nil)
+    ActiveRecord::Base.stubs(:connection).returns(stub_everything)
+    ActiveRecord::Base.expects(:clear_active_connections!).never
+    ActiveRecord::Base.expects(:establish_connection).never
+    @controller.send(:switch_database)
+  end
+
+  test "database configuration is stored in session after passed in through params" do
+    @controller.stubs(:session).returns(session = {})
+    @controller.stubs(:params).returns(:flipper_db_config => :connection_hash)
+    ActiveRecord::Base.stubs(:connection).returns(stub_everything)
+    ActiveRecord::Base.stubs(:clear_active_connections!)
+    ActiveRecord::Base.stubs(:establish_connection)
+    @controller.send(:switch_database)
+    assert_equal :connection_hash, session[:flipper_db_config]
+  end
+
+  test "controller restores original db connection and raises exception when establishing a new database_connection fails" do
+    @controller.stubs(:session).returns({})
+    @controller.stubs(:params).returns(:flipper_db_config => :connection_hash)
+    ActiveRecord::Base.stubs(:connection).returns(connection = stub)
+    connection.instance_variable_set "@config", :old_configuration
+    ActiveRecord::Base.expects(:clear_active_connections!)
+    exception = RuntimeError.new("will be raised if new connection cannot be established")
+    ActiveRecord::Base.expects(:establish_connection).with(:connection_hash).raises(exception)
+    ActiveRecord::Base.expects(:establish_connection).with(:old_configuration)
+    assert_raises(RuntimeError) { @controller.send(:switch_database) }
+  end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: Flipper
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+date: 2007-09-15 00:00:00 -04:00
+summary: Switch your Rails database on the fly for each HTTP request. Useful for integration and acceptance testing (test isolation & state management).
+require_paths: 
+- lib
+email: flipper-developer@rubyforge.org
+homepage: http://flipper.rubyforge.org
+rubyforge_project: flipper
+description: Switch your Rails database on the fly for each HTTP request. Useful for integration and acceptance testing (test isolation & state management).
+autorequire: flipper
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Philippe Hanrigou & Dan Manges
+files: 
+- lib/flipper.rb
+- test/flipper_test.rb
+- test/all_tests.rb
+- Rakefile
+- README
+test_files: 
+- test/all_tests.rb
+rdoc_options: 
+- --title
+- Flipper
+- --main
+- README
+- --line-numbers
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+