zenoss_client 0.5.3 → 0.5.4

data/.gitignore

@@ -0,0 +1,24 @@
+#https://github.com/github/gitignore/blob/master/Ruby.gitignore
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+
+# Extra's not part of the template
+.buildpath
+.project

data/README.textile

@@ -68,3 +68,15 @@ A gem is now available.  'gem install zenoss_client'
 </pre>
 
 Have fun and let me know what needs to be fixed / added.
+
+== Testing
+You can invoke a series of minitest based spec test using the supplied
+tests and rake task. Simply run the following to kick off the tests
+@rake test@
+
+You should see output similar to the following (The number of tests will
+of course grow over time):
+@3 tests, 6 assertions, 0 failures, 0 errors, 0 skips@
+
+If you get any failures, you should of course address them
+

data/Rakefile

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'rake/clean'
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
+require 'rake/testtask'
 
 CLEAN.include("pkg")
 CLEAN.include("doc")
@@ -70,3 +71,9 @@ def up_min_version
 	f.write(ver)
 	ver
 end
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.5.4

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+#http://net.tutsplus.com/tutorials/ruby/ruby-for-newbies-testing-with-rspec/
+require_relative '../lib/zenoss'
+require 'test/unit'
+
+
+ZENOSS_URL = ENV['zenoss_client_url'] || "http://localhost:8080/zport/dmd"
+ZENOSS_USER = ENV['zenoss_client_username'] || "admin"
+ZENOSS_PASSWORD = ENV['zenoss_client_password'] || "zenoss"
+  
+TEST_DEVICE_NAME = "UnitTestDevice"

data/test/zenoss_client_test.rb

@@ -0,0 +1,114 @@
+require_relative './test_helper'
+require 'minitest/spec'
+require 'logger'
+
+LOG = Logger.new(STDOUT)
+LOG.level = Logger::INFO
+
+
+describe Zenoss do
+  #Simulate some "before all" type of setup
+  #https://github.com/seattlerb/minitest/issues/61#issuecomment-4581115
+  def self.zen
+    @zen ||= begin
+      connection = Zenoss.connect ZENOSS_URL, ZENOSS_USER, ZENOSS_PASSWORD
+      #We Need to Create A Device for testing
+      #We do this here, so we can re-use the same device over and over
+      #Without needing to create a new one per test
+      LOG.info("Creating a Fresh Device For Testing")
+      new_device_rsp = connection.json_request(
+        'DeviceRouter', 'addDevice', 
+          [{:deviceName => TEST_DEVICE_NAME, :deviceClass => '/Devices/Server'}]
+      )
+
+      #Now we need to wait until the device is present before we proceed. 
+      #Once we issue the create command, it takes
+      if new_device_rsp.has_key?("success") && new_device_rsp['success'] == true
+        #Our job was accepted
+        retries = 20  
+        retry_delay = 15  #seconds
+        found_device = false
+        LOG.info("Waiting for the newly created device to be available. " +
+          "This might take a minute or two")
+        while found_device == false
+          if retries > 0
+            #This will return an Array, so we wait until the array has
+            #something, or we give up after a while
+            devs = connection.find_devices_by_name(TEST_DEVICE_NAME)
+            if devs.empty?
+              retries -= 1
+              LOG.info("#{TEST_DEVICE_NAME} not available yet")
+              sleep(retry_delay)
+            else
+              found_device = true
+              LOG.info("#{TEST_DEVICE_NAME} is available. Proceeding with " +
+                "testing")
+            end
+          else
+            raise ZenossError, "Unable to Create A New Device For Unit Tests"
+          end
+        end
+      else
+        #We failed to create a new device....
+      end
+      #Return the connection object
+      connection
+    end    
+  end
+  
+  before do
+    @zen = self.class.zen
+    @dev = @zen.find_devices_by_name(TEST_DEVICE_NAME).first
+  end
+
+    
+  it "returns an Array of devices when searched by name" do
+    x = @zen.find_devices_by_name(TEST_DEVICE_NAME)
+    x.must_be_kind_of Array
+    x.first.must_be_kind_of Zenoss::Model::Device
+  end
+  
+  it "returns device uptime when asked" do
+    @dev.sys_uptime.wont_be_nil
+    @dev.sys_uptime.wont_be_empty
+  end
+  
+  it "returns an Array of events for a device" do
+    #There could be 0 or more, events so an empty Array is OK
+    @dev.get_events.must_be_kind_of Array
+  end
+  
+  it "returns an Array of historical events for a device" do
+    #There could be 0 or more, events so an empty Array is OK
+    @dev.get_event_history.must_be_kind_of Array
+  end
+  
+  it "returns info for a device in the form of a Hash" do
+    @dev.get_info().wont_be_nil
+    @dev.get_info().wont_be_empty
+    @dev.get_info().must_be_kind_of Hash
+  end
+  
+  it "returns an Array of events for all devices" do
+    events = @zen.query_events
+    events.must_be_kind_of Array
+    events.first.must_be_kind_of Zenoss::Events::ZEvent
+  end
+
+  it "fetches the report tree" do
+    report_tree = @zen.get_report_tree
+    report_tree.must_be_kind_of Array
+    report_tree.first.must_be_kind_of Hash
+    report_tree.wont_be_empty
+  end
+  
+  it "fetches available report types and returns a Hash" do
+    report_types = @zen.get_report_types
+    report_types.must_be_kind_of Hash
+    report_types.wont_be_empty
+    report_types.has_key?("reportTypes").must_equal true
+  end
+  
+end
+
+

data/zenoss_client.gemspec

@@ -30,5 +30,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version	= '>= 1.8.7'
   gem.add_runtime_dependency  'httpclient', '~> 2.2.0'
   gem.add_runtime_dependency  'tzinfo', '~> 0.3.20'
-  gem.add_runtime_dependency  'json', '~> 1.5.0'
+  gem.add_runtime_dependency  'json', '~> 1.5'
+  
+  gem.add_development_dependency('minitest')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zenoss_client
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-05 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &13338900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *13338900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: &13338400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,18 +37,44 @@ dependencies:
         version: 0.3.20
   type: :runtime
   prerelease: false
-  version_requirements: *13338400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.20
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &13337800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *13337800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: ! "    This is a wrapper around the Zenoss JSON and REST APIs. For the
   most things it\n    should feel very familiar to zendmd, but there are some changes
   do to the merging\n    of the JSON and REST APIs. Please read the API docs for Zenoss
@@ -55,6 +86,7 @@ extra_rdoc_files:
 - README.textile
 - COPYING.txt
 files:
+- .gitignore
 - COPYING.txt
 - Gemfile
 - README.textile
@@ -96,6 +128,8 @@ files:
 - lib/zenoss/restapi.rb
 - lib/zenoss_client.rb
 - preamble
+- test/test_helper.rb
+- test/zenoss_client_test.rb
 - tools/callZenossMethod.py
 - zenoss_client.gemspec
 homepage: http://github.com/zenchild/zenoss_client
@@ -122,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A wrapper around the Zenoss JSON and REST APIs