rprov 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Cyril David, Michel Martens, Damian Janowski
+
+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

@@ -0,0 +1,40 @@
+NAME
+      rprov -- Redis Provisioning
+
+SYNOPSIS
+      rprov setup /some/path -m 1gb -h hostname
+      rprov setup /some/path -m 1gb --paranoid
+
+      rprov start /some/path
+      rprov stop  /some/path
+      rprov info  /some/path
+
+DESCRIPTION
+      Rprov is a simple ruby command line utility which helps you
+      provision and manage redis instances easily.
+
+COMMANDS
+      help        Show this usage guide
+
+      setup PATH  Provision a new Redis instance on the specified path.
+
+      start PATH  Start the previously provisioned instance located
+                  on the specified path.
+
+      stop PATH   Stop a running instance identified by a specific path.
+
+      info PATH   Get the necessary information for an instance, most notably
+                  a `REDIS_URL` which encapsulates all of the connection
+                  information necessary to access the instance.
+
+OPTIONS
+      -m          Customize the amount of max memory usable for the instance.
+                  (Defaults to no limit.)
+
+      -h          Specify the bind address for this redis instance.
+                  (Defaults to 127.0.0.1)
+
+      --paranoid  Removes some of the commands meant to be used by sysadmins
+                  and renames some into a cryptic, non-guessable one.
+
+

data/bin/rprov

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+
+help = <<-EOT
+RPROV(1)
+
+NAME
+      rprov -- Redis Provisioning
+
+SYNOPSIS
+      rprov setup /some/path -m 1gb -h hostname
+      rprov setup /some/path -m 1gb --paranoid
+
+      rprov start /some/path
+      rprov stop  /some/path
+      rprov info  /some/path
+
+DESCRIPTION
+      Rprov is a simple ruby command line utility which helps you
+      provision and manage redis instances easily.
+
+COMMANDS
+      help        Show this usage guide
+
+      setup PATH  Provision a new Redis instance on the specified path.
+
+      start PATH  Start the previously provisioned instance located
+                  on the specified path.
+
+      stop PATH   Stop a running instance identified by a specific path.
+
+      info PATH   Get the necessary information for an instance, most notably
+                  a `REDIS_URL` which encapsulates all of the connection
+                  information necessary to access the instance.
+
+OPTIONS
+      -m          Customize the amount of max memory usable for the instance.
+                  (Defaults to no limit.)
+
+      -h          Specify the bind address for this redis instance.
+                  (Defaults to 127.0.0.1)
+
+      --paranoid  Removes some of the commands meant to be used by sysadmins
+                  and renames some into a cryptic, non-guessable one.
+
+
+EOT
+
+$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+require "clap"
+require "rprov"
+
+if ARGV.empty?
+  puts help
+  exit
+end
+
+rprov = Rprov.new
+decor = Rprov::Decorator.new(rprov)
+
+begin
+  command_and_path = Clap.run ARGV,
+    "help"       => lambda { puts help; exit },
+    "-m"         => rprov.method(:memory=),
+    "-h"         => rprov.method(:host=),
+    "--paranoid" => lambda { rprov.paranoid = true }
+
+  Clap.run command_and_path,
+    "setup"      => decor.method(:setup),
+    "start"      => decor.method(:start),
+    "stop"       => decor.method(:stop),
+    "info"       => decor.method(:info),
+
+rescue ArgumentError
+  puts help
+end

data/lib/rprov.rb

@@ -0,0 +1,65 @@
+require "redis"
+require "nest"
+require "digest/sha1"
+require "erb"
+require "fileutils"
+
+class Rprov
+  Conflict = Class.new(StandardError)
+  Missing  = Class.new(StandardError)
+
+  VERSION = "0.0.1"
+
+  autoload :Config,    "rprov/config"
+  autoload :Decorator, "rprov/decorator"
+
+  attr_accessor :memory, :host, :paranoid
+
+  def start(path)
+    exec("redis-server #{redis_conf!(path)}")
+  end
+
+  def stop(path)
+    conf  = Config.new(key(path))
+    redis = Redis.connect(:url => conf.url)
+    redis.client.process(conf.shutdown_cmd)
+  end
+
+  def setup(path)
+    raise Conflict if redis_conf(path)
+
+    FileUtils.mkdir_p(path) if not File.exist?(path)
+
+    conf = Config.generate
+    conf.path     = path
+    conf.memory   = memory if memory
+    conf.host     = host if host
+    conf.paranoid = paranoid if paranoid
+
+    where = File.expand_path(File.join(path, "redis.%s.conf" % conf.key))
+
+    File.open(where, "w") do |file|
+      file.write conf.redis_conf
+    end
+  end
+
+  def info(path)
+    conf = Config.new(key(path))
+
+    puts "\nREDIS_URL:\n    #{conf.url}"
+    puts "\nRun `rprov start #{path}` to start this instance"
+  end
+
+private
+  def key(path)
+    redis_conf!(path)[/redis\.(.*?)\.conf/, 1]
+  end
+
+  def redis_conf(path)
+    Dir[File.expand_path(File.join(path, "redis.*.conf"))].first
+  end
+
+  def redis_conf!(path)
+    redis_conf(path) or raise(Missing)
+  end
+end

data/lib/rprov/config.rb

@@ -0,0 +1,109 @@
+class Rprov
+  class Config
+    STARTING_PORT = 10_000
+
+    DEFAULTS = {
+      :appendfsync   => "everysec",
+      :host          => "127.0.0.1",
+      :vm_enabled    => "no",
+      :vm_max_memory => 0,
+      :paranoid      => false
+    }
+
+    attr :key
+    attr :password
+    attr :port
+    attr :paranoid
+    attr :path
+
+    attr_accessor :host
+    attr_accessor :appendfsync
+    attr_accessor :vm_enabled
+    attr_accessor :vm_max_memory
+
+    def initialize(key)
+      @key = key
+
+      @password, @port = redis.hmget(:password, :port)
+
+      DEFAULTS.each do |key, value|
+        send("%s=" % key, redis.hget(key) || value)
+      end
+    rescue Errno::ECONNREFUSED
+      raise Errno::ECONNREFUSED, "You need to setup a master redis server."
+    end
+
+    def memory=(memory)
+      self.vm_max_memory = memory
+      self.vm_enabled = "yes"
+    end
+
+    def path=(path)
+      @path = path.to_s.gsub(/\/*$/, "")
+    end
+
+    def url
+      "redis://:#{password}@#{host}:#{port}"
+    end
+
+    def paranoid=(val)
+      @paranoid = val
+
+      if val
+        redis.hmset(:config_cmd,   self.class.random_string,
+                    :shutdown_cmd, self.class.random_string)
+      end
+    end
+
+    def config_cmd()   redis.hget(:config_cmd) || :config end
+    def shutdown_cmd() redis.hget(:shutdown_cmd) || :shutdown end
+
+    def redis_conf
+      redis_conf_erb.result(binding)
+    end
+
+    def self.generate(key = gen_key)
+      redis[key].hmset(:port, gen_port, :password, random_string)
+
+      return new(key)
+    end
+
+    def self.random_string
+      Digest::SHA1.hexdigest(uuid + Time.now.to_f.to_s)
+    end
+
+    def self.redis
+      @redis ||= Nest.new(:rprov)[:config]
+    end
+
+  private
+    def redis_conf_erb
+      ERB.new(File.read(template_path), nil, "-")
+    end
+
+    def template_path
+      File.expand_path("../../templates/redis.conf.erb",
+                       File.dirname(__FILE__))
+    end
+
+    def redis
+      @redis ||= self.class.redis[key]
+    end
+
+    def self.gen_port
+      unless redis[:port].setnx(STARTING_PORT)
+        redis[:port].incr
+      end
+
+      redis[:port].get
+    end
+
+    def self.gen_key
+      Digest::SHA1.hexdigest(uuid)
+    end
+
+    def self.uuid
+      `uuidgen`.strip
+    end
+  end
+end

data/lib/rprov/decorator.rb

@@ -0,0 +1,71 @@
+class Rprov
+  class Decorator
+    attr :component
+
+    def initialize(component)
+      @component = component
+    end
+
+    def start(path)
+      init("Starting Redis Instance: `#{path}`")
+
+      begin
+        component.start(path)
+      rescue Rprov::Missing
+        fail_missing(path)
+      end
+    end
+
+    def stop(path)
+      init("Stopping Redis Instance: `#{path}`")
+
+      begin
+        component.stop(path)
+      rescue Errno::ECONNREFUSED
+        fail("The instance appears to be down.")
+      rescue Rprov::Missing
+        fail_missing(path)
+      else
+        say("Done!")
+      end
+    end
+
+    def setup(path)
+      init("Setting up Redis Instance: #{path}")
+
+      begin
+        component.setup(path)
+      rescue Rprov::Conflict
+        fail("The path #{path} already exists.")
+      else
+        say("Done!")
+      end
+    end
+
+    def info(path)
+      begin
+        component.info(path)
+      rescue Rprov::Missing
+        fail_missing(path)
+      end
+    end
+
+  private
+    def init(str)
+      puts "-----> #{str}"
+    end
+
+    def fail(str)
+      puts "!!     #{str}"
+    end
+
+    def fail_missing(path)
+      fail("Tried to run rprov on non-existent path `#{path}`.")
+      fail("Maybe try `rprov setup #{path}` first?")
+    end
+
+    def say(str)
+      puts "       #{str}"
+    end
+  end
+end

data/templates/redis.conf.erb

@@ -0,0 +1,408 @@
+# Redis configuration file example
+
+# Note on units: when memory size is needed, it is possible to specifiy
+# it in the usual form of 1k 5GB 4M and so forth:
+#
+# 1k => 1000 bytes
+# 1kb => 1024 bytes
+# 1m => 1000000 bytes
+# 1mb => 1024*1024 bytes
+# 1g => 1000000000 bytes
+# 1gb => 1024*1024*1024 bytes
+#
+# units are case insensitive so 1GB 1Gb 1gB are all the same.
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize yes
+
+# When running daemonized, Redis writes a pid file in /var/run/redis.pid by
+# default. You can specify a custom pid file location here.
+pidfile <%= path -%>/redis.pid
+
+# Accept connections on the specified port, default is 6379.
+port <%= port -%>
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for incoming connections.
+#
+bind <%= host -%>
+
+# Specify the path for the unix socket that will be used to listen for
+# incoming connections. There is no default, so Redis will not listen
+# on a unix socket when not specified.
+#
+# unixsocket /tmp/redis.sock
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# verbose (many rarely useful info, but not a mess like the debug level)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel verbose
+
+# Specify the log file name. Also 'stdout' can be used to force
+# Redis to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile <%= path -%>/redis.log
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################ SNAPSHOTTING  #################################
+#
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+#
+#   Note: you can disable saving at all commenting all the "save" lines.
+
+# save 900 1
+# save 300 10
+# save 60 10000
+
+# Compress string objects using LZF when dump .rdb databases?
+# For default that's set to 'yes' as it's almost always a win.
+# If you want to save some CPU in the saving child set it to 'no' but
+# the dataset will likely be bigger if you have compressible values or keys.
+rdbcompression yes
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# The working directory.
+#
+# The DB will be written inside this directory, with the filename specified
+# above using the 'dbfilename' configuration directive.
+#
+# Also the Append Only File will be created inside this directory.
+#
+# Note that you must specify a directory here, not a file name.
+dir <%= path -%>
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+#
+# slaveof <masterip> <masterport>
+
+# If the master is password protected (using the "requirepass" configuration
+# directive below) it is possible to tell the slave to authenticate before
+# starting the replication synchronization process, otherwise the master will
+# refuse the slave request.
+#
+# masterauth <master-password>
+
+# When a slave lost the connection with the master, or when the replication
+# is still in progress, the slave can act in two different ways:
+#
+# 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
+#    still reply to client requests, possibly with out of data data, or the
+#    data set may just be empty if this is the first synchronization.
+#
+# 2) if slave-serve-stale data is set to 'no' the slave will reply with
+#    an error "SYNC with master in progress" to all the kind of commands
+#    but to INFO and SLAVEOF.
+#
+slave-serve-stale-data yes
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+#
+# Warning: since Redis is pretty fast an outside user can try up to
+# 150k passwords per second against a good box. This means that you should
+# use a very strong password otherwise it will be very easy to break.
+#
+requirepass <%= password -%>
+
+# Command renaming.
+#
+# It is possilbe to change the name of dangerous commands in a shared
+# environment. For instance the CONFIG command may be renamed into something
+# of hard to guess so that it will be still available for internal-use
+# tools but not available for general clients.
+#
+# Example:
+#
+# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
+#
+# It is also possilbe to completely kill a command renaming it into
+# an empty string:
+
+<%- if paranoid -%>
+rename-command CONFIG <%= config_cmd %>
+rename-command SHUTDOWN <%= shutdown_cmd %>
+rename-command SLAVEOF ""
+rename-command BGREWRITEAOF ""
+rename-command SAVE ""
+rename-command BGSAVE ""
+<%- end -%>
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limits.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+#
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+#
+# maxmemory <bytes>
+
+# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
+# is reached? You can select among five behavior:
+#
+# volatile-lru -> remove the key with an expire set using an LRU algorithm
+# allkeys-lru -> remove any key accordingly to the LRU algorithm
+# volatile-random -> remove a random key with an expire set
+# allkeys->random -> remove a random key, any key
+# volatile-ttl -> remove the key with the nearest expire time (minor TTL)
+# noeviction -> don't expire at all, just return an error on write operations
+#
+# Note: with all the kind of policies, Redis will return an error on write
+#       operations, when there are not suitable keys for eviction.
+#
+#       At the date of writing this commands are: set setnx setex append
+#       incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
+#       sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
+#       zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
+#       getset mset msetnx exec sort
+#
+# The default is:
+#
+# maxmemory-policy volatile-lru
+
+# LRU and minimal TTL algorithms are not precise algorithms but approximated
+# algorithms (in order to save memory), so you can select as well the sample
+# size to check. For instance for default Redis will check three keys and
+# pick the one that was used less recently, you can change the sample size
+# using the following configuration directive.
+#
+# maxmemory-samples 3
+
+############################## APPEND ONLY MODE ###############################
+
+# By default Redis asynchronously dumps the dataset on disk. If you can live
+# with the idea that the latest records will be lost if something like a crash
+# happens this is the preferred way to run Redis. If instead you care a lot
+# about your data and don't want to that a single record can get lost you should
+# enable the append only mode: when this mode is enabled Redis will append
+# every write operation received in the file appendonly.aof. This file will
+# be read on startup in order to rebuild the full dataset in memory.
+#
+# Note that you can have both the async dumps and the append only file if you
+# like (you have to comment the "save" statements above to disable the dumps).
+# Still if append only mode is enabled Redis will load the data from the
+# log file at startup ignoring the dump.rdb file.
+#
+# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
+# log file in background when it gets too big.
+
+appendonly yes
+
+# The name of the append only file (default: "appendonly.aof")
+appendfilename appendonly.aof
+
+# The fsync() call tells the Operating System to actually write data on disk
+# instead to wait for more data in the output buffer. Some OS will really flush
+# data on disk, some other OS will just try to do it ASAP.
+#
+# Redis supports three different modes:
+#
+# no: don't fsync, just let the OS flush the data when it wants. Faster.
+# always: fsync after every write to the append only log . Slow, Safest.
+# everysec: fsync only if one second passed since the last fsync. Compromise.
+#
+# The default is "everysec" that's usually the right compromise between
+# speed and data safety. It's up to you to understand if you can relax this to
+# "no" that will will let the operating system flush the output buffer when
+# it wants, for better performances (but if you can live with the idea of
+# some data loss consider the default persistence mode that's snapshotting),
+# or on the contrary, use "always" that's very slow but a bit safer than
+# everysec.
+#
+# If unsure, use "everysec".
+
+# appendfsync always
+# appendfsync everysec
+# appendfsync no
+appendfsync <%= appendfsync -%>
+
+# When the AOF fsync policy is set to always or everysec, and a background
+# saving process (a background save or AOF log background rewriting) is
+# performing a lot of I/O against the disk, in some Linux configurations
+# Redis may block too long on the fsync() call. Note that there is no fix for
+# this currently, as even performing fsync in a different thread will block
+# our synchronous write(2) call.
+#
+# In order to mitigate this problem it's possible to use the following option
+# that will prevent fsync() from being called in the main process while a
+# BGSAVE or BGREWRITEAOF is in progress.
+#
+# This means that while another child is saving the durability of Redis is
+# the same as "appendfsync none", that in pratical terms means that it is
+# possible to lost up to 30 seconds of log in the worst scenario (with the
+# default Linux settings).
+#
+# If you have latency problems turn this to "yes". Otherwise leave it as
+# "no" that is the safest pick from the point of view of durability.
+no-appendfsync-on-rewrite no
+
+################################ VIRTUAL MEMORY ###############################
+
+# Virtual Memory allows Redis to work with datasets bigger than the actual
+# amount of RAM needed to hold the whole dataset in memory.
+# In order to do so very used keys are taken in memory while the other keys
+# are swapped into a swap file, similarly to what operating systems do
+# with memory pages.
+#
+# To enable VM just set 'vm-enabled' to yes, and set the following three
+# VM parameters accordingly to your needs.
+
+# vm-enabled no
+# vm-enabled yes
+vm-enabled <%= vm_enabled %>
+
+# This is the path of the Redis swap file. As you can guess, swap files
+# can't be shared by different Redis instances, so make sure to use a swap
+# file for every redis process you are running. Redis will complain if the
+# swap file is already in use.
+#
+# The best kind of storage for the Redis swap file (that's accessed at random)
+# is a Solid State Disk (SSD).
+#
+# *** WARNING *** if you are using a shared hosting the default of putting
+# the swap file under /tmp is not secure. Create a dir with access granted
+# only to Redis user and configure Redis to create the swap file there.
+vm-swap-file <%= path -%>/redis.swap
+
+# vm-max-memory configures the VM to use at max the specified amount of
+# RAM. Everything that deos not fit will be swapped on disk *if* possible, that
+# is, if there is still enough contiguous space in the swap file.
+#
+# With vm-max-memory 0 the system will swap everything it can. Not a good
+# default, just specify the max amount of RAM you can in bytes, but it's
+# better to leave some margin. For instance specify an amount of RAM
+# that's more or less between 60 and 80% of your free RAM.
+# vm-max-memory 0
+vm-max-memory <%= vm_max_memory -%>
+
+# Redis swap files is split into pages. An object can be saved using multiple
+# contiguous pages, but pages can't be shared between different objects.
+# So if your page is too big, small objects swapped out on disk will waste
+# a lot of space. If you page is too small, there is less space in the swap
+# file (assuming you configured the same number of total swap file pages).
+#
+# If you use a lot of small objects, use a page size of 64 or 32 bytes.
+# If you use a lot of big objects, use a bigger page size.
+# If unsure, use the default :)
+vm-page-size 32
+
+# Number of total memory pages in the swap file.
+# Given that the page table (a bitmap of free/used pages) is taken in memory,
+# every 8 pages on disk will consume 1 byte of RAM.
+#
+# The total swap size is vm-page-size * vm-pages
+#
+# With the default of 32-bytes memory pages and 134217728 pages Redis will
+# use a 4 GB swap file, that will use 16 MB of RAM for the page table.
+#
+# It's better to use the smallest acceptable value for your application,
+# but the default is large in order to work in most conditions.
+vm-pages 134217728
+
+# Max number of VM I/O threads running at the same time.
+# This threads are used to read/write data from/to swap file, since they
+# also encode and decode objects from disk to memory or the reverse, a bigger
+# number of threads can help with big objects even if they can't help with
+# I/O itself as the physical device may not be able to couple with many
+# reads/writes operations at the same time.
+#
+# The special value of 0 turn off threaded I/O and enables the blocking
+# Virtual Memory implementation.
+vm-max-threads 4
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes
+
+# Hashes are encoded in a special way (much more memory efficient) when they
+# have at max a given numer of elements, and the biggest element does not
+# exceed a given threshold. You can configure this limits with the following
+# configuration directives.
+hash-max-zipmap-entries 64
+hash-max-zipmap-value 512
+
+# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
+# order to help rehashing the main Redis hash table (the one mapping top-level
+# keys to values). The hash table implementation redis uses (see dict.c)
+# performs a lazy rehashing: the more operation you run into an hash table
+# that is rhashing, the more rehashing "steps" are performed, so if the
+# server is idle the rehashing is never complete and some more memory is used
+# by the hash table.
+#
+# The default is to use this millisecond 10 times every second in order to
+# active rehashing the main dictionaries, freeing memory when possible.
+#
+# If unsure:
+# use "activerehashing no" if you have hard latency requirements and it is
+# not a good thing in your environment that Redis can reply form time to time
+# to queries with 2 milliseconds delay.
+#
+# use "activerehashing yes" if you don't have such hard requirements but
+# want to free memory asap when possible.
+activerehashing yes
+
+################################## INCLUDES ###################################
+
+# Include one or more other config files here.  This is useful if you
+# have a standard template that goes to all redis server but also need
+# to customize a few per-server settings.  Include files can include
+# other files, so use this wisely.
+#
+# include /path/to/local.conf
+# include /path/to/other.conf

data/test/config_test.rb

@@ -0,0 +1,76 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+setup { Redis.connect }
+
+def conf_value(data, key)
+ data[/^#{key}\s+(.*)$/, 1]
+end
+
+test "path assignment" do
+  c = Rprov::Config.generate
+  c.path = "/some/path/here/"
+
+  assert c.path == "/some/path/here"
+end
+
+test "url" do
+  c = Rprov::Config.generate
+
+  assert "redis://:#{c.password}@#{c.host}:#{c.port}" == c.url
+end
+
+test "generating" do |r|
+  config = Rprov::Config.generate
+
+  assert r.exists("rprov:config:#{config.key}")
+
+  pass, port = r.hmget("rprov:config:#{config.key}", :password, :port)
+
+  assert config.password == pass
+  assert config.port == port
+end
+
+test "generating with a specified key" do
+  config = Rprov::Config.generate("foobar")
+
+  assert config.key == "foobar"
+  assert config.password =~ /^[a-zA-Z0-9]{40}$/
+  assert config.port.to_i == Rprov::Config::STARTING_PORT
+end
+
+test "redis conf" do
+  config = Rprov::Config.generate
+  config.path = "/data/ferrari"
+
+  assert conf_value(config.redis_conf, :port) == config.port
+  assert conf_value(config.redis_conf, :requirepass) == config.password
+  assert conf_value(config.redis_conf, :dir) == "/data/ferrari"
+  assert conf_value(config.redis_conf, :pidfile) == "/data/ferrari/redis.pid"
+  assert conf_value(config.redis_conf, :logfile) == "/data/ferrari/redis.log"
+  assert conf_value(config.redis_conf, :bind) == "127.0.0.1"
+end
+
+test "safe mode" do
+  config = Rprov::Config.generate
+  config.path = "/data/ferrari"
+  config.paranoid = true
+
+  assert config.redis_conf =~ /^rename-command CONFIG [a-zA-Z0-9]{40}$/
+  assert config.redis_conf =~ /^rename-command SLAVEOF ""$/
+  assert config.redis_conf =~ /^rename-command BGREWRITEAOF ""$/
+  assert config.redis_conf =~ /^rename-command SHUTDOWN [a-zA-Z0-9]{40}$/
+  assert config.redis_conf =~ /^rename-command SAVE ""$/
+  assert config.redis_conf =~ /^rename-command BGSAVE ""$/
+end
+
+test "vm settings behavior" do
+  config = Rprov::Config.new("some_key")
+
+  # by default is disabled
+  assert config.vm_enabled == "no"
+
+  # setting max memory enables it
+  config.memory = "1gb"
+  assert config.vm_enabled == "yes"
+  assert config.vm_max_memory == "1gb"
+end

data/test/helper.rb

@@ -0,0 +1,66 @@
+require "cutest"
+require "stringio"
+
+$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+require "rprov"
+
+def TMP(*args)
+  File.join(File.dirname(__FILE__), "tmp", *args)
+end
+
+TMP = TMP()
+
+prepare do
+  FileUtils.rm_rf(TMP) if File.exist?(TMP)
+  FileUtils.mkdir_p(TMP)
+
+  redis = Redis.connect
+  redis.flushdb
+end
+
+# Since Kernel::exec transfers control to the external
+# program, we need to change Rprov#exec and use `` instead.
+
+class Rprov
+  def exec(cmd)
+    `#{cmd}`
+  end
+end
+
+module Cleanup
+  def test(*args, &block)
+    begin
+      super
+    rescue Exception => e
+      pids = `ps aux`.
+        split("\n").
+        grep(/redis-server \//).
+        map { |e| e.split(/\s+/)[1] }.
+        flatten
+
+      pids.each { |pid| Process.kill("TERM", pid.to_i) }
+
+      raise e
+    ensure
+      FileUtils.rm_rf(TMP)
+    end
+  end
+end
+
+include Cleanup
+
+class Cutest::Scope
+  include Cleanup
+end
+
+def silenced
+  stdout, $stdout = $stdout, StringIO.new
+
+  yield
+
+  $stdout.rewind && $stdout.read
+ensure
+  $stdout = stdout
+end
+alias :capture :silenced

data/test/rprov_test.rb

@@ -0,0 +1,205 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+setup do
+  [Redis.connect, Rprov.new]
+end
+
+def redis_conf(path = "redis.*.conf")
+  Dir[TMP(path)].first
+end
+
+def redis_conf_data
+  File.read(redis_conf)
+end
+
+def redis_conf_id(conf = redis_conf)
+  conf[/redis\.(.*?)\.conf/, 1]
+end
+
+def port_pass(redis)
+  redis.hmget("rprov:config:#{redis_conf_id}", :port, :password)
+end
+
+test "basic setup" do |redis, rprov|
+  silenced do
+    rprov.setup(TMP)
+  end
+
+  assert redis_conf
+  assert redis.exists("rprov:config:#{redis_conf_id}")
+end
+
+test "setup on a non existing directory" do |redis, rprov|
+  silenced do
+    rprov.setup(TMP("subdir"))
+  end
+
+  conf = redis_conf("subdir/redis.*.conf")
+
+  assert conf
+  assert redis.exists("rprov:config:#{redis_conf_id(conf)}")
+end
+
+test "setup with memory specification" do |redis, rprov|
+  silenced do
+    rprov.memory = "1gb"
+    rprov.setup(TMP)
+  end
+
+  assert redis_conf_data =~ /^vm-enabled yes$/
+  assert redis_conf_data =~ /^vm-max-memory 1gb$/
+end
+
+test "setup with host specification" do |redis, rprov|
+  silenced do
+    rprov.host = "test.server.com"
+    rprov.setup(TMP)
+  end
+
+  assert redis_conf_data =~ /^bind test.server.com$/
+end
+
+test "setting up on an already setup path" do |redis, rprov|
+  rprov.setup(TMP)
+
+  assert_raise Rprov::Conflict do
+    rprov.setup(TMP)
+  end
+
+  configs =
+    redis.keys("rprov:config:*").reject { |k|
+      k == "rprov:config:port"
+    }.size
+
+  assert configs == 1
+end
+
+# starting
+scope do
+  setup do
+    [Redis.connect, Rprov.new]
+  end
+
+  test "will setup when not existing" do |redis, rprov|
+    silenced do
+      rprov.setup(TMP)
+      rprov.start(TMP)
+    end
+
+    port, pass = port_pass(redis)
+
+    r = Redis.connect(:port => port, :password => pass)
+
+    assert r.set("foo", "bar")
+    assert r.get("foo") == "bar"
+
+    r.client.process(:shutdown)
+  end
+
+  test "running existing config" do |redis, rprov|
+    silenced do
+      rprov.setup(TMP)
+      rprov.start(TMP)
+    end
+
+    port, pass = port_pass(redis)
+
+    r = Redis.connect(:port => port, :password => pass)
+
+    assert r.set("foo", "bar")
+    assert r.get("foo") == "bar"
+
+    r.client.process(:shutdown)
+  end
+end
+
+# stopping
+scope do
+  setup do
+    [Redis.connect, Rprov.new]
+  end
+
+  test "start / stop" do |redis, rprov|
+    silenced do
+      rprov.setup(TMP)
+      rprov.start(TMP)
+    end
+
+    port, pass = port_pass(redis)
+
+    r = Redis.connect(:port => port, :password => pass)
+
+    r.set("foo", "bar")
+
+    rprov.stop(TMP)
+
+    foo =
+      begin
+        r.client.get("foo")
+      rescue
+      end
+
+    assert foo != "bar"
+  end
+
+  test "start / stop / start" do |redis, rprov|
+    silenced do
+      rprov.setup(TMP)
+      rprov.start(TMP)
+    end
+
+    port, pass = port_pass(redis)
+
+    r = Redis.connect(:port => port, :password => pass)
+
+    r.set("foo", "bar")
+
+    rprov.stop(TMP)
+
+    silenced do
+      rprov.start(TMP)
+    end
+
+    sleep 0.2
+
+    r = Redis.connect(:port => port, :password => pass)
+    assert r.get("foo") == "bar"
+
+    rprov.stop(TMP)
+  end
+end
+
+# info
+scope do
+  setup do
+    [Redis.connect, Rprov.new]
+  end
+
+  test "info" do |redis, rprov|
+    silenced do
+      rprov.setup(TMP)
+    end
+
+    out = capture { rprov.info(TMP) }
+
+    conf = Rprov::Config.new(redis_conf_id)
+
+    expected = (<<-EOT).gsub(/^ {4}/, "")
+
+    REDIS_URL:
+        #{conf.url}
+
+    Run `rprov start #{TMP}` to start this instance
+    EOT
+
+    assert expected == out
+  end
+
+  test "running info on a non-existent setup" do |redis, rprov|
+    assert ! redis_conf
+
+    assert_raise Rprov::Missing do
+      capture { rprov.info(TMP) }
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: rprov
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Cyril David
+- Michel Martens
+- Damian Janowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-03 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cutest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: |-
+  Rprov is a simple command line utility which helps
+                      you provision and manage Redis instances easily.
+email: 
+- cyx@pipetodevnull.com
+- michel@soveran.com
+- djanowski@dimaion.com
+executables: 
+- rprov
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rprov/config.rb
+- lib/rprov/decorator.rb
+- lib/rprov.rb
+- README
+- LICENSE
+- test/config_test.rb
+- test/helper.rb
+- test/rprov_test.rb
+- templates/redis.conf.erb
+- bin/rprov
+has_rdoc: true
+homepage: http://github.com/cyx/rprov
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 2
+summary: Redis Provisioning
+test_files: []
+