modern_times 0.1.2 → 0.2.0

data/README.rdoc

@@ -4,11 +4,20 @@
 
 == Description:
 
-JRuby library for performing background tasks via the hornetq messaging library.
+JRuby library for performing background tasks via JMS.
+
+Very much alpha stage at this point.
 
 == Features/Problems:
 
-* TBD
+* Ruby marshaling doesn't work
+* jms_test doesn't exit
+* jms_requestor needs testing for dummy requesting
+* Allow options (durable queues, etc)
+* Railsable needs testing
+* Fail options (fail queues, etc.)
+* Return exception for jms_requestor
+* Currently tested only for ActiveMQ
 
 == Install:
 
@@ -16,27 +25,30 @@ JRuby library for performing background tasks via the hornetq messaging library.
 
 == Rails Usage:
 
-Create config/hornetq.yml which might look as follows:
+TODO: This section needs updating for JMS
+
+Create config/jms.yml which might look as follows:
 
     development:
       :connection: hornetq://invm
 
     production:
       :connection:
-        :uri: hornetq://msg1,msg2
-        :failover_on_initial_connection: true
-        :failover_on_server_shutdown: true
-        # 5 Connection attempts takes about 16 seconds before it switches to the backup server
-        :reconnect_attempts: 5
+        :factory: org.apache.activemq.ActiveMQConnectionFactory
+        :broker_url: tcp://msghost:61616
+        :require_jars:
+          - <%= Dir.glob("#{ENV['ACTIVEMQ_HOME']}/activemq-all-*.jar")[0] %>
+          - <%= Dir.glob("#{ENV['ACTIVEMQ_HOME']}/lib/optional/slf4j-log4j*.jar")[0] %>
+          - <%= Dir.glob("#{ENV['ACTIVEMQ_HOME']}/lib/optional/log4j-*.jar")[0] %>
       :session:
-        :username: mycluster_username
-        :password: mycluster_password
+        :username: myuser
+        :password: mypassword
 
 In config/environment.rb, add the following lines:
 
     ModernTimes.init_rails
     # Publishers can be defined wherever appropriate
-    $foo_publisher = ModernTimes::HornetQ::Publisher.new('Foo')
+    $foo_publisher = ModernTimes::JMS::Publisher.new('Foo')
 
 In your code, queue foo objects:
 
@@ -136,7 +148,7 @@ I'm a Chaplin fan.
 
 == Author
 
-Brad Pardee, Reid Morrison
+Brad Pardee
 
 == Copyright
 

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'rake'
+require 'rake/testtask'
 
 begin
   require 'jeweler'
@@ -10,9 +11,8 @@ begin
     gemspec.authors = ['Brad Pardee', 'Reid Morrison']
     gemspec.email = ['bradpardee@gmail.com', 'rubywmq@gmail.com']
     gemspec.homepage = 'http://github.com/ClarityServices/modern_times'
-    gemspec.add_dependency 'jruby-hornetq', ['>= 0.3.3']
+    gemspec.add_dependency 'jruby-jms', ['>= 0.11.0']
     gemspec.add_dependency 'jmx',  ['>= 0.6']
-    gemspec.add_dependency 'json'
   end
 rescue LoadError
   puts 'Jeweler not available. Install it with: gem install jeweler'

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/examples/README

@@ -0,0 +1,4 @@
+In order to run the examples, you might need to modify the jms.yml file
+in this directory.  Also, you may have to set the enviroment variable
+ACTIVEMQ_HOME in order to run with no jms.yml file changes.  Refer to
+the jruby-jms project for more options for the jms.yml file.

data/examples/jms.yml

@@ -0,0 +1,9 @@
+:factory: org.apache.activemq.ActiveMQConnectionFactory
+:broker_url: tcp://localhost:61616
+:require_jars:
+  - <%= Dir.glob("#{ENV['ACTIVEMQ_HOME']}/activemq-all-*.jar")[0] %>
+  #Uncomment the following for 5.5 version
+  #- <%= Dir.glob("#{ENV['ACTIVEMQ_HOME']}/lib/optional/slf4j-log4j*.jar")[0] %>
+  #- <%= Dir.glob("#{ENV['ACTIVEMQ_HOME']}/lib/optional/log4j-*.jar")[0] %>
+#:username: myuser
+#:password: mypassword

data/examples/requestor/README

@@ -1,6 +1,8 @@
+# Step 0
+# Follow the directions for configuring jms.yml located in examples/README
+
 # Step 1
-# Start a hornetq server (gem install jruby-hornetq if necessary)
-hornetq_server hornetq.yml server
+# Start an ActiveMQ Server
 
 # Step 2
 # Start up the manager

data/examples/requestor/manager.rb

@@ -2,12 +2,13 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
 
 require 'rubygems'
+require 'erb'
 require 'modern_times'
 require 'yaml'
 require 'reverse_echo_worker'
 
-config = YAML.load_file('hornetq.yml')
-ModernTimes::HornetQ::Client.init(config['client'])
+config = YAML.load(ERB.new(File.read(File.join(File.dirname(__FILE__), '..', 'jms.yml'))).result(binding))
+ModernTimes::JMS::Connection.init(config)
 
 manager = ModernTimes::Manager.new
 manager.stop_on_signal

data/examples/requestor/request.rb

@@ -2,6 +2,7 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
 
 require 'rubygems'
+require 'erb'
 require 'modern_times'
 require 'yaml'
 require 'reverse_echo_worker'
@@ -16,9 +17,9 @@ $timeout     = (ARGV[1] || 4).to_f
 $sleep_time  = (ARGV[2] || 2).to_i
 $sim_count   = (ARGV[3] || 1).to_i
 
-config = YAML.load_file('hornetq.yml')
-ModernTimes::HornetQ::Client.init(config['client'])
-$requestor = ModernTimes::HornetQRequestor::Requestor.new(ReverseEchoWorker.address_name, :marshal => :string)
+config = YAML.load(ERB.new(File.read(File.join(File.dirname(__FILE__), '..', 'jms.yml'))).result(binding))
+ModernTimes::JMS::Connection.init(config)
+$requestor = ModernTimes::JMSRequestor::Requestor.new(:queue_name => ReverseEchoWorker.default_name, :marshal => :string)
 
 def make_request(ident='')
   puts "#{ident}Making request at #{Time.now.to_f}"
@@ -29,7 +30,7 @@ def make_request(ident='')
   response = handle.read_response
   puts "#{ident}Received at #{Time.now.to_f}: #{response}"
 rescue Exception => e
-  puts "#{ident}Exception: #{e.message}"
+  puts "#{ident}Exception: #{e.message}\n\t#{e.backtrace.join("\n\t")}"
 end
 
 if $sim_count == 1

data/examples/requestor/reverse_echo_worker.rb

@@ -1,5 +1,6 @@
-class ReverseEchoWorker < ModernTimes::HornetQRequestor::Worker
-  include ModernTimes::HornetQ::MarshalStrategy::String
+class ReverseEchoWorker
+  include ModernTimes::JMSRequestor::Worker
+  marshal :string
   
   def request(obj)
     puts "#{self}: Received #{obj} at #{Time.now}"

data/examples/simple/README

@@ -1,9 +1,12 @@
+# Step 0
+# Follow the directions for configuring jms.yml located in examples/README
+
 # Step 1
-# Start a hornetq server (gem install jruby-hornetq if necessary)
-hornetq_server hornetq.yml server
+# Start a JMS Server
 
 # Step 2
 # Start up the manager
+rm -f modern_times.state
 jruby manager.rb
 
 # Step 3
@@ -11,8 +14,8 @@ jruby manager.rb
 # Attach to the manager process
 # Go to the MBeans tab
 # Open up the tree to ModernTimes => Manager => Operations => start_worker
-# Enter BarWorker for worker and 2 for count and click the start_worker button
-# Enter BazWorker for worker and 3 for count and click the start_worker button
+# Enter BarWorker for worker, 2 for count, clear the options field, and click the start_worker button.
+# Enter BazWorker for worker, 3 for count, clear the options field, and click the start_worker button.
 
 # Step 4
 # Publish 10 messages to the BarWorker and 20 to the BazWorker

data/examples/simple/bar_worker.rb

@@ -1,4 +1,7 @@
-class BarWorker < ModernTimes::HornetQ::Worker
+class BarWorker
+  include ModernTimes::JMS::Worker
+  marshal :bson
+
   def perform(obj)
     puts "#{self}: Received #{obj.inspect} at #{Time.now}"
     sleep 5

data/examples/simple/baz_worker.rb

@@ -1,6 +1,7 @@
-class BazWorker < ModernTimes::HornetQ::Worker
-  include ModernTimes::HornetQ::MarshalStrategy::String
-  
+class BazWorker 
+  include ModernTimes::JMS::Worker
+  marshal :string
+
   def perform(obj)
     puts "#{self}: Received #{obj} at #{Time.now}"
     sleep 10

data/examples/simple/manager.rb

@@ -2,13 +2,14 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
 
 require 'rubygems'
+require 'erb'
 require 'modern_times'
 require 'yaml'
 require 'bar_worker'
 require 'baz_worker'
 
-config = YAML.load_file('hornetq.yml')
-ModernTimes::HornetQ::Client.init(config['client'])
+config = YAML.load(ERB.new(File.read(File.join(File.dirname(__FILE__), '..', 'jms.yml'))).result(binding))
+ModernTimes::JMS::Connection.init(config)
 
 manager = ModernTimes::Manager.new(:persist_file => 'modern_times.state')
 manager.stop_on_signal

data/examples/simple/publish.rb

@@ -2,6 +2,7 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
 
 require 'rubygems'
+require 'erb'
 require 'modern_times'
 require 'yaml'
 require 'bar_worker'
@@ -15,13 +16,13 @@ bar_count = ARGV[0].to_i
 baz_count = ARGV[1].to_i
 sleep_time = (ARGV[2] || 0.2).to_f
 
-config = YAML.load_file('hornetq.yml')
-ModernTimes::HornetQ::Client.init(config['client'])
-bar_publisher = ModernTimes::HornetQ::Publisher.new(BarWorker.address_name)
-baz_publisher = ModernTimes::HornetQ::Publisher.new(BazWorker.address_name, :marshal => :string)
+config = YAML.load(ERB.new(File.read(File.join(File.dirname(__FILE__), '..', 'jms.yml'))).result(binding))
+ModernTimes::JMS::Connection.init(config)
+bar_publisher = ModernTimes::JMS::Publisher.new(:queue_name => 'Bar', :marshal => :bson)
+baz_publisher = ModernTimes::JMS::Publisher.new(:queue_name => 'Baz', :marshal => :string)
 
 (1..bar_count).each do |i|
-  obj = {:message => i}
+  obj = {'message' => i}
   puts "Publishing to Bar object: #{obj.inspect}"
   bar_publisher.publish(obj)
   sleep sleep_time

data/lib/modern_times.rb

@@ -1,8 +1,9 @@
 require 'rubygems'
 require 'modern_times/exception'
+require 'modern_times/marshal_strategy'
 require 'modern_times/base'
-require 'modern_times/hornetq'
-require 'modern_times/hornetq_requestor'
+require 'modern_times/jms'
+require 'modern_times/jms_requestor'
 require 'modern_times/manager_mbean'
 require 'modern_times/manager'
 require 'modern_times/loggable'
@@ -11,4 +12,21 @@ require 'modern_times/railsable'
 module ModernTimes
   extend ModernTimes::Loggable
   extend ModernTimes::Railsable
+
+  DEFAULT_DOMAIN = 'ModernTimes'
+
+  def self.manager_mbean_name(domain)
+    domain = DEFAULT_DOMAIN unless domain
+    "#{domain}.Manager"
+  end
+
+  def self.manager_mbean_object_name(domain)
+    domain = DEFAULT_DOMAIN unless domain
+    "#{domain}:type=Manager"
+  end
+
+  def self.supervisor_mbean_object_name(domain, worker_name)
+    domain = DEFAULT_DOMAIN unless domain
+    "#{domain}:worker=#{worker_name},type=Worker"
+  end
 end

data/lib/modern_times/base/supervisor.rb

@@ -1,7 +1,7 @@
 module ModernTimes
   module Base
     class Supervisor
-      attr_reader :manager, :worker_klass, :name, :worker_options
+      attr_reader :manager, :worker_klass, :name, :worker_options, :workers
 
       # Create new supervisor to manage a number of similar workers
       # supervisor_options are those options defined on the Worker's Supervisor line
@@ -10,7 +10,7 @@ module ModernTimes
         @stopped        = false
         @manager        = manager
         @worker_klass   = worker_klass
-        @name           = worker_options.delete(:name) || worker_klass.default_name
+        @name           = worker_options[:name] || worker_klass.default_name
         @worker_options = worker_options
         @workers        = []
         @worker_mutex   = Mutex.new
@@ -29,14 +29,13 @@ module ModernTimes
           if curr_count < count
             (curr_count...count).each do |index|
               worker = @worker_klass.new(@worker_options)
-              worker.supervisor = self
               worker.index = index
               if index == 0
                 # HornetQ hack:  If I create the session in the jmx thread, it dies with no feedback
-                tmp_thread = Thread.new do
+                #tmp_thread = Thread.new do
                   worker.setup
-                end
-                tmp_thread.join
+                #end
+                #tmp_thread.join
               end
               worker.thread = Thread.new do
                 #ModernTimes.logger.debug "#{worker}: Started thread with priority #{Thread.current.priority}"
@@ -53,8 +52,8 @@ module ModernTimes
         end
       end
 
-      def worker_status(index)
-        @workers[index].status
+      def worker_statuses
+        @workers.map { |w| w.status }
       end
 
       def stop
@@ -76,22 +75,16 @@ module ModernTimes
         
       end
 
-      def self.mbean(klass, options={})
-#        self.class.class_eval do
-#          define_method :create_mbean do |domain, supervisor, worker_klass|
-#            klass.new("#{domain}.Worker.#{worker_klass.name}", "Supervisor for #{worker_klass.name}", supervisor, options)
-#          end
-#        end
-        # TODO: This is nasty but I'm not sure how to create a dynamic class method within a scope
-        eval <<-EOS
-          def self.create_mbean(domain, supervisor, worker_klass)
-            #{klass.name}.new("\#{domain}.Worker.\#{worker_klass.name}", "Supervisor for \#{worker_klass.name}", supervisor, #{options.inspect})
-          end
-        EOS
+      def mbean_name(domain)
+        "#{domain}.Worker.#{@name}"
+      end
+
+      def mbean_description
+        "Supervisor for #{@worker_klass.name} under #{@name}"
       end
 
       def create_mbean(domain)
-        self.class.create_mbean(domain, self, @worker_klass)
+        SupervisorMBean.new(mbean_name(domain), mbean_description, self, {})
       end
 
       #########

data/lib/modern_times/base/supervisor_mbean.rb

@@ -3,8 +3,9 @@ require 'jmx'
 module ModernTimes
   module Base
     class SupervisorMBean < RubyDynamicMBean
-      attr_reader :supervisor
+      attr_reader  :supervisor
       rw_attribute :worker_count, :int, "Number of workers"
+      r_attribute  :worker_statuses, :list, 'Status of the workers'
 
       def initialize(name, description, supervisor, options)
         super(name, description)
@@ -19,11 +20,8 @@ module ModernTimes
         supervisor.worker_count = count
       end
 
-      operation 'Get the worker status'
-      parameter :int, "index", "Index of the worker"
-      returns :string
-      def worker_status(index)
-        supervisor.worker_status(index)
+      def worker_statuses
+        java.util.ArrayList.new(supervisor.worker_statuses)
       end
     end
   end

data/lib/modern_times/base/worker.rb

@@ -1,36 +1,32 @@
-require 'json'
-
 module ModernTimes
   module Base
-    class Worker
-      attr_accessor :index, :supervisor, :thread
-
-      def self.supervisor(klass, options={})
-#        self.class_eval do
-#          define_method :create_supervisor do |manager|
-#            puts "calling create_supervisor for klass-#{klass.name} and self=#{self} and manager=#{manager}"
-#            klass.new(manager, self, options)
-#          end
-#        end
-        # TODO: This is nasty but I'm not sure how to create a dynamic class method within a scope
-        eval <<-EOS
-          def self.create_supervisor(manager, worker_options)
-            #{klass.name}.new(manager, self, #{options.to_json}, worker_options)
-          end
-        EOS
+    module Worker
+      attr_accessor :name, :index, :thread
+
+      module ClassMethods
+        def default_name
+          name = self.name.sub(/Worker$/, '')
+          name.sub(/::/, '_')
+        end
+
+        def create_supervisor(manager, worker_options)
+          Supervisor.new(manager, self, {}, worker_options)
+        end
       end
 
-      # Default supervisor is Base::Supervisor
-      supervisor Supervisor
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
 
       def initialize(opts={})
+        @name = opts[:name] || self.class.default_name
       end
 
       # One time initialization prior to first thread
       def setup
       end
 
-      def start
+      def start(name)
         raise "Need to override start method in #{self.class.name}"
       end
 
@@ -41,11 +37,6 @@ module ModernTimes
       def status
         raise "Need to override status method in #{self.class.name}"
       end
-
-      def self.default_name
-        name = self.name.sub(/Worker$/, '')
-        name.sub(/::/, '_')
-      end
     end
   end
 end