hawkular-client 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7913796f40acecb8ad5eaeca8bb846dbaae63626
-  data.tar.gz: afdf2f08190d90a4f0a4be6bed389e42826c9e8e
+  metadata.gz: e11ac018e665d5df965d8636e2854a668fccf67a
+  data.tar.gz: d832ab5278b0b256885b21a87825beb4fa39191a
 SHA512:
-  metadata.gz: 4b02e20b49ef0fb225d99cc736ee506f7eb5f6b318a2e18b4a6671f19643debdf9be69f31e879a3e7069d7f5b78ef4c42c6bcf2cd895704d39e83871b24daf19
-  data.tar.gz: da752848f50298b6385becb2447969d054e54e0721e281356f58c530e1373a8f249cda2090634a084663fa63494fd7a247f65da2894da4c95950ddd57ad57361
+  metadata.gz: f24ceb12b54bb212b93a3ed512b2c27656a1aa4b21fd7d55d638ae15542e8d174ff2dcb00d2eccccc9f9a83915fec36c5f53bc712b0cf6485dd7e00e3e049377
+  data.tar.gz: bb8479e029d5abdc8b530f4e8f1276d978c87ebb3bec858d24f98e006ba0578021605eb035a92054818216a85a20ed89b3a3b9014e749b87e2af1b27209cbe83

data/CHANGES.rdoc

@@ -3,6 +3,13 @@
 This document describes the relevant changes between releases of the
 _hawkular-client_ project.
 
+=== V 2.4.0
+
+* Expose `metric.type.id` in metric definitions from Inventory, as the agent changed what it sends
+* Fix the 'Undeploy' operation
+
+Full list of items can be found at https://github.com/hawkular/hawkular-client-ruby/milestone/9?closed=1
+
 === V 2.3.0
 
 * Wrap connection errors in `HawkularConnectionException` (a subclass of `HawkularException`)

data/hawkularclient.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency('websocket-client-simple', '~> 0.3.0')
   gem.add_runtime_dependency('addressable')
   gem.add_development_dependency('shoulda')
-  gem.add_development_dependency('rspec-rails', '~> 3.0')
+  gem.add_development_dependency('rspec-rails', '~> 3.1')
   gem.add_development_dependency('rake', '< 11')
   gem.add_development_dependency('simple-websocket-vcr', '= 0.0.7')
   gem.add_development_dependency('yard')

data/lib/hawkular/inventory/entities.rb

@@ -101,10 +101,13 @@ module Hawkular::Inventory
   class Metric < BaseEntity
     include MetricFields
 
+    attr_reader :type_id
+
     def initialize(metric_hash)
       super(metric_hash)
       @type = metric_hash['type']['type']
       @type_path = metric_hash['type']['path']
+      @type_id = metric_hash['type']['id']
       @unit = metric_hash['type']['unit']
       @collection_interval = metric_hash['type']['collectionInterval']
     end
@@ -175,39 +178,39 @@ module Hawkular::Inventory
       @metric_id = hash[:metric_id]
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def self.parse(path)
       fail 'CanonicalPath must not be nil or empty' if path.to_s.strip.length == 0
-      tmp = path.split('/')
-      hash = {}
-      tmp.each do |pair|
-        (key, val) = pair.split(';')
-        case key
-        when 't'
-          hash[:tenant_id] = val
-        when 'f'
-          hash[:feed_id] = val
-        when 'e'
-          hash[:environment_id] = val
-        when 'm'
-          hash[:metric_id] = val
-        when 'r'
-          hash[:resource_ids] = [] if hash[:resource_ids].nil?
-          hash[:resource_ids].push(val)
-        when 'mt'
-          hash[:metric_type_id] = val
-        when 'rt'
-          hash[:resource_type_id] = val
-        end
+      CanonicalPath.new(path_to_h path)
+    end
+
+    # Move up to the parent path of the resource. resource_ids set to empty array when there is no parent.
+    # @return CanonicalPath corresponding to the direct ancestor of the resource represented by this path object.
+    def up
+      hash = to_h
+      if hash[:resource_ids].nil?
+        hash[:resource_ids] = []
+      else
+        hash[:resource_ids].pop
       end
       CanonicalPath.new(hash)
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     def ==(other)
       self.equal?(other) || other.class == self.class && other.state == state
     end
 
+    def to_h
+      {
+        tenant_id: @tenant_id,
+        feed_id: @feed_id,
+        environment_id: environment_id,
+        resource_type_id: resource_type_id,
+        metric_type_id: metric_type_id,
+        resource_ids: resource_ids,
+        metric_id: @metric_id
+      }
+    end
+
     def to_s
       ret = "/t;#{@tenant_id}"
       ret += "/f;#{@feed_id}" unless @feed_id.nil?
@@ -230,5 +233,31 @@ module Hawkular::Inventory
     def resources_chunk
       @resource_ids.map { |r| "/r;#{r}" }.join unless @resource_ids.nil?
     end
+
+    def self.path_to_h(path)
+      tmp = path.split('/')
+      hash = {}
+      tmp.each do |pair|
+        (key, val) = pair.split(';')
+        case key
+        when 't'
+          hash[:tenant_id] = val
+        when 'f'
+          hash[:feed_id] = val
+        when 'e'
+          hash[:environment_id] = val
+        when 'm'
+          hash[:metric_id] = val
+        when 'r'
+          hash[:resource_ids] = [] if hash[:resource_ids].nil?
+          hash[:resource_ids].push(val)
+        when 'mt'
+          hash[:metric_type_id] = val
+        when 'rt'
+          hash[:resource_type_id] = val
+        end
+      end
+      hash
+    end
   end
 end

data/lib/hawkular/operations/operations_api.rb

@@ -2,6 +2,8 @@ require 'hawkular/base_client'
 require 'websocket-client-simple'
 require 'json'
 
+require 'hawkular/inventory/entities'
+
 # Adding a method `perform` for each block so that we can write nice callbacks for this client
 class Proc
   class PerformMethodMissing
@@ -144,6 +146,28 @@ module Hawkular::Operations
       invoke_operation_helper(operation_payload, 'DeployApplication', hash[:binary_content], &callback)
     end
 
+    # Removes an existing deployment from WildFly
+    #
+    # @param [Hash] hash Arguments for deployment removal
+    # @option hash [String]  :resource_path canonical path of the WildFly server from which to remove the deployment
+    # @option hash [String]  :deployment_name name of deployment to remove
+    #
+    # @param callback [Block] callback that is run after the operation is done
+    def remove_deployment(hash, &callback)
+      required = [:resource_path, :deployment_name]
+      check_pre_conditions hash, required, &callback
+
+      cp = ::Hawkular::Inventory::CanonicalPath.parse hash[:resource_path]
+      server_path = cp.up.to_s
+
+      payload_hash = {
+        resource_path: server_path,
+        destination_file_name: hash[:deployment_name]
+      }
+      operation_payload = prepare_payload_hash([], payload_hash)
+      invoke_operation_helper(operation_payload, 'UndeployApplication', &callback)
+    end
+
     # Adds a new datasource
     #
     # @param [Hash] hash Arguments for the datasource

data/lib/hawkular/version.rb

@@ -4,5 +4,5 @@
 # @see https://github.com/hawkular
 module Hawkular
   # Version of the Hawkular Ruby Gem
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/spec/integration/inventory_spec.rb

@@ -292,6 +292,15 @@ module Hawkular::Inventory::RSpec
       expect(metrics.size).to be(14)
     end
 
+    it 'Should have the same requested metric type id' do
+      metric_type_id = 'Server Availability~Server Availability'
+      type_path = CanonicalPath.new(feed_id: feed_id, metric_type_id: hawk_escape_id(metric_type_id))
+      metrics = @client.list_metrics_for_metric_type(type_path)
+
+      expect(metrics.size).to be > 0
+      expect(metrics).to all(have_attributes(type_id: metric_type_id))
+    end
+
     it 'Should return config data of given resource' do
       resource_path = CanonicalPath.new(feed_id: feed_id, resource_ids: [hawk_escape_id('Local~~')])
       config = @client.get_config_data_for_resource(resource_path)

data/spec/integration/operations_spec.rb

@@ -327,11 +327,11 @@ module Hawkular::Operations::RSpec
                                resource_ids: [wf_server_resource_id, alerts_war_resource_id])
 
       undeploy = {
-        operationName: 'Undeploy',
-        resourcePath: path.to_s
+        resource_path: path.to_s,
+        deployment_name: 'hawkular-alerts-actions-email.war'
       }
       actual_data = {}
-      @client.invoke_generic_operation(undeploy) do |on|
+      @client.remove_deployment(undeploy) do |on|
         on.success do |data|
           actual_data[:data] = data
         end

data/spec/unit/canonical_path_spec.rb

@@ -37,6 +37,15 @@ describe 'CanonicalPath' do
         .to be == CanonicalPath.new(tenant_id: 't1', environment_id: 'e1', resource_ids: %w(r1 r2 r3))
     end
 
+    it 'with resource hierarchy should be upable' do
+      expect(CanonicalPath.parse('/t;t1/f;f1/r;r1/r;r2/r;r3/r;r4/r;r5').up)
+        .to be == CanonicalPath.new(tenant_id: 't1', feed_id: 'f1', resource_ids: %w(r1 r2 r3 r4))
+      expect(CanonicalPath.parse('/t;t1/e;e1/r;r1').up)
+        .to be == CanonicalPath.new(tenant_id: 't1', environment_id: 'e1', resource_ids: [])
+      expect(CanonicalPath.parse('/t;t1/e;e1').up)
+        .to be == CanonicalPath.new(tenant_id: 't1', environment_id: 'e1', resource_ids: [])
+    end
+
     it 'should be identity when calling parse and then to_s' do
       path_str = '/t;t1/e;e1/r;r1/r;r2'
       path1 = CanonicalPath.parse(path_str)

data/spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_have_the_same_requested_metric_type_id.yml

@@ -0,0 +1,73 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://jdoe:password@localhost:8080/hawkular/inventory/traversal/f;<%= feed_uuid %>/mt;Server%20Availability~Server%20Availability/rl;defines/type=m
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - identity
+      User-Agent:
+      - hawkular-client-ruby
+      Hawkular-Tenant:
+      - hawkular
+      Content-Type:
+      - application/json
+      Host:
+      - localhost:8080
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Expires:
+      - '0'
+      Cache-Control:
+      - no-cache, no-store, must-revalidate
+      X-Powered-By:
+      - Undertow/1
+      Server:
+      - WildFly/10
+      Pragma:
+      - no-cache
+      Date:
+      - Thu, 28 Jul 2016 00:09:29 GMT
+      X-Total-Count:
+      - '1'
+      Connection:
+      - keep-alive
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '876'
+      Link:
+      - <http://localhost:8080/hawkular/inventory/traversal/f;<%= feed_uuid %>/mt;Server%20Availability~Server%20Availability/rl;defines/type=m>;
+        rel="current"
+    body:
+      encoding: UTF-8
+      string: |-
+        [ {
+          "path" : "/t;hawkular/f;<%= feed_uuid %>/m;AI~R~%5B<%= feed_uuid %>%2FLocal~~%5D~AT~Server%20Availability~Server%20Availability",
+          "properties" : {
+            "__identityHash" : "fa194dbc2719bcccbda7a8546db986adeff870df"
+          },
+          "name" : "Server Availability~Server Availability",
+          "identityHash" : "fa194dbc2719bcccbda7a8546db986adeff870df",
+          "type" : {
+            "path" : "/t;hawkular/f;<%= feed_uuid %>/mt;Server%20Availability~Server%20Availability",
+            "name" : "Server Availability~Server Availability",
+            "identityHash" : "69beedc2b0c5cf2f3d0484b9c1aa9e4cdcf93",
+            "unit" : "NONE",
+            "type" : "AVAILABILITY",
+            "collectionInterval" : 30,
+            "id" : "Server Availability~Server Availability"
+          },
+          "id" : "AI~R~[<%= feed_uuid %>/Local~~]~AT~Server Availability~Server Availability"
+        } ]
+    http_version: 
+  recorded_at: Thu, 28 Jul 2016 00:09:29 GMT
+recorded_with: VCR 3.0.3

data/spec/vcr_cassettes/Operation/Operation/Undeploy_should_be_performed_and_eventually_respond_with_success.json

@@ -7,7 +7,7 @@
     },
     {
       "operation": "write",
-      "data": "ExecuteOperationRequest={\"operationName\":\"Undeploy\",\"resourcePath\":\"/t;hawkular/f;33f22c4a-445a-4f90-a25e-caeff9579a10/r;Local~~/r;Local~%2Fdeployment%3Dhawkular-alerts-actions-email.war\",\"authentication\":{\"username\":\"jdoe\",\"password\":\"password\"}}"
+      "data": "UndeployApplicationRequest={\"resourcePath\":\"/t;hawkular/f;33f22c4a-445a-4f90-a25e-caeff9579a10/r;Local~~\",\"destinationFileName\":\"\hawkular-alerts-actions-email.war\",\"authentication\":{\"username\":\"jdoe\",\"password\":\"password\"}}"
     },
     {
       "operation": "read",
@@ -17,7 +17,7 @@
     {
       "operation": "read",
       "type": "text",
-      "data": "ExecuteOperationResponse={\"operationName\":\"Undeploy\",\"resourcePath\":\"/t;hawkular/f;33f22c4a-445a-4f90-a25e-caeff9579a10/r;Local~~/r;Local~%2Fdeployment%3Dhawkular-alerts-actions-email.war\",\"destinationSessionId\":\"1j9HQbWoBj9RMQZIR0BwpnU3IkxoMwQ-O9_Cr1Ds\",\"status\":\"OK\",\"message\":\"Performed [Undeploy] on a [DMR Node] given by Inventory path [/t;hawkular/f;33f22c4a-445a-4f90-a25e-caeff9579a10/r;Local~~/r;Local~%2Fdeployment%3Dhawkular-alerts-actions-email.war]\"}"
+      "data": "UndeployApplicationResponse={\"resourcePath\":\"/t;hawkular/f;33f22c4a-445a-4f90-a25e-caeff9579a10/r;Local~~\",\"destinationFileName\":\"\hawkular-alerts-actions-email.war\",\"destinationSessionId\":\"1j9HQbWoBj9RMQZIR0BwpnU3IkxoMwQ-O9_Cr1Ds\",\"status\":\"OK\",\"message\":\"Performed [Undeploy] on a [DMR Node] given by Inventory path [/t;hawkular/f;33f22c4a-445a-4f90-a25e-caeff9579a10/r;Local~~/r;Local~%2Fdeployment%3Dhawkular-alerts-actions-email.war]\"}"
     },
     {
       "operation": "close"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hawkular-client
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Libor Zoubek
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -75,14 +75,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -309,6 +309,7 @@ files:
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_create_a_resourcetype.yml
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_create_and_delete_feed.yml
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_create_and_get_a_resource.yml
+- spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_have_the_same_requested_metric_type_id.yml
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_list_URLs.yml
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_list_WildFlys.yml
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_list_WildFlys_with_props.yml
@@ -545,6 +546,7 @@ test_files:
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_create_a_resourcetype.yml
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_create_and_delete_feed.yml
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_create_and_get_a_resource.yml
+- spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_have_the_same_requested_metric_type_id.yml
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_list_URLs.yml
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_list_WildFlys.yml
 - spec/vcr_cassettes/Inventory/inventory_0_17/Templates/Should_list_WildFlys_with_props.yml