rundock 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eef77dde29974f83d4bef90d7ac82886ebfc46d5
-  data.tar.gz: 484b9c3e7f4f4f557a3ecb1d3d5ce506566bc45d
+  metadata.gz: 1185fca2a1ac6281bed2903980ac243aa515d728
+  data.tar.gz: 2a33d417121c653dbab71d14d20090bad52588df
 SHA512:
-  metadata.gz: adf8f0dc23a9a4f38db95b77eb804ac336dae9aba7d0a8d671572221c635c8ec8fc6fd3b71ef0cc8979162f22253b603345a85b33578e413bbe30005037622be
-  data.tar.gz: a8b0d0a20eb279a2ae8f46cbe800a38fe266736d4087a0eccb15546cea74d7e13525245e72706a999376e64fd622cad4198b8f4245a6b9408a8b397ab781f5da
+  metadata.gz: ee69507c2340f648f8d702d8fcb4d80153d1336633ab1eb55e3e4fd130a53f9318d408b73989aab65d3d95ef296b7790b1d5612a5c89984eb738ab76f9bf58e9
+  data.tar.gz: 6d319b172002d86612a4b986887dc76c0655268d36834b9e794b8c6946076985adbe1a28d07db30685bc0d4f26048dab62b77c0cf6a08362e850337b0c321495

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v0.2.3
+
+Fix
+
+- Fix symbol host access if localhost
+
+Improvements
+
+- Support operation plugins for extension
+
 ## v0.2.2
 
 Fix

data/lib/rundock/attribute/base.rb

@@ -0,0 +1,30 @@
+module Rundock
+  module Attribute
+    class Base
+      def initialize(attr = {})
+        attr.each { |k, v| define_attr(k.to_sym, v) }
+      end
+
+      def self.attr_accessor(*vars)
+        @attributes ||= []
+        @attributes.concat(vars)
+        super(*vars)
+      end
+
+      def self.list
+        @attributes
+      end
+
+      def list
+        self.class.list.each_with_object({}) do |a, result|
+          result[a] = self.send(a)
+        end
+      end
+
+      def define_attr(name, val)
+        self.class.send(:attr_accessor, name)
+        self.send("#{name}=", val)
+      end
+    end
+  end
+end

data/lib/rundock/attribute/node_attribute.rb

@@ -0,0 +1,21 @@
+module Rundock
+  module Attribute
+    class NodeAttribute < Base
+      attr_accessor :node
+      attr_accessor :nodename
+      attr_accessor :task_info
+      attr_accessor :errexit
+
+      AVAIL_TAKE_OVERS = [
+        :task_info,
+        :errexit
+      ]
+
+      def finalize_node
+        list.each do |k, _v|
+          define_attr(k, nil) unless AVAIL_TAKE_OVERS.include?(k)
+        end
+      end
+    end
+  end
+end

data/lib/rundock/backend.rb

@@ -3,6 +3,7 @@ require 'singleton'
 require 'specinfra/core'
 require 'io/console'
 require 'net/ssh'
+require 'net/ssh/proxy/command'
 
 Specinfra::Configuration.error_on_missing_backend_type = true
 
@@ -64,6 +65,10 @@ module Rundock
       def create_specinfra_backend
         raise NotImplementedError
       end
+
+      def method_missing(method, *args)
+        @backend.send(method, *args)
+      end
     end
 
     class Local < Base
@@ -88,10 +93,12 @@ module Rundock
           ssh_opts = Net::SSH::Config.for(options[:host])
         end
 
+        # priority = node_attributes > cli options
         ssh_opts[:host_name] = options[:host]
         ssh_opts[:keys] = Array(options[:key]) if options[:key]
         ssh_opts[:password] = parse_password_from_stdin if options[:ask_password]
         ssh_opts.merge!(filter_net_ssh_options(options))
+        ssh_opts[:proxy] = Kernel.eval(options[:proxy]) if options[:proxy]
 
         Logger.debug(%(Net::SSH Options: "#{ssh_opts}"))
 

data/lib/rundock/builder/backend_builder.rb

@@ -41,7 +41,7 @@ module Rundock
         @options.keys.select { |o| o.to_s =~ /(\w+)_ssh_default$/ }.each do |oo|
           # no use default ssh options if local
           # set unless scenario file and cli options specified and not localhost
-          next if @nodename =~ /localhost|127\.0\.0\.1/
+          next if localhost?
           opt = oo.to_s.gsub(/_ssh_default/, '').to_sym
           if !@node_info[@nodename.to_sym][:ssh_opts][opt] && !@options[opt]
             @node_info[@nodename.to_sym][:ssh_opts][opt] = @options[oo]
@@ -56,7 +56,7 @@ module Rundock
       end
 
       def parse_backend_type
-        if @nodename =~ /localhost|127\.0\.0\.1/ &&
+        if localhost? &&
            !@node_info[@nodename.to_sym][:ssh_opts][:port] &&
            !@node_info[@nodename.to_sym][:ssh_opts][:user] &&
            !@node_info[@nodename.to_sym][:ssh_opts][:ssh_config]
@@ -67,6 +67,11 @@ module Rundock
 
         backend_type
       end
+
+      def localhost?
+        @nodename =~ /localhost|127\.0\.0\.1/ ||
+          @node_info[@nodename.to_sym][:host] =~ /localhost|127\.0\.0\.1/
+      end
     end
   end
 end

data/lib/rundock/builder/operation_builder.rb

@@ -8,8 +8,8 @@ module Rundock
 
         node = nil
         scen = Scenario.new
-        node_attributes = { :task => {} }
-        tasks.each { |k, v| node_attributes[:task][k] = v } if tasks
+        node_attribute = Rundock::Attribute::NodeAttribute.new(task_info: {})
+        tasks.each { |k, v| node_attribute.task_info[k] = v } if tasks
         scen.node_info = node_info
         scen.tasks = tasks
 
@@ -19,10 +19,10 @@ module Rundock
 
           n.deep_symbolize_keys.each do |k, v|
             if k == :node
+              node_attribute.finalize_node
               backend = BackendBuilder.new(@options, v, node_info).build
               node = Node.new(v, backend)
-              node_attributes[:nodename] = v
-
+              node_attribute.nodename = v
               if @options[:command]
                 node.add_operation(build_cli_command_operation(@options[:command], @options))
               end
@@ -34,7 +34,7 @@ module Rundock
 
               next unless node
 
-              ope = build_operations(k, Array(v), node_attributes, @options)
+              ope = build_operations(k, Array(v), node_attribute, @options)
               node.add_operation(ope)
             end
           end
@@ -44,12 +44,12 @@ module Rundock
         scen
       end
 
-      def build_task(tasks, backend, node_attributes)
-        node = Node.new(node_attributes[:nodename], backend)
+      def build_task(tasks, backend, node_attribute)
+        node = Node.new(node_attribute.nodename, backend)
         scen = Scenario.new
 
         tasks.each do |k, v|
-          ope = build_operations(k, Array(v), node_attributes, nil)
+          ope = build_operations(k, Array(v), node_attribute, nil)
           node.add_operation(ope)
         end
 
@@ -73,15 +73,16 @@ module Rundock
       private
 
       def build_cli_command_operation(command, cli_options)
-        node_attributes = {}
-        node_attributes[:errexit] = !cli_options[:run_anyway]
+        node_attribute = Rundock::Attribute::NodeAttribute.new
+        node_attribute.errexit = !cli_options[:run_anyway]
         Rundock::OperationFactory.instance(:command).create(Array(command), nil)
       end
 
       def build_operations(ope_type, ope_content, node_attributes, cli_options)
-        node_attributes[:errexit] = !cli_options[:run_anyway] if cli_options
-        node_attributes[:errexit] = true if cli_options.nil?
-        Rundock::OperationFactory.instance(ope_type).create(Array(ope_content), node_attributes)
+        node_attributes.errexit = !cli_options[:run_anyway] if cli_options
+        node_attributes.errexit = true if cli_options.nil?
+        node_attributes.define_attr(ope_type, ope_content)
+        Rundock::OperationFactory.instance(ope_type).create(Array(ope_content), node_attributes.list)
       end
     end
   end

data/lib/rundock/cli.rb

@@ -52,5 +52,9 @@ module Rundock
 
       Runner.run(opts.merge(options.deep_symbolize_keys))
     end
+
+    def method_missing(command, *args)
+      help
+    end
   end
 end

data/lib/rundock/operation/task.rb

@@ -3,13 +3,13 @@ module Rundock
     class Task < Base
       def run(backend, attributes = {})
         @instruction.each do |i|
-          unless attributes[:task].key?(i.to_sym)
+          unless attributes[:task_info].key?(i.to_sym)
             Logger.warn("task not found and ignored: #{i}")
             next
           end
 
           scenario = Rundock::Builder::ScenarioBuilder.new(nil, nil).build_task(
-            attributes[:task][i.to_sym], backend, attributes)
+            attributes[:task_info][i.to_sym], backend, Rundock::Attribute::NodeAttribute.new(attributes))
 
           scenario.run
         end

data/lib/rundock/plugin/operation/sample_operation.rb

@@ -0,0 +1,44 @@
+require 'rundock/operation/base'
+
+module Rundock
+  module Operation
+    # You can use this sample as following scenario.yml for example.
+    #
+    # - node: anyhost-01
+    # sample_operation:
+    #   - cmd: 'ls ~'
+    #     all: true
+    # ---
+    # anyhost-01:
+    #   host: 192.168.1.11
+    #   ssh_opts:
+    #     port: 22
+    #     user: anyuser
+    #     key:  ~/.ssh/id_rsa
+    # ---
+    class SampleOperation < Base
+      def run(backend, attributes)
+        operation = attributes[:sample_operation][0]
+
+        cmd = ''
+        args_line = ''
+        operation.each do |k, v|
+          if k == :cmd
+            cmd = v
+            next
+          end
+
+          if v.is_a?(TrueClass)
+            args_line << " --#{k}"
+          elsif v.is_a?(String)
+            args_line << " --#{k} #{v}"
+          end
+        end
+
+        Logger.info("do #{cmd}#{args_line}")
+        result = backend.run_command("#{cmd}#{args_line}")
+        Logger.info(result.stdout)
+      end
+    end
+  end
+end

data/lib/rundock/runner.rb

@@ -4,12 +4,14 @@ require 'open-uri'
 module Rundock
   class Runner
     ScenarioNotFoundError = Class.new(StandardError)
+    RUNDOCK_PLUGINS = %w(operation hook)
 
     class << self
       def run(options)
         Logger.debug 'Starting Rundoc:'
 
         runner = self.new(options)
+        runner.load_plugins
         runner.build(options)
         runner.run
       end
@@ -25,10 +27,6 @@ module Rundock
       @scenario.run
     end
 
-    def run_tasks
-      @scenario.run
-    end
-
     def build(options)
       if options[:scenario] || options[:hostgroup]
         if options[:scenario] && !FileTest.exist?(options[:scenario])
@@ -55,5 +53,29 @@ module Rundock
         @scenario = Rundock::Builder::ScenarioBuilder.new(options, nil).build
       end
     end
+
+    def load_plugins
+      Dir.glob("#{File.expand_path(File.dirname(__FILE__))}/plugin/**/*.rb").each do |f|
+        require f.gsub(/.rb$/, '')
+      end
+
+      gems = []
+      Gem::Specification.each do |gem|
+        gems << gem.name
+      end
+      gems.uniq!
+
+      gems.each do |g|
+        RUNDOCK_PLUGINS.each do |plugin|
+          next if g !~ /^(rundock-plugin-#{plugin})-/
+          next if Gem::Specification.find_by_path(g).nil?
+          Logger.debug("Loading rundock plugin: #{g}")
+          libdir = "#{Gem::Specification.find_by_path(g).full_gem_path}/lib/rundock/plugin/#{Regexp.last_match(0)}"
+          Dir.glob("#{libdir}/*.rb").each do |f|
+            require f.gsub(/.rb$/, '')
+          end
+        end
+      end
+    end
   end
 end

data/lib/rundock/version.rb

@@ -1,3 +1,3 @@
 module Rundock
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/lib/rundock.rb

@@ -7,6 +7,8 @@ require 'rundock/operation/task'
 require 'rundock/operation/command'
 require 'rundock/operation_factory'
 require 'rundock/node'
+require 'rundock/attribute/base'
+require 'rundock/attribute/node_attribute'
 require 'rundock/scenario'
 require 'rundock/backend'
 require 'rundock/builder/base'

data/scenario_sample.yml

@@ -45,12 +45,12 @@
     - "rm /tmp/safetyfile"
     - "ls -1 /tmp"
 ---
-- anyhost-01:
+anyhost-01:
   host: 192.168.1.11
   ssh_opts:
     port: 22
     user: anyuser
-- anyhost-02:
+anyhost-02:
   host: 192.168.1.12
 ---
 echo_platform:

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

@@ -0,0 +1,10 @@
+- node: anyhost-01
+  task:
+    - write_echo
+---
+anyhost-01:
+  host: localhost
+---
+write_echo:
+  sample_operation:
+    - cmd: "echo 'Hello Rundock from SampleOperationPlugin Scenario.' > /var/tmp/hello_rundock_from_sample_operation_scenario"

data/spec/integration/recipes/simple_plugin_scenario_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe file('/var/tmp/hello_rundock_from_sample_operation_scenario') do
+  it { should be_file }
+  its(:content) { should match(/Hello Rundock from SampleOperationPlugin Scenario./) }
+end

data/spec/integration/scenarios/simple_plugin_scenario.yml

@@ -0,0 +1,14 @@
+- node: anyhost-01
+  task:
+    - write_echo
+---
+anyhost-01:
+  host: 172.17.42.1
+  ssh_opts:
+    port: 22222
+    user: tester
+    key: "<replaced_by_platforms>"
+---
+write_echo:
+  sample_operation:
+    - cmd: "echo 'Hello Rundock from SampleOperationPlugin Scenario.' > /var/tmp/hello_rundock_from_sample_operation_scenario"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rundock
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - hiracy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,6 +151,8 @@ files:
 - default_ssh.yml
 - exe/rundock
 - lib/rundock.rb
+- lib/rundock/attribute/base.rb
+- lib/rundock/attribute/node_attribute.rb
 - lib/rundock/backend.rb
 - lib/rundock/builder/backend_builder.rb
 - lib/rundock/builder/base.rb
@@ -166,6 +168,7 @@ files:
 - lib/rundock/operation/command.rb
 - lib/rundock/operation/task.rb
 - lib/rundock/operation_factory.rb
+- lib/rundock/plugin/operation/sample_operation.rb
 - lib/rundock/runner.rb
 - lib/rundock/scenario.rb
 - lib/rundock/version.rb
@@ -176,10 +179,13 @@ files:
 - spec/integration/platforms/centos6/setup.sh
 - spec/integration/platforms/localhost/scenarios/run_anyway_scenario.yml
 - spec/integration/platforms/localhost/scenarios/simple_echo_scenario.yml
+- spec/integration/platforms/localhost/scenarios/simple_plugin_scenario.yml
 - spec/integration/platforms/localhost/scenarios/use_default_ssh_scenario.yml
 - 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/simple_echo_scenario.yml
+- spec/integration/scenarios/simple_plugin_scenario.yml
 - spec/integration/scenarios/use_default_ssh_scenario.yml
 - spec/integration/spec_helper.rb
 homepage: https://github.com/hiracy/rundock