resque 0.2.0

data/tasks/redis.rake

@@ -0,0 +1,125 @@
+# Inspired by rabbitmq.rake the Redbox project at http://github.com/rick/redbox/tree/master
+require 'fileutils'
+require 'open-uri'
+
+class RedisRunner
+
+  def self.redisdir
+    "/tmp/redis/"
+  end
+
+  def self.redisconfdir
+    '/etc/redis.conf'
+  end
+
+  def self.dtach_socket
+    '/tmp/redis.dtach'
+  end
+
+  # Just check for existance of dtach socket
+  def self.running?
+    File.exists? dtach_socket
+  end
+
+  def self.start
+    puts 'Detach with Ctrl+\  Re-attach with rake redis:attach'
+    sleep 1
+    exec "dtach -A #{dtach_socket} redis-server #{redisconfdir}"
+  end
+
+  def self.attach
+    exec "dtach -a #{dtach_socket}"
+  end
+
+  def self.stop
+    sh 'echo "SHUTDOWN" | nc localhost 6379'
+  end
+
+end
+
+namespace :redis do
+
+  desc 'About redis'
+  task :about do
+    puts "\nSee http://code.google.com/p/redis/ for information about redis.\n\n"
+  end
+
+  desc 'Start redis'
+  task :start do
+    RedisRunner.start
+  end
+
+  desc 'Stop redis'
+  task :stop do
+    RedisRunner.stop
+  end
+
+  desc 'Restart redis'
+  task :restart do
+    RedisRunner.stop
+    RedisRunner.start
+  end
+
+  desc 'Attach to redis dtach socket'
+  task :attach do
+    RedisRunner.attach
+  end
+
+  desc 'Install the lastest verison of Redis from Github (requires git, duh)'
+  task :install => [:about, :download, :make] do
+    %w(redis-benchmark redis-cli redis-server).each do |bin|
+      sh "sudo cp /tmp/redis/#{bin} /usr/bin/"
+    end
+
+    puts "Installed redis-benchmark, redis-cli and redis-server to /usr/bin/"
+
+    unless File.exists?('/etc/redis.conf')
+      sh 'sudo cp /tmp/redis/redis.conf /etc/'
+      puts "Installed redis.conf to /etc/ \n You should look at this file!"
+    end
+  end
+
+  task :make do
+    sh "cd #{RedisRunner.redisdir} && make clean"
+    sh "cd #{RedisRunner.redisdir} && make"
+  end
+
+  desc "Download package"
+  task :download do
+    sh 'rm -rf /tmp/redis/' if File.exists?("#{RedisRunner.redisdir}/.svn")
+    sh 'git clone git://github.com/antirez/redis.git /tmp/redis' unless File.exists?(RedisRunner.redisdir)
+    sh "cd #{RedisRunner.redisdir} && git pull" if File.exists?("#{RedisRunner.redisdir}/.git")
+  end
+
+end
+
+namespace :dtach do
+
+  desc 'About dtach'
+  task :about do
+    puts "\nSee http://dtach.sourceforge.net/ for information about dtach.\n\n"
+  end
+
+  desc 'Install dtach 0.8 from source'
+  task :install => [:about] do
+
+    Dir.chdir('/tmp/')
+    unless File.exists?('/tmp/dtach-0.8.tar.gz')
+      require 'net/http'
+
+      url = 'http://downloads.sourceforge.net/project/dtach/dtach/0.8/dtach-0.8.tar.gz'
+      open('/tmp/dtach-0.8.tar.gz', 'wb') do |file| file.write(open(url).read) end
+    end
+
+    unless File.directory?('/tmp/dtach-0.8')
+      system('tar xzf dtach-0.8.tar.gz')
+    end
+
+    Dir.chdir('/tmp/dtach-0.8/')
+    sh 'cd /tmp/dtach-0.8/ && ./configure && make'
+    sh 'sudo cp /tmp/dtach-0.8/dtach /usr/bin/'
+
+    puts 'Dtach successfully installed to /usr/bin.'
+  end
+end
+

data/tasks/resque.rake

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'resque/tasks'

data/test/redis-test.conf

@@ -0,0 +1,132 @@
+# Redis configuration file example
+
+# 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 run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./test/redis-test.pid
+
+# Accept connections on the specified port, default is 6379
+port 9736
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# 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
+save 900 1
+save 300 10
+save 60 10000
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./test/
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon 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 stdout
+
+# 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
+
+################################# 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>
+
+################################## 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).
+
+# requirepass foobared
+
+################################### 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 limts.
+# 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>
+
+############################### 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
+
+# Use object sharing. Can save a lot of memory if you have many common
+# string in your dataset, but performs lookups against the shared objects
+# pool so it uses more CPU and can be a bit slower. Usually it's a good
+# idea.
+#
+# When object sharing is enabled (shareobjects yes) you can use
+# shareobjectspoolsize to control the size of the pool used in order to try
+# object sharing. A bigger pool size will lead to better sharing capabilities.
+# In general you want this value to be at least the double of the number of
+# very common strings you have in your dataset.
+#
+# WARNING: object sharing is experimental, don't enable this feature
+# in production before of Redis 1.0-stable. Still please try this feature in
+# your development environment so that we can test it better.
+shareobjects no
+shareobjectspoolsize 1024

data/test/resque_test.rb

@@ -0,0 +1,160 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+context "Resque" do
+  setup do
+    Resque.redis.flush_all
+
+    Resque.push(:people, { 'name' => 'chris' })
+    Resque.push(:people, { 'name' => 'bob' })
+    Resque.push(:people, { 'name' => 'mark' })
+  end
+
+  test "can put jobs on a queue" do
+    assert Resque::Job.create(:jobs, 'SomeJob', 20, '/tmp')
+    assert Resque::Job.create(:jobs, 'SomeJob', 20, '/tmp')
+  end
+
+  test "can grab jobs off a queue" do
+    Resque::Job.create(:jobs, 'some-job', 20, '/tmp')
+
+    job = Resque.reserve(:jobs)
+
+    assert_kind_of Resque::Job, job
+    assert_equal SomeJob, job.payload_class
+    assert_equal 20, job.args[0]
+    assert_equal '/tmp', job.args[1]
+  end
+
+  test "can put jobs on a queue by way of an ivar" do
+    assert_equal 0, Resque.size(:ivar)
+    assert Resque.enqueue(SomeIvarJob, 20, '/tmp')
+    assert Resque.enqueue(SomeIvarJob, 20, '/tmp')
+
+    job = Resque.reserve(:ivar)
+
+    assert_kind_of Resque::Job, job
+    assert_equal SomeIvarJob, job.payload_class
+    assert_equal 20, job.args[0]
+    assert_equal '/tmp', job.args[1]
+
+    assert Resque.reserve(:ivar)
+    assert_equal nil, Resque.reserve(:ivar)
+  end
+
+  test "jobs have a nice #inspect" do
+    assert Resque::Job.create(:jobs, 'SomeJob', 20, '/tmp')
+    job = Resque.reserve(:jobs)
+    assert_equal '(Job{jobs} | SomeJob | [20, "/tmp"])', job.inspect
+  end
+
+  test "can put jobs on a queue by way of a method" do
+    assert_equal 0, Resque.size(:method)
+    assert Resque.enqueue(SomeMethodJob, 20, '/tmp')
+    assert Resque.enqueue(SomeMethodJob, 20, '/tmp')
+
+    job = Resque.reserve(:method)
+
+    assert_kind_of Resque::Job, job
+    assert_equal SomeMethodJob, job.payload_class
+    assert_equal 20, job.args[0]
+    assert_equal '/tmp', job.args[1]
+
+    assert Resque.reserve(:method)
+    assert_equal nil, Resque.reserve(:method)
+  end
+
+  test "needs to infer a queue with enqueue" do
+    assert_raises Resque::NoQueueError do
+      Resque.enqueue(SomeJob, 20, '/tmp')
+    end
+  end
+
+  test "can put items on a queue" do
+    assert Resque.push(:people, { 'name' => 'jon' })
+  end
+
+  test "can pull items off a queue" do
+    assert_equal({ 'name' => 'chris' }, Resque.pop(:people))
+    assert_equal({ 'name' => 'bob' }, Resque.pop(:people))
+    assert_equal({ 'name' => 'mark' }, Resque.pop(:people))
+    assert_equal nil, Resque.pop(:people)
+  end
+
+  test "knows how big a queue is" do
+    assert_equal 3, Resque.size(:people)
+
+    assert_equal({ 'name' => 'chris' }, Resque.pop(:people))
+    assert_equal 2, Resque.size(:people)
+
+    assert_equal({ 'name' => 'bob' }, Resque.pop(:people))
+    assert_equal({ 'name' => 'mark' }, Resque.pop(:people))
+    assert_equal 0, Resque.size(:people)
+  end
+
+  test "can peek at a queue" do
+    assert_equal({ 'name' => 'chris' }, Resque.peek(:people))
+    assert_equal 3, Resque.size(:people)
+  end
+
+  test "can peek multiple items on a queue" do
+    assert_equal({ 'name' => 'bob' }, Resque.peek(:people, 1, 1))
+
+    assert_equal([{ 'name' => 'bob' }, { 'name' => 'mark' }], Resque.peek(:people, 1, 2))
+    assert_equal([{ 'name' => 'chris' }, { 'name' => 'bob' }], Resque.peek(:people, 0, 2))
+    assert_equal([{ 'name' => 'chris' }, { 'name' => 'bob' }, { 'name' => 'mark' }], Resque.peek(:people, 0, 3))
+    assert_equal({ 'name' => 'mark' }, Resque.peek(:people, 2, 1))
+    assert_equal nil, Resque.peek(:people, 3)
+    assert_equal [], Resque.peek(:people, 3, 2)
+  end
+
+  test "knows what queues it is managing" do
+    assert_equal %w( people ), Resque.queues
+    Resque.push(:cars, { 'make' => 'bmw' })
+    assert_equal %w( cars people ), Resque.queues
+  end
+
+  test "queues are always a list" do
+    Resque.redis.flush_all
+    assert_equal [], Resque.queues
+  end
+
+  test "keeps track of resque keys" do
+    assert_equal ["queue:people", "queues"], Resque.keys
+  end
+
+  test "badly wants a class name, too" do
+    assert_raises Resque::NoClassError do
+      Resque::Job.create(:jobs, nil)
+    end
+  end
+
+  test "keeps stats" do
+    Resque::Job.create(:jobs, SomeJob, 20, '/tmp')
+    Resque::Job.create(:jobs, BadJob)
+    Resque::Job.create(:jobs, GoodJob)
+
+    Resque::Job.create(:others, GoodJob)
+    Resque::Job.create(:others, GoodJob)
+
+    stats = Resque.info
+    assert_equal 8, stats[:pending]
+
+    @worker = Resque::Worker.new(:jobs)
+    @worker.register_worker
+    2.times { @worker.process }
+    job = @worker.reserve
+    @worker.working_on job
+
+    stats = Resque.info
+    assert_equal 1, stats[:working]
+    assert_equal 1, stats[:workers]
+
+    @worker.done_working
+
+    stats = Resque.info
+    assert_equal 3, stats[:queues]
+    assert_equal 3, stats[:processed]
+    assert_equal 1, stats[:failed]
+    assert_equal ['localhost:9736'], stats[:servers]
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,90 @@
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+$TESTING = true
+require 'test/unit'
+require 'rubygems'
+require 'resque'
+
+
+#
+# make sure we can run redis
+#
+
+if `which redis-server`.chomp.empty?
+  puts '', "** can't find `redis-server` in your path"
+  puts "** try running `sudo rake install`"
+  abort ''
+end
+
+
+#
+# start our own redis when the tests start,
+# kill it when they end
+#
+
+at_exit do
+  unless $! || Test::Unit.run?
+    status = Test::Unit::AutoRunner.run
+    pid = `ps -e -o pid,command | grep [r]edis-test`.split(" ")[0]
+    puts "Killing test redis server..."
+    `rm -f #{dir}/dump.rdb`
+    Process.kill("KILL", pid.to_i)
+    exit status
+  end
+end
+
+puts "Starting redis for testing at localhost:9736..."
+`redis-server #{dir}/redis-test.conf`
+Resque.redis = 'localhost:9736'
+
+
+##
+# test/spec/mini 2
+# http://gist.github.com/25455
+# chris@ozmm.org
+#
+def context(*args, &block)
+  return super unless (name = args.first) && block
+  require 'test/unit'
+  klass = Class.new(defined?(ActiveSupport::TestCase) ? ActiveSupport::TestCase : Test::Unit::TestCase) do
+    def self.test(name, &block)
+      define_method("test_#{name.gsub(/\W/,'_')}", &block) if block
+    end
+    def self.xtest(*args) end
+    def self.setup(&block) define_method(:setup, &block) end
+    def self.teardown(&block) define_method(:teardown, &block) end
+  end
+  klass.class_eval &block
+end
+
+
+#
+# fixture classes
+#
+
+class SomeJob
+  def self.perform(repo_id, path)
+  end
+end
+
+class SomeIvarJob < SomeJob
+  @queue = :ivar
+end
+
+class SomeMethodJob < SomeJob
+  def self.queue
+    :method
+  end
+end
+
+class BadJob
+  def self.perform
+    raise "Bad job!"
+  end
+end
+
+class GoodJob
+  def self.perform(name)
+    "Good job, #{name}"
+  end
+end