foreman_monitoring 0.0.3 → 0.1.0

data/app/models/host_status/monitoring_status.rb

@@ -6,7 +6,7 @@ module HostStatus
     UNKNOWN = 3
 
     def relevant?(_options = {})
-      host_not_in_build? && host_known_in_monitoring?
+      host_not_in_build? && host.monitored? && host_known_in_monitoring?
     end
 
     def to_status(_options = {})
@@ -59,6 +59,10 @@ module HostStatus
       host.monitoring_results.any?
     end
 
+    def host_monitored?
+      host.monitored?
+    end
+
     def should_affect_global_status?
       Setting[:monitoring_affect_global_status]
     end

data/app/models/setting/monitoring.rb

@@ -1,16 +1,33 @@
 class Setting
   class Monitoring < ::Setting
+
+    def self.default_settings
+      [
+        set('monitoring_affect_global_status',
+            _("Monitoring status will affect a host's global status when enabled"),
+            true, N_('Monitoring status should affect global status')),
+        set('monitoring_create_action',
+            _("What action should be taken when a host is created"),
+            'create', N_('Host Create Action'), nil, {:collection => Proc.new {::Monitoring::CREATE_ACTIONS} }),
+        set('monitoring_delete_action',
+            _("What action should be taken when a host is deleted"),
+            'delete', N_('Host Delete Action'), nil, {:collection => Proc.new {::Monitoring::DELETE_ACTIONS} })
+      ]
+    end
+
     def self.load_defaults
       # Check the table exists
       return unless super
 
-      Setting.transaction do
-        [
-          set('monitoring_affect_global_status',
-              _("Monitoring status will affect a host's global status when enabled"),
-              true, N_('Monitoring status should affect global status'))
-        ].compact.each { |s| create! s.update(:category => 'Setting::Monitoring') }
+      self.transaction do
+        default_settings.each { |s| self.create! s.update(:category => "Setting::Monitoring")}
       end
+
+      true
+    end
+
+    def self.humanized_category
+      N_('Monitoring')
     end
   end
 end

data/app/overrides/add_host_multiple_power_set_downtime_checkbox.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path  => 'hosts/select_multiple_power_state',
+                     :name          => 'add_host_multiple_power_set_downtime_checkbox',
+                     :insert_before => "erb[silent]:contains('end')",
+                     :partial       => 'hosts/host_downtime_checkbox'
+                    )

data/app/overrides/add_host_set_downtime_modal.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path  => 'hosts/show',
+                     :name          => 'add_monitoring_set_downtime_modal',
+                     :insert_after => 'div#review_before_build',
+                     :partial       => 'hosts/set_host_downtime'
+                    )

data/app/services/monitoring.rb

@@ -1,13 +1,66 @@
 class Monitoring
+  CREATE_ACTIONS = {
+    'none' => _('None'),
+    'create' => _('Create Host Object')
+  }.freeze
+
+  DELETE_ACTIONS = {
+    'none' => _('None'),
+    'delete' => _('Delete Host Object'),
+    'downtime' => _('Set Downtime for Host')
+  }.freeze
+
   delegate :logger, :to => :Rails
   attr_reader :proxy, :proxy_api
 
-  def initialize
-    @proxy = SmartProxy.with_features('Monitoring').first
+  def self.create_action?(action)
+    Setting[:monitoring_create_action] == action.to_s
+  end
+
+  def self.delete_action?(action)
+    Setting[:monitoring_delete_action] == action.to_s
+  end
+
+  def initialize(opts)
+    @proxy = opts.fetch(:monitoring_proxy)
     @proxy_api = ProxyAPI::Monitoring.new(:url => proxy.url)
   end
 
   def set_downtime_host(host, options = {})
-    proxy_api.create_host_downtime(host.fqdn, { :author => 'Foreman', :comment => 'triggered by Foreman' }.merge(options))
+    proxy_api.create_host_downtime(host.fqdn, default_downtime_options.merge(options))
+  end
+
+  def del_downtime_host(host, options = {})
+    proxy_api.remove_host_downtime(host.fqdn, default_downtime_options.merge(options))
+  end
+
+  def create_host(host)
+    proxy_api.create_host(host.fqdn, host.monitoring_attributes)
+  end
+
+  def update_host(host)
+    proxy_api.update_host(host.fqdn, host.monitoring_attributes)
+  end
+
+  def delete_host(host)
+    # We cannot use host.fqdn here as that is delegated to primary interface that does not exist anymore
+    proxy_api.delete_host(host.name)
+  end
+
+  def query_host(host)
+    result = proxy_api.query_host(host.name)
+    return {} unless result
+    {
+      :attrs => result
+    }
+  end
+
+  private
+
+  def default_downtime_options
+    {
+      :author => 'Foreman',
+      :comment => 'triggered by Foreman'
+    }
   end
 end

data/app/views/hosts/_downtime_fields.html.erb

@@ -0,0 +1,3 @@
+<%= text_f f, :comment, :size => "col-md-5", :label => _('Comment'), :help_inline => _('Short description that explains why the downtime was set.'), :required => true %>
+<%= datetime_f f, :starttime, :size => "col-md-5", :label => _('Starttime'), :help_inline => _('Time when the downtime should start.'), :value => DateTime.now.strftime("%Y-%m-%dT%H:%M"), :required => true %>
+<%= datetime_f f, :endtime, :size => "col-md-5", :label => _('Endtime'), :help_inline => _('Time when the downtime should end.'), :value => DateTime.now.advance(:hours => 2).strftime("%Y-%m-%dT%H:%M"), :required => true %>

data/app/views/hosts/_host_downtime_checkbox.html.erb

@@ -0,0 +1,8 @@
+<% if authorized_for(:controller => :hosts, :action => :select_multiple_downtime) %>
+  <%= checkbox_f f, :set_downtime, {
+    :label_size => 'col-md-6',
+    :help_inline => _('Set a downtime for this host')
+  },
+  'true',
+  'false' %>
+<% end %>

data/app/views/hosts/_set_host_downtime.html.erb

@@ -0,0 +1,20 @@
+<div id="set_host_downtime" class="modal fade hide">
+<div class="modal-dialog">
+  <div class="modal-content">
+    <div class="modal-header">
+      <%= alert_close('modal') %>
+      <h4 class="modal-title"><%= _('Set host downtime for %s') % @host %></h4>
+    </div>
+    <div class="modal-body">
+      <%= form_for :downtime,
+        :method => :put,
+        :url    => hash_for_downtime_host_path(:id => @host).merge(:auth_object => @host, :permission => 'build_hosts') do |f| %>
+        <%= render :partial => 'downtime_fields', :locals => { :f => f } %>
+        <div class="modal-footer">
+          <%= modal_close %>
+          <%= f.submit(_("Set downtime"), :class => "btn btn-success submit") %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/hosts/select_multiple_downtime.html.erb

@@ -0,0 +1,5 @@
+<%= render 'selected_hosts', :hosts => @hosts %>
+
+<%= form_for :downtime, :url => update_multiple_downtime_hosts_path(:host_ids => params[:host_ids]) do |f| %>
+  <%= render :partial => 'downtime_fields', :locals => { :f => f } %>
+<% end %>

data/app/views/hosts/select_multiple_monitoring_proxy.html.erb

@@ -0,0 +1,5 @@
+<%= render 'selected_hosts', :hosts => @hosts %>
+
+<%= form_for :proxy, :url => update_multiple_monitoring_proxy_hosts_path(:host_ids => params[:host_ids]) do |f| %>
+  <%= multiple_proxy_select(f, 'Monitoring') %>
+<% end %>

data/app/views/monitoring_results/_host_tab.html.erb

@@ -1 +1,3 @@
+<%- if authorized_for(:permission => 'view_monitoring_results', :auth_object => @host) && @host.monitored? -%>
 <li><a href="#monitoring" data-toggle="tab"><%= _("Monitoring") %></a></li>
+<%- end -%>

data/app/views/monitoring_results/_host_tab_pane.html.erb

@@ -1,3 +1,4 @@
+<%- if authorized_for(:permission => 'view_monitoring_results', :auth_object => @host) && @host.monitored? -%>
 <div class="tab-pane" id="monitoring">
 <% if @host.monitoring_results.any? %>
   <table class="table table-bordered table-striped">
@@ -23,3 +24,4 @@
   <div class="alert alert-success"> <%= _('No monitoring results for this host') %> </div>
 <% end %>
 </div>
+<%- end -%>

data/config/routes.rb

@@ -7,4 +7,20 @@ Rails.application.routes.draw do
       resources :monitoring_results, :only => [:create]
     end
   end
+
+  scope '/monitoring' do
+    constraints(:id => %r{[^\/]+}) do
+      resources :hosts, :only => [] do
+        member do
+          put 'downtime'
+        end
+        collection do
+          post :select_multiple_downtime
+          post :update_multiple_downtime
+          post :select_multiple_monitoring_proxy
+          post :update_multiple_monitoring_proxy
+        end
+      end
+    end
+  end
 end

data/db/migrate/20161220201510_add_monitoring_proxy_id_to_host_and_hostgroup.rb

@@ -0,0 +1,11 @@
+class AddMonitoringProxyIdToHostAndHostgroup < ActiveRecord::Migration
+  def self.up
+    add_column :hosts, :monitoring_proxy_id, :integer
+    add_column :hostgroups, :monitoring_proxy_id, :integer
+  end
+
+  def self.down
+    remove_column :hosts, :monitoring_proxy_id
+    remove_column :hostgroups, :monitoring_proxy_id
+  end
+end

data/lib/foreman_monitoring/engine.rb

@@ -30,15 +30,47 @@ module ForemanMonitoring
 
     initializer 'foreman_monitoring.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_monitoring do
-        requires_foreman '>= 1.11'
+        requires_foreman '>= 1.15'
+
+        apipie_documented_controllers ["#{ForemanMonitoring::Engine.root}/app/controllers/api/v2/*.rb"]
+
+        security_block :foreman_monitoring do
+          permission :view_monitoring_results,
+            {},
+            :resource_type => 'Host'
+          permission :manage_host_downtimes,
+            { :hosts => [:downtime, :select_multiple_downtime, :update_multiple_downtime] },
+            :resource_type => 'Host'
+          permission :upload_monitoring_results,
+            :'api/v2/monitoring_results' => [:create]
+        end
+
+        role 'Monitoring viewer', [:view_monitoring_results]
+        role 'Monitoring manager', [:view_monitoring_results, :manage_host_downtimes, :upload_monitoring_results]
+
         register_custom_status HostStatus::MonitoringStatus
+
+        add_controller_action_scope(HostsController, :index) { |base_scope| base_scope.includes(:monitoring_results) }
+
+        monitoring_proxy_options = {
+          :feature => 'Monitoring',
+          :label => N_('Monitoring Proxy'),
+          :description => N_('Monitoring Proxy to use to manage monitoring of this host'),
+          :api_description => N_('ID of Monitoring Proxy to use to manage monitoring of this host')
+        }
+
+        # add monitoring smart proxy to hosts and hostgroups
+        smart_proxy_for Host::Managed, :monitoring_proxy, monitoring_proxy_options
+        smart_proxy_for Hostgroup, :monitoring_proxy, monitoring_proxy_options
       end
     end
 
     config.to_prepare do
       begin
-        Host::Managed.send :include, ForemanMonitoring::HostExtensions
-        HostsHelper.send(:include, ForemanMonitoring::HostsHelperExt)
+        ::Host::Managed.send :include, ForemanMonitoring::HostExtensions
+        ::Hostgroup.send :include, ForemanMonitoring::HostgroupExtensions
+        ::HostsHelper.send(:include, ForemanMonitoring::HostsHelperExt)
+        ::HostsController.send :include, ForemanMonitoring::HostsControllerExtensions
       rescue => e
         Rails.logger.warn "ForemanMonitoring: skipping engine hook (#{e})"
       end

data/lib/foreman_monitoring/version.rb

@@ -1,3 +1,3 @@
 module ForemanMonitoring
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/test/factories/host.rb

@@ -1,5 +1,11 @@
 FactoryGirl.modify do
   factory :host do
+    trait :with_monitoring do
+      monitoring_proxy do
+        FactoryGirl.create(:smart_proxy, :monitoring)
+      end
+    end
+
     trait :with_monitoring_results do
       transient do
         monitoring_result_count 20

data/test/functional/hosts_controller_test.rb

@@ -0,0 +1,190 @@
+require 'test_plugin_helper'
+
+class HostsControllerExtensionsTest < ActionController::TestCase
+  tests ::HostsController
+  setup do
+    User.current = users(:admin)
+    disable_monitoring_orchestration
+    @host = FactoryGirl.create(:host, :managed)
+  end
+
+  context 'when setting a host downtime' do
+    setup do
+      @request.env['HTTP_REFERER'] = host_path(:id => @host)
+    end
+
+    test 'the flash should inform it' do
+      Host::Managed.any_instance.stubs(:downtime_host).returns(true)
+      put :downtime, {
+        :id => @host.name,
+        :downtime => {
+          :comment => 'Maintenance work.',
+          :starttime => DateTime.now,
+          :endtime => DateTime.now
+        }
+      }, set_session_user
+      assert_response :found
+      assert_redirected_to host_path(:id => @host)
+      assert_nil flash[:error]
+      assert_not_nil flash[:notice]
+      assert_equal "Created downtime for #{@host}", flash[:notice]
+    end
+
+    test 'with missing comment param the flash should inform it' do
+      put :downtime, { :id => @host.name }, set_session_user
+      assert_response :found
+      assert_redirected_to host_path(:id => @host)
+      assert_not_nil flash[:error]
+      assert_equal 'No comment for downtime set!', flash[:error]
+    end
+
+    test 'with missing date params the flash should inform it' do
+      put :downtime, { :id => @host.name, :downtime => { :comment => 'Maintenance work.' } }, set_session_user
+      assert_response :found
+      assert_redirected_to host_path(:id => @host)
+      assert_not_nil flash[:error]
+      assert_equal 'No start/endtime for downtime!', flash[:error]
+    end
+
+    test 'with invalid starttime the flash should inform it' do
+      put :downtime, {
+        :id => @host.name,
+        :downtime => {
+          :comment => 'Maintenance work.',
+          :starttime => 'invalid',
+          :endtime => 'invalid' }
+      }, set_session_user
+      assert_response :found
+      assert_redirected_to host_path(:id => @host)
+      assert_not_nil flash[:error]
+      assert_equal 'Invalid start/endtime for downtime!', flash[:error]
+    end
+  end
+
+  describe 'setting a downtime on multiple hosts' do
+    before do
+      @hosts = FactoryGirl.create_list(:host, 2, :with_monitoring)
+      @request.env['HTTP_REFERER'] = hosts_path
+    end
+
+    test 'show a host selection' do
+      host_ids = @hosts.map(&:id)
+      xhr :post, :select_multiple_downtime, {:host_ids => host_ids}, set_session_user
+      assert_response :success
+      assert response.body =~ /#{@hosts.first.name}.*#{@hosts.last.name}/m
+    end
+
+    test 'should set a downtime' do
+      Host::Managed.any_instance.expects(:downtime_host).twice.returns(true)
+      params = {
+        :host_ids => @hosts.map(&:id),
+        :downtime => {
+          :comment => 'Maintenance work.',
+          :starttime => DateTime.now,
+          :endtime => DateTime.now
+        }
+      }
+
+      post :update_multiple_downtime, params,
+           set_session_user
+
+      assert_response :found
+      assert_redirected_to hosts_path
+      assert_nil flash[:error]
+      assert_not_nil flash[:notice]
+      assert_equal 'A downtime was set for the selected hosts.', flash[:notice]
+    end
+  end
+
+  describe 'changing the power state on multiple hosts' do
+    before do
+      @hosts = FactoryGirl.create_list(:host, 2, :with_monitoring)
+      @request.env['HTTP_REFERER'] = hosts_path
+
+      power_mock = mock('power')
+      power_mock.expects(:poweroff).twice
+      Host::Managed.any_instance.stubs(:power).returns(power_mock)
+      Host::Managed.any_instance.stubs(:supports_power?).returns(true)
+    end
+
+    test 'should set a downtime if selected' do
+      Host::Managed.any_instance.expects(:downtime_host).twice.returns(true)
+      params = {
+        :host_ids => @hosts.map(&:id),
+        :power => {
+          :action => 'poweroff',
+          :set_downtime => true
+        }
+      }
+
+      post :update_multiple_power_state, params,
+           set_session_user
+
+      assert_response :found
+      assert_redirected_to hosts_path
+      assert_nil flash[:error]
+      assert_not_nil flash[:notice]
+      assert_equal 'The power state of the selected hosts will be set to poweroff', flash[:notice]
+    end
+
+    test 'should not set a downtime if not selected' do
+      Host::Managed.any_instance.expects(:downtime_host).never
+      params = {
+        :host_ids => @hosts.map(&:id),
+        :power => {
+          :action => 'poweroff',
+          :set_downtime => false
+        }
+      }
+
+      post :update_multiple_power_state, params,
+           set_session_user
+
+      assert_response :found
+      assert_redirected_to hosts_path
+      assert_nil flash[:error]
+      assert_not_nil flash[:notice]
+      assert_equal 'The power state of the selected hosts will be set to poweroff', flash[:notice]
+    end
+  end
+
+  describe 'changing the monitoring proxy of multiple hosts' do
+    let(:hosts) { FactoryGirl.create_list(:host, 2, :with_monitoring) }
+    let(:monitoring_proxy) { FactoryGirl.create(:smart_proxy, :monitoring, :organizations => [hosts.first.organization], :locations => [hosts.first.location]) }
+    before do
+      @request.env['HTTP_REFERER'] = hosts_path
+    end
+
+    test 'show a host selection' do
+      host_ids = hosts.map(&:id)
+      xhr :post, :select_multiple_monitoring_proxy, {:host_ids => host_ids}, set_session_user
+      assert_response :success
+      assert response.body =~ /#{hosts.first.name}.*#{hosts.last.name}/m
+    end
+
+    test 'should change the proxy' do
+      hosts.each do |host|
+        refute_equal monitoring_proxy, host.monitoring_proxy
+      end
+
+      params = {
+        :host_ids => hosts.map(&:id),
+        :proxy => { :proxy_id => monitoring_proxy.id }
+      }
+
+      post :update_multiple_monitoring_proxy, params,
+           set_session_user
+
+      assert_response :found
+      assert_redirected_to hosts_path
+      assert_nil flash[:error]
+      assert_equal "The Monitoring proxy of the selected hosts was set to #{monitoring_proxy.name}.", flash[:notice]
+
+      hosts.each do |host|
+        as_admin do
+          assert_equal monitoring_proxy, host.reload.monitoring_proxy
+        end
+      end
+    end
+  end
+end