boris 1.0.0.beta.1

data/test/setup_tests.rb

@@ -0,0 +1,14 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'shoulda'
+require 'boris'
+
+include Boris
+
+class ProfileTestSetup < Test::Unit::TestCase
+  def initialize(test)
+    super(test)
+    @target = Target.new('0.0.0.0')
+  end
+end

data/test/test_all.rb

@@ -0,0 +1,8 @@
+$: << '.'
+
+Dir.chdir(File.dirname(__FILE__)) do
+  test_files = Dir['test_*.rb'] - [('test_all.rb')]
+  test_files.concat(Dir['**/test_*.rb'])
+
+  test_files.each { |file| require file }
+end

data/test/test_options.rb

@@ -0,0 +1,44 @@
+require 'setup_tests'
+
+class OptionsTest < Test::Unit::TestCase
+  context 'the options for a Target' do
+    setup do
+      @options = Options.new
+    end
+
+    should 'be modifiable via the options hash' do
+      @options[:auto_scrub_data] = false
+      @options[:credentials] = [{:user=>'someuser'}]
+      @options[:log_level] = Logger::INFO
+      @options[:profiles] = [:windows_core]
+      @options[:snmp_options] = {:MibModules=>['IF-MIB']}
+      @options[:ssh_options] = {:keys=>'~/.ssh/my_private_key', :verbose=>:debug}
+
+      assert_equal(false, @options[:auto_scrub_data])
+      assert_equal([{:user=>'someuser'}], @options[:credentials])
+      assert_equal(Logger::INFO, @options[:log_level])
+      assert_equal([:windows_core], @options[:profiles])
+      assert_equal({:MibModules=>['IF-MIB']}, @options[:snmp_options])
+      assert_equal({:keys=>'~/.ssh/my_private_key', :verbose=>:debug}, @options[:ssh_options])
+    end
+
+    should 'error if invalid options are provided' do
+      assert_raise(ArgumentError) {@options[:invalid_option] = nil}
+    end
+
+    should 'error if invalid options are passed to #add_credential' do
+      assert_raise(ArgumentError) {@options.add_credential(:password=>'somepass')}
+      assert_raise(ArgumentError) {@options.add_credential(:user=>'someuser', :connection_types=>[:i_dont_exist])}
+      assert_raise(ArgumentError) {@options.add_credential([{:user=>'someuser1'},{:user=>'someuser2'}])}
+    end
+
+    should 'allow its credentials be added through #add_credential' do
+      @options.add_credential(:user=>'someuser', :password=>'somepass', :connection_types=>[:wmi])
+      @options.add_credential(:user=>'someotheruser', :connection_types=>[:ssh])
+      assert_equal([
+        {:user=>'someuser', :password=>'somepass', :connection_types=>[:wmi]},
+        {:user=>'someotheruser', :connection_types=>[:ssh]}
+      ], @options[:credentials])
+    end
+  end
+end

data/test/test_structure.rb

@@ -0,0 +1,136 @@
+require 'setup_tests'
+
+class ProfileStructure
+  include Profiles::Structure
+  attr_accessor :logger, :options
+end
+
+class StructureTest < Test::Unit::TestCase
+  context 'a data structure' do
+    setup do
+      @structure = ProfileStructure.new
+      @structure.options = Options.new
+    end
+
+    should 'provide us with a file system template via #file_system_template' do
+      expected = [
+        :capacity_mb,
+        :file_system,
+        :mount_point,
+        :san_storage,
+        :used_space_mb
+      ].to_nil_hash
+
+      assert_equal(expected, @structure.file_system_template)
+    end
+
+    should 'provide us with a hardware template via #get_hardware' do
+      expected = [
+        :cpu_architecture,
+        :cpu_core_count,
+        :cpu_model,
+        :cpu_physical_count,
+        :cpu_speed_mhz,
+        :cpu_vendor,
+        :firmware_version,
+        :model,
+        :memory_installed_mb,
+        :serial,
+        :vendor
+      ].to_nil_hash
+
+      assert_equal(expected, @structure.get_hardware)
+    end
+
+    should 'provide us with an installed application template via #installed_application_template' do
+      expected = [
+        :date_installed,
+        :install_location,
+        :license_key,
+        :name,
+        :vendor,
+        :version
+      ].to_nil_hash
+
+      assert_equal(expected, @structure.installed_application_template)
+    end
+
+    should 'provide us with a local user groups template via #local_user_groups_template' do
+      expected = {
+        :group=>nil,
+        :members=>[]
+      }
+      
+      assert_equal(expected, @structure.local_user_groups_template)
+    end
+
+    should 'provide us with a network identification template via #get_network_id' do
+      expected = [
+        :domain,
+        :hostname
+      ].to_nil_hash
+
+      assert_equal(expected, @structure.get_network_id)
+    end
+
+    should 'provide us with a network interface template via #network_interface_template' do
+      expected = [
+        :auto_negotiate,
+        :current_speed_mbps,
+        :duplex,
+        :fabric_name,
+        :is_uplink,
+        :mac_address,
+        :model,
+        :model_id,
+        :mtu,
+        :name,
+        :node_wwn,
+        :port_wwn,
+        :remote_mac_address,
+        :status,
+        :type,
+        :vendor,
+        :vendor_id,
+        :dns_servers=>[],
+        :ip_addresses=>[]
+      ].to_nil_hash
+      
+      assert_equal(expected, @structure.network_interface_template)
+    end
+
+    should 'provide us with an operating system template via #get_operating_system' do
+      expected = [
+        :date_installed,
+        :kernel,
+        :license_key,
+        :name,
+        :service_pack,
+        :version,
+        :features=>[],
+        :roles=>[]
+      ].to_nil_hash
+      
+      assert_equal(expected, @structure.get_operating_system)
+    end
+
+    should 'provide us with a patch template via #installed_patch_template' do
+      expected = [
+        :date_installed,
+        :installed_by,
+        :patch_code        
+      ].to_nil_hash
+
+      assert_equal(expected, @structure.installed_patch_template)
+    end
+
+    should 'provide us with a share template via #hosted_share_template' do
+      expected = [
+        :name,
+        :path
+      ].to_nil_hash
+
+      assert_equal(expected, @structure.hosted_share_template)
+    end
+  end
+end

data/test/test_target.rb

@@ -0,0 +1,146 @@
+require 'setup_tests'
+
+class TargetTest < Test::Unit::TestCase
+  context 'a Target' do
+    setup do
+      @target = Target.new('0.0.0.0')
+      @target.extend(Profiles::Structure)
+      @cred = {:user=>'someuser', :password=>'somepass'}
+    end
+
+    should 'return host info after calling #load_host_info' do
+      @target.expects(:load_host_info).returns([@host, nil])
+      assert_equal(@target.load_host_info, [@host, nil])
+    end
+
+    should 'allow its target name to be readable' do
+      assert_equal('0.0.0.0', @target.host)
+    end
+
+    should 'allow its options to be modifiable by passing a block to Target#new' do
+      Target.new(@host) do |t|
+        t.options[:ssh_options] = {:timeout=>10}
+
+        assert_equal({:timeout=>10}, t.options[:ssh_options])
+      end
+    end
+
+    should 'allow us to call methods for retrieving all standard configuration items via #retrieve_all' do
+      @target.options[:auto_scrub_data] = false
+      @target.retrieve_all
+
+      assert_equal([], @target.file_systems)
+      assert_equal([], @target.installed_applications)
+      assert_equal([], @target.local_user_groups)
+      assert_equal([], @target.network_interfaces)
+      assert_equal([], @target.installed_patches)
+      assert_equal([], @target.hosted_shares)
+    end
+
+    should 'allow its data (instance variables) to be produced as json' do
+      long_json_string = %w{
+        {"file_systems":null,
+        "hardware":null,
+        "hosted_shares":null,
+        "installed_applications":null,
+        "installed_patches":null,
+        "installed_services":null,
+        "local_user_groups":null,
+        "network_id":null,
+        "network_interfaces":null,
+        "operating_system":null}}.join
+
+      assert_equal(long_json_string, @target.to_json)
+    end
+
+
+    should 'allow credentials to be added through #add_credential' do
+      @target.options.add_credential(@cred.merge!(:connection_types=>[:wmi]))
+      assert_equal([@cred], @target.options[:credentials])
+    end
+
+    context 'listening on certain ports' do
+      should "allow us to detect a possible SSH connection if it is listening on port #{Boris::PORT_DEFAULTS[:ssh]}" do
+        @target.expects(:tcp_port_responding?).with(22).returns(true)
+        @target.expects(:tcp_port_responding?).with(135).returns(false)
+        assert_equal(:ssh, @target.suggested_connection_method)
+      end
+
+      should "allow us to detect a possible WMI connection if if it is listening on port #{Boris::PORT_DEFAULTS[:wmi]}" do
+        @target.expects(:tcp_port_responding?).with(135).returns(true)
+        assert_equal(:wmi, @target.suggested_connection_method)
+      end
+
+      should 'return with no detected connection method if all attempts fail' do
+        @target.expects(:tcp_port_responding?).with(22).returns(false)
+        @target.expects(:tcp_port_responding?).with(135).returns(false)
+        assert_nil(nil, @target.suggested_connection_method)
+      end
+    end
+
+    context 'that we will try to connect to' do
+      should 'error if no credentials are specified' do
+        assert_raise(InvalidOption) {@target.connect}
+      end
+
+      should 'error if we try to detect the profile when there is no active connection' do
+        assert_raise(NoActiveConnection) {@target.detect_profile}
+      end
+
+      should 'attempt an SSH and WMI connection only once if the target does not respond to an attempt' do
+        skip("test relies on WIN32OLE") if PLATFORM != :win32
+        
+        @target.options.add_credential(@cred.merge!(:connection_types=>[:snmp, :ssh, :wmi]))
+        
+        Net::SSH.stubs(:start).raises(Net::SSH::HostKeyMismatch)
+        WIN32OLE.any_instance.stubs(:ConnectServer).raises(WIN32OLERuntimeError, 'rpc server is unavailable')
+
+        SSHConnector.any_instance.expects(:establish_connection).once
+        WMIConnector.any_instance.expects(:establish_connection).once
+
+        @target.connect
+      end
+
+      should 'attempt a connection only once when connection is not available and when multiple credentials are supplied' do
+        @target.options[:credentials] = [@cred.merge(:connection_types=>[:ssh])]
+        @target.options[:credentials] << @cred.merge(:connection_types=>[:ssh])
+
+        SSHConnector.any_instance.stubs(:reconnectable).returns(false)
+        SSHConnector.any_instance.expects(:establish_connection).once
+
+        @target.connect
+      end
+    end
+
+    context 'that we have successfully connected to' do
+      setup do
+        ssh_connection = mock('SSHConnector')
+        @target.connector = ssh_connection
+
+        @target.connector.stubs(:connected?).returns(true)
+        @target.connector.stubs(:class).returns(Connector::SSHConnector)
+        @target.stubs(:connect).returns(@target.connector)
+
+        @target.options[:profiles].each do |profile|
+          profile.stubs(:matches_target?).returns(false)
+        end
+
+        @target.connect
+      end
+
+      should 'raise an error if no profiles are found to be suitable' do
+        assert_raise(NoProfileDetected) {@target.detect_profile}
+      end
+
+      should 'detect the best profile for our target' do
+        Profiles::RedHat.stubs(:matches_target?).returns(true)
+        assert_equal(Profiles::RedHat, @target.detect_profile)
+      end
+
+      should 'allow us to force a profile to be used for our target even if it is not ideal' do
+        @target.force_profile_to(Profiles::RedHat)
+        assert_equal(Profiles::RedHat, @target.target_profile)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification
+name: boris
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta.1
+  prerelease: 6
+platform: ruby
+authors:
+- Joe Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: netaddr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: snmp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Boris: A networked-device scanning library. Boris allows you to write
+  programs for logging into and pulling information off of various server platforms,
+  appliances, and other types of networked devices, producing clean and consistent
+  data ideal for configuration managment usage.'
+email: jwmartin83@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./boris.gemspec
+- ./doc/_index.html
+- ./doc/Array.html
+- ./doc/Boris/ConnectionAlreadyActive.html
+- ./doc/Boris/ConnectionFailed.html
+- ./doc/Boris/Connector.html
+- ./doc/Boris/InvalidCredentials.html
+- ./doc/Boris/InvalidOption.html
+- ./doc/Boris/InvalidTargetName.html
+- ./doc/Boris/Lumberjack.html
+- ./doc/Boris/MissingCredentials.html
+- ./doc/Boris/NoActiveConnection.html
+- ./doc/Boris/NoProfileDetected.html
+- ./doc/Boris/Options.html
+- ./doc/Boris/Profiles/Linux.html
+- ./doc/Boris/Profiles/RedHat.html
+- ./doc/Boris/Profiles/Solaris.html
+- ./doc/Boris/Profiles/Structure.html
+- ./doc/Boris/Profiles/UNIX.html
+- ./doc/Boris/Profiles/Windows/Windows2003.html
+- ./doc/Boris/Profiles/Windows/Windows2008.html
+- ./doc/Boris/Profiles/Windows/Windows2012.html
+- ./doc/Boris/Profiles/Windows.html
+- ./doc/Boris/Profiles.html
+- ./doc/Boris/SNMPConnector.html
+- ./doc/Boris/SSHConnector.html
+- ./doc/Boris/Target.html
+- ./doc/Boris/WMIConnector.html
+- ./doc/Boris.html
+- ./doc/BorisLogger.html
+- ./doc/class_list.html
+- ./doc/css/common.css
+- ./doc/css/full_list.css
+- ./doc/css/style.css
+- ./doc/file.README.html
+- ./doc/file_list.html
+- ./doc/frames.html
+- ./doc/Hash.html
+- ./doc/index.html
+- ./doc/js/app.js
+- ./doc/js/full_list.js
+- ./doc/js/jquery.js
+- ./doc/method_list.html
+- ./doc/String.html
+- ./doc/top-level-namespace.html
+- ./lib/boris/connectors/snmp.rb
+- ./lib/boris/connectors/ssh.rb
+- ./lib/boris/connectors/wmi.rb
+- ./lib/boris/connectors.rb
+- ./lib/boris/errors.rb
+- ./lib/boris/helpers/array.rb
+- ./lib/boris/helpers/constants.rb
+- ./lib/boris/helpers/hash.rb
+- ./lib/boris/helpers/scrubber.rb
+- ./lib/boris/helpers/string.rb
+- ./lib/boris/lumberjack.rb
+- ./lib/boris/options.rb
+- ./lib/boris/profiles/linux/redhat.rb
+- ./lib/boris/profiles/linux_core.rb
+- ./lib/boris/profiles/unix/solaris.rb
+- ./lib/boris/profiles/unix_core.rb
+- ./lib/boris/profiles/windows/windows2003.rb
+- ./lib/boris/profiles/windows/windows2008.rb
+- ./lib/boris/profiles/windows/windows2012.rb
+- ./lib/boris/profiles/windows_core.rb
+- ./lib/boris/structure.rb
+- ./lib/boris/target.rb
+- ./lib/boris.rb
+- ./LICENSE.md
+- ./README.md
+- ./test/connector_tests/test_snmp.rb
+- ./test/connector_tests/test_ssh.rb
+- ./test/connector_tests/test_wmi.rb
+- ./test/helper_tests/test_array.rb
+- ./test/helper_tests/test_hash.rb
+- ./test/helper_tests/test_string.rb
+- ./test/profile_tests/test_core_skeleton
+- ./test/profile_tests/test_linux_core.rb
+- ./test/profile_tests/test_redhat.rb
+- ./test/profile_tests/test_solaris.rb
+- ./test/profile_tests/test_unix_core.rb
+- ./test/profile_tests/test_windows.rb
+- ./test/setup_tests.rb
+- ./test/test_all.rb
+- ./test/test_options.rb
+- ./test/test_structure.rb
+- ./test/test_target.rb
+- lib/boris/connectors/snmp.rb
+- lib/boris/connectors/ssh.rb
+- lib/boris/connectors/wmi.rb
+- lib/boris/connectors.rb
+- lib/boris/errors.rb
+- lib/boris/helpers/array.rb
+- lib/boris/helpers/constants.rb
+- lib/boris/helpers/hash.rb
+- lib/boris/helpers/scrubber.rb
+- lib/boris/helpers/string.rb
+- lib/boris/lumberjack.rb
+- lib/boris/options.rb
+- lib/boris/profiles/linux/redhat.rb
+- lib/boris/profiles/linux_core.rb
+- lib/boris/profiles/unix/solaris.rb
+- lib/boris/profiles/unix_core.rb
+- lib/boris/profiles/windows/windows2003.rb
+- lib/boris/profiles/windows/windows2008.rb
+- lib/boris/profiles/windows/windows2012.rb
+- lib/boris/profiles/windows_core.rb
+- lib/boris/structure.rb
+- lib/boris/target.rb
+- lib/boris.rb
+homepage: https://github.com/alkalinecoffee/boris
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements:
+- netaddr
+- net/ssh
+- snmp
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ! 'Boris: A networked-device scanning library.'
+test_files: []
+has_rdoc: