zenoss_client 0.6.1 → 0.10.0

data/test/fixtures/vcr_cassettes/6_2_1_test_0010_sets_info_for_a_device.yml

@@ -0,0 +1,100 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost: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":15}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 25 Feb 2019 23:20:07 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '1064'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "6245a13a-8add-4ee0-a04d-8e6206b8d8c8", "action": "DeviceRouter",
+        "result": {"totalCount": 1, "hash": "1", "success": true, "devices": [{"ipAddressString":
+        null, "serialNumber": "", "pythonClass": "Products.ZenModel.Device", "hwManufacturer":
+        null, "collector": "zencollector01", "osModel": null, "productionState": -1,
+        "systems": [], "priority": 3, "hwModel": null, "tagNumber": "", "osManufacturer":
+        null, "location": null, "groups": [{"uid": "/zport/dmd/Groups/BackboneDevices",
+        "path": "/Groups/BackboneDevices", "uuid": "65142f38-df6e-482e-a74d-ec825af8e058",
+        "name": "/BackboneDevices"}], "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": 15, "type": "rpc", "method": "getDevices"}'
+    http_version: 
+  recorded_at: Mon, 25 Feb 2019 23:20:08 GMT
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: '[{"action":"DeviceRouter","method":"setInfo","data":[{"uid":"/zport/dmd/Devices/Server/devices/UnitTestDevice","productionState":-1}],"type":"rpc","tid":16}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '150'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "7e7ea36e-b80b-4fa6-bb1f-3ba6ab104996", "action": "DeviceRouter",
+        "result": {"success": true}, "tid": 16, "type": "rpc", "method": "setInfo"}'
+    http_version: 
+  recorded_at: Mon, 25 Feb 2019 23:20:08 GMT
+recorded_with: VCR 4.0.0

data/test/fixtures/vcr_cassettes/6_2_1_test_0011_sets_info_for_a_device_on_a_device_object.yml

@@ -0,0 +1,100 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost: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":21}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '1064'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "9e2f968f-be4a-4cc2-836a-9e5687d3c86c", "action": "DeviceRouter",
+        "result": {"totalCount": 1, "hash": "1", "success": true, "devices": [{"ipAddressString":
+        null, "serialNumber": "", "pythonClass": "Products.ZenModel.Device", "hwManufacturer":
+        null, "collector": "zencollector01", "osModel": null, "productionState": -1,
+        "systems": [], "priority": 3, "hwModel": null, "tagNumber": "", "osManufacturer":
+        null, "location": null, "groups": [{"uid": "/zport/dmd/Groups/BackboneDevices",
+        "path": "/Groups/BackboneDevices", "uuid": "65142f38-df6e-482e-a74d-ec825af8e058",
+        "name": "/BackboneDevices"}], "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": 21, "type": "rpc", "method": "getDevices"}'
+    http_version: 
+  recorded_at: Mon, 25 Feb 2019 23:20:08 GMT
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: '[{"action":"DeviceRouter","method":"setInfo","data":[{"uid":"/zport/dmd/Devices/Server/devices/UnitTestDevice","productionState":-1}],"type":"rpc","tid":22}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 25 Feb 2019 23:20:09 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '150'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "25ba2f17-7cdd-4229-9a5f-7c4e1d0c240b", "action": "DeviceRouter",
+        "result": {"success": true}, "tid": 22, "type": "rpc", "method": "setInfo"}'
+    http_version: 
+  recorded_at: Mon, 25 Feb 2019 23:20:09 GMT
+recorded_with: VCR 4.0.0

data/test/fixtures/vcr_cassettes/6_2_1_test_0012_remodels_a_device.yml

@@ -0,0 +1,99 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost: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":4}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Wed, 15 Apr 2020 20:39:11 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 15 Apr 2020 20:39:11 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '905'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "d7e1f3b6-bff3-4ac0-b915-974e7b57bd24", "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": 4, "type": "rpc", "method": "getDevices"}'
+    http_version: 
+  recorded_at: Wed, 15 Apr 2020 20:39:11 GMT
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: '[{"action":"DeviceRouter","method":"remodel","data":[{"deviceUid":"/zport/dmd/Devices/Server/devices/UnitTestDevice","collectPlugins":"","background":false}],"type":"rpc","tid":5}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Wed, 15 Apr 2020 20:39:11 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 15 Apr 2020 20:40:46 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '166'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "40e52e10-789f-4da0-b15a-b839dbce38ae", "action": "DeviceRouter",
+        "result": {"exitStatus": 0, "success": true}, "tid": 5, "type": "rpc", "method":
+        "remodel"}'
+    http_version: 
+  recorded_at: Wed, 15 Apr 2020 20:40:46 GMT
+recorded_with: VCR 4.0.0

data/test/test_helper.rb

@@ -17,4 +17,18 @@ WebMock.enable!
 VCR.configure do |config|
   config.cassette_library_dir = "test/fixtures/vcr_cassettes"
   config.hook_into :webmock
+
+  config.filter_sensitive_data('admin') { ZENOSS_USER }
+  config.filter_sensitive_data('http://localhost:8080/zport/dmd') { ZENOSS_URL }
+  config.filter_sensitive_data('zenoss') { ZENOSS_PASSWORD }
+
+  config.before_record do |interaction, cassette|
+    if cassette.name == '6.2.1_initial connection'
+      interaction.request.body = '__ac_name=admin&__ac_password=zenoss'\
+                                 '&submitted=true&came_from=https%3A%2F'\
+                                 '%2Fhttp:://localhost:8080/zport/dmd'\
+                                 '%2Fzport%2Fdmd'
+    end
+  end
 end
+

data/test/zenoss_client_test.rb

@@ -1,5 +1,4 @@
 require_relative './test_helper'
-require 'minitest/spec'
 require 'minitest/autorun'
 require 'logger'
 
@@ -12,7 +11,9 @@ describe Zenoss do
   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
+        opts = {}
+        opts[:version] = ZENOSS_VERSION
+        connection = Zenoss.connect ZENOSS_URL, ZENOSS_USER, ZENOSS_PASSWORD, opts
         # 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
@@ -69,7 +70,7 @@ describe Zenoss do
   end
 
   before do
-    VCR.insert_cassette gen_cassette_name, :match_requests_on => [:method, :path, :query]
+    VCR.insert_cassette gen_cassette_name, :match_requests_on => [:method, :path, :query], :allow_playback_repeats => true
     @zen = self.class.zen
     @dev = @zen.find_devices_by_name(TEST_DEVICE_NAME).first
   end
@@ -137,4 +138,89 @@ describe Zenoss do
       renamed_device.rename_device(TEST_DEVICE_NAME)
     end
   end
+
+  if ZENOSS_VERSION > '6'
+    it 'sets info for a device' do
+      opts = {}
+      opts[:uid] = @dev.uid
+      opts[:productionState] = -1
+      set_info = @zen.set_info(opts)
+      set_info.must_be_kind_of Hash
+      set_info.wont_be_empty
+      set_info['success'].must_equal true
+    end
+
+    it 'sets info for a device on a device object' do
+      opts = {}
+      opts[:productionState] = -1
+      set_info = @dev.set_info(opts)
+      set_info.must_be_kind_of Hash
+      set_info.wont_be_empty
+      set_info['success'].must_equal true
+    end
+
+    it 'remodels a device' do
+      uid = @dev.uid
+      remodel = @zen.remodel(uid)
+      remodel.must_be_kind_of Hash
+      remodel.wont_be_empty
+      remodel['success'].must_equal true
+      remodel['exitStatus'].must_equal 0
+    end
+  end
+end
+
+describe Zenoss::Events::Event do
+  it 'initializes an object with times as strings' do
+    @zenoss = Zenoss
+    firstTime = Time.new(2018, 10, 3, 1, 0, 0)
+    lastTime = Time.new(2018, 10, 3, 3, 0, 0)
+    zhash = {
+      firstTime: firstTime.to_s,
+      lastTime: lastTime.to_s
+    }
+    event = Zenoss::Events::Event.new(@zenoss, zhash)
+    event.must_be_kind_of Zenoss::Events::Event
+    event.firstTime.must_be_kind_of Time
+    event.lastTime.must_be_kind_of Time
+  end
+
+  it 'intializes an object with times as unix time' do
+    @zenoss = Zenoss
+    firstTime = Time.new(2018, 10, 3, 2, 0, 0)
+    lastTime = Time.new(2018, 10, 3, 5, 0, 0)
+    zhash = {
+      firstTime: firstTime.to_f,
+      lastTime: lastTime.to_f
+    }
+    event = Zenoss::Events::Event.new(@zenoss, zhash)
+    event.must_be_kind_of Zenoss::Events::Event
+    event.firstTime.class.must_equal Time
+    event.firstTime.must_be_kind_of Time
+    event.lastTime.must_be_kind_of Time
+  end
+
+  it 'intializes an object with times set to nil' do
+    @zenoss = Zenoss
+    zhash = {
+      firstTime: nil,
+      lastTime: nil
+    }
+    event = Zenoss::Events::Event.new(@zenoss, zhash)
+    event.must_be_kind_of Zenoss::Events::Event
+    assert_nil event.firstTime
+    assert_nil event.lastTime
+  end
+
+  it 'intializes an object with times set to false' do
+    @zenoss = Zenoss
+    zhash = {
+      firstTime: false,
+      lastTime: false
+    }
+    event = Zenoss::Events::Event.new(@zenoss, zhash)
+    event.must_be_kind_of Zenoss::Events::Event
+    event.firstTime.must_equal false
+    event.lastTime.must_equal false
+  end
 end

data/test/zenoss_model_device_test.rb

@@ -0,0 +1,25 @@
+require_relative './test_helper'
+require 'minitest/autorun'
+
+describe Zenoss::Model::Device do
+  it 'raises error on #set_info when version is less than 6' do
+    opts = {}
+    opts[:version] = '4.2.5'
+    opts[:no_sign_in] = true
+    connection = Zenoss::Connection.new('http://localhost', 'admin', 'zenoss', opts)
+    zhash = {
+      productionState: 400,
+      priority: 3,
+      uid: '/zport/dmd/Devices/Server/devices/UnitTestDevice',
+      name: 'UnitTestDevice'
+    }
+
+    dev = Zenoss::Model::Device.new(connection, zhash)
+    options = {}
+    options[:productionState] = -1
+    exception = assert_raises Zenoss::ZenossError do
+      dev.set_info(options)
+    end
+    assert_equal('setInfo method on DeviceRouter is only allowed for version 6 and above', exception.message)
+  end
+end