rundock 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee97ce7e9fab113c27e6782b3dc5a541b77fd6d7
-  data.tar.gz: c449097d5bb33e5fa09be5d00b69bf9e37a74d01
+  metadata.gz: ac0d1b1d024e3fb776363046e50b0491d565bd14
+  data.tar.gz: fcc471769968893cec01ad5448596f89a25a60c4
 SHA512:
-  metadata.gz: c096af8d1d925c6902ec72358b22d821e216dbb410981cb5d6fcacd363dbdd0730b543c6fcb0eb68a75c6bcd1636157f44fbb71687fdfe82883d35da62f2273d
-  data.tar.gz: 9b9cab0135ffc8b2d710a3fdbd6b8a39d479d7339c28f3a14780256066ecda90e7346b3274d6a681dbac8fcfc208d4c6251a01428c1f80d0526a79fa325c5609
+  metadata.gz: 1ed1fa084c198d5ef541533a5b6dea968a9bdfef73b8fe952b50ded41587ac905eab7d1af64e92c31db8272083f2045e2ed4069b0eb72fc856dbfd225caaecd3
+  data.tar.gz: aeddc0612d79caa97beb41d77e104085514fed0cc96dcbf298b4df8ab4045721ebb5f69068a0ffb0fed7085f2b3f992e9a08423067536540d169d02f4d52f3af

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v0.4.0
+
+Improvements
+
+- Support node hooks
+
+Fix
+
+- Fix plugin lib search path bug
+
 ## v0.3.0
 
 Improvements

data/Rakefile

@@ -73,8 +73,14 @@ def do_rundock_scenarios(platform)
       default_ssh_opt = ''
     end
 
+    if scenario =~ %r{^*scenarios/(.*_hooks)_scenario.yml$}
+      hooks_opt = " -k ./spec/integration/hooks/#{Regexp.last_match(1)}.yml"
+    else
+      hooks_opt = ''
+    end
+
     execute('bundle exec exe/rundock' \
-       " do #{scenario}#{default_ssh_opt} -l debug", true)
+       " do #{scenario}#{default_ssh_opt}#{hooks_opt} -l debug", true)
   end
 end
 

data/hooks_sample.yml

@@ -0,0 +1,7 @@
+#
+# Sample hook defines
+# (This sample will be able to output to the log file)
+#
+logging:
+  hook_type: file
+  filepath: /var/log/rundock.log

data/lib/rundock/attribute/node_attribute.rb

@@ -6,6 +6,7 @@ module Rundock
       attr_accessor :nodeinfo
       attr_accessor :task_info
       attr_accessor :errexit
+      attr_accessor :enable_hooks
 
       AVAIL_TAKE_OVERS = [
         :task_info,

data/lib/rundock/builder/hook_builder.rb

@@ -0,0 +1,46 @@
+require 'yaml'
+
+module Rundock
+  module Builder
+    class HookBuilder < Base
+      HookStructureError = Class.new(NotImplementedError)
+
+      def build(enables)
+        if enables.blank?
+          return []
+        elsif @options[:hooks] && FileTest.exist?(@options[:hooks])
+          hooks_file = @options[:hooks]
+        else
+          return []
+        end
+
+        build_from_file(hooks_file, enables)
+      end
+
+      def build_from_attributes(attributes)
+        return [] unless attributes.key?(:enable_hooks)
+        build_from_file(attributes[:hooks], attributes[:enable_hooks])
+      end
+
+      private
+
+      def build_from_file(file, enables)
+        hooks = []
+        allow_all = enables.include?('all')
+
+        File.open(file) do |f|
+          YAML.load_documents(f) do |y|
+            y.each do |k, v|
+              raise HookStructureError if !v.is_a?(Hash) || !v.key?('hook_type')
+              next if !allow_all && enables.include?(k)
+              hook = Rundock::HookFactory.instance(v['hook_type']).create(k, v.deep_symbolize_keys)
+              hooks << hook
+            end
+          end
+        end
+
+        hooks
+      end
+    end
+  end
+end

data/lib/rundock/builder/operation_builder.rb

@@ -21,16 +21,19 @@ module Rundock
           n.deep_symbolize_keys.each do |k, v|
             if k == :node
               node_attribute.finalize_node
-              builder = BackendBuilder.new(@options, v, node_info)
-              backend = builder.build
+              backend_builder = BackendBuilder.new(@options, v, node_info)
+              backend = backend_builder.build
 
               node = Node.new(v, backend)
               node_attribute.nodename = v
-              scen.node_info[v.to_sym] = node_attribute.nodeinfo = builder.parsed_options
+              scen.node_info[v.to_sym] = node_attribute.nodeinfo = backend_builder.parsed_options
 
               if @options[:command]
                 node.add_operation(build_cli_command_operation(@options[:command], node_attribute, @options))
               end
+            elsif k == :hook
+              node_attribute.enable_hooks = Array(v)
+              node.hooks = HookBuilder.new(@options).build(Array(v)) if node
             else
 
               next unless node
@@ -47,6 +50,7 @@ module Rundock
 
       def build_task(tasks, backend, node_attribute)
         node = Node.new(node_attribute.nodename, backend)
+        node.hooks = HookBuilder.new(nil).build_from_attributes(node_attribute.nodeinfo)
         scen = Scenario.new
 
         tasks.each do |k, v|
@@ -64,6 +68,7 @@ module Rundock
         @options[:host].split(',').each do |host|
           backend = BackendBuilder.new(@options, host, nil).build
           node = Node.new(host, backend)
+          node.hooks = HookBuilder.new(@options).build(['all'])
           node.add_operation(
             build_cli_command_operation(@options[:command], Rundock::Attribute::NodeAttribute.new, @options))
           scen.nodes.push(node)

data/lib/rundock/cli.rb

@@ -6,6 +6,7 @@ module Rundock
     DEFAULT_SCENARIO_FILE_PATH = './scenario.yml'
     DEFAULT_SSH_OPTIONS_DEFAULT_FILE_PATH = './default_ssh.yml'
     DEFAULT_HOSTGROUP_FILE_PATH = './hostgroup.yml'
+    DEFAULT_HOOKS_FILE_PATH = './hooks.yml'
 
     class_option :log_level, type: :string, aliases: ['-l'], default: 'info'
     class_option :color, type: :boolean, default: true
@@ -27,6 +28,7 @@ module Rundock
     desc 'do [SCENARIO] [options]', 'Run rundock from scenario file'
     option :sudo, type: :boolean, default: false
     option :default_ssh_opts, type: :string, aliases: ['-d'], default: DEFAULT_SSH_OPTIONS_DEFAULT_FILE_PATH
+    option :hooks, type: :string, aliases: ['-k'], default: DEFAULT_HOOKS_FILE_PATH
     option :run_anyway, type: :boolean, default: false
     option :dry_run, type: :boolean, aliases: ['-n']
     def do(*scenario_file_path)
@@ -39,6 +41,7 @@ module Rundock
     desc 'ssh [options]', 'Run rundock ssh with various options'
     option :command, type: :string, aliases: ['-c']
     option :default_ssh_opts, type: :string, aliases: ['-d'], default: DEFAULT_SSH_OPTIONS_DEFAULT_FILE_PATH
+    option :hooks, type: :string, aliases: ['-k'], default: DEFAULT_HOOKS_FILE_PATH
     option :host, type: :string, aliases: ['-h'], banner: 'You can specify comma separated hosts.[ex: host1,host2,..]'
     option :hostgroup, type: :string, aliases: ['-g']
     option :user, type: :string, aliases: ['-u']

data/lib/rundock/hook/base.rb

@@ -0,0 +1,19 @@
+module Rundock
+  module Hook
+    class Base
+      HookNotImplementedError = Class.new(NotImplementedError)
+
+      attr_reader :name
+      attr_reader :contents
+
+      def initialize(name, contents = {})
+        @name = name
+        @contents = contents
+      end
+
+      def hook(log_buffer = [], node_info = {})
+        raise HookNotImplementedError
+      end
+    end
+  end
+end

data/lib/rundock/hook_factory.rb

@@ -0,0 +1,31 @@
+module Rundock
+  class HookFactory
+    HookNotImplementedError = Class.new(NotImplementedError)
+
+    def self.instance(type)
+      self.new(type)
+    end
+
+    def initialize(type)
+      @type = type
+    end
+
+    def create(name, attributes)
+      klass = "Rundock::Hook::#{@type.to_s.to_camel_case}"
+      Logger.debug("initialize #{klass} hook")
+      raise HookNotImplementedError unless Rundock::Hook::Base.subclasses.map(&:to_s).include?(klass)
+
+      obj = nil
+      klass.split('::').map do |k|
+        if obj.nil?
+          obj = Kernel.const_get(k)
+        else
+          obj = obj.const_get(k)
+        end
+      end
+
+      hook = obj.new(name, attributes)
+      hook
+    end
+  end
+end

data/lib/rundock/logger.rb

@@ -4,15 +4,34 @@ require 'ansi/code'
 
 module Rundock
   module Logger
+    class LogEntity
+      attr_accessor :severity
+      attr_accessor :datetime
+      attr_accessor :progname
+      attr_accessor :msg
+      attr_accessor :indent_depth
+
+      def initialize(severity, datetime, progname, msg, indent_depth)
+        @severity = severity
+        @datetime = datetime
+        @progname = progname
+        @msg      = msg
+        @indent_depth = indent_depth
+      end
+    end
+
     class Formatter
       attr_accessor :colored
       attr_accessor :indent_depth
       attr_accessor :color
       attr_accessor :show_header
+      attr_accessor :onrec
+      attr_accessor :buffer
 
       def initialize(*args)
         super
         @indent_depth = 0
+        @buffer = []
       end
 
       def call(severity, datetime, progname, msg)
@@ -22,6 +41,8 @@ module Rundock
           out = "%s\n" % [msg2str(msg)]
         end
 
+        @buffer << LogEntity.new(severity, datetime, progname, msg, indent_depth)
+
         if colored
           colorize(out, severity)
         else
@@ -52,6 +73,12 @@ module Rundock
         @color = prev_color
       end
 
+      def flush
+        ret = @buffer.dup
+        @buffer.clear
+        ret
+      end
+
       private
 
       def msg2str(msg)

data/lib/rundock/node.rb

@@ -5,11 +5,13 @@ module Rundock
     attr_reader :name
     attr_reader :operations
     attr_reader :backend
+    attr_accessor :hooks
 
     def initialize(name, backend)
       @name = name
       @backend = backend
       @operations = []
+      @hooks = []
     end
 
     def add_operation(ope)
@@ -24,15 +26,29 @@ module Rundock
     end
 
     def run
+      Logger.formatter.onrec = true
       Logger.debug("run node: #{@name}")
       if @operations.blank?
         Logger.warn("no operation running: #{@name}")
         return
       end
+
+      nodeinfo = nil
+
       @operations.each do |ope|
         Logger.debug("run operation: #{ope.class}")
+        nodeinfo = ope.attributes[:nodeinfo] if nodeinfo.nil?
         ope.run(@backend, ope.attributes)
       end
+
+      log_buffer = Logger.formatter.flush unless Logger.formatter.buffer.empty?
+
+      @hooks.each do |h|
+        Logger.debug("run hook: #{h.name}")
+        h.hook(log_buffer, nodeinfo)
+      end
+
+      Logger.formatter.onrec = false
     end
   end
 end

data/lib/rundock/plugin/hook/file.rb

@@ -0,0 +1,45 @@
+require 'rundock/operation/base'
+
+module Rundock
+  module Hook
+    # You can use this sample as following yaml files for example.
+    #
+    # [hook.yml]
+    # major_log:
+    #   hook_type: file
+    #   filepath: /var/log/rundock.log
+    # minor_log:
+    #   hook_type: file
+    #   filepath: /tmp/rundock.log
+    #
+    # [scenario.yml]
+    # - node: anyhost-01
+    # command:
+    #   - 'rm -f /tmp/aaa'
+    # hook:
+    #   - major_log
+    #   - minor_log
+    # - node: localhost
+    # command:
+    #   - 'echo aaa > /tmp/abc'
+    # hook: all
+    # ---
+    # anyhost-01:
+    #   host: 192.168.1.11
+    #   ssh_opts:
+    #     port: 22
+    #     user: anyuser
+    #     key:  ~/.ssh/id_rsa
+    # ---
+    class File < Base
+      def hook(log_buffer, node_info)
+        file = ::File.open(@contents[:filepath], 'w')
+        file.puts("[hookname:#{@name} node:#{node_info[:host]}]")
+        log_buffer.each do |log|
+          file.puts("[\%5s:] %s%s\n" % [log.severity, ' ' * 2 * log.indent_depth, log.msg])
+        end
+        file.close
+      end
+    end
+  end
+end

data/lib/rundock/runner.rb

@@ -77,7 +77,7 @@ module Rundock
           next if g !~ /^(rundock-plugin-#{plugin})-/
           next if Gem::Specification.find_by_name(g).nil?
           Logger.debug("Loading rundock plugin: #{g}")
-          libdir = "#{Gem::Specification.find_by_name(g).full_gem_path}/lib/#{Regexp.last_match(0).gsub(/-/, '/')}"
+          libdir = "#{Gem::Specification.find_by_name(g).full_gem_path}/lib/#{Regexp.last_match(1).gsub(/-/, '/')}"
           Dir.glob("#{libdir}/*.rb").each do |f|
             require f.gsub(/.rb$/, '')
           end

data/lib/rundock/version.rb

@@ -1,3 +1,3 @@
 module Rundock
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/rundock.rb

@@ -6,6 +6,8 @@ require 'rundock/operation/base'
 require 'rundock/operation/task'
 require 'rundock/operation/command'
 require 'rundock/operation_factory'
+require 'rundock/hook_factory'
+require 'rundock/hook/base'
 require 'rundock/node'
 require 'rundock/attribute/base'
 require 'rundock/attribute/node_attribute'
@@ -14,6 +16,7 @@ require 'rundock/backend'
 require 'rundock/builder/base'
 require 'rundock/builder/default_ssh_builder'
 require 'rundock/builder/backend_builder'
+require 'rundock/builder/hook_builder'
 require 'rundock/builder/operation_builder'
 require 'rundock/builder/scenario_builder'
 require 'rundock/runner'

data/scenario_sample.yml

@@ -34,6 +34,9 @@
   command:
     - "hostname"
     - "uname -a"
+  hook:
+    - mail
+    - file
 - node: anyhost-01
   task:
     - echo_platform
@@ -44,6 +47,7 @@
     - errexit: false
     - "rm /tmp/safetyfile"
     - "ls -1 /tmp"
+  hook: all
 ---
 anyhost-01:
   host: 192.168.1.11

data/spec/integration/hooks/all_file_hooks.yml

@@ -0,0 +1,6 @@
+file_all_1:
+  hook_type: file
+  filepath: /var/tmp/hello_rundock_from_file_hook_all_1_scenario
+file_all_2:
+  hook_type: file
+  filepath: /var/tmp/hello_rundock_from_file_hook_all_2_scenario

data/spec/integration/hooks/simple_file_hooks.yml

@@ -0,0 +1,9 @@
+file_one:
+  hook_type: file
+  filepath: /var/tmp/hello_rundock_from_file_hook_one_scenario
+file_array_1:
+  hook_type: file
+  filepath: /var/tmp/hello_rundock_from_file_hook_array_1_scenario
+file_array_2:
+  hook_type: file
+  filepath: /var/tmp/hello_rundock_from_file_hook_array_2_scenario

data/spec/integration/platforms/localhost/scenarios/all_file_hooks_scenario.yml

@@ -0,0 +1,5 @@
+- node: localhost
+  command:
+    - "rm -f /var/tmp/hello_rundock_from_file_hook_all_1_scenario"
+    - "rm -f /var/tmp/hello_rundock_from_file_hook_all_2_scenario"
+  hook: file_all

data/spec/integration/platforms/localhost/scenarios/simple_file_hooks_scenario.yml

@@ -0,0 +1,15 @@
+- node: localhost
+  command:
+    - "rm -f /var/tmp/hello_rundock_from_file_hook_one_scenario"
+    - "rm -f /var/tmp/hello_rundock_from_file_hook_array_1_scenario"
+    - "rm -f /var/tmp/hello_rundock_from_file_hook_array_2_scenario"
+  hook: file_one
+- node: anyhost-01
+  command:
+    - "echo aaa"
+  hook:
+    - file_array_1
+    - file_array_2
+---
+anyhost-01:
+  host: localhost

data/spec/integration/recipes/file_hook_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe file('/var/tmp/hello_rundock_from_file_hook_one_scenario') do
+  it { should be_file }
+  its(:content) { should match(/hookname:file_one /) }
+end
+
+describe file('/var/tmp/hello_rundock_from_file_hook_array_1_scenario') do
+  it { should be_file }
+  its(:content) { should match(/hookname:file_array_1 /) }
+end
+
+describe file('/var/tmp/hello_rundock_from_file_hook_array_2_scenario') do
+  it { should be_file }
+  its(:content) { should match(/hookname:file_array_2 /) }
+end
+
+describe file('/var/tmp/hello_rundock_from_file_hook_all_1_scenario') do
+  it { should be_file }
+  its(:content) { should match(/hookname:file_all_1 /) }
+end
+
+describe file('/var/tmp/hello_rundock_from_file_hook_all_2_scenario') do
+  it { should be_file }
+  its(:content) { should match(/hookname:file_all_2 /) }
+end

data/spec/integration/scenarios/all_file_hooks_scenario.yml

@@ -0,0 +1,12 @@
+- node: anyhost-01
+  command:
+    - "echo 'hookname:file_all_1 ' > /var/tmp/hello_rundock_from_file_hook_all_1_scenario"
+    - "echo 'hookname:file_all_2 ' > /var/tmp/hello_rundock_from_file_hook_all_2_scenario"
+  hook: all
+---
+anyhost-01:
+  host: 172.17.42.1
+  ssh_opts:
+    port: 22222
+    user: tester
+    key: "<replaced_by_platforms>"

data/spec/integration/scenarios/simple_file_hooks_scenario.yml

@@ -0,0 +1,16 @@
+- node: anyhost-01
+  command:
+    - "echo 'hookname:file_one ' > /var/tmp/hello_rundock_from_file_hook_one_scenario"
+    - "echo 'hookname:file_array_1 ' > /var/tmp/hello_rundock_from_file_hook_array_1_scenario"
+    - "echo 'hookname:file_array_2 ' > /var/tmp/hello_rundock_from_file_hook_array_2_scenario"
+  hook:
+    - file_one
+    - file_array_1
+    - file_array_2
+---
+anyhost-01:
+  host: 172.17.42.1
+  ssh_opts:
+    port: 22222
+    user: tester
+    key: "<replaced_by_platforms>"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rundock
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - hiracy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-13 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,7 @@ files:
 - circle.yml
 - default_ssh.yml
 - exe/rundock
+- hooks_sample.yml
 - lib/rundock.rb
 - lib/rundock/attribute/base.rb
 - lib/rundock/attribute/node_attribute.rb
@@ -157,17 +158,21 @@ files:
 - lib/rundock/builder/backend_builder.rb
 - lib/rundock/builder/base.rb
 - lib/rundock/builder/default_ssh_builder.rb
+- lib/rundock/builder/hook_builder.rb
 - lib/rundock/builder/operation_builder.rb
 - lib/rundock/builder/scenario_builder.rb
 - lib/rundock/cli.rb
 - lib/rundock/ext/hash.rb
 - lib/rundock/ext/object/blank.rb
+- lib/rundock/hook/base.rb
+- lib/rundock/hook_factory.rb
 - lib/rundock/logger.rb
 - lib/rundock/node.rb
 - lib/rundock/operation/base.rb
 - lib/rundock/operation/command.rb
 - lib/rundock/operation/task.rb
 - lib/rundock/operation_factory.rb
+- lib/rundock/plugin/hook/file.rb
 - lib/rundock/plugin/operation/deploy.rb
 - lib/rundock/plugin/operation/host_inventory.rb
 - lib/rundock/plugin/operation/sample_operation.rb
@@ -177,19 +182,26 @@ files:
 - rundock.gemspec
 - scenario_sample.yml
 - spec/integration/groups/simple_host_group.yml
+- spec/integration/hooks/all_file_hooks.yml
+- spec/integration/hooks/simple_file_hooks.yml
 - spec/integration/platforms/centos6/Dockerfile
 - spec/integration/platforms/centos6/setup.sh
+- spec/integration/platforms/localhost/scenarios/all_file_hooks_scenario.yml
 - spec/integration/platforms/localhost/scenarios/deploy_scenario.yml
 - spec/integration/platforms/localhost/scenarios/run_anyway_scenario.yml
 - spec/integration/platforms/localhost/scenarios/simple_echo_scenario.yml
+- spec/integration/platforms/localhost/scenarios/simple_file_hooks_scenario.yml
 - spec/integration/platforms/localhost/scenarios/simple_plugin_scenario.yml
 - spec/integration/platforms/localhost/scenarios/use_default_ssh_scenario.yml
 - spec/integration/recipes/deploy_spec.rb
+- spec/integration/recipes/file_hook_spec.rb
 - spec/integration/recipes/simple_echo_scenario_spec.rb
 - spec/integration/recipes/simple_echo_spec.rb
 - spec/integration/recipes/simple_plugin_scenario_spec.rb
+- spec/integration/scenarios/all_file_hooks_scenario.yml
 - spec/integration/scenarios/deploy_scenario.yml
 - spec/integration/scenarios/simple_echo_scenario.yml
+- spec/integration/scenarios/simple_file_hooks_scenario.yml
 - spec/integration/scenarios/simple_plugin_scenario.yml
 - spec/integration/scenarios/use_default_ssh_scenario.yml
 - spec/integration/spec_helper.rb