inprovise 0.2.4 → 0.2.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjA2NmY3ZWEzYjMzZWZhN2NiZTQ1MTkzODNlMjFhZmMyZDA5MzYzMQ==
+    NTQ5MmNkZGZjZmJlZjZhNmYxOWE0ZTM3Y2U1MWVjYWQ0ZGM2N2U5Mw==
   data.tar.gz: !binary |-
-    YzMxY2Q2NzNiMmYyZjg4YjRlOTFhNDBlNmM0YTZiNzM5OTg5ZDNhNg==
+    MjUyY2E2M2M3MWY2OTQwZDY2ZTFhODRhMTM0OWU5ZWFhNTk0Y2MxYQ==
 SHA512:
   metadata.gz: !binary |-
-    ZDk2Nzc2ZDZlYjhjNjFiMmM0NzdiMDFiOWNmNjIyYWNlOTdjMDViOTQxOGRi
-    ZjQwMGUwYWZmYzU0YjBmZTI0MjZmZjE2NjAyZjQwMGEzNmMyODk5ZjRjOWQ4
-    MDgwNjBiNzZlYTBiNTQxYjUyNDUzMWViODQwNGI0Y2QzMTZjZTE=
+    YTA0MjcyMGE0YWI3OWYxNzQ2MDEwYzBhZjEwMWFhYTY4ZGZjYTNlNzdiZmUy
+    ZGM0ZGFhNmUyMjAwMjdiMzYyZjY0YjA4YTYzOTNiMDY1OGE4ODdlYWE2YWU5
+    NTdjOGZlMDRjYmNmOWJjMGRiZjJiN2IwMmQ4YzBjZGExYzZjNDM=
   data.tar.gz: !binary |-
-    YjA0ZWY1YmJmODJjMjhlZTIzYmJhYzE0OTMzNTMyMmE4NjkwN2E2OGUyMjcy
-    MzdkZDQxODMwZDNiOTNhOTlkYTcyMGQ2NGQ3ZGIzNDc5MmFiNWI5ZDFhNGZm
-    Y2ZhYWYwYzEwZDRhZWE0NzAwODUzNDYzMDYyMTk3Y2I5ZjI0ZTI=
+    MGExZGNlNzFmZGRmMDM4MjU4OTE0NWY2OGEyZDg3Y2M1OGZlZmVhZDYyZjg4
+    NjVjMGUyZWUzMjBiNGEyOWQ5OTRiMTFiMmQ5YTI0ZGY4NTk5ZjA3NjUzNzEx
+    MjE1N2RjMTQzM2I0ZWM0MDM2N2VkOGNhNzhiMGRkOTlkZTNlOTk=

data/.codeclimate.yml

@@ -0,0 +1,24 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+    exclude_paths:
+    - "lib/inprovise/node.rb"
+    - "lib/inprovise/control.rb"
+    - "lib/inprovise/cli/provision.rb"
+    - "lib/inprovise/cli/node.rb"
+    - "lib/inprovise/cli/group.rb"
+    - "lib/inprovise/helper/linux.rb"
+    - "lib/inprovise/channel/ssh.rb"
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Lint/RescueException:
+        enabled: false
+      Rubocop/Metrics/ClassLength:
+        enabled: false
+ratings:
+   paths:
+   - "lib/**/*"

data/lib/inprovise/channel/ssh.rb

@@ -7,6 +7,8 @@ require 'net/ssh'
 require 'net/sftp'
 require 'digest/sha1'
 
+# :nocov:
+
 Inprovise::CmdChannel.define('ssh') do
 
   def initialize(node)
@@ -45,34 +47,30 @@ Inprovise::CmdChannel.define('ssh') do
     sftp.mkdir!(path)
   end
 
-  def exists?(path)
-    @node.log.remote("SFTP.EXISTS?: #{path}") if Inprovise.verbosity > 1
+  def path_check(path, type=nil)
     begin
-      sftp.stat!(path) != nil
+      stat = sftp.stat!(path)
+      stat != nil && (type.nil? || stat.symbolic_type == type)
     rescue Net::SFTP::StatusException => ex
       raise ex unless ex.code == Net::SFTP::Response::FX_NO_SUCH_FILE
       false
     end
   end
+  private :path_check
+
+  def exists?(path)
+    @node.log.remote("SFTP.EXISTS?: #{path}") if Inprovise.verbosity > 1
+    path_check(path)
+  end
 
   def file?(path)
     @node.log.remote("SFTP.FILE?: #{path}") if Inprovise.verbosity > 1
-    begin
-      sftp.stat!(path).symbolic_type == :regular
-    rescue Net::SFTP::StatusException => ex
-      raise ex unless ex.code == Net::SFTP::Response::FX_NO_SUCH_FILE
-      false
-    end
+    path_check(path, :regular)
   end
 
   def directory?(path)
     @node.log.remote("SFTP.DIRECTORY?: #{path}") if Inprovise.verbosity > 1
-    begin
-      sftp.stat!(path).symbolic_type == :directory
-    rescue Net::SFTP::StatusException => ex
-      raise ex unless ex.code == Net::SFTP::Response::FX_NO_SUCH_FILE
-      false
-    end
+    path_check(path, :directory)
   end
 
   def content(path)
@@ -142,42 +140,58 @@ Inprovise::CmdChannel.define('ssh') do
     log_bak = @node.log
     begin
       @node.log_to(Inprovise::Logger.new(@node, 'ssh[init]'))
-      unless exists?('./.ssh')
-        mkdir('./.ssh') rescue run('mkdir .ssh')
-        set_permissions('./.ssh', 755) rescue run('chmod 0755 ./.ssh')
-      end
+
+      # load public key
       pubkey = File.read(pubkey_path)
-      # check if public key already configured
-      if exists?('./.ssh/authorized_keys')
-        auth_keys = begin
-                      content('./.ssh/authorized_keys')
-                    rescue
-                      run('cat ./.ssh/authorized_keys')
-                    end.split("\n")
-        return if auth_keys.any? { |key| key == pubkey }
-      end
+      # quit if already installed
+      return if check_pubkey(pubkey)
+
       begin
-        @node.log.remote("APPEND: #{pubkey_path} -> ./.ssh/authorized_keys") if Inprovise.verbosity > 0
-        sftp.file.open('./.ssh/authorized_keys', 'a') do |f|
-          f.puts pubkey
+        # create .ssh dir if necessary
+        unless exists?('./.ssh')
+          mkdir('./.ssh')
+          set_permissions('./.ssh', 755)
         end
+        @node.log.remote("SFTP.APPEND: #{pubkey_path} -> ./.ssh/authorized_keys") if Inprovise.verbosity > 0
+        sftp.file.open('./.ssh/authorized_keys', 'a') { |f| f.puts pubkey }
+        # make sure the key file has the right permissions
+        set_permissions('./.ssh/authorized_keys', 644)
       rescue
         # using the SFTP option failed, let's try a more basic approach
+        run('mkdir -p .ssh')      # make sure the directory exists
+        run('chmod 0755 ./.ssh')  # and has the right permissions
+        # upload pubkey file to remote temp file
         upload_path = "inprovise-upload-#{Digest::SHA1.file(pubkey_path).hexdigest}"
         upload(pubkey_path, upload_path)
+        # concatenate temp file to ssh file
         run("cat #{upload_path} >> ./.ssh/authorized_keys")
+        # remove temp file
         run("rm #{upload_path}")
+        # make sure the key file has the right permissions
+        run('chmod 0644 ./.ssh/authorized_keys')
       end
-      set_permissions('./.ssh/authorized_keys', 644) rescue run('chmod 0644 ./.ssh/authorized_keys')
     ensure
       @node.log_to(log_bak)
     end
   end
 
+  def check_pubkey(pubkey)
+    # check if public key already configured
+    if exists?('./.ssh/authorized_keys')
+      auth_keys = begin
+                    content('./.ssh/authorized_keys')
+                  rescue
+                    run('cat ./.ssh/authorized_keys')
+                  end.split("\n")
+      return auth_keys.any? { |key| key == pubkey }
+    end
+    false
+  end
+
   def execute(cmd, forcelog=false)
     @node.log.remote("SSH: #{cmd}") if Inprovise.verbosity > 1 || forcelog
     output = ''
-    connection.exec! cmd do |channel, stream, data|
+    connection.exec! cmd do |_channel, stream, data|
       output << data if stream == :stdout
       data.split("\n").each do |line|
         @node.log.send(stream, line, forcelog)
@@ -200,3 +214,6 @@ Inprovise::CmdChannel.define('ssh') do
   end
 
 end
+
+# :nocov:
+

data/lib/inprovise/cli/group.rb

@@ -15,7 +15,7 @@ class Inprovise::Cli
       cgrp_add.flag [:t, :target], :arg_name => 'NAME', :multiple => true, :desc => 'Add a known target (node or group) to this new group.'
       cgrp_add.flag [:c, :config], :arg_name => 'CFGKEY=CFGVAL', :multiple => true, :desc => 'Specify a configuration setting for the group.'
 
-      cgrp_add.action do |global,options,args|
+      cgrp_add.action do |_global,options,args|
         raise ArgumentError, 'Missing or too many arguments!' unless args.size == 1
         Inprovise::Controller.run(:add, options, :group, *args)
         Inprovise::Controller.wait!
@@ -27,7 +27,7 @@ class Inprovise::Cli
     cgrp.arg_name 'GROUP[ GROUP [...]]'
     cgrp.command :remove do |cgrp_del|
 
-      cgrp_del.action do |global,options,args|
+      cgrp_del.action do |_global,options,args|
         raise ArgumentError, 'Missing argument!' if args.empty?
         Inprovise::Controller.run(:remove, options, :group, *args)
         Inprovise::Controller.wait!
@@ -43,7 +43,7 @@ class Inprovise::Cli
       cgrp_update.switch [:r, :reset], negatable: false, :desc => 'Reset configuration before update (default is to merge updates)'
       cgrp_update.flag [:t, :target], :arg_name => 'NAME', :multiple => true, :desc => 'Add a known target (node or group) to the group(s)'
 
-      cgrp_update.action do |global,options,args|
+      cgrp_update.action do |_global,options,args|
         raise ArgumentError, 'Missing argument!' if args.empty?
         Inprovise::Controller.run(:update, options, :group, *args)
         Inprovise::Controller.wait!
@@ -55,9 +55,9 @@ class Inprovise::Cli
     cgrp.command :list do |cgrp_list|
       cgrp_list.switch [:d, :details], negatable: false, :desc => 'Show group details'
 
-      cgrp_list.action do |global_options,options,args|
-        $stdout.puts "   INFRASTRUCTURE GROUPS"
-        $stdout.puts "   ====================="
+      cgrp_list.action do |_global,options,args|
+        $stdout.puts '   INFRASTRUCTURE GROUPS'
+        $stdout.puts '   ====================='
         if args.empty?
           Inprovise::Infrastructure.list(Inprovise::Infrastructure::Group).each do |g|
             Inprovise::Cli.show_target(g, options[:details])

data/lib/inprovise/cli/node.rb

@@ -18,7 +18,7 @@ class Inprovise::Cli
       cnod_add.switch [:sniff], :default_value => true, :desc => 'Enable or disable running sniffers'
       cnod_add.flag [:g, :group], :arg_name => 'GROUP', :multiple => true, :desc => 'Existing infrastructure group to add new node to.'
 
-      cnod_add.action do |global,options,args|
+      cnod_add.action do |_global,options,args|
         raise ArgumentError, 'Missing or too many arguments!' unless args.size == 1
         Inprovise::Controller.run(:add, options, :node, *args)
         Inprovise::Controller.wait!
@@ -30,7 +30,7 @@ class Inprovise::Cli
     cnod.arg_name 'NODE[ NODE [...]]'
     cnod.command :remove do |cnod_del|
 
-      cnod_del.action do |global,options,args|
+      cnod_del.action do |_global,options,args|
         raise ArgumentError, 'Missing argument!' if args.empty?
         Inprovise::Controller.run(:remove, options, :node, *args)
         Inprovise::Controller.wait!
@@ -48,7 +48,7 @@ class Inprovise::Cli
       cnod_update.switch [:sniff], :default_value => true, :desc => 'Enable or disable running sniffers'
       cnod_update.flag [:g, :group], :arg_name => 'GROUP', :multiple => true, :desc => 'Existing infrastructure group to add node(s) to.'
 
-      cnod_update.action do |global,options,args|
+      cnod_update.action do |_global,options,args|
         raise ArgumentError, 'Missing argument!' if args.empty?
         Inprovise::Controller.run(:update, options, :node, *args)
         Inprovise::Controller.wait!
@@ -60,10 +60,10 @@ class Inprovise::Cli
     cnod.command :list do |cnod_list|
       cnod_list.switch [:d, :details], negatable: false, :desc => 'Show node details'
 
-      cnod_list.action do |global_options,options,args|
+      cnod_list.action do |_global,options,args|
         $stdout.puts
-        $stdout.puts "   INFRASTRUCTURE NODES"
-        $stdout.puts "   ===================="
+        $stdout.puts '   INFRASTRUCTURE NODES'
+        $stdout.puts '   ===================='
         if args.empty?
           Inprovise::Infrastructure.list(Inprovise::Infrastructure::Node).each do |n|
             Inprovise::Cli.show_target(n, options[:details])
@@ -75,7 +75,7 @@ class Inprovise::Cli
               when Inprovise::Infrastructure::Node
                 Inprovise::Cli.show_target(tgt, options[:details])
               when Inprovise::Infrastructure::Group
-                $stdout.puts "   #{tgt.to_s}"
+                $stdout.puts "   #{tgt}"
                 $stdout.puts "   #{'-' * tgt.to_s.size}"
                 tgt.targets.each {|n| Inprovise::Cli.show_target(n, options[:details]) }
                 $stdout.puts "   #{'-' * tgt.to_s.size}"

data/lib/inprovise/cli/provision.rb

@@ -5,15 +5,18 @@
 
 class Inprovise::Cli
 
+  def self.setup_provisioning_cmd(cmd, &block)
+    cmd.desc 'Path to a provisioning scheme to load'
+    cmd.flag [:s,:scheme], :arg_name => 'FILE', :multiple => true, :default_value => Inprovise.default_scheme
+    cmd.flag [:c, :config], :arg_name => 'CFGKEY=CFGVAL', :multiple => true, :desc => 'Specify a configuration setting for the script execution'
+    cmd.action(&block)
+  end
+
   desc 'Apply the given script/package to the specified infrastructure nodes and/or groups.'
   arg_name 'SCRIPT TARGET[ TARGET[...]]'
   command :apply do |capply|
 
-    capply.desc 'Path to a provisioning scheme to load'
-    capply.flag [:s,:scheme], :arg_name => 'FILE', :multiple => true, :default_value => Inprovise.default_scheme
-    capply.flag [:c, :config], :arg_name => 'CFGKEY=CFGVAL', :multiple => true, :desc => 'Specify a configuration setting for the script execution'
-
-    capply.action do |global, options, args|
+    Inprovise::Cli.setup_provisioning_cmd(capply) do |_global, options, args|
       raise ArgumentError, 'Missing arguments!' if args.empty?
       raise ArgumentError, 'Missing targets!' if args.size < 2
       Inprovise::Controller.run(:apply, options, *args)
@@ -25,11 +28,7 @@ class Inprovise::Cli
   arg_name 'SCRIPT NAME[ NAME[...]]'
   command :revert do |crevert|
 
-    crevert.desc 'Path to a provisioning scheme to load'
-    crevert.flag [:s,:scheme], :arg_name => 'FILE', :multiple => true, :default_value => Inprovise.default_scheme
-    crevert.flag [:c, :config], :arg_name => 'CFGKEY=CFGVAL', :multiple => true, :desc => 'Specify a configuration setting for the script execution'
-
-    crevert.action do |global, options, args|
+    Inprovise::Cli.setup_provisioning_cmd(crevert) do |_global, options, args|
       raise ArgumentError, 'Missing arguments!' if args.empty?
       raise ArgumentError, 'Missing targets!' if args.size < 2
       Inprovise::Controller.run(:revert, options, *args)
@@ -41,11 +40,7 @@ class Inprovise::Cli
   arg_name 'SCRIPT NAME[ NAME[...]]'
   command :validate do |cvalid|
 
-    cvalid.desc 'Path to a provisioning scheme to load'
-    cvalid.flag [:s,:scheme], :arg_name => 'FILE', :multiple => true, :default_value => Inprovise.default_scheme
-    cvalid.flag [:c, :config], :arg_name => 'CFGKEY=CFGVAL', :multiple => true, :desc => 'Specify a configuration setting for the script execution'
-
-    cvalid.action do |global, options, args|
+    Inprovise::Cli.setup_provisioning_cmd(cvalid) do |_global, options, args|
       raise ArgumentError, 'Missing arguments!' if args.empty?
       raise ArgumentError, 'Missing targets!' if args.size < 2
       Inprovise::Controller.run(:validate, options, *args)
@@ -57,11 +52,7 @@ class Inprovise::Cli
   arg_name 'ACTION NAME[ NAME[...]]'
   command :trigger do |ctrigger|
 
-    ctrigger.desc 'Path to a provisioning scheme to load'
-    ctrigger.flag [:s,:scheme], :arg_name => 'FILE', :multiple => true, :default_value => Inprovise.default_scheme
-    ctrigger.flag [:c, :config], :arg_name => 'CFGKEY=CFGVAL', :multiple => true, :desc => 'Specify a configuration setting for the script execution'
-
-    ctrigger.action do |global, options, args|
+    Inprovise::Cli.setup_provisioning_cmd(ctrigger) do |_global, options, args|
       raise ArgumentError, 'Missing arguments!' if args.empty?
       raise ArgumentError, 'Missing targets!' if args.size < 2
       Inprovise::Controller.run(:trigger, options, *args)
@@ -76,7 +67,7 @@ class Inprovise::Cli
     clist.flag [:s,:scheme], :arg_name => 'FILE', :multiple => true, :default_value => Inprovise.default_scheme
     clist.switch [:a, :all], negatable: false, :desc => 'List all scripts (with or without description)'
 
-    clist.action do |global, options, args|
+    clist.action do |_global, options, _args|
       Inprovise::Controller.list_scripts(options)
     end
   end

data/lib/inprovise/cli.rb

@@ -42,7 +42,7 @@ class Inprovise::Cli
 
   desc 'Initialize Inprovise project.'
   command :init do |cinit|
-    cinit.action do |global,options,args|
+    cinit.action do |_global,_options,_args|
       raise RuntimeError, 'Cannot initialize existing project directory.' if File.exists?(Inprovise::INFRA_FILE)
       raise RuntimeError, "Default scheme #{Inprovise.default_scheme} already exists." if File.exists?(Inprovise.default_scheme)
       begin
@@ -57,7 +57,7 @@ class Inprovise::Cli
     end
   end
 
-  pre do |global,command,options,args|
+  pre do |global,command,_options,_args|
     # Pre logic here
     # Return true to proceed; false to abort and not call the
     # chosen command
@@ -79,11 +79,11 @@ class Inprovise::Cli
     true
   end
 
-  post do |global,command,options,args|
-    # Post logic here
-    # Use skips_post before a command to skip this
-    # block on that command only
-  end
+  # post do |global,command,options,args|
+  #   # Post logic here
+  #   # Use skips_post before a command to skip this
+  #   # block on that command only
+  # end
 
   on_error do |exception|
     # Error logic here
@@ -96,7 +96,7 @@ class Inprovise::Cli
   end
 
   def self.show_target(tgt, details=false)
-    $stdout.puts "   #{tgt.to_s}"
+    $stdout.puts "   #{tgt}"
     if details
       $stdout.puts "   \t"+JSON.pretty_generate(tgt.config).split("\n").join("\n   \t")
     end

data/lib/inprovise/cmd_channel.rb

@@ -48,17 +48,17 @@ module Inprovise::CmdChannel
 
   # command execution (MANDATORY)
 
-  def run(command, forcelog=false)
+  def run(_command, _forcelog=false)
     raise RuntimeError, 'UNIMPLEMENTED'
   end
 
   # MANDATORY file management routines
 
-  def upload(from, to)
+  def upload(_from, _to)
     raise RuntimeError, 'UNIMPLEMENTED'
   end
 
-  def download(from, to)
+  def download(_from, _to)
     raise RuntimeError, 'UNIMPLEMENTED'
   end
 

data/lib/inprovise/cmd_helper.rb

@@ -47,7 +47,7 @@ module Inprovise::CmdHelper
     nil
   end
 
-  def env_reference(varname)
+  def env_reference(_varname)
     nil
   end
 
@@ -56,7 +56,7 @@ module Inprovise::CmdHelper
   end
 
   # *must* return previous value
-  def set_cwd(path)
+  def set_cwd(_path)
     nil
   end
 
@@ -83,7 +83,7 @@ module Inprovise::CmdHelper
 
   # basic commands
 
-  def echo(arg)
+  def echo(_arg)
     nil
   end
 
@@ -91,59 +91,59 @@ module Inprovise::CmdHelper
     echo(env_reference(var))
   end
 
-  def cat(path)
+  def cat(_path)
     nil
   end
 
-  def hash_for(path)
+  def hash_for(_path)
     nil
   end
 
-  def mkdir(path)
+  def mkdir(_path)
     nil
   end
 
-  def exists?(path)
+  def exists?(_path)
     false
   end
 
-  def file?(path)
+  def file?(_path)
     false
   end
 
-  def directory?(path)
+  def directory?(_path)
     false
   end
 
-  def copy(from, to)
+  def copy(_from, _to)
     nil
   end
 
-  def move(from, to)
+  def move(_from, _to)
     nil
   end
 
-  def delete(path)
+  def delete(_path)
     nil
   end
 
-  def permissions(path)
+  def permissions(_path)
     0
   end
 
-  def set_permissions(path, perm)
+  def set_permissions(_path, _perm)
     nil
   end
 
-  def owner(path)
+  def owner(_path)
     nil
   end
 
-  def set_owner(path, user, group=nil)
+  def set_owner(_path, _user, _group=nil)
     nil
   end
 
-  def binary_exists?(bin)
+  def binary_exists?(_bin)
     false
   end