trinidad_resque_extension 0.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in test_gem.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    trinidad_resque_extension (0.1.0)
+      rake
+      resque
+      trinidad
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    jruby-rack (1.0.7)
+    json (1.4.6-java)
+    mocha (0.9.12)
+    rack (1.2.2)
+    rake (0.8.7)
+    redis (2.1.1)
+    redis-namespace (0.10.0)
+      redis (< 3.0.0)
+    resque (1.15.0)
+      json (~> 1.4.6)
+      redis-namespace (>= 0.10.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    sinatra (1.2.0)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    tilt (1.2.2)
+    trinidad (1.1.0)
+      jruby-rack (>= 1.0.6)
+      trinidad_jars (>= 1.0.0)
+    trinidad_jars (1.0.1)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  mocha
+  rspec
+  trinidad_resque_extension!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David Calavera
+
+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,57 @@
+Trinidad resque extension
+-------------------------
+
+Extension to initialize resque as a process under Trinidad's control and integrate resque's console. 
+When Trinidad starts up it also starts the resque's workers and the console up.
+
+http://github.com/defunkt/resque
+
+Installation
+============
+
+jruby -S gem install trinidad_resque_extension
+
+Configuration
+=============
+
+Any of the configuration options that resque needs can be specified in the trinidad's configuration file:
+
+<pre>
+---
+  extensions:
+    resque:
+      queues: critical, normal, low   # resque workers
+      count:  354                     # number of resque processes, by default 1
+      redis_host: 'localhost:6379'    # where redis is running
+</pre>
+
+By default, trinidad creates a worker called `trinidad_resque` if we don't
+specify anyone, so we can configure the extension through the command line
+with all the default options:
+
+<pre>$ jruby -S trinidad -l resque</pre>
+
+The resque console is deployed on /resque but we can disable it with the
+option `disable_web`:
+
+<pre>
+---
+ extensions:
+   resque:
+     disable_web: true
+</pre>
+
+The extension tries to load the tasks from the directory `lib/tasks` but
+this parameter can be overrided with the option `path`:
+
+<pre>
+---
+  extensions:
+    resque:
+      path: 'tasks_dir'
+</pre>
+
+Copyright
+=========
+
+Copyright (c) 2011 David Calavera <calavera@apache.org>. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,115 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--color', "--format documentation"]
+end
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+#
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "release a version"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push --tags"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "build gem"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "install gem"
+task :install => :build do
+  sh "gem install pkg/#{name}-#{version}.gem"
+end
+
+task :gemspec do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg|src|git-hooks)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end

data/lib/resque_ext.rb

@@ -0,0 +1,11 @@
+require 'resque'
+
+module Resque
+  class Worker
+    # if we let resque trap signals trinidad cannot ever be stopped
+    alias :old_register_signal_handlers :register_signal_handlers
+
+    def register_signal_handlers
+    end
+  end
+end

data/lib/resque_lifecycle_listener.rb

@@ -0,0 +1,69 @@
+require File.expand_path('../resque_ext', __FILE__)
+
+module Trinidad
+  module Extensions
+    module Resque
+      require 'rake'
+      require 'resque/tasks'
+
+      class ResqueLifecycleListener
+        include Trinidad::Tomcat::LifecycleListener
+
+        def initialize(options)
+          @options = options
+        end
+
+        def lifecycle_event(event)
+          case event.type
+          when Trinidad::Tomcat::Lifecycle::BEFORE_START_EVENT
+            start_workers
+          when Trinidad::Tomcat::Lifecycle::BEFORE_STOP_EVENT
+            stop_workers
+          end
+        end
+
+        def start_workers
+          Thread.new do
+            load_tasks
+            task = configure_workers
+            invoke_workers task
+          end
+        end
+
+        def load_tasks
+          Dir.glob(File.join(@options[:path], '**', '*.rb')).each do |path|
+            load path
+          end
+        end
+
+        def configure_workers
+          task = 'resque:work'
+
+          if @options[:count]
+            ENV['COUNT'] = @options[:count].to_s
+            task = 'resque:workers'
+          end
+
+          ENV['QUEUES'] ||= @options[:queues]
+
+          ::Resque.redis = @options[:redis_host]
+
+          load @options[:setup] if @options[:setup]
+          task
+        end
+
+        def invoke_workers(task)
+          Rake::Task[task].invoke
+        rescue Errno::ECONNREFUSED
+          puts "WARN: Cannot connect with Redis. Please restart the server when Redis is up again."
+          @redis_econnref = true
+        end
+
+        def stop_workers
+          return if @redis_econnref # double check redis is connected, otherwise return
+          ::Resque.workers.each { |w| w.shutdown! }
+        end
+      end
+    end
+  end
+end

data/lib/trinidad_resque_extension.rb

@@ -0,0 +1,82 @@
+module Trinidad
+  module Extensions
+    require File.expand_path('../resque_lifecycle_listener', __FILE__)
+    module Resque
+      VERSION = '0.1.0'
+    end
+
+    class ResqueApp < Trinidad::RackupWebApp
+      def init_params
+        super
+        add_parameter_unless_exist 'rackup', "require 'rubygems';require 'resque';require 'resque/server';run Resque::Server.new"
+        @params
+      end
+    end
+
+    class ResqueServerExtension < ServerExtension
+      attr_accessor :options
+
+      def initialize(options)
+        super
+        @options[:redis_host] ||= 'localhost:6379'
+        @options[:queues] ||= 'trinidad_resque'
+        @options[:path] ||= File.join('lib', 'tasks')
+      end
+
+      def configure(tomcat)
+        add_resque_listener(tomcat)
+
+        init_resque_web(tomcat) unless @options[:disable_web]
+
+        trap_signals(tomcat)
+      end
+
+      def add_resque_listener(tomcat)
+        tomcat.host.add_lifecycle_listener(Trinidad::Extensions::Resque::ResqueLifecycleListener.new(@options))
+      end
+
+      def init_resque_web(tomcat)
+        opts = prepare_options
+
+        app_context = tomcat.addWebapp(opts[:context_path], opts[:web_app_dir])
+
+        web_app = ResqueApp.new({}, opts)
+
+        app_context.add_lifecycle_listener(Trinidad::Lifecycle::Default.new(web_app))
+        web_app
+      end
+
+      def prepare_options
+        # where resque gem is
+        resque_path = Gem::GemPathSearcher.new.find('resque').full_gem_path
+
+        opts = {
+          :context_path => '/resque',
+          :jruby_min_runtimes => 1,
+          :jruby_max_runtimes => 2,
+          :libs_dir => 'libs',
+          :classes_dir => 'classes',
+          :public => 'public',
+          :environment => 'production'
+        }
+
+        opts.deep_merge!(@options)
+        opts[:web_app_dir] = File.expand_path('lib/resque/server', resque_path)
+        opts
+      end
+
+      def trap_signals(tomcat)
+        # trap signals and stop tomcat properly to make sure resque is also stopped properly
+        trap('INT') { tomcat.stop }
+        trap('TERM') { tomcat.stop }
+      end
+    end
+
+    class ResqueOptionsExtension < OptionsExtension
+      def configure(parser, default_options)
+        default_options[:extensions] ||= {}
+        default_options[:extensions][:resque] = {}
+      end
+    end
+  end
+end

data/spec/resque_lifecycle_listener_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe "Trinidad::Extensions::Resque::ResqueLifecycleListener" do
+  R = Trinidad::Extensions::Resque::ResqueLifecycleListener
+
+  it "configures workers with the task 'resque:work'" do
+    task = configure_with_opts({})
+    task.should == 'resque:work'
+  end
+
+  it "sets the name of the queues in the environment variable" do
+    configure_with_opts({:queues => 'test'})
+    ENV['QUEUES'].should == 'test'
+  end
+
+  it "sets the redis host name" do
+    r = ::Resque.expects(:"redis=").with('localhost:6359')
+    configure_with_opts({:redis_host => 'localhost:6359'})
+  end
+
+  it "sets the number of workers with the option :count" do
+    task = configure_with_opts({:count => 3})
+    ENV['COUNT'].should == '3'
+    task.should == 'resque:workers'
+  end
+
+  it "loads the setup script with the option :setup" do
+    configure_with_opts({:setup => File.expand_path('../resque_test_setup.rb', __FILE__)})
+    Rake::Task['test:setup'].should be_instance_of(Rake::Task)
+  end
+
+  it "invokes the rake task given its name" do
+    Rake::Task.any_instance.expects(:invoke)
+    listener = R.new({})
+    listener.invoke_workers('resque:work')
+  end
+
+  it "does not try to shut the workers down when it could not connect with Redis" do
+    Rake::Task.any_instance.expects(:invoke).raises(Errno::ECONNREFUSED)
+    ::Resque.expects(:workers).never
+
+    listener = R.new({})
+    listener.invoke_workers('resque:work')
+    listener.stop_workers
+  end
+
+  it "invokes the shutdown! method for each worker before stopping the host" do
+    m = mock
+    m.expects(:shutdown!)
+    ::Resque.expects(:workers).returns([m])
+
+    listener = R.new({})
+    listener.stop_workers
+  end
+
+  def configure_with_opts(options)
+    listener = R.new(options)
+    listener.configure_workers
+  end
+end

data/spec/resque_test_setup.rb

@@ -0,0 +1,4 @@
+namespace :test do
+  task :setup do
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'trinidad'
+require 'trinidad_resque_extension'
+require 'mocha'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

data/spec/trinidad_resque_extension_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe "Trinidad::Extensions::ResqueServerExtension" do
+  subject { Trinidad::Extensions::ResqueServerExtension.new({}) }
+  let(:tomcat) { Trinidad::Tomcat::Tomcat.new }
+
+  context "without user options" do
+    it "uses localhost:6379 as default redis installation" do
+      subject.options[:redis_host].should == 'localhost:6379'
+    end
+
+    it "adds a default queue called 'trinidad_resque'" do
+      subject.options[:queues].should == 'trinidad_resque'
+    end
+
+    it "enables the reque console" do
+      subject.options[:disable_web].should be_nil
+    end
+  end
+
+  it "add the resque listener to the tomcat's default host" do
+    subject.add_resque_listener tomcat
+    tomcat.host.find_lifecycle_listeners.should have(1).listener
+  end
+
+  it "creates an application context for the resque console" do
+    context = find_resque_web
+    context.should be_instance_of(Trinidad::Tomcat::StandardContext)
+  end
+
+  it "does not create the application context when the option :disable_web is true" do
+    e = Trinidad::Extensions::ResqueServerExtension.new({:disable_web => true})
+    e.configure tomcat
+    tomcat.host.find_child('/resque').should be_nil
+  end
+
+  it "uses the rackup parameter to start the application" do
+    find_web_app.init_params['rackup'].should =~ /Resque::Server.new/
+  end
+
+  it "uses resque gem directory as application base directory" do
+    resque_path = Gem::GemPathSearcher.new.find('resque').full_gem_path
+    find_web_app.web_app_dir.should =~ /^#{resque_path}/
+  end
+
+  def find_resque_web
+    subject.init_resque_web tomcat
+    tomcat.host.find_child('/resque')
+  end
+
+  def find_web_app
+    context = find_resque_web
+    listener = context.find_lifecycle_listeners.select {|l| l.is_a? Trinidad::Lifecycle::Default }.first
+    listener.webapp
+  end
+end

data/trinidad_resque_extension.gemspec

@@ -0,0 +1,77 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'trinidad_resque_extension'
+  s.version           = '0.1.0'
+  s.date              = '2011-04-01'
+  s.rubyforge_project = 'trinidad_resque_extension'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Trinidad resque extension"
+  s.description = "Trinidad extension to autoconfigure and launch Resque"
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["David Calavera"]
+  s.email    = 'calavera@apache.org'
+  s.homepage = 'http://github.com/trinidad/trinidad_resque_extension'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('rake')
+  s.add_dependency('trinidad')
+  s.add_dependency('resque')
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('mocha')
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    Gemfile.lock
+    LICENSE
+    README.md
+    Rakefile
+    lib/resque_ext.rb
+    lib/resque_lifecycle_listener.rb
+    lib/trinidad_resque_extension.rb
+    spec/resque_lifecycle_listener_spec.rb
+    spec/resque_test_setup.rb
+    spec/spec.opts
+    spec/spec_helper.rb
+    spec/trinidad_resque_extension_spec.rb
+    trinidad_resque_extension.gemspec
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^spec\/.*_spec\.rb/ }
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: trinidad_resque_extension
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+  - David Calavera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-01 00:00:00 -07:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: trinidad
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: resque
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: mocha
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id005
+description: Trinidad extension to autoconfigure and launch Resque
+email: calavera@apache.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - README.md
+  - LICENSE
+files: 
+  - Gemfile
+  - Gemfile.lock
+  - LICENSE
+  - README.md
+  - Rakefile
+  - lib/resque_ext.rb
+  - lib/resque_lifecycle_listener.rb
+  - lib/trinidad_resque_extension.rb
+  - spec/resque_lifecycle_listener_spec.rb
+  - spec/resque_test_setup.rb
+  - spec/spec.opts
+  - spec/spec_helper.rb
+  - spec/trinidad_resque_extension_spec.rb
+  - trinidad_resque_extension.gemspec
+has_rdoc: true
+homepage: http://github.com/trinidad/trinidad_resque_extension
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --charset=UTF-8
+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: trinidad_resque_extension
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 2
+summary: Trinidad resque extension
+test_files: 
+  - spec/resque_lifecycle_listener_spec.rb
+  - spec/trinidad_resque_extension_spec.rb