hawkular-client 2.9.0 → 3.0.0

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.gitignore

@@ -1,56 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-spec/vcr.log
-Gemfile.lock
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# test config
-spec/endpoint.yml
-
-# IDE files
-.project
-.classpath
-.settings
-.idea
-*.ipr
-*.iml
-*.iws
-nb-configuration.xml
-
-# KDE
-.directory
-
-# OSX
-.DS_Store

data/.rubocop.yml

@@ -1,32 +0,0 @@
-# possible values:
-# https://github.com/bbatsov/rubocop/blob/master/config/
-
-#
-# Overrides
-#
-CyclomaticComplexity:
-  Max: 9
-  Severity: refactor
-PerceivedComplexity:
-  Max: 9
-Metrics/LineLength:
-  Max: 120
-Metrics/ParameterLists:
-  Max: 8
-#
-# Enabled/Disabled
-#
-ClassLength:
-  Enabled: false
-Documentation:
-  Enabled: false
-MethodLength:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-ModuleLength:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent

data/.travis.yml

@@ -1,20 +0,0 @@
-sudo: required
-
-language: ruby
-rvm:
-  - 2.2
-  - 2.3.0
-env:
-  global:
-    - ADMIN_TOKEN=4f4a1434-8cb3-11e6-ae22-56b6b6499611
-  matrix:
-    - RUN_ON_LIVE_SERVER=1 \
-      VCR_UPDATE=1 \
-      SKIP_SSL_WITHOUT_CERTIFICATE_TEST=1 \
-      SKIP_SECURE_CONTEXT=1 \
-      SKIP_V8_METRICS=1 \
-    - RUN_ON_LIVE_SERVER=0
-services:
-  - docker
-before_install:
-  - (test $RUN_ON_LIVE_SERVER = 1 && ./.travis/start_hawkular_services.sh -d && ./.travis/wait_for_services.rb) || echo "Skipping live server"

data/.travis/start_hawkular_services.sh

@@ -1,21 +0,0 @@
-#!/bin/bash
-
-docker-compose up -d myCassandra
-
-# Wait for Cassandra
-CASSANDRA_STATUS="undecided"
-TOTAL_WAIT=0;
-while [ "$CASSANDRA_STATUS" != "running" ] && [ $TOTAL_WAIT -lt 60 ]; do
- CASSANDRA_STATUS=`docker-compose exec myCassandra nodetool statusbinary | tr -dc '[[:print:]]'`
- echo "Cassandra server status: $CASSANDRA_STATUS."
-
- sleep 3
-
- TOTAL_WAIT=$((TOTAL_WAIT+3))
- echo "Waited $TOTAL_WAIT seconds for Cassandra to start."
-done
-
-# Ensure the volume exists and has correct permissions.
-mkdir -p /tmp/opt/hawkular/server
-chown 1000:1000 -R /tmp/opt/hawkular
-docker-compose up -d hawkular

data/.travis/wait_for_services.rb

@@ -1,39 +0,0 @@
-#!/usr/bin/env ruby
-require 'net/http'
-require 'json'
-
-services = {
-  'hawkular-services' => {
-    url: 'http://localhost:8080/hawkular/status',
-    is_ready: -> (response) { response.code == '200' }
-  },
-  'metrics' => {
-    url: 'http://localhost:8080/hawkular/metrics/status',
-    is_ready: -> (response) { response.code == '200' && JSON.parse(response.body)['MetricsService'] == 'STARTED' }
-  },
-  'alerts' => {
-    url: 'http://localhost:8080/hawkular/alerts/status',
-    is_ready: -> (response) { response.code == '200' && JSON.parse(response.body)['status'] == 'STARTED' }
-  },
-  'inventory' => {
-    url: 'http://localhost:8080/hawkular/inventory/status',
-    is_ready: -> (response) { response.code == '200' && JSON.parse(response.body)['Initialized'] == 'true' }
-  }
-}
-
-services.each do |name, service|
-  loop do
-    uri = URI(service[:url])
-    begin
-      response = Net::HTTP.get_response(uri)
-      break if service[:is_ready].call(response)
-      puts "Waiting for: #{name}"
-    rescue
-      puts 'Waiting for Hawkular-Services to accept connections'
-    end
-    sleep 5
-  end
-end
-puts 'Waiting 2 minutes for agent to complete it\'s first round...'
-sleep 120
-puts 'Hawkular-services started successfully... '

data/.yardopts

@@ -1 +0,0 @@
-- CHANGES.rdoc api_breaking_changes.rdoc

data/Gemfile

@@ -1,2 +0,0 @@
-source 'http://rubygems.org'
-gemspec

data/Rakefile

@@ -1,20 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-desc 'Runs all the specs'
-RSpec::Core::RakeTask.new(:spec) do |task|
-  task.pattern = './spec/**/*_spec.rb'
-  task.rspec_opts = ['--color']
-end
-
-desc 'Runs the specs for metrics 0.8.0.Final'
-RSpec::Core::RakeTask.new(:'old-metrics') do |task|
-  task.pattern = './spec/integration/metric_spec.rb'
-  task.rspec_opts = ['--color']
-  ENV['SKIP_SERVICES_METRICS'] = '1'
-end
-
-RuboCop::RakeTask.new
-
-task default: [:rubocop, :spec]

data/api_breaking_changes.rdoc

@@ -1,84 +0,0 @@
-== Breaking changes in the major releases
-
-=== 2.0.0
-
-By default no Hawkular-Tenant HTTP header is being set. If you need it (for instance for hawkular-services), provide the tenant option when creating a client.
-e.g. <code>::Hawkular::Client.new(..., options: { tenant: 'hawkular' })</code>
-
-=== 1.0.0
-
-To use the client use the <code>require 'hawkular/hawkular_client'</code> instead of <code>require 'hawkular_all'</code>
-
----
-
-While it's still possible to use individual component clients (inventory, alert, metrics, operation, token), the preferred way is to use
-the unified client that has reference on those 'sub-clients':
-
-<code>::Hawkular::Client.new(:entrypoint => 'http://localhost:8080', :credentials => {username: 'jdoe', password: 'password'})</code>
-
-See the link:spec/integraion/hawkular_client_spec.rb to see more details.
-
-
----
-
-In the <code>lib/hawkular/inventory/inventory_api.rb</code> all following methods have different signatures (+old+ -> +new+):
-
-<code>list_resources_for_type(feed_id, type, fetch_properties = false)</code>
-->
-<code>list_resources_for_type(type_path, fetch_properties = false, filter = {})</code>
-
-
-<code>get_config_data_for_resource(feed_id, res_ids)</code>
-->
-<code>get_config_data_for_resource(resource_path)</code>
-
-
-<code>def list_child_resources(Resource parent_resource, recursive = false)</code>
-->
-<code>def list_child_resources(parent_resource_path, recursive = false)</code>
-
-
-<code>list_relationships(Resource resource, named = nil)</code>
-->
-<code>list_relationships(path, named = nil)</code>
-
-
-<code>list_relationships_for_feed(feed_id, named = nil)</code>
-->
-<code>list_relationships_for_feed(path, named = nil)</code>
-
-
-<code>list_metrics_for_metric_type(feed_id, type)</code>
-->
-<code>list_metrics_for_metric_type(met_type_path)</code>
-
-
-<code>list_metrics_for_resource_type(feed, type)</code>
-->
-<code>list_metrics_for_resource_type(res_type_path)</code>
-
-
-<code>list_metrics_for_resource(Resource resource, filter = {})</code>
-->
-<code>list_metrics_for_resource(resource_path, filter = {})</code>
-
-
-<code>create_resource(feed_id, type_path, resource_id, resource_name = nil, properties = {})</code>
-->
-<code>create_resource(type_path, resource_id, resource_name = nil, properties = {})</code>
-
-
-<code>create_resource_under_resource(feed_id, type_path, parent_resource_ids, resource_id, resource_name = nil, properties = {})</code>
-->
-<code>create_resource_under_resource(type_path, parent_resource_path, resource_id, resource_name = nil, properties = {})</code>
-
-
-<code>get_resource(feed_id, res_ids, fetch_resource_config = true)</code>
-->
-<code>get_resource(res_path, fetch_resource_config = true)</code>
-
-
-<code>create_metric_for_resource(feed_id, metric_id, type_path, res_ids, metric_name = nil)</code>
-->
-<code>create_metric_for_resource(metric_type_path, resource_path, metric_id, metric_name = nil)</code>
-

data/docker-compose.yml

@@ -1,17 +0,0 @@
-hawkular:
-  image: "hawkular/hawkular-services:latest"
-  ports:
-    - "8080:8080"
-    - "8443:8443"
-    - "9990:9990"
-  links:
-    - myCassandra
-  volumes:
-    - /tmp/opt/hawkular/server:/opt/data
-  environment:
-    - CASSANDRA_NODES=myCassandra
-    - ADMIN_TOKEN
-myCassandra:
-  image: cassandra:3.0.9
-  environment:
-    - CASSANDRA_START_RPC=true

data/hawkularclient.gemspec

@@ -1,43 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hawkular/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = 'hawkular-client'
-  gem.version       = Hawkular::VERSION
-  gem.authors       = ['Libor Zoubek', 'Heiko W. Rupp', 'Jirka Kremser', 'Federico Simoncelli']
-  gem.email         = %w(lzoubek@redhat.com hrupp@redhat.com jkremser@redhat.com)
-  gem.homepage      = 'https://github.com/hawkular/hawkular-client-ruby'
-  gem.summary       = 'A Ruby client for Hawkular'
-  gem.license       = 'Apache-2.0'
-  gem.required_ruby_version = '>= 2.0.0'
-  gem.description = <<-EOS
-    A Ruby client for Hawkular
-  EOS
-
-  gem.files         = `git ls-files -z`.split("\x0")
-  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ['lib']
-
-  gem.add_runtime_dependency('rest-client', '~> 2.0.0')
-  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.1')
-  gem.add_development_dependency('actionpack',  '~> 4')
-  gem.add_development_dependency('rake', '< 11')
-  gem.add_development_dependency('simple-websocket-vcr', '= 0.0.7')
-  gem.add_development_dependency('yard')
-  gem.add_development_dependency('webmock', '~> 1.24.0')
-  gem.add_development_dependency('vcr')
-  gem.add_development_dependency('rubocop', '= 0.34.2')
-  gem.add_development_dependency('coveralls')
-  gem.add_development_dependency('rack', '~> 1.6.4')
-  gem.add_development_dependency('pry-byebug')
-
-  gem.rdoc_options << '--title' << gem.name <<
-    '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'
-  gem.extra_rdoc_files = ['README.rdoc', 'CHANGES.rdoc']
-end

data/spec/README.rdoc

@@ -1,62 +0,0 @@
-= Test suite
-Read me if you want more information about the test suite and VCR cassettes.
-
-== Running all the tests
-
-   bundle exec rake test
-or shorter
-   rspec 
-
-== Running individual tests
-
-Run all the tests for metrics
-   rspec ./spec/integration/metric_spec.rb
-   
-Run one particular test:
-that starts on line 74
-   rspec ./spec/integration/metric_spec.rb:74
-   
-that contains a description 'push metric data to existing counter'
-   rspec -e 'push metric data to existing counter' ./spec/integration/metric_spec.rb:74
-
-== VCRs
-By default, all the interaction over HTTP is done via the VCR testing suite. So no real calls to the server side are made, but the communication is read from +.yml+ files, called cassettes. This allows the whole testsuite to run very quickly, whitout the need for the server to be up. Obviously, the drawback is that the data may be stale. To re-record the VCR cassettes, one can run the +rspec+ with environment property <code>VCR_UPDATE=1</code>.
-
-For inventory and metrics specs, there is a support for templating the VCR cassettes. This means that some data that vary in different hawkular-services server starts may be parametrized, because there is no point in checking if the +feed_id+ is really the desired uuid or the timestamp is really the xyz. Good thing about it is that when re-recording the cassette and the api is the same, it'll remain the same up to the minor stuff like +recorded_at:+ fields. An example of the VCR template can be seen {here}[link:https://git.io/vKm99]. This is all done under the hood by using the around interceptors ({here}[link:https://git.io/vKmHE] and {here}[link:https://git.io/vKmH7]) and the helper methods in +spec_helper.rb+.
-
-Parametrization of the cassette is basically replacing the raw data in it by its reference, so for instance following pseudo-code:
-
-   parametrize('Hello, asdfasdf', {id: 'asdfasdf'})
-
-would provide
-   Hello, <%= id%>
-in the resulting cassette.
-
-For inventory, the data that is parametrized in the VCR cassettes needs to be in the +@state+ hash, while for the metrics it's only the +@random_id+ field that's an random (for each test case) uuid. This will be probably unified in the future and will be the same across all the components.
-
- If you need to override the default behavior and use your own data during the parametrization, this can be done the following way (https://git.io/vKmQF): 
- 
-   it 'Should push metric data to existing gauge', :skip_auto_vcr do
-     now = @client.now
-     ends = now - t4h
-     starts = now - (2 * t4h)
-     ...
-     bindings = { id: @random_id, ends: ends, starts: starts, ... }
-     example = proc do
-       # do all the asserts
-     end
-     record("Metrics/#{metrics_context}", bindings, cassette_name, example: example)
-   end
-
-In the example above, whenever the values of +starts+, +ends+ or +@random_id+ appear in the cassette, it'll be replaced by its reference => parametrized. This process is done only if the <code>VCR_UPDATE=1</code> is passed to the +rspec+. Otherwise, the templates will be just used (not created). This allows the fact that one template can be used for whole set of different calls if we abstract from the (volatile) data that doesn't matter, like generated ids or timestamps.
-
-=== Metrics VCRs
-Currently, the metrics sub-client is special, because we keep the VCR cassettes for +hawkular-metrics+ in version <code>0.8.0.Final</code> as well as for metrics that are part of the hawkular-services. Thus, there is a support for so called "metric contexts" in the {spec file}[https://git.io/vKmBa]. By default, all the test-suite is run for all the metric contexts. Some tests can have a tag on them that they make sense only for certain context. This is done by using the <code>run_for: [services_context] </code> tag (see {example}[https://git.io/vKm5M]). If it's omitted, the test case is meant to run in all the contexts.
-
-When re-recording the templates, it's handy to update only one metrics context. To do that, you can use the env variables:
-   SKIP_V8_METRICS=1
-or
-   SKIP_SERVICES_METRICS=1
-To skip the suite for v8 metrics or the services one, respectively.
-
-Good thing about this approach is that we can store the historical data in its own directories and not override over and over the some methods and end up with an inconsistent state, where some methods are captured in state +t+ and some in state <code>t+1</code>. Here is how it looks like: https://git.io/vKmdb In the future, we will be fixing also the version of the hawkular-services.

data/spec/integration/alert-resources/alerts-test-data.json

@@ -1,40 +0,0 @@
-{
-  "triggers":[
-    {
-      "trigger": {
-        "id": "hello-world-trigger",
-        "name": "Hello World Trigger",
-        "description": "A mandatory Hello World Trigger",
-        "severity": "HIGH",
-        "enabled": true
-      },
-      "conditions":[
-        {
-          "triggerMode": "FIRING",
-          "type": "threshold",
-          "dataId": "data-x",
-          "operator": "LT",
-          "threshold": 5
-        }
-      ]
-    },
-    {
-      "trigger": {
-        "id": "a-trigger",
-        "name": "A trigger name",
-        "description": "Just a trigger",
-        "severity": "HIGH",
-        "enabled": true
-      },
-      "conditions":[
-        {
-          "triggerMode": "FIRING",
-          "type": "threshold",
-          "dataId": "data-x",
-          "operator": "LT",
-          "threshold": 5
-        }
-      ]
-    }
-  ]
-}