reliable-msg-agent 0.0.2 → 0.0.3

data/History.txt

@@ -1,4 +1,10 @@
 
+== 0.0.3 2011-03-31
+
+* Added testcase for Service class.
+* Changed target default. (queue.* to queue.agent)
+* bugfix: Message could not be acquired from ReliableMsg(!=Ap4r-queue)
+
 == 0.0.2 2011-03-19
 
 * resources/ was includ in gemfiles.

data/lib/reliable-msg/agent/agent.rb

@@ -19,8 +19,8 @@ module ReliableMsg::Agent #:nodoc:
     # +conf+    :: consumer configurations.
     # +options+ :: the options (it is still unused.)
     #
-    def call msg, options = {}
-      raise AgentError, "#call(msg,options={}) not implemented!"
+    def call msg, conf, options = {}
+      raise AgentError, "#call(msg,conf,options={}) not implemented!"
     end   
   end
 end

data/lib/reliable-msg/agent/consumers.rb

@@ -5,15 +5,35 @@ require "reliable-msg/agent"
 require "monitor"
 
 module ReliableMsg::Agent #:nodoc:
+
+  # Class of consumers for reliable-msg queue massaging.
+  #
+  # It has the function to make the agent acquire the message
+  # from ReliableMsg-Queue of the object and execute processing. 
+  #
   class Consumers
 
     @@default_options = {
       "source_uri" => "druby://localhost:6438",
-      "target"     => "queue.*",
+      "target"     => "queue.agent",
       "every"      => 1.0,
       "threads"    => 1,
     }.freeze
 
+    # Initialize.
+    #
+    # === Args
+    #
+    # +logger+  :: the logger.
+    # +options+ :: consumers options.
+    #
+    # valid options for +options+ are:
+    #
+    # +source_uri+ :: uri for source reliable-msg queue.
+    # +target+     :: target queue name for source reliable-msg queue.
+    # +every+      :: interval seconds when connection fails
+    # +threads+    :: times for consumer threads.
+    #
     def initialize logger, options
       @logger  = logger
       @options = options
@@ -22,6 +42,8 @@ module ReliableMsg::Agent #:nodoc:
       @threads = nil
     end
 
+    # Start consumers.
+    #
     def start
       @locker.synchronize {
         raise AgentError, "workers already started." if alive?
@@ -38,6 +60,8 @@ module ReliableMsg::Agent #:nodoc:
       }
     end
 
+    # Stop consumers.
+    #
     def stop
       @locker.synchronize {
         raise AgentError, "workers already stopped." unless alive?
@@ -51,10 +75,18 @@ module ReliableMsg::Agent #:nodoc:
       }
     end
 
+    # Return the state of alive or not alive.
+    #
     def alive?; @locker.synchronize { !! @threads }; end
 
     private
 
+    # Loop for consumer.
+    #
+    # === Args
+    #
+    # +conf+:: consumer configurations.
+    #
     def consuming_loop conf
       agent = Agent.new @logger
       uri, every, target = conf["source_uri"], conf["every"], conf["target"]
@@ -78,12 +110,22 @@ module ReliableMsg::Agent #:nodoc:
       end
     end
 
+    # Test for connect to reliable-msg queue manager.
+    # Returns valid queue-name.
+    #
+    # === Args
+    #
+    # +qm+     :: the queue manager.
+    # +target+ :: target queue name for source reliable-msg queue.
+    # +uri+    :: uri for source reliable-msg queue.
+    # +every+  :: interval seconds when connection fails
+    #
     def connect_qm qm, target, uri, every
       error_raised = false
       begin
-        queue_name = qm.stale_queue target
+        raise "queue-manager is not alive." unless qm.alive?
         @logger.warn { "Connect to #{uri} successfully at #{Time.now}" } if error_raised
-        return queue_name
+        return target
 
       rescue => e
         @logger.warn { "Lost connection to #{uri} at #{Time.now} - #{e.message}" } unless error_raised
@@ -94,6 +136,14 @@ module ReliableMsg::Agent #:nodoc:
       end
     end
 
+    # Fetch message from reliable-msg queue.
+    # Return evaluation result of yield.
+    #
+    # === Args
+    #
+    # +queue_name+ :: queue name for source reliable-msg queue.
+    # +source_uri+ :: uri for source reliable-msg queue.
+    #
     def fetch queue_name, source_uri
       ReliableMsg::Queue.new(queue_name, :drb_uri => source_uri).get { |m|
         begin

data/lib/reliable-msg/agent/service.rb

@@ -5,40 +5,93 @@ require "reliable-msg/agent"
 require "monitor"
 
 module ReliableMsg::Agent #:nodoc:
+
+  # Class of ReliableMsg-Agent service
+  #
   class Service
+
+    # Initialilze.
+    #
+    # === Args
+    #
+    # +logger+  :: the logger.
+    # +options+ :: service options.
+    #
     def initialize logger, options = {}
       @logger  = logger
       @options = options
 
-      @workers = Consumers.new @logger, @options["consumers"]
+      @consumers = @@dependency_classes[:Consumers].new @logger, @options["consumers"]
       @locker = Monitor.new
     end
 
+    # Start service.
+    #
     def start
       @locker.synchronize {
         raise AgentError, "service already started." if alive?
 
         @logger.info { "*** reliable-msg agent service starting..." }
-        @workers.start
+        @consumers.start
         @logger.info { "*** reliable-msg agent service started." }
       }
     end
 
+    # Stop service.
+    #
     def stop
       @locker.synchronize {
         raise AgentError, "service already stopped." unless alive?
 
         @logger.info { "*** reliable-msg agent service stopping..." }
-        @workers.stop
+        @consumers.stop
         @logger.info { "*** reliable-msg agent service stopped." }
       }
     end
 
+    # Return the state of alive or not alive.
+    #
     def alive?
       @locker.synchronize {
-        !! @workers.alive?
+        !! @consumers.alive?
       }
     end
+
+    # For testcase. To replace the class for which Service depends with Mock.
+    #
+    # === Example
+    #
+    #   # Change method scope.
+    #   Service.class_eval {
+    #     public_class_method :dependency_classes
+    #     public_class_method :dependency_classes_init
+    #   }
+    #
+    #   # Consumers is replaced with ConsumersMock.
+    #   Service.dependency_classes[:Consumers] = ConsumersMock
+    #
+    #   # test code that uses ConsumersMock...
+    #   test_foo
+    #   test_bar
+    #
+    #   # re-init.
+    #   Service.dependency_classes_init
+    #
+    def self.dependency_classes
+      @@dependency_classes
+    end
+    private_class_method :dependency_classes
+    
+    # For testcase. Dependency classes is initialized.
+    #
+    def self.dependency_classes_init
+      @@dependency_classes = {
+        :Consumers => Consumers,
+      }
+    end
+    private_class_method :dependency_classes_init
+    dependency_classes_init
+
   end
 end
 

data/lib/reliable-msg/agent/version.rb

@@ -7,7 +7,7 @@ module ReliableMsg::Agent #:nodoc:
     unless defined? MAJOR
       MAJOR  = 0
       MINOR  = 0
-      TINY   = 2
+      TINY   = 3
       PRE    = nil
 
       STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/resources/agent.conf

@@ -8,6 +8,6 @@ consumers:
   -
     source_uri: druby://localhost:6438
     every: 1.0
-    target: queue.*
+    target: queue.agent
     threads: 1
 

data/resources/examples/log-level-change-agent.conf

@@ -8,6 +8,6 @@ consumers:
   -
     source_uri: druby://localhost:6438
     every: 1.0
-    target: queue.*
+    target: queue.agent
     threads: 1
 

data/resources/examples/log-rotate-daily-agent.conf

@@ -8,6 +8,6 @@ consumers:
   -
     source_uri: druby://localhost:6438
     every: 1.0
-    target: queue.*
+    target: queue.agent
     threads: 1
 

data/resources/examples/log-rotate-size-agent.conf

@@ -8,6 +8,6 @@ consumers:
   -
     source_uri: druby://localhost:6438
     every: 1.0
-    target: queue.*
+    target: queue.agent
     threads: 1
 

data/spec/service_spec.rb

@@ -5,8 +5,12 @@ require "logger"
 
 describe ReliableMsg::Agent::Service do
   before do
-    logger = Logger.new(nil)
-    conf = {
+    @times_of_start_stop = 30
+
+    @logger = Logger.new(nil)
+    @conf = {
+      "foo" => "bar",
+      "baz" => "qux",
       "consumers" => [
         {
           "source_uri" => "druby://localhost:6438",
@@ -16,31 +20,90 @@ describe ReliableMsg::Agent::Service do
         },
       ],
     }
-    @s = ReliableMsg::Agent::Service.new logger, conf
   end
 
-  it "should be able to #start" do
-    @s.start
-  end
+  describe "When initialize" do
+    before do
+      @s = ReliableMsg::Agent::Service.new @logger, @conf
+    end
 
-  it "should not be alive" do
-    @s.alive?.should_not be_true
+    it "should be able to #start" do
+      @s.start
+    end
+  
+    it "should not be able to #stop" do
+      Proc.new {
+       @s.stop
+      }.should raise_error ReliableMsg::Agent::AgentError
+    end
+  
+    it "should not be alive" do
+      @s.alive?.should_not be_true
+    end
+  
+    describe "When started" do
+      before do
+        @s.start
+      end
+  
+      it "should not be able to #start" do
+        Proc.new {
+          @s.start
+        }.should raise_error ReliableMsg::Agent::AgentError
+      end
+    
+      it "should be able to #stop" do
+       @s.stop
+      end
+  
+      it "should be alive" do
+        @s.alive?.should be_true
+      end
+  
+    end
+  
+    it "should be able to #start > #stop > #start > ..." do
+      @times_of_start_stop.times {
+        @s.start
+        @s.stop
+      }
+    end
+  
+    after do
+      @s.stop rescue nil
+      @s = nil
+    end
   end
 
-  describe "When started" do
+  describe "When replace the mock classes depend Service" do
     before do
-      @s.start
-    end
+      @consumers = mock ReliableMsg::Agent::Consumers
+      @consumers.stub!(:new).and_return @consumers
+  
+      @consumers.stub!(:start)
+      @consumers.stub!(:stop)
+      @consumers.stub!(:alive?).and_return(true)
 
-    it "should be alive" do
-      @s.alive?.should be_true
+      ReliableMsg::Agent::Service.class_eval {
+        public_class_method :dependency_classes
+        public_class_method :dependency_classes_init
+      }
+      ReliableMsg::Agent::Service.dependency_classes[:Consumers] = @consumers
+    end
+  
+    describe "When initialize" do
+      it "mockclass should receive #new(@logger, @conf['consumers']) exactly 1" do
+        @consumers.should_receive(:new).
+          with(@logger, @conf["consumers"]).
+          exactly(1)
+        ReliableMsg::Agent::Service.new @logger, @conf
+      end
+    end
+  
+    after do
+      ReliableMsg::Agent::Service.dependency_classes_init
     end
-
   end
 
-  after do
-    @s.stop rescue nil
-    @s = nil
-  end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: reliable-msg-agent
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - hamajyotan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-19 00:00:00 +09:00
+date: 2011-03-31 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency