zenoss_client 0.5.4 → 0.6.0

data/test/fixtures/vcr_cassettes/4_2_5_test_0009_renames_the_device.yml

@@ -0,0 +1,160 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://192.168.56.2:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: '[{"action":"DeviceRouter","method":"getDevices","data":[{"uid":"/zport/dmd/Devices","params":{"name":"UnitTestDevice"}}],"type":"rpc","tid":13}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.6.0.1, ruby 2.2.0 (2014-12-25))
+      Accept:
+      - "*/*"
+      Date:
+      - Fri, 22 May 2015 12:14:36 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie:
+      - _ZopeId=47495875A68v.lkNK6o
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Zope/(2.13.13, python 2.7.2, linux2) ZServer/1.1
+      Date:
+      - Fri, 22 May 2015 12:14:36 GMT
+      Content-Length:
+      - '906'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "97f48fcd-7b09-43c1-94f0-d2ec4e3dd7c8", "action": "DeviceRouter",
+        "result": {"totalCount": 1, "hash": "1", "success": true, "devices": [{"ipAddressString":
+        null, "serialNumber": "", "pythonClass": "Products.ZenModel.Device", "hwManufacturer":
+        null, "collector": "localhost", "osModel": null, "productionState": 1000,
+        "systems": [], "priority": 3, "hwModel": null, "tagNumber": "", "osManufacturer":
+        null, "location": null, "groups": [], "uid": "/zport/dmd/Devices/Server/devices/UnitTestDevice",
+        "ipAddress": null, "events": {"info": {"count": 0, "acknowledged_count": 0},
+        "clear": {"count": 0, "acknowledged_count": 0}, "warning": {"count": 0, "acknowledged_count":
+        0}, "critical": {"count": 0, "acknowledged_count": 0}, "error": {"count":
+        0, "acknowledged_count": 0}, "debug": {"count": 0, "acknowledged_count": 0}},
+        "name": "UnitTestDevice"}]}, "tid": 13, "type": "rpc", "method": "getDevices"}'
+    http_version: 
+  recorded_at: Fri, 22 May 2015 12:14:36 GMT
+- request:
+    method: get
+    uri: http://192.168.56.2:8080/zport/dmd/zport/dmd/Devices/Server/devices/UnitTestDevice/renameDevice?newId=unit_test_temporary_device_name
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.6.0.1, ruby 2.2.0 (2014-12-25))
+      Accept:
+      - "*/*"
+      Date:
+      - Fri, 22 May 2015 12:14:36 GMT
+      Cookie:
+      - _ZopeId=47495875A68v.lkNK6o
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Zope/(2.13.13, python 2.7.2, linux2) ZServer/1.1
+      Date:
+      - Fri, 22 May 2015 12:14:36 GMT
+      Content-Length:
+      - '65'
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: "/zport/dmd/Devices/Server/devices/unit_test_temporary_device_name"
+    http_version: 
+  recorded_at: Fri, 22 May 2015 12:14:37 GMT
+- request:
+    method: post
+    uri: http://192.168.56.2:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: '[{"action":"DeviceRouter","method":"getDevices","data":[{"uid":"/zport/dmd/Devices","params":{"name":"unit_test_temporary_device_name"}}],"type":"rpc","tid":14}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.6.0.1, ruby 2.2.0 (2014-12-25))
+      Accept:
+      - "*/*"
+      Date:
+      - Fri, 22 May 2015 12:14:37 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie:
+      - _ZopeId=47495875A68v.lkNK6o
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Zope/(2.13.13, python 2.7.2, linux2) ZServer/1.1
+      Date:
+      - Fri, 22 May 2015 12:14:36 GMT
+      Content-Length:
+      - '940'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "ba140e8f-1063-46c9-95d7-0a8e5cbff659", "action": "DeviceRouter",
+        "result": {"totalCount": 1, "hash": "1", "success": true, "devices": [{"ipAddressString":
+        null, "serialNumber": "", "pythonClass": "Products.ZenModel.Device", "hwManufacturer":
+        null, "collector": "localhost", "osModel": null, "productionState": 1000,
+        "systems": [], "priority": 3, "hwModel": null, "tagNumber": "", "osManufacturer":
+        null, "location": null, "groups": [], "uid": "/zport/dmd/Devices/Server/devices/unit_test_temporary_device_name",
+        "ipAddress": null, "events": {"info": {"count": 0, "acknowledged_count": 0},
+        "clear": {"count": 0, "acknowledged_count": 0}, "warning": {"count": 0, "acknowledged_count":
+        0}, "critical": {"count": 0, "acknowledged_count": 0}, "error": {"count":
+        0, "acknowledged_count": 0}, "debug": {"count": 0, "acknowledged_count": 0}},
+        "name": "unit_test_temporary_device_name"}]}, "tid": 14, "type": "rpc", "method":
+        "getDevices"}'
+    http_version: 
+  recorded_at: Fri, 22 May 2015 12:14:37 GMT
+- request:
+    method: get
+    uri: http://192.168.56.2:8080/zport/dmd/zport/dmd/Devices/Server/devices/unit_test_temporary_device_name/renameDevice?newId=UnitTestDevice
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.6.0.1, ruby 2.2.0 (2014-12-25))
+      Accept:
+      - "*/*"
+      Date:
+      - Fri, 22 May 2015 12:14:37 GMT
+      Cookie:
+      - _ZopeId=47495875A68v.lkNK6o
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Zope/(2.13.13, python 2.7.2, linux2) ZServer/1.1
+      Date:
+      - Fri, 22 May 2015 12:14:37 GMT
+      Content-Length:
+      - '48'
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: "/zport/dmd/Devices/Server/devices/UnitTestDevice"
+    http_version: 
+  recorded_at: Fri, 22 May 2015 12:14:37 GMT
+recorded_with: VCR 2.9.3

data/test/test_helper.rb

@@ -1,11 +1,20 @@
-$:.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"
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+#http://net.tutsplus.com/tutorials/ruby/ruby-for-newbies-testing-with-rspec/
+require_relative '../lib/zenoss'
+require 'vcr'
+
+
+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"
+
+ZENOSS_VERSION = ENV['zenoss_version'] || '4.2.5'
+
+
+# VCR
+VCR.configure do |config|
+  config.cassette_library_dir = "test/fixtures/vcr_cassettes"
+  config.hook_into :webmock
+end

data/test/zenoss_client_test.rb

@@ -1,114 +1,140 @@
-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
-
-
+require_relative './test_helper'
+require 'minitest/spec'
+require 'minitest/autorun'
+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
+    VCR.use_cassette "#{ZENOSS_VERSION}_initial connection", :match_requests_on => [:method, :path, :query]  do
+      @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.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) if VCR.current_cassette.recording?
+              else
+                found_device = true
+                LOG.info("#{TEST_DEVICE_NAME} is available. Proceeding with " \
+                  'testing')
+              end
+            else
+              fail 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
+  end
+
+  def gen_cassette_name
+    n = "#{ZENOSS_VERSION}_#{name}"
+    # name method is not available on ruby 1.9
+    rescue NoMethodError, NameError
+      fallback_method = [:__name__, :__NAME__].find { |m| self.respond_to? m }
+      n = "#{ZENOSS_VERSION}_#{send(fallback_method)}"
+    n.gsub!('.', '_')
+    n
+  end
+
+  before do
+    VCR.insert_cassette gen_cassette_name, :match_requests_on => [:method, :path, :query]
+    @zen = self.class.zen
+    @dev = @zen.find_devices_by_name(TEST_DEVICE_NAME).first
+  end
+
+  after do
+    VCR.eject_cassette gen_cassette_name
+  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.key?('reportTypes').must_equal true
+  end
+
+  it 'renames the device' do
+    TEMPORARY_DEVICE_NAME = 'unit_test_temporary_device_name'
+    begin
+      @dev.rename_device(TEMPORARY_DEVICE_NAME)
+      renamed_devices = @zen.find_devices_by_name(TEMPORARY_DEVICE_NAME)
+      renamed_devices.wont_be_empty
+      renamed_device = renamed_devices.first
+      renamed_device.name.must_equal TEMPORARY_DEVICE_NAME
+    ensure
+      renamed_device.rename_device(TEST_DEVICE_NAME)
+    end
+  end
+end

data/zenoss_client.gemspec

@@ -6,16 +6,17 @@ require 'date'
 Gem::Specification.new do |gem|
   gem.name = "zenoss_client"
   gem.version = File.open('VERSION').readline.chomp
-  gem.date		= Date.today.to_s
+  gem.date = Date.today.to_s
   gem.platform = Gem::Platform::RUBY
   gem.rubyforge_project  = nil
 
-  gem.author = "Dan Wanek"
-  gem.email = "dan.wanek@gmail.com"
-  gem.homepage = "http://github.com/zenchild/zenoss_client"
+  gem.authors = ['Dan Wanek', 'Ben Miller', 'Marek Skrobacki']
+  gem.email = ['dan.wanek@gmail.com', 'bjmllr@gmail.com', 'marek@skrobacki.uk']
+  gem.homepage = "http://github.com/RubyOpenSource/zenoss_client"
 
   gem.summary = "A wrapper around the Zenoss JSON and REST APIs"
-  gem.description	= <<-EOF
+  gem.license = 'GPL-3.0'
+  gem.description = <<-EOF
     This is a wrapper around the Zenoss JSON and REST APIs. For the most things it
     should feel very familiar to zendmd, but there are some changes do to the merging
     of the JSON and REST APIs. Please read the API docs for Zenoss and the YARDDoc for
@@ -24,13 +25,16 @@ Gem::Specification.new do |gem|
 
   gem.files = `git ls-files`.split(/\n/)
   gem.require_path = "lib"
-  gem.rdoc_options	= %w(-x test/ -x examples/)
+  gem.rdoc_options = %w(-x test/ -x examples/)
   gem.extra_rdoc_files = %w(README.textile COPYING.txt)
 
-  gem.required_ruby_version	= '>= 1.8.7'
-  gem.add_runtime_dependency  'httpclient', '~> 2.2.0'
+  gem.required_ruby_version = '>= 1.8.7'
+  gem.add_runtime_dependency  'httpclient', '~> 2.0'
   gem.add_runtime_dependency  'tzinfo', '~> 0.3.20'
   gem.add_runtime_dependency  'json', '~> 1.5'
-  
+
+  gem.add_development_dependency('rake')
   gem.add_development_dependency('minitest')
+  gem.add_development_dependency('vcr')
+  gem.add_development_dependency('webmock')
 end