op5util 0.1.1

data/lib/op5util/check_auth.rb

@@ -0,0 +1,36 @@
+# rubocop:disable Lint/UnneededDisable
+# rubocop:disable LineLength
+# rubocop:disable AbcSize
+# rubocop:disable SymbolArray
+# rubocop:disable Metrics/MethodLength
+# rubocop:disable HashSyntax
+
+# Toplevel documentation
+module Op5util
+  class NoAuthMethodError < StandardError; end
+  def check_authfile(file)
+    authline = File.open(File.expand_path(file)).readline.chomp
+  rescue StandardError
+    [nil, nil]
+  else
+    authinfo = authline.split(':')
+    authinfo.count == 2 ? authinfo : [nil, nil]
+  end
+
+  def check_auth(global_opts)
+    if !global_opts[:username].nil? && !global_opts[:password].nil?
+      true
+    elsif !ENV['OP5USER'].nil? && !ENV['OP5PASS'].nil?
+      global_opts[:username] = ENV['OP5USER']
+      global_opts[:password] = ENV['OP5PASS']
+      true
+    elsif File.exist?(File.expand_path(global_opts[:authfile]))
+      (global_opts[:username], global_opts[:password]) = check_authfile(global_opts[:authfile])
+      global_opts[:username].nil? ? false : true
+    else
+      raise NoAuthMethodError
+    end
+  end
+
+  module_function :check_auth, :check_authfile
+end

data/lib/op5util/list_hostgroups.rb

@@ -0,0 +1,63 @@
+# rubocop:disable LineLength, MethodLength, AbcSize
+# Foo
+module Op5util
+  class NoSuchHostgroupError; end
+  # Foo
+  class Monitor
+    def list_hostgroups(hostgroup, options)
+      response = self.class.get(@base_uri + 'config/hostgroup?format=json',
+                                basic_auth: @auth, verify: false)
+      raise ApiError unless response.code == 200
+      if hostgroup.nil?
+        hostgroups = JSON.parse!(response.body).map { |h| h['name'] }
+      else
+        hostgroups = JSON.parse!(response.body).map { |h| h['name'] }.select { |hg| hg == hostgroup }
+        raise NoSuchHostgroupError if hostgroups.empty?
+      end
+      if options[:long]
+        list_hostgroups_with_services(hostgroups)
+      else
+        hostgroups.each { |h| puts h }
+      end
+    end
+
+    private
+
+    def hostgroup_info(h)
+      response = self.class.get(@base_uri + "config/hostgroup/#{URI.escape(h)}?format=json",
+                                basic_auth: @auth, verify: false)
+      raise ApiError unless response.code == 200
+      hostgroup = JSON.parse!(response.body)
+      hostgroup['members'].nil? ? '' : members = hostgroup['members'].join(',')
+      max = max_cell_width
+      if hostgroup['services'].nil?
+        services = ''
+      else
+        services = hostgroup['services'].map { |s| fold_string('"' + s['service_description'] + '"', max) }.join("\n")
+      end
+      [members, services]
+    end
+
+    def max_cell_width
+      # The magic number 15 is the size of tables cells padding + the heading 'State'
+      # and a an extra characters for safe layout on narrow terminals, down to
+      # 80 characters width tested.
+      require 'io/console'
+      (_terminal_height, terminal_width) = IO.console.winsize
+      ((terminal_width - 15) / 2).floor
+    end
+
+    def list_hostgroups_with_services(hostgroups)
+      max = max_cell_width
+      table = Terminal::Table.new do |t|
+        t.add_row ['Hostgroup'.blue, 'Member hosts'.blue, 'Service checks'.blue]
+        t.add_separator
+        hostgroups.each do |h|
+          (members, services) = hostgroup_info(h)
+          t.add_row [h, fold_string(members, max), services ]
+        end
+      end
+      puts table
+    end
+  end
+end

data/lib/op5util/method_template.rb

@@ -0,0 +1,13 @@
+# rubocop:disable LineLength, MethodLength, AccessorMethodName
+# Foo
+module Op5util
+  # Foo
+  class Monitor
+    def method_template
+      response = self.class.get(@base_uri + 'some/path?format=json',
+                                basic_auth: @auth, verify: false)
+      raise ApiError unless response.code == 200
+      puts 'Do something'
+    end
+  end
+end

data/lib/op5util/monitor.rb

@@ -0,0 +1,29 @@
+# rubocop:disable Lint/UnneededDisable
+# rubocop:disable LineLength
+# rubocop:disable AbcSize
+# rubocop:disable SymbolArray
+# rubocop:disable Metrics/MethodLength
+# rubocop:disable HashSyntax
+
+# Top level documentation
+module Op5util
+  require 'httparty'
+  class AuthenticationError < StandardError; end
+  class CommunicationError < StandardError; end
+  # Top level documentation
+  class Monitor
+    include HTTParty
+    #debug_output $stdout
+
+    def initialize(monitor, username, password)
+      @monitor = monitor
+      @auth = { username: username, password: password }
+      @base_uri = "https://#{@monitor}/api/"
+      url = 'status/status?format=json'
+      response = self.class.get(@base_uri + url, basic_auth: @auth, verify: false)
+      raise AuthenticationError if !response.nil? && !response.code.nil? && response.code == 401
+      raise CommunicationError if response.nil? || response.code.nil? || response.code != 200
+      self
+    end
+  end
+end

data/lib/op5util/schedule_checks.rb

@@ -0,0 +1,72 @@
+# rubocop:disable LineLength, MethodLength, AccessorMethodName
+# Foo
+module Op5util
+  # Foo
+  class Monitor
+    def schedule_checks(host, options)
+      schedule_host_check(host)
+      schedule_service_checks_for_host(host, options)
+    end
+
+    private
+
+    def build_host_check_body(host)
+      time = Time.now.to_i
+      { host_name:  host,
+        check_time: time }.to_json
+    end
+
+    def schedule_host_check(host)
+      body = build_host_check_body(host)
+      response = self.class.post(@base_uri + 'command/SCHEDULE_HOST_CHECK?format=json',
+                                 headers: { 'Content-Type' => 'application/json' },
+                                 body: body, basic_auth: @auth, verify: false)
+      raise ApiError unless response.code == 200
+      puts 'Host check scheduled'
+    end
+
+    def hostgroup_services(hg)
+      response = self.class.get(@base_uri + "config/hostgroup/#{URI.escape(hg)}?format=json",
+                                basic_auth: @auth, verify: false)
+      raise ApiError unless response.code == 200
+      hg_info = JSON.parse!(response.body)
+      hg_info['services'].nil? ? [] : hg_info['services'].map { |s| s['service_description'] }
+    end
+
+    # TODO: split hostgroup_info into better re-usable code
+    def service_description_for_host(host)
+      response = self.class.get(@base_uri + "config/host/#{host}?format=json",
+                                basic_auth: @auth, verify: false)
+      raise ApiError unless response.code == 200
+      host_config = JSON.parse!(response.body)
+      if host_config['services'].nil?
+        services = []
+      else
+        services = host_config['services'].map { |s| s['service_description'] }
+      end
+      host_config['hostgroups'].each do |hg|
+        services += hostgroup_services(hg)
+      end
+      services.nil? ? [] : services
+    end
+
+    def build_service_check_body(host, service_description)
+      time = Time.now.to_i
+      { host_name:           host,
+        check_time:          time,
+        service_description: service_description }.to_json
+    end
+
+    def schedule_service_checks_for_host(host, options)
+      service_description_for_host(host).each do |s|
+        body = build_service_check_body(host, s)
+        response = self.class.post(@base_uri + 'command/SCHEDULE_SVC_CHECK?format=json',
+                                   headers: { 'Content-Type' => 'application/json' },
+                                   body: body, basic_auth: @auth, verify: false)
+        raise ApiError unless response.code == 200
+        puts "Service check for service \"#{s}\" scheduled" if options[:verbose]
+      end
+      puts "All services for host #{host} scheduled for check"
+    end
+  end
+end

data/lib/op5util/schedule_downtime.rb

@@ -0,0 +1,31 @@
+# rubocop:disable Lint/UnneededDisable, LineLength, AbcSize, SymbolArray, MethodLength, HashSyntax
+# Foo
+module Op5util
+  # Foo
+  class Monitor
+    def schedule_downtime(host, options)
+      body = build_schedule_downtime_request_body(host, options)
+      response = self.class.post(@base_uri + 'command/SCHEDULE_HOST_DOWNTIME',
+                                 headers: { 'Content-Type' => 'application/json' },
+                                 body: body, basic_auth: @auth, verify: false)
+      raise ApiError unless response.code == 200
+      puts 'Downtime Scheduled'
+    end
+
+    private
+
+    def build_schedule_downtime_request_body(host, options)
+      start_time = Time.now.to_i + options[:wait].to_i
+      end_time   = start_time + + options[:time].to_i * 3600 + 10
+      {
+        host_name:      host.to_s,
+        start_time:     start_time,
+        end_time:       end_time,
+        fixed:          1,
+        trigger_id:     0,
+        duration:       options[:time].to_i * 3600 + 10,
+        comment:        options[:comment]
+      }.to_json
+    end
+  end
+end

data/lib/op5util/status_host.rb

@@ -0,0 +1,152 @@
+# rubocop:disable LineLength, MethodLength, AbcSize, Lint/UselessAssignment
+# Foo
+module Op5util
+  # Foo
+  class Monitor
+    require 'colorize'
+    require 'terminfo'
+
+    def status_host(host, options)
+      full_status = JSON.parse!(get_host_status(host))
+      if options[:short] || (!options[:short] && !options[:long])
+        print_short_status(full_status)
+      else
+        print_full_status(full_status)
+      end
+    end
+
+    private
+
+    def print_short_status(full_status)
+      tot_s     = full_status['num_services'].to_s
+      ok_s      = full_status['num_services_hard_ok'].to_s
+      mark_ok   = tot_s == ok_s
+      warn_s    = full_status['num_services_hard_warn'].to_s
+      mark_warn = warn_s != '0'
+      crit_s    = full_status['num_services_hard_crit'].to_s
+      mark_crit = crit_s != '0'
+      s = "The host #{full_status['name']} is in " + host_state_to_s(full_status['state'].to_i)
+      s += ' state, and it was last checked ' + pp_unixtime_ago(full_status['last_check']) + "ago.\n"
+      s += 'Out of ' + tot_s.blue.bold + ' services is '
+      s += pp_n_services(ok_s.to_i, tot_s.to_i) + ' in the '
+      s += mark_ok ? 'OK'.green : 'OK'.red.bold
+      s += + ' state, '
+      s += mark_warn ? warn_s.yellow.bold : warn_s
+      s += ' in the '
+      s += mark_warn ? 'WARN'.yellow.bold : 'WARN'
+      s += + ' state and '
+      s += mark_crit ? crit_s.red.bold : crit_s
+      s += ' in the '
+      s += mark_crit ? 'CRIT'.red.bold : 'CRIT' + ' state'
+      puts s
+    end
+
+    def service_state(service, full_status)
+      full_status['services_with_state'].each do |s|
+        return s[1] if s[0] == service
+      end
+      ''
+    end
+
+    def service_info(service, full_status)
+      full_status['services_with_info'].each do |s|
+        return s[3] if s[0] == service
+      end
+      ''
+    end
+
+    def print_full_status(full_status)
+      host_status = "The host #{full_status['name']} is "
+      host_status += host_state_to_s full_status['hard_state']
+      host_status += ', last check was done ' + pp_unixtime_ago(full_status['last_check'])
+      host_status += " seconds ago.\n"
+      puts host_status
+      max_field_length = max_cell_width
+      table = Terminal::Table.new do |t|
+        t.add_row ['Service'.blue, 'State'.blue, 'Info'.blue]
+        t.add_separator
+        full_status['services'].each do |service|
+          t.add_row [fold_string(service, max_field_length),
+                     service_state_to_s(service_state(service, full_status)),
+                     fold_string(service_info(service, full_status), max_field_length)]
+        end
+      end
+      puts table
+    end
+
+    def fold_string(s, width)
+      return nil if s.nil?
+      start_pos = 0
+      result = ''
+      while start_pos < s.length
+        cut_chars = [width, (s.length - start_pos)].min
+        cut_pos = start_pos + cut_chars - 1
+        result += s[start_pos..cut_pos]
+        start_pos += cut_chars
+        result += "\n" if start_pos < s.length
+      end
+      result
+    end
+
+    def pp_seconds(seconds)
+      retval = ''
+      s = seconds
+      if s > 86_400
+        retval = (s / 8600).to_s + ' days, '
+        s = s % 86_400
+      end
+      if s > 3600
+        retval += (s / 3660).to_s + ' hours, '
+        s = s % 3600
+      end
+      if s > 60
+        retval += (s / 60).to_s + ' minutes, '
+        s = s % 60
+      end
+      retval += (s % 60).to_s + ' seconds '
+    end
+
+    def pp_unixtime_ago(t)
+      pp_seconds(Time.now.to_i - t)
+    end
+
+    def pp_n_services(n, total = 0)
+      if n == total || ( total == 0 && n > 0 )
+        n.to_s.green
+      else
+        n.to_s.red.bold
+      end
+    end
+
+    def host_state_to_s(state)
+      case state
+      when 0
+        'UP'.green
+      when 1
+        'DOWN'.red.bold
+      else
+        'UNKNOWN'.white.bold
+      end
+    end
+
+    def service_state_to_s(state)
+      case state
+      when 0
+        'OK'.green
+      when 1
+        'WARN'.yellow.bold
+      when 2
+        'CRITICAL'.red.bold
+      else
+        'UNKNOWN'.white.bold
+      end
+    end
+
+    def get_host_status(host)
+      response = self.class.get(@base_uri + "status/host/#{host}?format=json",
+                                basic_auth: @auth, verify: false)
+      raise ApiError unless response.code == 200
+      response.body
+    end
+  end
+end

data/lib/op5util/status_summary.rb

@@ -0,0 +1,88 @@
+# rubocop:disable LineLength, MethodLength, AccessorMethodName
+# Foo
+module Op5util
+  require 'terminal-table'
+  # Foo
+  class Monitor
+    def status_summary(options)
+      if options[:long]
+        print_hosts_summary
+      else
+        print_summary
+      end
+    end
+
+    private
+
+    def print_hosts_summary
+      response = self.class.get(@base_uri + 'status/host?format=json',
+                                basic_auth: @auth, verify: false)
+      raise ApiError unless response.code == 200
+      hosts = JSON.parse!(response.body).map { |h| h['name'] }
+      table = Terminal::Table.new do |t|
+        t.add_row ['Host'.blue, 'Host status'.blue, 'Total Services'.blue, 'OK'.green, 'WARN'.yellow, 'CRIT'.red]
+        t.add_separator
+        hosts.each do |h|
+          t.add_row row_for_host(h)
+        end
+      end
+      puts table
+    end
+
+    def row_for_host(host)
+      full_status = JSON.parse!(get_host_status(host))
+      row = []
+      row << host
+      row << host_state_to_s(full_status['state'].to_i)
+      row << full_status['num_services'].to_s.green
+      row << full_status['num_services_hard_ok'].to_s.green
+      row << full_status['num_services_hard_warn'].to_s.yellow
+      row << full_status['num_services_hard_crit'].to_s.red
+      row
+    end
+
+    def print_summary
+      h = get_host_statuses
+      s = get_service_statuses
+      table = Terminal::Table.new do |t|
+        t.add_row ['', 'Total'.blue, 'OK'.green, 'Acknowledged problems'.yellow, 'Unhandled problems'.red]
+        t.add_separator
+        t.add_row ['Hosts'.blue, h[0].to_s, count_ok(h).to_s.green, h[1].to_s.yellow, h[2].to_s.red ]
+        t.add_row ['Services'.blue, s[0].to_s, count_ok(s).to_s.green, s[1].to_s.yellow, s[2].to_s.red ]
+      end
+      puts table
+    end
+
+    def get_service_statuses
+      service_urls = ['=%5Bservices%5D%20all',
+                      '=%5Bservices%5D%20acknowledged%20%3D%201',
+                      '=[services] state !%3D 0 and acknowledged %3D 0 and scheduled_downtime_depth %3D 0 and host.scheduled_downtime_depth %3D 0']
+      service_statuses = []
+      service_urls.each do |url|
+        response = self.class.get(@base_uri + 'filter/count?query' + url,
+                                  basic_auth: @auth, verify: false)
+        raise ApiError unless response.code == 200
+        service_statuses << JSON.parse!(response.body)['count'].to_i
+      end
+      service_statuses
+    end
+
+    def count_ok(a)
+      a[0] - a[1] - a[2]
+    end
+
+    def get_host_statuses
+      host_urls = ['=%5Bhosts%5D%20all',
+                   '=%5Bhosts%5D%20acknowledged%20%3D%201',
+                   '=%5Bhosts%5D%20state%20!%3D%200%20and%20acknowledged%20%3D%200%20and%20scheduled_downtime_depth%20%3D%200']
+      host_statuses = []
+      host_urls.each do |url|
+        response = self.class.get(@base_uri + 'filter/count?query' + url,
+                                  basic_auth: @auth, verify: false)
+        raise ApiError unless response.code == 200
+        host_statuses << JSON.parse!(response.body)['count'].to_i
+      end
+      host_statuses
+    end
+  end
+end

data/lib/op5util/version.rb

@@ -0,0 +1,3 @@
+module Op5util
+  VERSION = '0.1.1'.freeze
+end

data/lib/op5util.rb

@@ -0,0 +1,11 @@
+require 'op5util/version.rb'
+require 'op5util/check_auth.rb'
+require 'op5util/monitor.rb'
+require 'op5util/add_host.rb'
+require 'op5util/add_hostgroups.rb'
+require 'op5util/schedule_downtime.rb'
+require 'op5util/status_host.rb'
+require 'op5util/status_summary.rb'
+require 'op5util/acknowledge_alarm.rb'
+require 'op5util/list_hostgroups.rb'
+require 'op5util/schedule_checks.rb'

data/op5util.gemspec

@@ -0,0 +1,27 @@
+# rubocop:disable UselessAssignment, StringLiterals
+require File.join([File.dirname(__FILE__), 'lib', 'op5util', 'version.rb'])
+spec = Gem::Specification.new do |s|
+  s.name = 'op5util'
+  s.version = Op5util::VERSION
+  s.author = 'Niklas Paulsson'
+  s.email = 'niklasp@gmail.com'
+  s.platform = Gem::Platform::RUBY
+  s.licenses = ['MIT License']
+  s.homepage = 'https://github.com/np422/Op5util'
+  s.summary = 'A utility to do common Op5 administration from the commandline'
+  s.files = `git ls-files`.split("
+")
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc', 'op5util.rdoc']
+  s.rdoc_options << '--title' << 'op5util' << '--main' << 'README.rdoc'
+  s.bindir = 'bin'
+  s.executables << 'op5util'
+  s.add_development_dependency 'rake', '~> 0'
+  s.add_development_dependency 'rdoc', '~> 0'
+  s.add_development_dependency 'test-unit', '~> 0'
+  s.add_runtime_dependency('colorize', '0.8.1')
+  s.add_runtime_dependency('gli', '2.16.1')
+  s.add_runtime_dependency('httparty', '0.15.5')
+  s.add_runtime_dependency('terminal-table', '1.8.0')
+end

data/op5util.rdoc

@@ -0,0 +1,5 @@
+= op5util
+
+Generate this with
+    op5util rdoc
+After you have described your command line interface

data/test/default_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class DefaultTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_the_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+
+# Add test libraries you want to use here, e.g. mocha
+
+class Test::Unit::TestCase
+
+  # Add global extensions to the test case class here
+  
+end