integration_test_redis 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in integration_test_redis.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Licensed under MIT License:
+
+Copyright (c) 2011 Brendon Murphy
+
+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,49 @@
+IntegrationTestRedis
+====================
+
+Provide a non-persistent [Redis](http://redis.io/) server for use in integration tests.
+
+Why?
+----
+
+Many Redis test solutions work by completely mocking out the Redis client
+interface.  This is sometimes a good approach, especially if you want to
+write pure unit tests.  However, there are times you want to integrate
+with Redis safely for testing purposes.
+
+Testing against a running Redis server instance can be tricky.  Since Redis
+supports a few numeric database ids, knowing where it's safe to tread
+during tests is iffy.  This is especially true when writing tests that
+integrate through to the service inside a public gem.  One errant
+`redis.flushdb` and you might have just dropped some cherished data on
+behalf of a user.  That is, not good.
+
+How?
+----
+
+The IntegrationTestRedis class provides `start`, `stop`, and `client` methods
+to get at a Redis setup suitable for integration testing.  It starts a running,
+non-persistent server for you.
+
+Usage
+-----
+
+```ruby
+require "integration_test_redis"
+# Start the server
+IntegrationTestRedis.start
+# Get a suitable client to the server
+redis_client = IntegrationTestRedis.client
+# Stop the server.  Also handled automatically in an at_exit callback
+IntegrationTestRedis.stop
+```
+
+Thanks
+------
+
+This code was extracted from the work of various individuals to the
+[Likeable](https://github.com/schneems/likeable) codebase.
+
+#### Copyright
+
+Copyright (c) (2011) Brendon Murphy. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]

data/integration_test_redis.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "integration_test_redis/version"
+
+Gem::Specification.new do |s|
+  s.name        = "integration_test_redis"
+  s.version     = IntegrationTestRedis::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brendon Murphy"]
+  s.email       = ["xternal1+github@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Redis integration test server}
+  s.description = %q{Control a non-persistent Redis server for use in integration tests.}
+
+  s.rubyforge_project = "integration_test_redis"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "redis"
+  s.add_development_dependency "rspec"
+end

data/lib/integration_test_redis/version.rb

@@ -0,0 +1,3 @@
+module IntegrationTestRedis
+  VERSION = "0.0.1"
+end

data/lib/integration_test_redis.rb

@@ -0,0 +1,77 @@
+require "singleton"
+require "tempfile"
+require "redis"
+
+class IntegrationTestRedis
+  include ::Singleton
+
+  class DatabaseNotEmpty < RuntimeError
+    def initialize(msg = "Database not empty, aborting!")
+      super
+    end
+  end
+
+  PORT    = 9737
+  PIDFILE = Tempfile.new('integration-test-redis-pid')
+  DIR     = Dir.mktmpdir('integration-test-redis')
+
+  def self.start
+    instance.start
+  end
+
+  def self.stop
+    instance.stop
+  end
+
+  def self.client
+    instance.client
+  end
+
+  def start
+    install_at_exit_handler
+    system("echo '#{options}' | redis-server -")
+    sleep 0.1 # allow a grace period for starting
+    enforce_empty_db
+    true
+  end
+
+  def stop
+    pid = File.read(PIDFILE).to_i
+    begin
+      Process.getpgid(pid)
+      system("kill -QUIT #{pid}")
+    rescue Errno::ESRCH
+      false
+    end
+  end
+
+  def client
+    ::Redis.new(:port => PORT, :db => 15)
+  end
+
+  private
+
+  def options
+    {
+      'daemonize' => 'yes',
+      'pidfile'   => PIDFILE.path,
+      'bind'      => '127.0.0.1',
+      'port'      => PORT,
+      'timeout'   => 300,
+      'dir'       => DIR,
+      'loglevel'  => 'debug',
+      'logfile'   => 'stdout',
+      'databases' => 16
+    }.map { |k, v| "#{k} #{v}" }.join("\n")
+  end
+
+  def enforce_empty_db
+    raise DatabaseNotEmpty unless client.dbsize == 0
+  end
+
+  def install_at_exit_handler
+    at_exit {
+      IntegrationTestRedis.instance.stop
+    }
+  end
+end

data/spec/integration_test_redis_spec.rb

@@ -0,0 +1,92 @@
+require 'rspec'
+
+require 'integration_test_redis'
+
+module ServerSpecHelpers
+  def assert_server_running
+    server_pid.should > 0
+    lambda {
+      Process.getpgid(server_pid)
+    }.should_not raise_error
+  end
+
+  def refute_server_running
+    lambda {
+      Process.getpgid(server_pid)
+    }.should raise_error(Errno::ESRCH)
+  end
+
+  def allow_server_grace
+    sleep 0.1
+  end
+
+  def start_server
+    IntegrationTestRedis.start
+    allow_server_grace
+  end
+
+  def stop_server
+    IntegrationTestRedis.stop && allow_server_grace
+    @server_pid = nil
+  end
+
+  def server_pid
+    @server_pid ||= File.read(IntegrationTestRedis::PIDFILE).to_i
+  end
+end
+
+describe IntegrationTestRedis do
+  include ServerSpecHelpers
+
+  after do
+    stop_server
+  end
+
+  it "acts as a singleton to protect access" do
+    lambda { IntegrationTestRedis.new }.should raise_error(NoMethodError)
+  end
+
+  it "can start a redis server" do
+    start_server
+    assert_server_running
+  end
+
+  it "can stop the running redis server" do
+    start_server
+    stop_server
+    refute_server_running
+  end
+
+  it "provides a working client to the server" do
+    start_server
+    client = IntegrationTestRedis.client
+    client.del "foo"
+    client.set "foo", "bar"
+    client.get("foo").should == "bar"
+  end
+
+  it "doesn't persist data after stop" do
+    start_server
+    client = IntegrationTestRedis.client
+    client.set "fizz", "buzz"
+    stop_server
+    start_server
+    client = IntegrationTestRedis.client
+    client.dbsize.should == 0
+  end
+
+  context "when the server starts and data is present" do
+    it "raises IntegrationTestRedis::DatabaseNotEmpty" do
+      redis = mock("redis")
+      Redis.stub(:new).and_return(redis)
+      redis.should_receive(:dbsize).and_return(42)
+      lambda {
+        start_server
+      }.should raise_error(IntegrationTestRedis::DatabaseNotEmpty)
+    end
+  end
+
+  # it "is killed off at exit" do
+  #   pending("find a way to test this, fork it?")
+  # end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: integration_test_redis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-18 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2156189320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156189320
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156188900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156188900
+description: Control a non-persistent Redis server for use in integration tests.
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- integration_test_redis.gemspec
+- lib/integration_test_redis.rb
+- lib/integration_test_redis/version.rb
+- spec/integration_test_redis_spec.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: integration_test_redis
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Redis integration test server
+test_files: []