reliable-msg-agent 0.0.3 → 0.1.0

data/History.txt

@@ -1,4 +1,14 @@
 
+== 0.1.0 2011-04-04
+
+* Changed README.rdoc
+* Added testcase.
+* bugfix: The relative path was not correctly interpreted.
+* Added commandline option daemon mode(-d).
+* Added commandline option user(-u) and group(-g).
+* Removed "user" and "group" from configurations.
+* Changed "agent" config option changes arbitrarily from indispensability.
+
 == 0.0.3 2011-03-31
 
 * Added testcase for Service class.

data/README.rdoc

@@ -24,20 +24,153 @@ in A and processes it is taken.
       | Agent |  ...  + Agent +
       +-------+       +-------+
 
-== Getting started
+== Getting started 1
 
 === Install
 
  gem install reliable-msg-agent
 
-=== Set configuration file
-
-* {GEM_INSTALL_DIR}/resources/agent.conf
-  please arrange agent.conf in appropriate path.
-  (default: /etc/reliable-msg-agent/agent.conf)
-* {GEM_INSTALL_DIR}/resources/agent.rb
-  please arrange agent.conf in appropriate path.
-  (default: /etc/reliable-msg-agent/agent.rb)
+=== Start reliable-msg
+
+reliable-msg is started beforehand.
+
+ $ queues manager start
+ I, [2011-04-03T23:00:43.781875 #1856]  INFO -- : Created queues configuration file in: /usr/loc...
+ I, [2011-04-03T23:00:43.781875 #1856]  INFO -- : Using message store: disk
+ I, [2011-04-03T23:00:43.812875 #1856]  INFO -- : Accepting requests at: druby://localhost:6438
+
+=== Start reliable-msg-agent
+
+ $ reliable-msg-agent start
+ *** Starting ReliableMsg-Agent...
+ I, [2011-04-03T23:02:11.390875 #2724]  INFO -- : *** reliable-msg agent service starting...
+ I, [2011-04-03T23:02:11.390875 #2724]  INFO -- : --- starting workers.
+ I, [2011-04-03T23:02:11.452875 #2724]  INFO -- : *** reliable-msg agent service started.
+
+=== Push message to reliable-msg queue.
+
+The message "foo" is push to queue of reliable-msg.
+
+ $ irb -rubygems -rreliable-msg
+ irb(main):001:0> ReliableMsg::Queue.new("queue.agent").put("foo")
+  => "0d98c020-402a-012e-f635-000ae47391e2"
+ irb(main):002:0> exit
+ $
+
+=== The console that executes reliable-msg-agent is seen. 
+
+The message is acquired from reliable-msg, and the log is output. 
+
+ $ queues manager start
+ I, [2011-04-03T23:13:41.046875 #3860]  INFO -- : *** reliable-msg agent service starting...
+ I, [2011-04-03T23:13:41.046875 #3860]  INFO -- : --- starting workers.
+ I, [2011-04-03T23:13:41.093875 #3860]  INFO -- : *** reliable-msg agent service started.
+ I, [2011-04-03T23:14:24.280875 #3860]  INFO -- : message fetched - <9957e5a0-402a-012e-f635-000ae47391e2>
+ I, [2011-04-03T23:14:24.280875 #3860]  INFO -- : message received
+ --- !ruby/object:ReliableMsg::Message
+ headers:
+   :delivery: :best_effort
+   :max_deliveries: 5
+   :created: 1301840063
+   :id: 9957e5a0-402a-012e-f635-000ae47391e2
+   :expires:
+   :priority: 0
+ id: 9957e5a0-402a-012e-f635-000ae47391e2
+ object: foo
+
+== Getting started 2 - The behavior when the message is acquired is changed.
+
+Default operation of reliable-msg-agent is only a log output. 
+This can be changed. 
+
+=== Start reliable-msg
+
+reliable-msg is started beforehand.
+
+ $ queues manager start
+ I, [2011-04-03T23:00:43.781875 #1856]  INFO -- : Created queues configuration file in: /usr/loc...
+ I, [2011-04-03T23:00:43.781875 #1856]  INFO -- : Using message store: disk
+ I, [2011-04-03T23:00:43.812875 #1856]  INFO -- : Accepting requests at: druby://localhost:6438
+
+=== Preparation for configuration file
+
+The file /etc/reliable-msg-agent.conf of the following content is prepared. 
+
+ # /etc/reliable-msg-agent.conf
+ ---
+ agent: /etc/reliable-msg-agent.rb
+ consumers:
+   -
+     source_uri: druby://localhost:6438
+     every: 1.0
+     target: queue.agent
+     threads: 1
+
+In addition, the file /etc/reliable-msg-agent.rb of the following content is prepared.
+Here, the directory specified by the message is made.
+
+ # /etc/reliable-msg-agnet.rb
+ require "fileutils"
+
+ # The method of processing the message is defined.
+ #
+ # if the evaluation result is nil or false,
+ # it is considered that it failes.
+ #
+ # === Args
+ #
+ # +msg+     :: fetched message from reliable-msg queue.
+ # +conf+    :: consumer configurations.
+ # +options+ :: the options (it is still unused.)
+ #
+ def call msg, conf, options = {}
+   dir = File.join "/tmp", msg.object
+   FileUtils.mkdir_p dir
+   @logger.info { "directory created - #{dir}" }
+ end
+
+=== Start reliable-msg-agent
+
+The configuration file is specified by commandline option.
+
+ $ reliable-msg-agent start -c /etc/reliable-msg-agent.conf
+ *** Starting ReliableMsg-Agent...
+ I, [2011-04-04T00:06:23.759875 #1804]  INFO -- : *** reliable-msg agent service starting...
+ I, [2011-04-04T00:06:23.759875 #1804]  INFO -- : --- starting workers.
+ I, [2011-04-04T00:06:23.783875 #1804]  INFO -- : *** reliable-msg agent service started.
+
+=== Push message to reliable-msg queue.
+
+The message "foo" and "bar" are push to queue of reliable-msg.
+
+ $ irb -rubygems -rreliable-msg
+ irb(main):001:0> ReliableMsg::Queue.new("queue.agent").put("foo")
+  => "f19aadd0-4032-012e-f635-000ae47391e2"
+ irb(main):002:0> ReliableMsg::Queue.new("queue.agent").put("bar")
+  => "f3c33320-4032-012e-f635-000ae47391e2"
+ irb(main):003:0> exit
+ $
+
+=== The console that executes reliable-msg-agent is seen. 
+
+The message is acquired from reliable-msg, and directory was made.
+
+ $ reliable-msg-agent start -c /etc/reliable-msg-agent.conf
+ *** Starting ReliableMsg-Agent...
+ I, [2011-04-04T00:06:23.759875 #1804]  INFO -- : *** reliable-msg agent service starting...
+ I, [2011-04-04T00:06:23.759875 #1804]  INFO -- : --- starting workers.
+ I, [2011-04-04T00:06:23.783875 #1804]  INFO -- : *** reliable-msg agent service started.
+ I, [2011-04-04T00:14:07.921875 #1804]  INFO -- : message fetched - <f19aadd0-4032-012e-f635-000ae47391e2>
+ I, [2011-04-04T00:14:07.936875 #1804]  INFO -- : directory created - /tmp/foo
+ I, [2011-04-04T00:14:11.102875 #1804]  INFO -- : message fetched - <f3c33320-4032-012e-f635-000ae47391e2>
+ I, [2011-04-04T00:14:11.106875 #1804]  INFO -- : directory created - /tmp/bar
+
+ $ ls -l /tmp/{foo,bar}
+ /tmp/bar:
+ total 0
+
+ /tmp/foo:
+ total 0
 
 == Reliable-msg-agent commands
 
@@ -51,20 +184,29 @@ in A and processes it is taken.
  $ reliable-msg-agent start --help
  Usage: reliable-msg-agent start [options]
      -v, --verbose                    Verbose output
+     -d, --daemon                     Daemon mode
+     -u, --user=USER                  Effective user name
+     -g, --group=GROUP                Effective group name
      -c, --conf=CONFFILE              Config file
-     -l, --log=LOGFILE                Log file
-     -p, --pid=PIDFILE                PID file
+     -l, --log=LOGFILE                Log file (only for the daemon mode)
+     -p, --pid=PIDFILE                PID file (only for the daemon mode)
      -h, --help                       Show this message
          --version                    Show version
 
 * -v, --verbose
   verbose output.
+* -d, --daemon
+  daemon mode.
+* -u, --user
+  effective user name (The authority of seteuid is necessary.)
+* -g, --group
+  effective group name (The authority of setegid is necessary.)
 * -c, --conf=CONFFILE
-  path for config file. default is /etc/reliable-msg-agent/agent.conf
+  path for config file. default is {GEM_INSTALL_DIR}/resources/agent.conf
 * -l, --log=LOGFILE
-  path for log file. default is /var/reliable-msg-agent/agent.log
+  path for log file. default is /var/reliable-msg-agent/agent.log (only for the daemon mode)
 * -p, --pid=PIDFILE
-  path for pid file. default is /var/reliable-msg-agent/agent.pid
+  path for pid file. default is /var/reliable-msg-agent/agent.pid (only for the daemon mode)
 * -h, --help
   show this message.
 * --version
@@ -75,7 +217,7 @@ in A and processes it is taken.
  $ reliable-msg-agent stop --help
  Usage: reliable-msg-agent stop [options]
      -v, --verbose                    Verbose output
-     -p, --pid=PIDFILE                PID file (only for the daemon mode)
+     -p, --pid=PIDFILE                PID file
      -h, --help                       Show this message
          --version                    Show version
 

data/bin/reliable-msg-agent

@@ -14,14 +14,23 @@ parsers["start"] = OptionParser.new { |parser|
   parser.on("-v", "--verbose", "Verbose output") {
     options[:verbose] = true
   }
+  parser.on("-d", "--daemon", "Daemon mode") {
+    options[:daemon] = true
+  }
+  parser.on("-u", "--user=USER", "Effective user name") { |v|
+    options[:user] = v
+  }
+  parser.on("-g", "--group=GROUP", "Effective group name") { |v|
+    options[:group] = v
+  }
   parser.on("-c", "--conf=CONFFILE", "Config file") { |v|
-    options[:conf] = v
+    options[:conf] = File.expand_path(v)
   }
-  parser.on("-l", "--log=LOGFILE", "Log file") { |v|
-    options[:log] = v
+  parser.on("-l", "--log=LOGFILE", "Log file (only for the daemon mode)") { |v|
+    options[:log] = File.expand_path(v)
   }
-  parser.on("-p", "--pid=PIDFILE", "PID file") { |v|
-    options[:pid] = v
+  parser.on("-p", "--pid=PIDFILE", "PID file (only for the daemon mode)") { |v|
+    options[:pid] = File.expand_path(v)
   }
 }
 parsers["stop"]  = OptionParser.new { |parser|
@@ -30,8 +39,8 @@ parsers["stop"]  = OptionParser.new { |parser|
   parser.on("-v", "--verbose", "Verbose output") {
     options[:verbose] = true
   }
-  parser.on("-p", "--pid=PIDFILE", "PID file (only for the daemon mode)") { |v|
-    options[:pid] = v
+  parser.on("-p", "--pid=PIDFILE", "PID file") { |v|
+    options[:pid] = File.expand_path(v)
   }
 }
 parsers.each { |k,v| parser = v
@@ -54,7 +63,13 @@ unless parsers.keys.include?(subcommand)
   $stderr.puts
   exit 1
 end
-parsers[subcommand].parse! ARGV
+
+begin
+  parsers[subcommand].parse! ARGV
+rescue
+  $stderr.puts parsers[subcommand].help
+  exit 1
+end
 
 require "reliable-msg/agent/scripts/script_runner"
 ReliableMsg::Agent::ScriptRunner.new.send subcommand.to_sym, options

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

@@ -2,6 +2,8 @@
 require "rubygems"
 require "reliable-msg/agent"
 
+require "yaml"
+
 module ReliableMsg::Agent #:nodoc:
   class Agent
     def initialize logger
@@ -20,7 +22,7 @@ module ReliableMsg::Agent #:nodoc:
     # +options+ :: the options (it is still unused.)
     #
     def call msg, conf, options = {}
-      raise AgentError, "#call(msg,conf,options={}) not implemented!"
+      @logger.info { "message received\n#{msg.to_yaml}" }
     end   
   end
 end

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

@@ -17,28 +17,43 @@ module ReliableMsg::Agent #:nodoc:
 
       default_options = {
         :verbose => false,
-        :conf => "/etc/reliable-msg-agent/agent.conf",
+        :daemon => false,
+        :user => nil,
+        :group => nil,
+        :conf => File.expand_path(File.dirname(__FILE__) + "/../../../../resources/agent.conf"),
         :log => "/var/reliable-msg-agent/agent.log",
         :pid => "/var/reliable-msg-agent/agent.pid",
       }
       opt = default_options.merge options
       
       conf = load_configurations opt[:conf]
-      change_privilege conf
-      pidfile_accessible_test opt[:pid]
-      logger = create_logger conf["logger"], opt[:log]
+      change_privilege opt[:user], opt[:group]
+      pidfile_accessible_test opt[:pid] if opt[:daemon]
+      logger = if opt[:daemon]
+                 create_logger conf["logger"], opt[:log]
+               else
+                 create_logger conf["logger"], $stdout
+               end
 
       agent_definition conf["agent"]
 
-      daemonize(logger) {
+      if opt[:daemon]
+        daemonize(logger) {
+          service = Service.new logger, conf
+          register_signal_handler logger, service, opt[:pid]
+    
+          service.start
+          write_pidfile opt[:pid]
+          while service.alive?; sleep 3; end
+        }
+      else
         service = Service.new logger, conf
-  
-        register_signal_handler logger, service, opt[:pid]
-  
+        register_signal_handler logger, service
+
         service.start
-        write_pidfile opt[:pid]
         while service.alive?; sleep 3; end
-      }
+        exit 0
+      end
 
     rescue Exception => e
       $stderr.puts "--- ReliableMsg-Agent error! - #{e.message}"
@@ -80,22 +95,18 @@ module ReliableMsg::Agent #:nodoc:
       YAML.load(ERB.new(IO.read(conffile)).result)
     end
 
-    def change_privilege conf
-      user  = conf["user"]
+    def change_privilege user, group
       uid   = begin
-                Etc.getpwnam(user.to_s).uid
+                user ? Etc.getpwnam(user.to_s).uid : Process.euid
               rescue ArgumentError
                 raise "can't find user for #{user}"
               end
-      group = conf["group"]
       gid   = begin
-                Etc.getgrnam(group.to_s).gid
+                group ? Etc.getgrnam(group.to_s).gid : Process.egid
               rescue ArgumentError
                 raise "can't find group for #{group}"
               end
 
-      raise "Dont't run as root user." if uid == 0
-
       Process::Sys.setegid(gid)
       Process::Sys.seteuid(uid)
     end
@@ -135,19 +146,19 @@ module ReliableMsg::Agent #:nodoc:
       }
     end
 
-    def register_signal_handler logger, service, pidfile
+    def register_signal_handler logger, service, pidfile = nil
       stopping = false
-      [:TERM].each { |sig|
+      [:INT, :TERM].each { |sig|
         Signal.trap(sig) {
           unless stopping
             begin
               stopping = true
               service.stop
-              File.unlink pidfile if File.exist? pidfile
+              File.unlink pidfile if pidfile and File.exist? pidfile
               exit! 0
 
             rescue Exception => e
-              File.unlink pidfile if File.exist? pidfile
+              File.unlink pidfile if pidfile and File.exist? pidfile
               logger.fatal { "ReliableMsg-Agent error! - #{e.message}" }
               logger.fatal { e.backtrace.join("\n\t") }
               exit! 1
@@ -162,7 +173,7 @@ module ReliableMsg::Agent #:nodoc:
     end
 
     def agent_definition deffile
-      Agent.class_eval open(deffile, "r") { |f| f.read }
+      Agent.class_eval open(deffile, "r") { |f| f.read } if deffile
     end
 
   end

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

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

data/resources/agent.conf

@@ -1,8 +1,5 @@
 ---
-user: agent
-group: agent
 logger: " Proc.new { |file| l = Logger.new(file); l.level = Logger::DEBUG; l } "
-agent: /etc/reliable-msg-agent/agent.rb
 
 consumers:
   -

data/resources/examples/ap4r-dispatch-agent.conf

@@ -1,6 +1,4 @@
 ---
-user: agent
-group: agent
 logger: " Proc.new { |file| l = Logger.new(file); l.level = Logger::DEBUG; l } "
 agent: /etc/reliable-msg-agent/agent.rb
 

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

@@ -1,6 +1,4 @@
 ---
-user: agent
-group: agent
 logger: " Proc.new { |file| l = Logger.new(file); l.level = Logger::WARN; l } "
 agent: /etc/reliable-msg-agent/agent.rb
 

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

@@ -1,6 +1,4 @@
 ---
-user: agent
-group: agent
 logger: " Proc.new { |file| Logger.new(file, 'daily') } "
 agent: /etc/reliable-msg-agent/agent.rb
 

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

@@ -1,6 +1,4 @@
 ---
-user: agent
-group: agent
 logger: " Proc.new { |file| Logger.new(file, 7, 10*1024*1024) } "
 agent: /etc/reliable-msg-agent/agent.rb
 

data/resources/reliable-msg-agentd

@@ -7,13 +7,15 @@
 prog=reliable-msg-agentd
 
 base=reliable-msg-agent
+user=root
+group=root
 cnf=/etc/reliable-msg-agent/agent.conf
 pid=/var/reliable-msg-agent/agent.pid
 log=/var/reliable-msg-agent/agent.log
 
 start() {
   echo $"Start ReliableMsg-Agent ..."
-  $base start -c $cnf -p $pid -l $log -d
+  $base start -u $user -g $group -c $cnf -p $pid -l $log -d
 }
 
 stop() {

data/spec/service_spec.rb

@@ -80,9 +80,10 @@ describe ReliableMsg::Agent::Service do
       @consumers = mock ReliableMsg::Agent::Consumers
       @consumers.stub!(:new).and_return @consumers
   
-      @consumers.stub!(:start)
-      @consumers.stub!(:stop)
-      @consumers.stub!(:alive?).and_return(true)
+      consumers_alive = false
+      @consumers.stub!(:start) { consumers_alive = true }
+      @consumers.stub!(:stop) { consumers_alive = false }
+      @consumers.stub!(:alive?).and_return { consumers_alive }
 
       ReliableMsg::Agent::Service.class_eval {
         public_class_method :dependency_classes
@@ -98,12 +99,27 @@ describe ReliableMsg::Agent::Service do
           exactly(1)
         ReliableMsg::Agent::Service.new @logger, @conf
       end
+
+      describe "#start" do
+        before do
+          @s = ReliableMsg::Agent::Service.new @logger, @conf
+        end
+
+        it "mockclass should receive #start exactly 1" do
+          @consumers.should_receive(:start).with(no_args).exactly(1)
+          @s.start
+        end
+
+        after do
+          @s.stop rescue nil
+          @s = nil
+        end
+      end
     end
   
     after do
       ReliableMsg::Agent::Service.dependency_classes_init
     end
   end
-
 end
 

metadata

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