RubyGems - boris - Versions diffs - 1.0.0.beta.1 - Mend

boris 1.0.0.beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (88) hide show

data/LICENSE.md +9 -0
data/README.md +94 -0
data/boris.gemspec +28 -0
data/doc/Array.html +437 -0
data/doc/Boris.html +230 -0
data/doc/Boris/ConnectionAlreadyActive.html +123 -0
data/doc/Boris/ConnectionFailed.html +127 -0
data/doc/Boris/Connector.html +794 -0
data/doc/Boris/InvalidCredentials.html +131 -0
data/doc/Boris/InvalidOption.html +123 -0
data/doc/Boris/InvalidTargetName.html +123 -0
data/doc/Boris/Lumberjack.html +466 -0
data/doc/Boris/MissingCredentials.html +123 -0
data/doc/Boris/NoActiveConnection.html +123 -0
data/doc/Boris/NoProfileDetected.html +123 -0
data/doc/Boris/Options.html +783 -0
data/doc/Boris/Profiles.html +117 -0
data/doc/Boris/Profiles/Linux.html +1151 -0
data/doc/Boris/Profiles/RedHat.html +875 -0
data/doc/Boris/Profiles/Solaris.html +1230 -0
data/doc/Boris/Profiles/Structure.html +2050 -0
data/doc/Boris/Profiles/UNIX.html +893 -0
data/doc/Boris/Profiles/Windows.html +1846 -0
data/doc/Boris/Profiles/Windows/Windows2003.html +304 -0
data/doc/Boris/Profiles/Windows/Windows2008.html +379 -0
data/doc/Boris/Profiles/Windows/Windows2012.html +304 -0
data/doc/Boris/SNMPConnector.html +512 -0
data/doc/Boris/SSHConnector.html +633 -0
data/doc/Boris/Target.html +2002 -0
data/doc/Boris/WMIConnector.html +1134 -0
data/doc/BorisLogger.html +217 -0
data/doc/Hash.html +195 -0
data/doc/String.html +1246 -0
data/doc/_index.html +420 -0
data/doc/class_list.html +53 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +328 -0
data/doc/file.README.html +183 -0
data/doc/file_list.html +55 -0
data/doc/frames.html +28 -0
data/doc/index.html +183 -0
data/doc/js/app.js +214 -0
data/doc/js/full_list.js +173 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +1468 -0
data/doc/top-level-namespace.html +126 -0
data/lib/boris.rb +30 -0
data/lib/boris/connectors.rb +47 -0
data/lib/boris/connectors/snmp.rb +56 -0
data/lib/boris/connectors/ssh.rb +110 -0
data/lib/boris/connectors/wmi.rb +186 -0
data/lib/boris/errors.rb +17 -0
data/lib/boris/helpers/array.rb +63 -0
data/lib/boris/helpers/constants.rb +20 -0
data/lib/boris/helpers/hash.rb +8 -0
data/lib/boris/helpers/scrubber.rb +51 -0
data/lib/boris/helpers/string.rb +130 -0
data/lib/boris/lumberjack.rb +47 -0
data/lib/boris/options.rb +86 -0
data/lib/boris/profiles/linux/redhat.rb +77 -0
data/lib/boris/profiles/linux_core.rb +216 -0
data/lib/boris/profiles/unix/solaris.rb +307 -0
data/lib/boris/profiles/unix_core.rb +85 -0
data/lib/boris/profiles/windows/windows2003.rb +15 -0
data/lib/boris/profiles/windows/windows2008.rb +23 -0
data/lib/boris/profiles/windows/windows2012.rb +15 -0
data/lib/boris/profiles/windows_core.rb +530 -0
data/lib/boris/structure.rb +167 -0
data/lib/boris/target.rb +340 -0
data/test/connector_tests/test_snmp.rb +35 -0
data/test/connector_tests/test_ssh.rb +51 -0
data/test/connector_tests/test_wmi.rb +129 -0
data/test/helper_tests/test_array.rb +25 -0
data/test/helper_tests/test_hash.rb +10 -0
data/test/helper_tests/test_string.rb +136 -0
data/test/profile_tests/test_core_skeleton +107 -0
data/test/profile_tests/test_linux_core.rb +331 -0
data/test/profile_tests/test_redhat.rb +134 -0
data/test/profile_tests/test_solaris.rb +523 -0
data/test/profile_tests/test_unix_core.rb +117 -0
data/test/profile_tests/test_windows.rb +536 -0
data/test/setup_tests.rb +14 -0
data/test/test_all.rb +8 -0
data/test/test_options.rb +44 -0
data/test/test_structure.rb +136 -0
data/test/test_target.rb +146 -0
metadata +241 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,126 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.3
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Boris.html" title="Boris (module)">Boris</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span>, <span class='object_link'><a href="BorisLogger.html" title="BorisLogger (class)">BorisLogger</a></span>, <span class='object_link'><a href="Hash.html" title="Hash (class)">Hash</a></span>, <span class='object_link'><a href="String.html" title="String (class)">String</a></span>
+</p>
+  <h2>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="PLATFORM-constant" class="">PLATFORM =
+        </dt>
+        <dd><pre class="code"><span class='const'>RbConfig</span><span class='op'>::</span><span class='const'>CONFIG</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>host_os</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>mswin|mingw|cygwin</span><span class='regexp_end'>/</span></span> <span class='op'>?</span> <span class='symbol'>:win32</span> <span class='op'>:</span> <span class='const'>RbConfig</span><span class='op'>::</span><span class='const'>CONFIG</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>host_os</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span></pre></dd>
+    </dl>
+</div>
+    <div id="footer">
+  Generated on Sun Feb  3 16:32:41 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.3 (ruby-1.9.3).
+</div>
+  </body>
+</html>

data/lib/boris.rb ADDED Viewed

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+PLATFORM = RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/ ? :win32 : RbConfig::CONFIG['host_os']
+require 'date'
+require 'json'
+require 'logger'
+require 'netaddr'
+require 'net/ssh'
+require 'rbconfig'
+require 'snmp'
+require 'socket'
+require 'thread'
+require 'win32ole' if PLATFORM == :win32
+require 'boris/lumberjack'
+require 'boris/errors'
+require 'boris/options'
+require 'boris/target'
+require 'boris/helpers/array'
+require 'boris/helpers/constants'
+require 'boris/helpers/hash'
+require 'boris/helpers/scrubber'
+require 'boris/helpers/string'
+module Boris
+end

data/lib/boris/connectors.rb ADDED Viewed

@@ -0,0 +1,47 @@
+module Boris
+  class Connector
+    include Lumberjack
+    attr_reader :connected
+    attr_reader :host
+    attr_reader :options
+    attr_reader :reconnectable
+    def initialize(host, cred, options, logger=nil)
+      debug 'creating connection object'
+      @host = host
+      @user = cred[:user]
+      @password = cred[:password]
+      @connected = false
+      @reconnectable = true
+      @logger = logger
+    end
+    def connected?
+      @connected
+    end
+    def disconnect
+      debug 'closing connection to host'
+      @connected = false
+    end
+    def establish_connection
+      debug 'attempting connection'
+    end
+    def values_at(request, limit)
+      if !limit.kind_of?(Integer)
+        raise ArgumentError, "non-integer limit specified (#{limit.inspect})"
+      elsif limit < 1
+        raise ArgumentError, "specified limit must be greater than 1 (or nil for no limit) (#{limit.inspect})"
+      end unless limit.nil?
+      amount = limit == 1 ? 'single value' : 'multiple values'
+      debug "issuing request for #{amount} (#{request.inspect})"
+    end
+  end
+end

data/lib/boris/connectors/snmp.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require 'boris/connectors'
+module Boris
+  class SNMPConnector < Connector
+    def initialize(host, cred, options, logger=nil)
+      super(host, cred, options, logger)
+      @snmp_options = options[:snmp_options].merge(:host=>@host, :version=>:SNMPv1, :community=>@user)
+      #snmp connections are always reconnectable
+      @reconnectable = true
+    end
+    def disconnect
+      super
+      @transport = nil
+      debug 'connections closed'
+    end
+    def establish_connection
+      super
+      begin
+        @transport = SNMP::Manager.new(@snmp_options)
+        value_at('sysDescr')
+        debug 'connection established'
+        @connected = true
+      rescue SNMP::RequestTimeout
+        warn 'connection failed (connection timeout)'
+      rescue => error
+        warn "connection failed (#{error.message})"
+      end
+      return self
+    end
+    def value_at(request)
+      values_at(request, 1)[0]
+    end
+    def values_at(request, limit=nil)
+      super(request, limit)
+      return_data = []
+      @transport.walk(request) do |row|
+        row.each {|item| return_data << {:name=>item.name.to_s, :value=>item.value}}
+      end
+      info "#{return_data.size} row(s) returned"
+      limit = return_data.size if limit.nil?
+      return_data[0..limit]
+    end
+  end
+end

data/lib/boris/connectors/ssh.rb ADDED Viewed

@@ -0,0 +1,110 @@
+require 'boris/connectors'
+module Boris
+  class SSHConnector < Connector
+    def initialize(host, cred, options, logger=nil)
+      @ssh_options = options[:ssh_options]
+      @ssh_options[:password] = @password if @password
+      invalid_ssh_options = @ssh_options.keys - Net::SSH::VALID_OPTIONS
+      raise ArgumentError, "invalid ssh option(s): #{invalid_ssh_options.join(', ')}" if invalid_ssh_options.any?
+      super(host, cred, options, logger)
+    end
+    def disconnect
+      super
+      @transport = nil
+      debug 'connections closed'
+    end
+    def establish_connection
+      super
+      begin
+        @transport = Net::SSH.start(@host, @user, @ssh_options)
+        debug 'connection established'
+        @connected = @reconnectable = true
+      rescue Net::SSH::AuthenticationFailed
+        warn "connection failed (connection made but credentials not accepted with user #{@user})"
+        @reconnectable = true
+      rescue Net::SSH::HostKeyMismatch
+        warn 'connection failed (host key mismatch)'
+        @reconnectable = false
+      rescue => error
+        warn "connection failed (#{error.message})"
+        @reconnectable = true
+      end
+      if @reconnectable == true
+        info 'connection available for retry'
+      elsif @reconnectable == false
+        info 'connection does not seem to be available (so we will not retry)'
+      end unless @transport
+      return self
+    end
+    def value_at(request, request_pty=false)
+      values_at(request, request_pty, 1)[0]
+    end
+    def values_at(request, request_pty=false, limit=nil)
+      super(request, limit)
+      error_messages = []
+      reconnect = false
+      return_data = []
+      chan = @transport.open_channel do |chan|
+        if request_pty
+          debug 'requsting pty...'
+          chan.request_pty()
+          debug 'pty successfully requested'
+        end
+        chan.on_data do |ch, data|
+          if data =~ /^\[sudo\] password for/i
+            debug 'system asking for password for sudo request'
+            if @password
+              ch.send_data "#{@password}\n"
+              debug 'password sent'
+            else
+              ch.close
+              info "channel closed (we don't have a password to supply)"
+            end
+          elsif data =~ /sorry, try again/i
+            ch.close
+            return_data = []
+            info "channel closed (we have a password to supply but system its not accepted)"
+          elsif data =~ /permission denied/i
+            warn "permission denied for this request (#{data.gsub(/\n|\s+/, ', ')})"
+          else
+            return_data << data
+          end
+        end
+        # called when something is written to stderr
+        chan.on_extended_data do |ch, type, data|
+          error_messages.concat(data.split(/\n/))
+        end
+        chan.exec(request)
+      end
+      chan.wait
+      if !error_messages.empty?
+        warn "message written to STDERR for this request (#{error_messages.join('. ')})"
+      end
+      return_data = return_data.join.split(/\n/)
+      info "#{return_data.size} row(s) returned"
+      limit = return_data.size if limit.nil?
+      return_data[0..limit]
+    end
+  end
+end

data/lib/boris/connectors/wmi.rb ADDED Viewed

@@ -0,0 +1,186 @@
+require 'boris/connectors'
+module Boris
+  class WMIConnector < Connector
+    attr_accessor :wmi, :root_wmi, :registry
+    HKEY_LOCAL_MACHINE = 0x80000002
+    KEY_QUERY_VALUE = 1
+    KEY_ENUMERATE_SUB_KEYS = 8
+    def initialize(host, cred, options, logger=nil)
+      super(host, cred, options, logger)
+    end
+    def disconnect
+      super
+      @wmi = nil
+      @registry = nil
+      @root_wmi = nil
+      debug 'connections closed'
+    end
+    def establish_connection
+      super
+      begin
+        locator = WIN32OLE.new('WbemScripting.SWbemLocator')
+        debug 'attempting connection to cimv2 namespace'
+        @wmi = locator.ConnectServer(@host, 'root\cimv2', @user, @password, nil, nil, 128)
+        debug 'connection to cimv2 namespace successful'
+        debug 'attempting connection to wmi root namespace'
+        @root_wmi = locator.ConnectServer(@host, 'root\WMI', @user, @password, nil, nil, 128)
+        debug 'connection to wmi root namespace successful'
+        debug 'attempting connection to registry'
+        @registry = locator.ConnectServer(@host, 'root\default', @user, @password, nil, nil, 128).Get('StdRegProv')
+        debug 'connection to registry successful'
+        debug 'all required connections established'
+        @connected = @reconnectable = true
+      rescue WIN32OLERuntimeError => error
+        @connected = false
+        if error.message =~ /access is denied/i
+          warn "connection failed (connection made but credentials not accepted with user #{@user})"
+          @reconnectable = true
+        elsif error.message =~ /rpc server is unavailable/i
+          warn 'connection failed (rpc server not available)'
+          @reconnectable = false
+        else
+          warn "connection failed (#{error.message.gsub(/\n\s*/, '. ')})"
+          @reconnectable = true
+        end
+      end
+      if @reconnectable == true
+        info 'connection available for retry'
+      elsif @reconnectable == false
+        info 'connection does not seem to be available (so we will not retry)'
+      end unless @transport
+      return self
+    end
+    def value_at(request, conn=:wmi)
+      values_at(request, conn, limit=1)[0]
+    end
+    def values_at(request, conn=:wmi, limit=nil)
+      super(request, limit)
+      rows = case conn
+      when :root_wmi
+        @root_wmi.ExecQuery(request, nil, 48)
+      when :wmi
+        @wmi.ExecQuery(request, nil, 48)
+      end
+      return_data = []
+      i = 0
+      rows.each do |row|
+        i += 1
+        return_hash = {}
+        row.Properties_.each do |property|
+          if property.Name =~ /^attributes/i && property.Value.kind_of?(WIN32OLE)
+            row.Attributes.Properties_.each do |property|
+              return_hash[property.Name.downcase.to_sym] = property.Value
+            end
+          else
+            return_hash[property.Name.downcase.to_sym] = property.Value
+          end
+        end
+        return_data << return_hash
+        break if (limit.nil? && i == limit)
+      end
+      info "#{return_data.size} row(s) returned"
+      return return_data
+    end
+    def has_access_for(key_path, permission_to_check=nil)
+      debug "checking for registry read access for #{key_path}"
+      access_params = @registry.Methods_('CheckAccess').inParameters.SpawnInstance_
+      access_params.hDefKey = HKEY_LOCAL_MACHINE
+      access_params.sSubKeyName = key_path
+      access_params.uRequired = permission_to_check
+      @registry.ExecMethod_('CheckAccess', access_params).bGranted
+    end
+    def registry_subkeys_at(key_path)
+      return_data = []
+      debug "reading registry subkeys at path #{key_path}"
+      if has_access_for(key_path, KEY_ENUMERATE_SUB_KEYS)
+        in_params = @registry.Methods_('EnumKey').inParameters.SpawnInstance_
+        in_params.hDefKey = HKEY_LOCAL_MACHINE
+        in_params.sSubKeyName = key_path
+        @registry.ExecMethod_('EnumKey', in_params).sNames.each do |key|
+          return_data << key_path + '\\' + key
+        end
+      else
+        info "no access for enumerating keys at (#{key_path})"
+      end
+      return return_data
+    end
+    def registry_values_at(key_path)
+      values = Hash.new
+      debug "reading registry values at path #{key_path}"
+      if has_access_for(key_path, KEY_QUERY_VALUE)
+        in_params = @registry.Methods_('EnumValues').inParameters.SpawnInstance_
+        in_params.hDefKey = HKEY_LOCAL_MACHINE
+        in_params.sSubKeyName = key_path
+        str_params = @registry.Methods_('GetStringValue').inParameters.SpawnInstance_
+        str_params.sSubKeyName = key_path
+        subkey_values = @registry.ExecMethod_('EnumValues', in_params).sNames
+        subkey_values ||= []
+        subkey_values.each do |value|
+          if !value.empty?
+            str_params.sValueName = value
+            begin
+              x = @registry.ExecMethod_('GetStringValue', str_params).sValue
+              x = @registry.ExecMethod_('GetBinaryValue', str_params).uValue unless x
+              x = @registry.ExecMethod_('GetDWORDValue', str_params).uValue unless x
+              x = @registry.ExecMethod_('GetExpandedStringValue', str_params).sValue unless x
+              x = @registry.ExecMethod_('GetMultiStringValue', str_params).sValue unless x
+              x = @registry.ExecMethod_('GetQWORDValue', str_params).uValue unless x
+              values[value.downcase.to_sym] = x
+            rescue
+              if $!.message =~ /#{invalid method}/i
+                warn "unreadable registry value (#{key_path}\\#{value})"
+              end
+            end
+          end
+        end
+      else
+        info "no access for enumerating values at (#{key_path})"
+      end
+      return values
+    end
+  end
+end