ruboty-exec_command 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f31fbeb824f00f5843ea7a7168363a33539b82f
-  data.tar.gz: d7fabdad9e511f00165e8096e828e83f1af70023
+  metadata.gz: ed267f398d5e36b654ce35cece09794eec585a8b
+  data.tar.gz: 36b55cda29a3336492150319973786b11805eab7
 SHA512:
-  metadata.gz: 45bc5f831cdc072533200b0ce52c2a4dadc83cb9808c7620c407de2fbf4e64a30b7de6660c5c5b651b0c03693d32c9abab394577d1967b53891b30a3a186b3ce
-  data.tar.gz: 6c91c79b5694c3017427aeea2f804395f662ff8bc949aa51a72fc1bf99436faa9fb43f3495162eeba4fc76cd174211d57466420764a83f6de57584360ea0cc6a
+  metadata.gz: d3616c0a4b014f983cf81f8838b5404ac654e391fa63dc984409b602adcff3809d9235ebbc58db2e2fba0a1a07a6fdf30ca5a189c2b6c361200fe9cce9fec6bf
+  data.tar.gz: 203d2ece0eefb17fd223a6740957ba576725a03c6acca090b3c5682d00efb0b08d5b69bc688563c1952d0e30edbdce0f422f67c1bab737a8145f07af2f0d2f52

data/README.md

@@ -9,8 +9,9 @@ When you say '@bot: example hello', ruboty runs the command
 $PWD/commands/example/hello or $RUBOTY_ROOT/commands/example/hello
 if RUBOTY_ROOT is defined.
 
-For your convinience, please implement -h option into the
-command. The usage will be used for help message of ruboty.
+All of commands under `commands/` directory are executed with `-h`
+option once to gather their usage information used for help message
+of ruboty. Please implement `-h` option into the commands.
 
 ## Command Controll
 
@@ -38,9 +39,26 @@ Or install it yourself as:
 
     $ gem install ruboty-exec_command
 
+## Environment Variables
+
+| Name                     | Description                  | Default           |
+|--------------------------|------------------------------|-------------------|
+| LOG_LEVEL                | log level                    | 1 (Logger::INFO)  |
+| EXEC_COMMAND_OUTPUT_ROOT | The command output root      | logs/exec_command |
+| EXEC_COMMAND_OUTPUT_DIR  | The command output directory | "#{root}/%Y-%m    |
+
 ## History
 
-- 0.0.4:
+- 0.1.2:
+ - fix: not to match with shorter name commands
+ - add: symlink to output files to tail -F easily
+ - add: Bundler.with_clean_env to run a ruby script with bundler inside ruboty
+ - add: logging to see what's going on with ruboty 
+
+- 0.1.1:
+ - each message contains PID
+
+- 0.1.0:
  - command runs as a back ground thread
  - command accepts option arguments
 

data/commands/example/sleep

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 if [ "$1" == "-h" ]; then
-  echo "sleep"
+  echo "sleep <seconds>"
 else
   echo "Have a good sleep." 1>&2
   sleep $*

data/lib/ruboty/exec_command/actions/command.rb

@@ -19,16 +19,16 @@ module Ruboty
         def kill_command
           # TODO: command list lock
           # kill running process, command is "kill command <index>"
-          killed = command_slot.kill(message.body.split.last.to_i)
-
-          if killed.nil?
+          if command_slot.kill(message.body.split.last.to_i).nil?
             message.reply("Command [#{message.body.split.last}] not found.")
           end
         end
 
         def run_and_monitor(comm)
           pid = command_slot.run(comm)
-          message.reply("[#{comm.command_name}] invoked.")
+          msg = "[#{comm.command_name}] invoked. PID: #{comm.pid}"
+          Ruboty.logger.info { "[EXEC_COMMAND] #{msg}" }
+          message.reply(msg)
 
           # Waiter thread
           thread = Thread.new do
@@ -36,15 +36,19 @@ module Ruboty
             command_slot.forget(pid)
 
             if status.exitstatus == 0
-              message.reply("[#{comm.command_name}] completed successfully.")
+              msg = "[#{comm.command_name}] completed successfully. PID: #{comm.pid}"
+              Ruboty.logger.info { "[EXEC_COMMAND] #{msg}" }
+              message.reply(msg)
               message.reply(comm.stdout_log.chomp)
             elsif status.signaled?
-              message.reply("[#{comm.command_name}] killed by signal #{status.termsig}")
+              msg = "[#{comm.command_name}] killed by signal #{status.termsig} PID: #{comm.pid}"
+              Ruboty.logger.info { "[EXEC_COMMAND] #{msg}" }
+              message.reply(msg)
             else
-              message.reply("[#{comm.command_name}] exit status with #{status}\n" +
-                          comm.stdout_log +
-                          "stderr: " + comm.stderr_log.chomp
-                        )
+              msg = "[#{comm.command_name}] exit status with #{status} PID: #{comm.pid}\n" +
+                comm.stdout_log + "stderr: " + comm.stderr_log.chomp
+              Ruboty.logger.info { "[EXEC_COMMAND] #{msg}" }
+              message.reply(msg)
             end
           end
 

data/lib/ruboty/exec_command/command.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module Ruboty
   module ExecCommand
     class Command
@@ -11,8 +13,8 @@ module Ruboty
           "#{ruboty_root}/commands"
         end
 
-        def log_root
-          "#{ruboty_root}/logs/exec_command"
+        def output_root
+          ENV['EXEC_COMMAND_OUTPUT_ROOT'] || "#{ruboty_root}/logs/exec_command"
         end
 
         def command?(path)
@@ -86,28 +88,38 @@ module Ruboty
         Time.now.strftime "%Y-%m-%d_%H:%M:%S"
       end
 
-      def log_dir
-        d = "#{self.class.log_root}/#{this_month}"
+      def output_dir
+        d = ENV['EXEC_COMMAND_OUTPUT_DIR'] || "#{self.class.output_root}/#{this_month}"
         FileUtils.mkdir_p(d) if not Dir.exists?(d)
         d
       end
 
+      # symlink to output_file_name so that we can easily tail -F
+      def symlink_file_name
+        %Q(#{output_dir}/#{command_name.gsub(" ", "_")})
+      end
+
       def output_file_name
-        %Q(#{log_dir}/#{command_name.gsub(" ", "_")}-#{this_time})
+        %Q(#{output_dir}/#{command_name.gsub(" ", "_")}-#{this_time})
+      end
+
+      # return symlink output file name [stdout, stderr]
+      def symlink_files
+        ["#{symlink_file_name}.out", "#{symlink_file_name}.err"]
       end
 
+      # return temporary output file name [stdout, stderr]
       def output_files
-        # return temporary output file IO objects [stdout, stderr]
         ["#{output_file_name}.out", "#{output_file_name}.err"]
       end
 
+      # return contents of stdout
       def stdout_log
-        # return contents of stdout
         File.open(output_files[0]).read
       end
 
+      # return contents of stderr
       def stderr_log
-        # return contents of stderr
         File.open(output_files[1]).read
       end
 
@@ -118,14 +130,30 @@ module Ruboty
       def run_bg(args=[])
         stdout, stderr = output_files
         @start_at = this_time
-        @pid = Process.spawn(%Q(#{absolute_path} #{args.join(" ")}),
-                        pgroup: true, out: stdout, err: stderr)
+        stdout_link, stderr_link = symlink_files
+        FileUtils.ln_sf(stdout, stdout_link)
+        FileUtils.ln_sf(stderr, stderr_link)
+        cmd = %Q(#{absolute_path} #{args.join(" ")})
+        with_clean_env do
+          @pid = Process.spawn(cmd, pgroup: true, out: stdout, err: stderr)
+        end
+        Ruboty.logger.debug { "[EXEC_COMMAND] Invoked `#{cmd}`. PID: #{@pid}" }
+        @pid
       end
 
       def help
         run(args=['-h']).chomp
       end
 
+      def with_clean_env(&block)
+        if defined?(Bundler)
+          Bundler.with_clean_env do
+            yield
+          end
+        else
+          yield
+        end
+      end
     end
   end
 end

data/lib/ruboty/exec_command/command_slot.rb

@@ -28,9 +28,9 @@ module Ruboty
         found = @commands.index { |c| c.pid == idx_or_pid }
 
         if found.nil?
+          # look for the command with index
           i = idx_or_pid.to_i
-          num_commands = @commands.size
-          if i <= 0 or i > num_commands
+          if i <= 0 or i > @commands.size
             nil
           else
             @commands[i-1]
@@ -49,10 +49,8 @@ module Ruboty
         if @commands.size == 0
           "No command running."
         else
-          number = 0
-          @commands.map do |c|
-            number += 1
-            "#{number}: #{c.command_name} (PID[#{c.pid}], started at #{c.start_at})\n"
+          @commands.map.with_index do |c, number|
+            "#{number+1}: #{c.command_name} (PID[#{c.pid}], started at #{c.start_at})\n"
           end.join.chomp
         end
       end
@@ -62,8 +60,9 @@ module Ruboty
         unless command.nil?
           Process.kill(-9, command.pid) # kill process group
           forget(command.pid)
+        else
+          false
         end
-        command
       end
     end
   end

data/lib/ruboty/exec_command/version.rb

@@ -1,5 +1,5 @@
 module Ruboty
   module ExecCommand
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

data/lib/ruboty/handlers/command.rb

@@ -14,10 +14,11 @@ module Ruboty
       # under "commands" directory. The path name to the
       # executable command is gonna be a command name.
       #  i.e. commands/server/monitor => /server monitor/
+      # All of commands are called with -h option on the startup.
       # The command should return a usage with -h option
       def self.register_commands
         Ruboty::ExecCommand::Command.all.each do |e|
-          on /#{e.command_name}/i, name: "command_handler", description: e.help
+          on /#{e.command_name}(?:\z|\s+)/i, name: "command_handler", description: e.help
         end
       end
 

data/spec/lib/ruboty/handlers/command_spec.rb

@@ -19,7 +19,7 @@ describe Ruboty::Handlers::Command do
   end
 
   let(:said_to_sleep) do
-    "@ruboty example sleep 1"
+    "@ruboty example sleep 5"
   end
 
   let(:said_to_kill) do
@@ -31,15 +31,15 @@ describe Ruboty::Handlers::Command do
   end
 
   let(:replied) do
-    "[example hello] invoked."
+    /\[example hello\] invoked. PID: \d+/
   end
 
   let(:replied_sleep) do
-    "[example sleep] invoked."
+    /\[example sleep\] invoked. PID: \d+/
   end
 
   let(:replied_success) do
-    "[example hello] completed successfully."
+    /\[example hello\] completed successfully. PID: \d+/
   end
 
   let(:replied_stdout) do
@@ -47,7 +47,7 @@ describe Ruboty::Handlers::Command do
   end
 
   let(:replied_after_kill) do
-    "[example sleep] killed by signal 9"
+    /\[example sleep\] killed by signal 9 PID: \d+/
   end
 
   def reply_data(body, original_body)
@@ -64,6 +64,13 @@ describe Ruboty::Handlers::Command do
     }
   end
 
+
+  def should_receive_body(reply)
+    robot.should_receive(:say) do |args, options|
+      args[:body].should match(reply)
+    end
+  end
+
   before do
     ENV['RUBOTY_ROOT'] = Dir.pwd
   end
@@ -75,8 +82,9 @@ describe Ruboty::Handlers::Command do
     end
 
     it "run example command" do
-      robot.should_receive(:say).with(reply_data(replied, said))
-      robot.should_receive(:say).with(reply_data(replied_success, said))
+      #robot.should_receive(:say).with(reply_data(replied, said))
+      should_receive_body(replied)
+      should_receive_body(replied_success)
       robot.should_receive(:say).with(reply_data(replied_stdout, said))
       robot.receive(body: said, from: from, to: to)
     end
@@ -90,8 +98,8 @@ describe Ruboty::Handlers::Command do
     it "run kill command" do
       thread = Thread.new do
         ENV['RUBOTY_ENV'] = "blocked_test"
-        robot.should_receive(:say).with(reply_data(replied_sleep, said_to_sleep))
-        robot.should_receive(:say).with(reply_data(replied_after_kill, said_to_sleep))
+        should_receive_body(replied_sleep)
+        should_receive_body(replied_after_kill)
         robot.receive(body: said_to_sleep, from: from, to: to)
       end
 
@@ -103,7 +111,7 @@ describe Ruboty::Handlers::Command do
         # Wait killed message
       thread.join
     end
-    
+
     after do
       ENV['RUBOTY_ENV'] = "test"
     end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: ruboty-exec_command
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Nakai Tooru
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-04 00:00:00.000000000 Z
+date: 2015-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruboty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -70,42 +70,42 @@ dependencies:
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: growl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: ''
@@ -115,7 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -144,17 +144,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Add command to ruboty as a handler