hawkular-client 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0deaaa015739eac52e9e7dee6baa5af63676ead7
-  data.tar.gz: 86167936dc2869bc8ae120649edf36d0078fba52
+  metadata.gz: a881d3c60a017681d81648d65397217c78f5c30f
+  data.tar.gz: 4ab68c65b422bcc0eaa5075c4ce8ac873af54d03
 SHA512:
-  metadata.gz: c568daeb2e618ea436afc6af14ba5b98d6531e24ca6d7478b123ea868318e82700c1b4556eab69b4f9814aae57a4dc5dec029c9a6ef43c5b8828c410ff41de9e
-  data.tar.gz: 1e3595bf9e178c835d84bc17f5c0104a630e0c14e506f9e119807f39b2625c1e30f1428125b4df6d6a14ad141d085cb9c5c2d074a76e83c3af03893ad46fd144
+  metadata.gz: 2b463dbb1267dd39f7701e09491f85f5341baa29f72b492a5df090461b12a4ac8e2a934f13dcc18fa65cedae37f0f7de3d5c8b022fc13bda9c6b54adf0734996
+  data.tar.gz: 780f5436eebc3149df30ed2329b4a7ee7d1245163e10fd8078e112b266be8f43758a3f3e1cd0d636525f1f197160c201bffd187fdd2a77000bbd3a3818268a17

data/CHANGES.rdoc

@@ -3,6 +3,11 @@
 This document describes the relevant changes between releases of the
 _hawkular-client_ project.
 
+=== V 2.1.0
+* Fix an issue where the operations endpoint constructor expected a host to be passed, which was not.
+* Add authentication to the websocket setup in Operations sub-client.
+* Add a status endpoint call for the Alerts sub-client
+
 === V 2.0.0
 * This version is compatible with hawkular-services[https://github.com/hawkular/hawkular-services]
 * By default no Tenant-Header is send in the requests, which is compatible with the old versions of Hawkular. However,

data/lib/hawkular/alerts/alerts_api.rb

@@ -20,6 +20,13 @@ module Hawkular::Alerts
       super(entrypoint, credentials, options)
     end
 
+    # Return version and status information for the used version of Hawkular-Alerting
+    # @return [Hash{String=>String}]
+    #         ('Implementation-Version', 'Built-From-Git-SHA1', 'status')
+    def fetch_version_and_status
+      http_get('/status')
+    end
+
     # Lists defined triggers in the system
     # @param [Array] ids List of trigger ids. If provided, limits to the given triggers
     # @param [Array] tags List of tags. If provided, limits to the given tags. Individual

data/lib/hawkular/operations/operations_api.rb

@@ -43,9 +43,12 @@ module Hawkular::Operations
 
     # Initialize new OperationsClient
     #
-    # @param [Hash] args Arguments for client
+    # @param [Hash] args Arguments for client.
+    # There are two ways of passing in the target host/port: via :host and via :entrypoint. If
+    # both are given, then :entrypoint will be used.
     #
-    # @option args [String]  :host base url of Hawkular - e.g http://localhost:8080
+    # @option args [String] :entrypoint Base URL of the hawkular server e.g. http://localhost:8080.
+    # @option args [String] :host base host:port pair of Hawkular - e.g localhost:8080
     # @option args [Hash{String=>String}]  :credentials Hash of (username password) or token
     # @option args [Hash{String=>String}] :options Additional rest client options
     # @option args [Fixnum]  :wait_time Time in seconds describing how long the constructor should block - handshake
@@ -53,14 +56,29 @@ module Hawkular::Operations
     # @example
     #   Hawkular::Operations::OperationsClient.new(credentials: {username: 'jdoe', password: 'password'})
     def initialize(args)
-      args[:host] ||= 'localhost:8080'
+      ep = args[:entrypoint]
+
+      unless ep.nil?
+        uri = URI.parse ep
+        args[:host] ||= "#{uri.host}:#{uri.port}"
+      end
+
+      fail 'no parameter ":host" or ":entrypoint" given' if args[:host].nil?
       args[:credentials] ||= {}
       args[:options] ||= {}
       args[:wait_time] ||= 0.5
       super(args[:host], args[:credentials], args[:options])
       # note: if we start using the secured WS, change the protocol to wss://
-      url = "ws://#{entrypoint}/hawkular/command-gateway/ui/ws"
-      @ws = Simple.connect url do |client|
+      url = "ws://#{args[:host]}/hawkular/command-gateway/ui/ws"
+      ws_options = {}
+      creds = args[:credentials]
+      base64_creds = ["#{creds[:username]}:#{creds[:password]}"].pack('m').delete("\r\n")
+      ws_options[:headers] = { 'Authorization' => 'Basic ' + base64_creds,
+                               'Hawkular-Tenant' => args[:options][:tenant],
+                               'Accept' => 'application/json'
+      }
+
+      @ws = Simple.connect url, ws_options do |client|
         client.on(:message, once: true) do |msg|
           parsed_message = msg.data.to_msg_hash
           puts parsed_message if ENV['HAWKULARCLIENT_LOG_RESPONSE']

data/lib/hawkular/version.rb

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

data/spec/integration/alerts_spec.rb

@@ -424,13 +424,16 @@ module Hawkular::Alerts::RSpec
     end
   end
 
-  # TODO: enable when alerts supports it
-  # describe 'Alerts' do
-  #   it 'Should return the version' do
-  #     data = @client.get_version_and_status
-  #     expect(data).not_to be_nil
-  #   end
-  # end
+  describe 'Alerts', vcr: { decode_compressed_response: true } do
+    before(:each) do
+      @client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+    end
+
+    it 'Should return the version' do
+      data = @client.fetch_version_and_status
+      expect(data).not_to be_nil
+    end
+  end
 
   describe 'Alert/Events', :vcr do
     VCR.configure do |c|

data/spec/integration/hawkular_client_spec.rb

@@ -188,7 +188,7 @@ module Hawkular::Client::RSpec
           }
 
           actual_data = {}
-          client = Hawkular::Operations::OperationsClient.new(credentials: @creds)
+          client = Hawkular::Operations::OperationsClient.new(entrypoint: 'http://localhost:8080', credentials: @creds)
           client.invoke_generic_operation(redeploy) do |on|
             on.success do |data|
               actual_data[:data] = data

data/spec/integration/operations_spec.rb

@@ -20,16 +20,95 @@ module Hawkular::Operations::RSpec
 
       WebSocketVCR.record(example, self) do
         client = OperationsClient.new(host: HOST,
+                                      wait_time: WebSocketVCR.live? ? 1.5 : 2,
+                                      credentials: {
+                                        username: 'jdoe',
+                                        password: 'password'
+                                      },
+                                      options: {
+                                        tenant: 'hawkular'
+                                      })
+        ws = client.ws
+        expect(ws).not_to be nil
+        expect(ws.open?).to be true
+      end
+    end
+
+    it 'should be established via entrypoint' do
+      WebSocketVCR.configure do |c|
+        c.hook_uris = ['127.0.0.1:8080']
+      end
+
+      WebSocketVCR.record(example, self) do
+        ep = URI::HTTP.build(host: '127.0.0.1', port: 8080).to_s
+
+        client = OperationsClient.new(entrypoint: ep,
                                       wait_time: WebSocketVCR.live? ? 1.5 : 0,
                                       credentials: {
                                         username: 'jdoe',
                                         password: 'password'
+                                      },
+                                      options: {
+                                        tenant: 'hawkular'
                                       })
         ws = client.ws
         expect(ws).not_to be nil
         expect(ws.open?).to be true
       end
     end
+
+    it 'should run into error callback' do
+      WebSocketVCR.configure do |c|
+        c.hook_uris = [HOST]
+      end
+
+      WebSocketVCR.record(example, self) do
+        client = OperationsClient.new(host: HOST,
+                                      wait_time: WebSocketVCR.live? ? 1.5 : 2,
+                                      credentials: {
+                                        username: 'jdoe',
+                                        password: 'password'
+                                      },
+                                      options: {
+                                        tenant: 'hawkular'
+                                      })
+
+        noop = { operationName: 'noop', resourcePath: '/bla' }
+
+        client.invoke_generic_operation(noop) do |on|
+          on.success do |_data|
+            fail 'This should have failed'
+          end
+          on.failure do |error|
+            puts 'error callback was correctly called, reason: ' + error.to_s
+          end
+        end
+      end
+    end
+
+    it 'should bail with no host' do
+      WebSocketVCR.configure do |c|
+        c.hook_uris = [HOST]
+      end
+
+      WebSocketVCR.record(example, self) do
+        begin
+          OperationsClient.new(
+            wait_time: WebSocketVCR.live? ? 1.5 : 2,
+            credentials: {
+              username: 'jdoe',
+              password: 'password'
+            },
+            options: {
+              tenant: 'hawkular'
+            })
+        rescue
+          puts 'We got an exception and this is good'
+        else
+          fail 'Should have failed as no host was given'
+        end
+      end
+    end
   end
 
   describe 'Operation/Operation', :websocket, vcr: { decode_compressed_response: true } do
@@ -51,7 +130,8 @@ module Hawkular::Operations::RSpec
 
     before(:each) do |ex|
       unless ex.metadata[:skip_open]
-        @client = OperationsClient.new(credentials: @creds,
+        @client = OperationsClient.new(entrypoint: 'http://localhost:8080',
+                                       credentials: @creds,
                                        wait_time: WebSocketVCR.live? ? 1.5 : 0)
         @ws = @client.ws
       end
@@ -235,7 +315,7 @@ module Hawkular::Operations::RSpec
       @client.close_connection! unless @client.nil?
 
       # open the connection
-      operations_client = OperationsClient.new(credentials: @creds)
+      operations_client = OperationsClient.new(entrypoint: 'http://localhost:8080', credentials: @creds)
 
       redeploy = {
         operationName: 'Redeploy',

data/spec/spec_helper.rb

@@ -165,7 +165,7 @@ RSpec.configure do |config|
   if ENV['VCR_OFF'] == '1'
     VCR.eject_cassette
     VCR.turn_off!(ignore_cassettes: true)
-    WebSocketVCR.turn_off!
+    WebSocketVCR.turn_off! # TODO: this does not work as the impl is empty
     WebMock.allow_net_connect!
     puts 'VCR is turned off!'
   end

data/spec/vcr_cassettes/Alerts/Should_return_the_version.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://jdoe:password@localhost:8080/hawkular/alerts/status
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Type:
+      - application/json
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - Undertow/1
+      Server:
+      - WildFly/10
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '124'
+      Date:
+      - Tue, 21 Jun 2016 07:58:51 GMT
+    body:
+      encoding: UTF-8
+      string: '{"Implementation-Version":"1.1.1.Final","Built-From-Git-SHA1":"d5381ab686932023c5a2e136dc25a4848bd7ba43","status":"STARTED"}'
+    http_version: 
+  recorded_at: Tue, 21 Jun 2016 07:58:51 GMT
+recorded_with: VCR 3.0.1

data/spec/vcr_cassettes/Operation/Websocket_connection/should_bail_with_no_host.json

@@ -0,0 +1,3 @@
+[
+
+]

data/spec/vcr_cassettes/Operation/Websocket_connection/should_be_established_via_entrypoint.json

@@ -0,0 +1,9 @@
+[
+  [
+    {
+      "operation": "read",
+      "type": "text",
+      "data": "WelcomeResponse={\"sessionId\":\"4y1VEeMV520Ok-c-0busP6CL8auBUS6jNEMCVPyV\"}"
+    }
+  ]
+]

data/spec/vcr_cassettes/Operation/Websocket_connection/should_run_into_error_callback.json

@@ -0,0 +1,13 @@
+[
+  [
+    {
+      "operation": "read",
+      "type": "text",
+      "data": "WelcomeResponse={\"sessionId\":\"r4OAdkbOPYTA5HRnjgKW2vsq1TCGjZNT-Y3_qpco\"}"
+    },
+    {
+      "operation": "write",
+      "data": "ExecuteOperationRequest={\"operationName\":\"noop\",\"resourcePath\":\"/bla\",\"authentication\":{\"username\":\"jdoe\",\"password\":\"password\"}}"
+    }
+  ]
+]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hawkular-client
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Libor Zoubek
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -181,8 +181,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-      A Ruby client for Hawkular
+description: "    A Ruby client for Hawkular\n"
 email:
 - lzoubek@redhat.com
 - hrupp@redhat.com
@@ -258,6 +257,7 @@ files:
 - spec/vcr_cassettes/Alert/Triggers/Should_get_the_action_definitions.yml
 - spec/vcr_cassettes/Alert/Triggers/Should_not_create_an_action_for_unknown_plugin.yml
 - spec/vcr_cassettes/Alert/Triggers/Should_not_create_an_action_for_unknown_properties.yml
+- spec/vcr_cassettes/Alerts/Should_return_the_version.yml
 - spec/vcr_cassettes/Availability_metrics/Should_create_Availability_definition_using_MetricDefinition_parameter.yml
 - spec/vcr_cassettes/Availability_metrics/Should_create_and_return_Availability_using_Hash_parameter.yml
 - spec/vcr_cassettes/Availability_metrics/Should_push_metric_data_to_non-existing_Availability.yml
@@ -344,7 +344,10 @@ files:
 - spec/vcr_cassettes/Operation/Operation/Remove_deployment_should_be_performed_and_eventually_respond_with_success.json
 - spec/vcr_cassettes/Operation/Operation/Undeploy_should_be_performed_and_eventually_respond_with_success.json
 - spec/vcr_cassettes/Operation/Operation/should_not_be_possible_to_perform_on_closed_client.json
+- spec/vcr_cassettes/Operation/Websocket_connection/should_bail_with_no_host.json
 - spec/vcr_cassettes/Operation/Websocket_connection/should_be_established.json
+- spec/vcr_cassettes/Operation/Websocket_connection/should_be_established_via_entrypoint.json
+- spec/vcr_cassettes/Operation/Websocket_connection/should_run_into_error_callback.json
 - spec/vcr_cassettes/Simple/Should_be_Cool.yml
 - spec/vcr_cassettes/Tenants/Should_Get_Tenant_For_Explicit_Credentials.yml
 - spec/vcr_cassettes/Tenants/Should_Get_Tenant_For_Implicit_Credentials.yml
@@ -425,6 +428,7 @@ test_files:
 - spec/vcr_cassettes/Alert/Triggers/Should_get_the_action_definitions.yml
 - spec/vcr_cassettes/Alert/Triggers/Should_not_create_an_action_for_unknown_plugin.yml
 - spec/vcr_cassettes/Alert/Triggers/Should_not_create_an_action_for_unknown_properties.yml
+- spec/vcr_cassettes/Alerts/Should_return_the_version.yml
 - spec/vcr_cassettes/Availability_metrics/Should_create_Availability_definition_using_MetricDefinition_parameter.yml
 - spec/vcr_cassettes/Availability_metrics/Should_create_and_return_Availability_using_Hash_parameter.yml
 - spec/vcr_cassettes/Availability_metrics/Should_push_metric_data_to_non-existing_Availability.yml
@@ -511,7 +515,10 @@ test_files:
 - spec/vcr_cassettes/Operation/Operation/Remove_deployment_should_be_performed_and_eventually_respond_with_success.json
 - spec/vcr_cassettes/Operation/Operation/Undeploy_should_be_performed_and_eventually_respond_with_success.json
 - spec/vcr_cassettes/Operation/Operation/should_not_be_possible_to_perform_on_closed_client.json
+- spec/vcr_cassettes/Operation/Websocket_connection/should_bail_with_no_host.json
 - spec/vcr_cassettes/Operation/Websocket_connection/should_be_established.json
+- spec/vcr_cassettes/Operation/Websocket_connection/should_be_established_via_entrypoint.json
+- spec/vcr_cassettes/Operation/Websocket_connection/should_run_into_error_callback.json
 - spec/vcr_cassettes/Simple/Should_be_Cool.yml
 - spec/vcr_cassettes/Tenants/Should_Get_Tenant_For_Explicit_Credentials.yml
 - spec/vcr_cassettes/Tenants/Should_Get_Tenant_For_Implicit_Credentials.yml