nagios-promoo 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03a43d2f650bc5bfa06dc735193c61b22ec16fba
-  data.tar.gz: f07fda7f6d2240c5e140509feeb05ab2b5c405d7
+  metadata.gz: a526ad530f8f724a31721b81e321ad2d6ba7d847
+  data.tar.gz: a8627259081ce7c0d5b928b826d5bab32a0af4c5
 SHA512:
-  metadata.gz: 437c81a1847705426e476d597ed0e7744d463d3158c888db3b402340e374e1644ee74cc67c5782589f2719389e8fd950add0fa8ae2c3a28a73b9029e2b9fe8b4
-  data.tar.gz: 36d059ca5a98c910f570b1ae6ca376f25e104fb618f817f2931ee4f01f5406d77def52f9671ca33cbea62db23357af1a950fb9a84d9b329c75c2ca9388388349
+  metadata.gz: 4b467c9e3a11f3f41c47f084c7a6f91efaf47a2f1b8c39995f1fe9dbd6056ab08e71eeb1ebded5f3747a9721c90233f06838d6337b72b121f793734ef5160439
+  data.tar.gz: 6c82cf8ac8d6a19ffaa9ae75eba459eb4e561cec0ef5547dea7a155d8d141e12699506d506cc1a9480e1c3c656cc8b069c4e931a9a54f3362a448d878b38aa3c

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*'
+  - 'test/**/*'
+  - '*.gemspec'

data/.rubocop_todo.yml

@@ -0,0 +1,29 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-05-28 17:27:37 +0200 using RuboCop version 0.49.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 20
+Metrics/AbcSize:
+  Max: 50
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 200
+
+# Offense count: 5
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 20
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 34
+
+# Offense count: 3
+Metrics/PerceivedComplexity:
+  Max: 10

data/.travis.yml

@@ -0,0 +1,27 @@
+language: ruby
+
+rvm:
+  - 2.2.2
+  - 2.3.0
+  - 2.4.0
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: 2.3.0
+    - rvm: 2.4.0
+    - rvm: ruby-head
+  fast_finish: true
+
+branches:
+  only:
+    - master
+
+env:
+  - ON_TRAVIS_CI=yes
+
+install: 'gem install bundler -v ">= 1.12" && bundle install --retry=10'
+
+script: 'bundle exec rake rubocop && bundle exec bin/nagios-promoo version'
+
+sudo: false

data/README.md

@@ -1,16 +1,20 @@
-# Nagios Probes for Monitoring OpenNebula and OCCI-enabled clouds
+# Nagios Probes for Monitoring OCA and OCCI
+[![Travis](https://img.shields.io/travis/arax/nagios-promoo.svg?style=flat-square)](http://travis-ci.org/arax/nagios-promoo)
+[![Gemnasium](https://img.shields.io/gemnasium/arax/nagios-promoo.svg?style=flat-square)](https://gemnasium.com/arax/nagios-promoo)
+[![Gem](https://img.shields.io/gem/v/nagios-promoo.svg?style=flat-square)](https://rubygems.org/gems/nagios-promoo)
+[![Code Climate](https://img.shields.io/codeclimate/github/arax/nagios-promoo.svg?style=flat-square)](https://codeclimate.com/github/arax/nagios-promoo)
 
 ## Installation
 
-    $ gem install nagios-promoo
+  $ gem install nagios-promoo
 
 ## Usage
 
-	$ nagios-promoo help
+  $ nagios-promoo help
 
 ## Contributing
 
-1. Fork it ( https://github.com/EGI-FCTF/nagios-promoo/fork )
+1. Fork it ( https://github.com/arax/nagios-promoo/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,2 +1,7 @@
-require "bundler/gem_tasks"
+require 'rubygems/tasks'
+require 'rubocop/rake_task'
 
+Gem::Tasks.new(build: { tar: true, zip: true }, sign: { checksum: true, pgp: false })
+RuboCop::RakeTask.new
+
+task default: 'rubocop'

data/lib/nagios/promoo.rb

@@ -10,11 +10,17 @@ require 'date'
 # Force multi_xml to use ox
 MultiXml.parser = :ox
 
-# Define modules
-module Nagios; end
-module Nagios::Promoo; end
+# Gem namespace module.
+#
+# @author Boris Parak <parak@cesnet.cz>
+module Nagios
+  # Namespace for `promoo` classes and modules.
+  #
+  # @author Boris Parak <parak@cesnet.cz>
+  module Promoo; end
+end
 
 # Include necessary files
-require "nagios/promoo/version"
-require "nagios/promoo/utils"
-require "nagios/promoo/master"
+require 'nagios/promoo/version'
+require 'nagios/promoo/utils'
+require 'nagios/promoo/master'

data/lib/nagios/promoo/appdb/master.rb

@@ -1,40 +1,67 @@
 # Internal deps
 require File.join(File.dirname(__FILE__), 'version')
 
-# Define modules
-module Nagios::Promoo::Appdb; end
-module Nagios::Promoo::Appdb::Probes; end
+module Nagios
+  module Promoo
+    # Namespace for AppDB-related code.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    module Appdb
+      # Namespace for probes checking AppDB.
+      #
+      # @author Boris Parak <parak@cesnet.cz>
+      module Probes; end
+    end
+  end
+end
+
 Dir.glob(File.join(File.dirname(__FILE__), 'probes', '*.rb')) { |probe| require probe.chomp('.rb') }
 
-class Nagios::Promoo::Appdb::Master < ::Thor
-  class << self
-    # Hack to override the help message produced by Thor.
-    # https://github.com/wycats/thor/issues/261#issuecomment-16880836
-    def banner(command, namespace = nil, subcommand = nil)
-      "#{basename} appdb #{command.usage}"
-    end
+module Nagios
+  module Promoo
+    module Appdb
+      # Master class for all AppDB probes.
+      #
+      # @author Boris Parak <parak@cesnet.cz>
+      class Master < ::Thor
+        class << self
+          # Hack to override the help message produced by Thor.
+          # https://github.com/wycats/thor/issues/261#issuecomment-16880836
+          def banner(command, _namespace = nil, _subcommand = nil)
+            "#{basename} appdb #{command.usage}"
+          end
 
-    def available_probes
-      Nagios::Promoo::Appdb::Probes.constants.collect { |probe| Nagios::Promoo::Appdb::Probes.const_get(probe) }.reject { |probe| !probe.runnable? }
-    end
-  end
+          def available_probes
+            probes = Nagios::Promoo::Appdb::Probes.constants.collect do |probe|
+              Nagios::Promoo::Appdb::Probes.const_get(probe)
+            end
+            probes.select(&:runnable?)
+          end
+        end
 
-  class_option :endpoint, type: :string, desc: 'Site\'s OCCI endpoint, as specified in GOCDB', default: 'http://localhost:3000/'
+        class_option :endpoint,
+                     type: :string,
+                     desc: 'Site\'s OCCI endpoint, as specified in GOCDB',
+                     default: 'http://localhost:3000/'
 
-  available_probes.each do |probe|
-    desc *probe.description
-    probe.options.each do |opt|
-      option opt.first, opt.last
-    end
-    class_eval %Q^
+        available_probes.each do |probe|
+          desc(*probe.description)
+          probe.options.each do |opt|
+            option opt.first, opt.last
+          end
+
+          class_eval %^
 def #{probe.declaration}(*args)
   #{probe}.new(options).run(args)
 end
 ^
-  end
+        end
 
-  desc 'version', 'Print version of the AppDB probe set'
-  def version
-    puts Nagios::Promoo::Appdb::VERSION
+        desc 'version', 'Print version of the AppDB probe set'
+        def version
+          puts Nagios::Promoo::Appdb::VERSION
+        end
+      end
+    end
   end
 end

data/lib/nagios/promoo/appdb/probes/appliances_probe.rb

@@ -1,43 +1,56 @@
 # Internal deps
 require File.join(File.dirname(__FILE__), 'base_probe')
 
-class Nagios::Promoo::Appdb::Probes::AppliancesProbe < Nagios::Promoo::Appdb::Probes::BaseProbe
-  class << self
-    def description
-      ['appliances', 'Run a probe checking appliances in AppDB']
+module Nagios
+  module Promoo
+    module Appdb
+      module Probes
+        # Probe for checking appliance availability in AppDB.
+        #
+        # @author Boris Parak <parak@cesnet.cz>
+        class AppliancesProbe < Nagios::Promoo::Appdb::Probes::BaseProbe
+          class << self
+            def description
+              ['appliances', 'Run a probe checking appliances in AppDB']
+            end
+
+            def options
+              []
+            end
+
+            def declaration
+              'appliances'
+            end
+
+            def runnable?
+              true
+            end
+          end
+
+          def run(_args = [])
+            @_count = 0
+
+            Timeout.timeout(options[:timeout]) { check_appliances }
+
+            if @_count < 1
+              puts 'APPLIANCES CRITICAL - No appliances found in AppDB'
+              exit 2
+            end
+
+            puts "APPLIANCES OK - Found #{@_count} appliances in AppDB"
+          rescue => ex
+            puts "APPLIANCES UNKNOWN - #{ex.message}"
+            puts ex.backtrace if options[:debug]
+            exit 3
+          end
+
+          private
+
+          def check_appliances
+            @_count = [appdb_provider['provider:image']].flatten.compact.count
+          end
+        end
+      end
     end
-
-    def options
-      []
-    end
-
-    def declaration
-      "appliances"
-    end
-
-    def runnable?; true; end
-  end
-
-  def run(args = [])
-    @_count = 0
-
-    Timeout::timeout(options[:timeout]) { check_appliances }
-
-    if @_count < 1
-      puts "APPLIANCES CRITICAL - No appliances found in AppDB" 
-      exit 2
-    end
-
-    puts "APPLIANCES OK - Found #{@_count} appliances in AppDB"
-  rescue => ex
-    puts "APPLIANCES UNKNOWN - #{ex.message}"
-    puts ex.backtrace if options[:debug]
-    exit 3
-  end
-
-  private
-
-  def check_appliances
-    @_count = [appdb_provider['provider:image']].flatten.compact.count
   end
 end

data/lib/nagios/promoo/appdb/probes/base_probe.rb

@@ -1,42 +1,62 @@
-class Nagios::Promoo::Appdb::Probes::BaseProbe
-  class << self
-    def runnable?; false; end
-  end
-
-  APPDB_PROXY_URL = 'https://appdb.egi.eu/api/proxy'
-  APPDB_REQUEST_FORM = 'version=1.0&resource=broker&data=%3Cappdb%3Abroker%20xmlns%3Axs%3D%22http%3A%2F%2Fwww.w3.org%2F2001%2FXMLSchema%22%20xmlns%3Axsi%3D%22http%3A%2F%2Fwww.w3.org%2F2001%2FXMLSchema-instance%22%20xmlns%3Aappdb%3D%22http%3A%2F%2Fappdb.egi.eu%2Fapi%2F1.0%2Fappdb%22%3E%3Cappdb%3Arequest%20id%3D%22vaproviders%22%20method%3D%22GET%22%20resource%3D%22va_providers%22%3E%3Cappdb%3Aparam%20name%3D%22listmode%22%3Edetails%3C%2Fappdb%3Aparam%3E%3C%2Fappdb%3Arequest%3E%3C%2Fappdb%3Abroker%3E'
-
-  attr_reader :options
-
-  def initialize(options)
-    @options = options
-  end
-
-  def appdb_provider
-    return @_provider if @_provider
-
-    response = HTTParty.post(APPDB_PROXY_URL, { :body => APPDB_REQUEST_FORM })
-    fail "Could not get site"\
-         "details from AppDB [HTTP #{response.code}]" unless response.success?
-    fail "Response from AppDB has unexpected structure" unless valid_response?(response.parsed_response)
-
-    providers = response.parsed_response['appdb:broker']['appdb:reply']['appdb:appdb']['virtualization:provider']
-    providers.delete_if { |prov| prov['provider:endpoint_url'].blank? }
-
-    @_provider = providers.select do |prov|
-                   prov['provider:endpoint_url'].chomp('/') == options[:endpoint].chomp('/')
-                 end.first
-    fail "Could not locate site by endpoint #{options[:endpoint].inspect} in AppDB" unless @_provider
-
-    @_provider
-  end
-
-  private
-
-  def valid_response?(response)
-    response['appdb:broker'] \
-    && response['appdb:broker']['appdb:reply'] \
-    && response['appdb:broker']['appdb:reply']['appdb:appdb'] \
-    && response['appdb:broker']['appdb:reply']['appdb:appdb']['virtualization:provider']
+module Nagios
+  module Promoo
+    module Appdb
+      module Probes
+        # Base probe class for all AppDB-related probes.
+        #
+        # @author Boris Parak <parak@cesnet.cz>
+        class BaseProbe
+          class << self
+            def runnable?
+              false
+            end
+          end
+
+          APPDB_PROXY_URL = 'https://appdb.egi.eu/api/proxy'.freeze
+          APPDB_REQUEST_FORM = 'version=1.0&resource=broker&data=%3Cappdb%3Abroker%20xmlns%3Axs%3D%22http%3A%2F%2F' \
+                               'www.w3.org%2F2001%2FXMLSchema%22%20xmlns%3Axsi%3D%22http%3A%2F%2Fwww.w3.org%2F2001%2F' \
+                               'XMLSchema-instance%22%20xmlns%3Aappdb%3D%22http%3A%2F%2Fappdb.egi.eu%2Fapi%2F1.0%2F' \
+                               'appdb%22%3E%3Cappdb%3Arequest%20id%3D%22vaproviders%22%20method%3D%22GET%22%20' \
+                               'resource%3D%22va_providers%22%3E%3Cappdb%3Aparam%20name%3D%22listmode%22%3Edetails' \
+                               '%3C%2Fappdb%3Aparam%3E%3C%2Fappdb%3Arequest%3E%3C%2Fappdb%3Abroker%3E'.freeze
+
+          attr_reader :options
+
+          def initialize(options)
+            @options = options
+          end
+
+          def appdb_provider
+            return @_provider if @_provider
+
+            @_provider = appdb_providers.detect do |prov|
+              prov['provider:endpoint_url'].chomp('/') == options[:endpoint].chomp('/')
+            end
+            raise "Could not locate site by endpoint #{options[:endpoint].inspect} in AppDB" unless @_provider
+
+            @_provider
+          end
+
+          private
+
+          def appdb_providers
+            response = HTTParty.post(APPDB_PROXY_URL, body: APPDB_REQUEST_FORM)
+            raise "Could not get site details from AppDB [HTTP #{response.code}]" unless response.success?
+            raise 'Response from AppDB has unexpected structure' unless valid_response?(response.parsed_response)
+
+            providers = response.parsed_response['appdb:broker']['appdb:reply']\
+                                                ['appdb:appdb']['virtualization:provider']
+            providers.delete_if { |prov| prov['provider:endpoint_url'].blank? }
+          end
+
+          def valid_response?(response)
+            response['appdb:broker'] \
+            && response['appdb:broker']['appdb:reply'] \
+            && response['appdb:broker']['appdb:reply']['appdb:appdb'] \
+            && response['appdb:broker']['appdb:reply']['appdb:appdb']['virtualization:provider']
+          end
+        end
+      end
+    end
   end
 end

data/lib/nagios/promoo/appdb/probes/sizes_probe.rb

@@ -1,43 +1,56 @@
 # Internal deps
 require File.join(File.dirname(__FILE__), 'base_probe')
 
-class Nagios::Promoo::Appdb::Probes::SizesProbe < Nagios::Promoo::Appdb::Probes::BaseProbe
-  class << self
-    def description
-      ['sizes', 'Run a probe checking size/flavor/resource templates in AppDB']
+module Nagios
+  module Promoo
+    module Appdb
+      module Probes
+        # Probe for checking flavors/sizes in AppDB.
+        #
+        # @author Boris Parak <parak@cesnet.cz>
+        class SizesProbe < Nagios::Promoo::Appdb::Probes::BaseProbe
+          class << self
+            def description
+              ['sizes', 'Run a probe checking size/flavor/resource templates in AppDB']
+            end
+
+            def options
+              []
+            end
+
+            def declaration
+              'sizes'
+            end
+
+            def runnable?
+              true
+            end
+          end
+
+          def run(_args = [])
+            @_count = 0
+
+            Timeout.timeout(options[:timeout]) { check_sizes }
+
+            if @_count < 1
+              puts 'SIZES CRITICAL - No size/flavor/resource templates found in AppDB'
+              exit 2
+            end
+
+            puts "SIZES OK - Found #{@_count} size/flavor/resource templates in AppDB"
+          rescue => ex
+            puts "SIZES UNKNOWN - #{ex.message}"
+            puts ex.backtrace if options[:debug]
+            exit 3
+          end
+
+          private
+
+          def check_sizes
+            @_count = [appdb_provider['provider:template']].flatten.compact.count
+          end
+        end
+      end
     end
-
-    def options
-      []
-    end
-
-    def declaration
-      "sizes"
-    end
-
-    def runnable?; true; end
-  end
-
-  def run(args = [])
-    @_count = 0
-
-    Timeout::timeout(options[:timeout]) { check_sizes }
-
-    if @_count < 1
-      puts "SIZES CRITICAL - No size/flavor/resource templates found in AppDB"
-      exit 2
-    end
-
-    puts "SIZES OK - Found #{@_count} size/flavor/resource templates in AppDB"
-  rescue => ex
-    puts "SIZES UNKNOWN - #{ex.message}"
-    puts ex.backtrace if options[:debug]
-    exit 3
-  end
-
-  private
-
-  def check_sizes
-    @_count = [appdb_provider['provider:template']].flatten.compact.count
   end
 end