redis_test 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68c259a753408811ee1e2c7c716b87f18ad897e6
+  data.tar.gz: 101f4f1167f1a1a0e7376c2b2da822781da0e886
+SHA512:
+  metadata.gz: 8b1568af13475d87d9402cff828c76e5f582cda89cf04f6bdea775eaf8b6021f54f341ac774d30b239a24e7d87113269e9bc1c35146ef1a506e383d56207f136
+  data.tar.gz: cfaf64d531c02e590ea56d7a5efeeafde630c2aad6d165694f5baacf9fdb3bfa689da71db813c94fad7523e96f6fa240eac9c5d54e4e2c534b0cf0cdf6056b29

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis-test.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Phuong Nguyen
+
+MIT License
+
+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,91 @@
+# RedisTest
+
+This is a very simple gem to help start/stop an instance of redis server
+during test.
+
+There is different option out there like fakeredis but I dislike
+fakeredis approach as it require the gem to re-implement all the
+functionality of redis, so every time redis is upgrading, the gem
+need to be updated as well.
+
+My approach is very simple, and may be already widely used:
+Start a redis server on port 9736 (can be
+customized by setting `ENV['TEST_REDIS_PORT']`) and simply change your
+config so your redis client will connect there during test instead.
+
+I just try to package it in a convenient way so I don't have to repeat
+it for every project I use.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_test'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_test
+
+## Usage
+
+You can use it with RSpec by putting this block under your spec/support:
+
+```ruby
+RSpec.configure do |config|
+  config.before(:suite) do
+    RedisTest.start
+    RedisTest.configure(:default, :sidekiq, :ohm)
+    # RedisTest provide common configuration for :default (set
+    # Redis.current), :sidekiq, :ohm and :resque.
+  end
+
+  config.after(:each) do
+    RedisTest.clear
+    # notice that will flush the Redis db, so it's less
+    # desirable to put that in a config.before(:each) since it may clean any
+    # data that you try to put in redis prior to that
+  end
+
+  config.after(:suite) do
+    RedisTest.stop
+  end
+end
+```
+
+Or with Cucumber by putting this block under your features/support:
+
+```ruby
+RedisTest.start # start this when cucumber load
+RedisTest.configure(:default, :sidekiq, :ohm)
+# available option: :default, :sidekiq, :ohm, :resque
+
+After do
+  RedisTest.clear
+  # clear redis after every scenario to avoid interference
+end
+
+at_exit do
+  RedisTest.stop
+end
+
+```
+
+There is a `RedisTest.server_url` (which by default return
+`"redis://localhost:9763"`) that you can use to configure your custom tool
+that use Redis
+
+## For Parallel Testing
+You can start multiple instances of redis in parallel by rotating
+`ENV['TEST_REDIS_PORT']`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/redis_test/version.rb

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

data/lib/redis_test.rb

@@ -0,0 +1,103 @@
+require "redis_test/version"
+
+module RedisTest
+  class << self
+    def port
+      (ENV['TEST_REDIS_PORT'] || 9736).to_i
+    end
+
+    def db_filename
+      "redis-test-#{port}.rdb"
+    end
+
+    def cache_path
+      "#{Rails.root}/tmp/cache/#{port}/"
+    end
+
+    def pids_path
+      "#{Rails.root}/tmp/pids"
+    end
+
+    def pidfile
+      "#{pids_path}/redis-test-#{port}.pid"
+    end
+
+    def start
+      FileUtils.mkdir_p cache_path
+      FileUtils.mkdir_p pids_path
+      redis_options = {
+        "daemonize"     => 'yes',
+        "pidfile"       => pidfile,
+        "port"          => port,
+        "timeout"       => 300,
+        "save 900"      => 1,
+        "save 300"      => 1,
+        "save 60"       => 10000,
+        "dbfilename"    => db_filename,
+        "dir"           => cache_path,
+        "loglevel"      => "debug",
+        "logfile"       => "stdout",
+        "databases"     => 16
+      }.map { |k, v| "#{k} #{v}" }.join('\n')
+      `echo '#{redis_options}' | redis-server -`
+
+
+      wait_time_remaining = 5
+      begin
+        TCPSocket.open("localhost", port)
+        success = true
+      rescue Exception => e
+        if wait_time_remaining > 0
+          wait_time_remaining -= 0.1
+          sleep 0.1
+        else
+          raise "Cannot start redis server in 5 seconds. Pinging server yield\n#{e.inspect}"
+        end
+      end while(!success)
+    end
+
+    def stop
+      %x{
+        cat #{pidfile} | xargs kill -QUIT
+        rm -f #{cache_path}#{db_filename}
+      }
+    end
+
+    def server_url
+      "redis://localhost:#{port}"
+    end
+
+    def configure(*options)
+      options.flatten.each do |option|
+        case option
+        when :default
+          Redis.current = Redis.new(url: server_url)
+
+        when :sidekiq
+          Sidekiq.configure_server do |config|
+            config.redis = { url: server_url, namespace: 'sidekiq' }
+          end
+
+          Sidekiq.configure_client do |config|
+            config.redis = { url: server_url, namespace: 'sidekiq' }
+          end
+
+        when :ohm
+          Ohm.redis = Redic.new(server_url)
+
+        when :resque
+          Resque.configure do |config|
+            config.redis = "#{server_url}/resque"
+          end
+
+        else
+          raise "Unable to configure #{option}"
+        end
+      end
+    end
+
+    def clear
+      Redis.current.flushdb
+    end
+  end
+end

data/redis_test.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_test/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_test"
+  spec.version       = RedisTest::VERSION
+  spec.authors       = ["Phuong Nguyen"]
+  spec.email         = ["phuongnd08@gmail.com"]
+  spec.description   = %q{A helper to launch redis server during test}
+  spec.summary       = %q{A helper to launch redis server during test}
+  spec.homepage      = "https://github.com/phuongnd08/redis_test"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: redis_test
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Phuong Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A helper to launch redis server during test
+email:
+- phuongnd08@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_test.rb
+- lib/redis_test/version.rb
+- redis_test.gemspec
+homepage: https://github.com/phuongnd08/redis_test
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A helper to launch redis server during test
+test_files: []