inprovise 0.2.4 → 0.2.5

data/lib/inprovise/control.rb

@@ -9,10 +9,11 @@ class Inprovise::Controller
 
   class << self
 
+  private
+
     def controllers
       @controllers ||= Array.new.extend(MonitorMixin)
     end
-    private :controllers
 
     def add(ctrl)
       controllers.synchronize do
@@ -20,28 +21,24 @@ class Inprovise::Controller
       end
       ctrl
     end
-    private :add
 
     def head
       controllers.synchronize do
         return controllers.first
       end
     end
-    private :head
 
     def shift
       controllers.synchronize do
         return controllers.shift
       end
     end
-    private :shift
 
     def empty?
       controllers.synchronize do
         return controllers.empty?
       end
     end
-    private :empty?
 
     def get_value(v)
       begin
@@ -50,14 +47,19 @@ class Inprovise::Controller
         v
       end
     end
-    private :get_value
 
-    def list_scripts(options)
+    def load_schemes(options)
       # load all specified schemes
       (Array === options[:scheme] ? options[:scheme] : [options[:scheme]]).each {|s| Inprovise::DSL.include(s) }
+    end
+
+  public
+
+    def list_scripts(options)
+      load_schemes(options)
       $stdout.puts
-      $stdout.puts "   PROVISIONING SCRIPTS"
-      $stdout.puts "   ===================="
+      $stdout.puts '   PROVISIONING SCRIPTS'
+      $stdout.puts '   ===================='
       Inprovise::ScriptIndex.default.scripts.sort.each do |scrname|
         script = Inprovise::ScriptIndex.default.get(scrname)
         if script.description || options[:all]
@@ -66,8 +68,8 @@ class Inprovise::Controller
       end
     end
 
-    def parse_config(cfg, opts = {})
-      cfg.inject(opts) do |rc,cfg|
+    def parse_config(cfglist, opts = {})
+      cfglist.inject(opts) do |rc, cfg|
         k,v = cfg.split('=')
         k = k.split('.')
         h = rc
@@ -92,8 +94,7 @@ class Inprovise::Controller
             run_group_command(command, options, *args)
           end
         else # :apply, :revert, :validate or :trigger
-          # load all specified schemes
-          (Array === options[:scheme] ? options[:scheme] : [options[:scheme]]).each {|s| Inprovise::DSL.include(s) }
+          load_schemes(options)
           # extract config
           cfg = parse_config(options[:config])
           # get script/action
@@ -129,11 +130,13 @@ class Inprovise::Controller
     end
 
     def run_node_command(cmd, options, *names)
-      add(Inprovise::Controller.new).run_node_command(cmd, options, *names)
+      add(Inprovise::Controller.new).send(:"#{cmd}_node", options, *names)
+      Inprovise::Infrastructure.save
     end
 
     def run_group_command(cmd, options, *names)
-      add(Inprovise::Controller.new).run_group_command(cmd, options, *names)
+      add(Inprovise::Controller.new).send(:"#{cmd}_group", options, *names)
+      Inprovise::Infrastructure.save
     end
 
     def run_provisioning_command(command, script, opts, *targets)
@@ -183,93 +186,93 @@ class Inprovise::Controller
     end
   end
 
-  def run_node_command(command, options, *names)
-    case command
-    when :add
-      opts = self.class.parse_config(options[:config], { host: options[:address] })
-      opts[:credentials] = self.class.parse_config(options[:credential])
-      @targets << (node = Inprovise::Infrastructure::Node.new(names.first, opts))
+  def add_node(options, *names)
+    opts = self.class.parse_config(options[:config], { host: options[:address] })
+    opts[:credentials] = self.class.parse_config(options[:credential])
+    @targets << (node = Inprovise::Infrastructure::Node.new(names.first, opts))
 
-      Inprovise.log.local("Adding #{node.to_s}")
+    Inprovise.log.local("Adding #{node}")
 
-      Inprovise::Sniffer.run_sniffers_for(node) if options[:sniff]
+    Inprovise::Sniffer.run_sniffers_for(node) if options[:sniff]
 
-      options[:group].each do |g|
-        grp = Inprovise::Infrastructure.find(g)
-        raise ArgumentError, "Unknown group #{g}" unless grp
-        node.add_to(grp)
-      end
-    when :remove
-      names.each do |name|
-        node = Inprovise::Infrastructure.find(name)
-        raise ArgumentError, "Invalid node #{name}" unless node && node.is_a?(Inprovise::Infrastructure::Node)
+    options[:group].each do |g|
+      grp = Inprovise::Infrastructure.find(g)
+      raise ArgumentError, "Unknown group #{g}" unless grp
+      node.add_to(grp)
+    end
+  end
 
-        Inprovise.log.local("Removing #{node.to_s}")
+  def remove_node(_options, *names)
+    names.each do |name|
+      node = Inprovise::Infrastructure.find(name)
+      raise ArgumentError, "Invalid node #{name}" unless node && node.is_a?(Inprovise::Infrastructure::Node)
 
-        Inprovise::Infrastructure.deregister(name)
-      end
-    when :update
-      @targets = names.collect do |name|
-        tgt = Inprovise::Infrastructure.find(name)
-        raise ArgumentError, "Unknown target [#{name}]" unless tgt
-        tgt.targets
-      end.flatten.uniq
-      opts = self.class.parse_config(options[:config])
-      opts[:credentials] = self.class.parse_config(options[:credential])
-      if Inprovise.sequential || (!options[:sniff]) || @targets.size == 1
-        @targets.each {|tgt| run_target_update(tgt, opts.dup, options) }
-      else
-        threads = @targets.map {|tgt| Thread.new { run_target_update(tgt, opts.dup, options) } }
-        threads.each {|t| t.join }
-      end
+      Inprovise.log.local("Removing #{node}")
+
+      Inprovise::Infrastructure.deregister(name)
     end
-    Inprovise::Infrastructure.save
   end
 
-  def run_group_command(command, options, *names)
-    case command
-    when :add
-      options[:target].each {|t| raise ArgumentError, "Unknown target [#{t}]" unless Inprovise::Infrastructure.find(t) }
-      opts = self.class.parse_config(options[:config])
-      grp = Inprovise::Infrastructure::Group.new(names.first, opts, options[:target])
+  def update_node(options, *names)
+    @targets = names.collect do |name|
+      tgt = Inprovise::Infrastructure.find(name)
+      raise ArgumentError, "Unknown target [#{name}]" unless tgt
+      tgt.targets
+    end.flatten.uniq
+    opts = self.class.parse_config(options[:config])
+    opts[:credentials] = self.class.parse_config(options[:credential])
+    if Inprovise.sequential || (!options[:sniff]) || @targets.size == 1
+      @targets.each {|tgt| run_target_update(tgt, opts.dup, options) }
+    else
+      threads = @targets.map {|tgt| Thread.new { run_target_update(tgt, opts.dup, options) } }
+      threads.each {|t| t.join }
+    end
+  end
 
-      Inprovise.log.local("Adding #{grp.to_s}")
+  def add_group(options, *names)
+    options[:target].each {|t| raise ArgumentError, "Unknown target [#{t}]" unless Inprovise::Infrastructure.find(t) }
+    opts = self.class.parse_config(options[:config])
+    grp = Inprovise::Infrastructure::Group.new(names.first, opts, options[:target])
 
-      options[:target].each do |t|
-        tgt = Inprovise::Infrastructure.find(t)
-        raise ArgumentError, "Unknown target #{t}" unless tgt
-        tgt.add_to(grp)
-      end
-    when :remove
-      names.each do |name|
-        grp = Inprovise::Infrastructure.find(name)
-        raise ArgumentError, "Invalid group #{name}" unless grp && grp.is_a?(Inprovise::Infrastructure::Group)
+    Inprovise.log.local("Adding #{grp}")
 
-        Inprovise.log.local("Removing #{grp.to_s}")
+    options[:target].each do |t|
+      tgt = Inprovise::Infrastructure.find(t)
+      raise ArgumentError, "Unknown target #{t}" unless tgt
+      tgt.add_to(grp)
+    end
+  end
 
-        Inprovise::Infrastructure.deregister(name)
-      end
-    when :update
-      groups = names.collect do |name|
-        grp = Inprovise::Infrastructure.find(name)
-        raise ArgumentError, "Invalid group #{name}" unless grp && grp.is_a?(Inprovise::Infrastructure::Group)
-        grp
-      end
-      opts = self.class.parse_config(options[:config])
-      grp_tgts = options[:target].collect do |t|
-                   tgt = Inprovise::Infrastructure.find(t)
-                   raise ArgumentError, "Unknown target #{t}" unless tgt
-                   tgt
-                 end
-      groups.each do |grp|
-        Inprovise.log.local("Updating #{grp.to_s}")
-
-        grp.config.clear if options[:reset]
-        grp.config.merge!(opts)
-        grp_tgts.each {|tgt| tgt.add_to(grp) }
-      end
+  def remove_group(_options, *names)
+    names.each do |name|
+      grp = Inprovise::Infrastructure.find(name)
+      raise ArgumentError, "Invalid group #{name}" unless grp && grp.is_a?(Inprovise::Infrastructure::Group)
+
+      Inprovise.log.local("Removing #{grp}")
+
+      Inprovise::Infrastructure.deregister(name)
+    end
+  end
+
+  def update_group(options, *names)
+    groups = names.collect do |name|
+      tgt = Inprovise::Infrastructure.find(name)
+      raise ArgumentError, "Invalid group #{name}" unless tgt && tgt.is_a?(Inprovise::Infrastructure::Group)
+      tgt
+    end
+    opts = self.class.parse_config(options[:config])
+    grp_tgts = options[:target].collect do |tnm|
+      tgt = Inprovise::Infrastructure.find(tnm)
+      raise ArgumentError, "Unknown target #{tnm}" unless tgt
+      tgt
+    end
+    groups.each do |grp|
+      Inprovise.log.local("Updating #{grp}")
+
+      grp.config.clear if options[:reset]
+      grp.config.merge!(opts)
+      grp_tgts.each {|gt| gt.add_to(grp) }
     end
-    Inprovise::Infrastructure.save
   end
 
   private
@@ -298,7 +301,7 @@ class Inprovise::Controller
   end
 
   def run_target_update(tgt, tgt_opts, options)
-    Inprovise.log.local("Updating #{tgt.to_s}")
+    Inprovise.log.local("Updating #{tgt}")
 
     if options[:reset]
       # preserve :host

data/lib/inprovise/helper/cygwin.rb

@@ -3,6 +3,8 @@
 # Author::    Martin Corino
 # License::   Distributes under the same license as Ruby
 
+# :nocov:
+
 Inprovise::CmdHelper.define('cygwin', Inprovise::CmdHelper.implementations['linux']) do
 
   def initialize(channel)
@@ -41,3 +43,6 @@ Inprovise::CmdHelper.define('cygwin', Inprovise::CmdHelper.implementations['linu
   # basic commands
 
 end
+
+# :nocov:
+

data/lib/inprovise/helper/linux.rb

@@ -3,6 +3,8 @@
 # Author::    Martin Corino
 # License::   Distributes under the same license as Ruby
 
+# :nocov:
+
 Inprovise::CmdHelper.define('linux') do
 
   def initialize(channel, sudo=false)
@@ -48,11 +50,11 @@ Inprovise::CmdHelper.define('linux') do
   # file management
 
   def upload(from, to)
-    @channel.upload(real_path(from), real_path(to))
+    @channel.upload(from, real_path(to))
   end
 
   def download(from, to)
-    @channel.download(real_path(from), real_path(to))
+    @channel.download(real_path(from), to)
   end
 
   # basic commands
@@ -101,7 +103,7 @@ Inprovise::CmdHelper.define('linux') do
   def directory?(path)
     path = real_path(path)
     begin
-      @channel.file?(path)
+      @channel.directory?(path)
     rescue
       (exec("stat --format=%f #{path}").chomp.hex & 0x4000) == 0x4000
     end
@@ -185,3 +187,6 @@ Inprovise::CmdHelper.define('linux') do
   end
 
 end
+
+# :nocov:
+

data/lib/inprovise/helper/windows.rb

@@ -5,6 +5,8 @@
 
 require 'digest/sha1'
 
+# :nocov:
+
 Inprovise::CmdHelper.define('windows') do
 
   # platform properties
@@ -125,3 +127,5 @@ Inprovise::CmdHelper.define('windows') do
   end
 
 end
+
+# :nocov:

data/lib/inprovise/node.rb

@@ -253,7 +253,7 @@ class Inprovise::Infrastructure::Node < Inprovise::Infrastructure::Target
       @history << {cmd:cmd, output:output}
       output
     rescue Exception
-      raise RuntimeError, "Failed to communicate with [#{self.to_s}]"
+      raise RuntimeError, "Failed to communicate with [#{self}]"
     end
   end
 

data/lib/inprovise/sniffer/linux.rb

@@ -5,6 +5,8 @@
 
 Inprovise::Sniffer.define('linux', false) do
 
+  # :nocov:
+
   action('main') do |attrs|
     attrs[:machine] = run('uname -m').chomp
     if remote('/etc/os-release').exists?
@@ -61,4 +63,6 @@ Inprovise::Sniffer.define('linux', false) do
     end
   end
 
+  # :nocov:
+
 end

data/lib/inprovise/sniffer/platform.rb

@@ -5,6 +5,8 @@
 
 Inprovise::Sniffer.define('platform') do
 
+  # :nocov:
+
   action('helper') do |attrs|
     # determin the best CmdHelper if not user defined
     attrs[:helper] = case attrs[:os]
@@ -39,6 +41,8 @@ Inprovise::Sniffer.define('platform') do
     (node.config[:attributes][:platform] ||= {}).merge!(attrs)
   end
 
+  # :nocov:
+
 end
 
 require_relative './windows.rb'

data/lib/inprovise/sniffer/windows.rb

@@ -5,6 +5,8 @@
 
 Inprovise::Sniffer.define('windows', false) do
 
+  # :nocov:
+
   action('main') do |attrs|
     attrs[:machine] = env('PROCESSOR_ARCHITECTURE').chomp =~ /amd64/i ? 'x86_64' : 'x86'
     osver = run('cmd /c ver').strip
@@ -29,4 +31,6 @@ Inprovise::Sniffer.define('windows', false) do
     end
   end
 
+  # :nocov:
+
 end

data/lib/inprovise/template.rb

@@ -19,7 +19,7 @@ class Inprovise::Template
   end
 
   def render_to_tempfile(locals={})
-    basename = @path.respond_to?(:call) ? 'inprovise-inline-tpl' : File.basename(@path).gsub('.', '-')
+    basename = @path.respond_to?(:call) ? 'inprovise-inline-tpl' : File.basename(@path).tr('.', '-')
     file = Tempfile.new(basename)
     file.write render(locals)
     file.close

data/lib/inprovise/version.rb

@@ -5,6 +5,6 @@
 
 module Inprovise
 
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 
 end

data/test/helper_test.rb

@@ -0,0 +1,189 @@
+# ScriptRunner  tests for Inprovise
+#
+# Author::    Martin Corino
+# License::   Distributes under the same license as Ruby
+
+require_relative 'test_helper'
+
+describe Inprovise::CmdHelper do
+  before :each do
+    @node = Inprovise::Infrastructure::Node.new('myNode', {channel: 'test', helper: 'linux'})
+  end
+
+  after :each do
+    reset_infrastructure!
+  end
+
+  describe 'helper' do
+
+    describe 'platform specifics' do
+      it 'provides appropriate administrator account' do
+        @node.helper.admin_user.must_equal 'root'
+      end
+
+      it 'provides appropriate environment variable format' do
+        @node.helper.env_reference('VAR').must_equal '$VAR'
+      end
+    end
+
+    describe 'working directory' do
+      it 'manages working directory' do
+        @node.channel.expects(:run).with('pwd', false).returns('/root')
+        @node.helper.cwd.must_equal '/root'
+      end
+
+      it 'returns old cwd on setting cwd' do
+        @node.helper.set_cwd('/home/user').must_be_nil
+        @node.helper.cwd.must_equal '/home/user'
+        @node.helper.set_cwd('/root').must_equal '/home/user'
+        @node.helper.cwd.must_equal '/root'
+        @node.helper.set_cwd(nil).must_equal '/root'
+        @node.channel.expects(:run).with('pwd', false).returns('/root')
+        @node.helper.cwd.must_equal '/root'
+      end
+    end
+
+    describe 'command execution' do
+      it 'runs commands' do
+        @node.channel.expects(:run).with('echo ok', false).returns('ok')
+        @node.helper.run('echo ok').must_equal 'ok'
+      end
+
+      it 'runs sudo commands' do
+        @node.channel.expects(:run).with('sudo sh -c "echo ok"', false).returns('ok')
+        @node.helper.sudo.run('echo ok').must_equal 'ok'
+      end
+
+      it 'runs commands in cwd' do
+        @node.helper.set_cwd('/home/user')
+        @node.channel.expects(:run).with('cd /home/user; echo ok', false).returns('ok')
+        @node.helper.run('echo ok').must_equal 'ok'
+      end
+    end
+
+    describe 'file transfer' do
+      it 'uploads files' do
+        @node.channel.expects(:upload).with('/from/path', '/to/path')
+        @node.helper.upload('/from/path', '/to/path')
+      end
+
+      it 'downloads files' do
+        @node.channel.expects(:download).with('/from/path', '/to/path')
+        @node.helper.download('/from/path', '/to/path')
+      end
+
+      it 'uploads files with changed cwd' do
+        @node.helper.set_cwd('/home/user')
+        @node.channel.expects(:upload).with('/from/path', '/home/user/to/path')
+        @node.helper.upload('/from/path', 'to/path')
+      end
+
+      it 'downloads files with changed cwd' do
+        @node.helper.set_cwd('/home/user')
+        @node.channel.expects(:download).with('/home/user/from/path', '/to/path')
+        @node.helper.download('from/path', '/to/path')
+      end
+    end
+
+    describe 'file management' do
+
+      it 'returns file content' do
+        @node.channel.expects(:content).with('/file/path')
+        @node.helper.cat('/file/path')
+      end
+
+      it 'returns file content from cwd' do
+        @node.helper.set_cwd('/home/user')
+        @node.channel.expects(:content).with('/home/user/file/path')
+        @node.helper.cat('file/path')
+      end
+
+      it 'creates a directory' do
+        @node.channel.expects(:run).with('mkdir -p /dir/path', false)
+        @node.helper.mkdir('/dir/path')
+      end
+
+      it 'creates a directory from cwd' do
+        @node.helper.set_cwd('/home/user')
+        @node.channel.expects(:run).with('mkdir -p /home/user/dir/path', false)
+        @node.helper.mkdir('dir/path')
+      end
+
+      it 'checks path existence' do
+        @node.channel.expects(:exists?).with('/file/path').returns(true)
+        @node.helper.exists?('/file/path').must_equal true
+      end
+
+      it 'check file existence' do
+        @node.channel.expects(:file?).with('/file/path').returns(true)
+        @node.helper.file?('/file/path').must_equal true
+      end
+
+      it 'checks directory existence' do
+        @node.channel.expects(:directory?).with('/dir/path').returns(true)
+        @node.helper.directory?('/dir/path').must_equal true
+      end
+
+      it 'copies files' do
+        @node.channel.expects(:run).with("cp /from/path /to/path", false)
+        @node.helper.copy('/from/path', '/to/path')
+      end
+
+      it 'moves files' do
+        @node.channel.expects(:run).with("mv /from/path /to/path", false)
+        @node.helper.move('/from/path', '/to/path')
+      end
+
+      it 'deletes files' do
+        @node.channel.expects(:delete).with('/file/path')
+        @node.helper.delete('/file/path')
+      end
+
+      it 'returns file permissions' do
+        @node.channel.expects(:permissions).with('/file/path').returns(0755)
+        @node.helper.permissions('/file/path').must_equal 0755
+      end
+
+      it 'sets file permissions' do
+        @node.channel.expects(:set_permissions).with('/file/path', 0755)
+        @node.helper.set_permissions('/file/path', 0755)
+      end
+
+      it 'returns file owner' do
+        @node.channel.expects(:owner).with('/file/path').returns({ :user => 'me', :group => 'them'  })
+        @node.helper.owner('/file/path').must_equal({ :user => 'me', :group => 'them'  })
+      end
+
+      it 'sets file owner' do
+        @node.channel.expects(:set_owner).with('/file/path', 'me','them')
+        @node.helper.set_owner('/file/path', 'me','them')
+      end
+
+    end
+
+    describe 'shell utilities' do
+
+      it 'echoes' do
+        @node.channel.expects(:run).with('echo ok', false).returns('ok')
+        @node.helper.echo('ok').must_equal 'ok'
+      end
+
+      it 'returns an environment variables value' do
+        @node.channel.expects(:run).with('echo $HOME', false).returns('/home/user')
+        @node.helper.env('HOME').must_equal '/home/user'
+      end
+
+      it 'returns an SHA1 hash for the file content' do
+        @node.channel.expects(:run).with('sha1sum /file/path', false).returns('A1B2C3D4')
+        @node.helper.hash_for('/file/path').must_equal 'A1B2C3D4'
+      end
+
+      it 'checks binary existence' do
+        @node.channel.expects(:run).with('which ruby', false).returns('/usr/bin/ruby')
+        @node.helper.binary_exists?('ruby').must_equal true
+      end
+
+    end
+
+  end
+end