foreman_monitoring 0.1.2 → 2.1.0

data/lib/foreman_monitoring/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanMonitoring
-  VERSION = '0.1.2'.freeze
+  VERSION = '2.1.0'
 end

data/lib/tasks/foreman_monitoring_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tests
 namespace :test do
   desc 'Test ForemanMonitoring'
@@ -11,7 +13,7 @@ namespace :test do
 end
 
 namespace :foreman_monitoring do
-  task :rubocop do
+  task rubocop: :environment do
     begin
       require 'rubocop/rake_task'
       RuboCop::RakeTask.new(:rubocop_foreman_monitoring) do |task|
@@ -19,7 +21,7 @@ namespace :foreman_monitoring do
                          "#{ForemanMonitoring::Engine.root}/lib/**/*.rb",
                          "#{ForemanMonitoring::Engine.root}/test/**/*.rb"]
       end
-    rescue
+    rescue StandardError
       puts 'Rubocop not loaded.'
     end
 
@@ -30,6 +32,4 @@ end
 Rake::Task[:test].enhance ['test:foreman_monitoring']
 
 load 'tasks/jenkins.rake'
-if Rake::Task.task_defined?(:'jenkins:unit')
-  Rake::Task['jenkins:unit'].enhance ['test:foreman_monitoring', 'foreman_monitoring:rubocop']
-end
+Rake::Task['jenkins:unit'].enhance ['test:foreman_monitoring', 'foreman_monitoring:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')

data/locale/gemspec.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # Matches foreman_monitoring.gemspec
 _('Set a downtime for hosts after they are deleted in Foreman.')

data/test/controllers/api/v2/downtime_controller_test.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class Api::V2::DowntimeControllerTest < ActionController::TestCase
+  let(:host1) { as_admin { FactoryBot.create(:host, :managed) } }
+
+  context 'with user authentication' do
+    context '#create' do
+      test 'should deny access' do
+        post :create
+        assert_response :forbidden
+      end
+    end
+  end
+
+  context 'with client cert' do
+    setup do
+      User.current = nil
+      reset_api_credentials
+
+      Setting[:ssl_client_dn_env] = 'SSL_CLIENT_S_DN'
+      Setting[:ssl_client_verify_env] = 'SSL_CLIENT_VERIFY'
+
+      @request.env['HTTPS'] = 'on'
+      @request.env['SSL_CLIENT_S_DN'] = "CN=#{host1.name},DN=example,DN=com"
+      @request.env['SSL_CLIENT_VERIFY'] = 'SUCCESS'
+    end
+
+    context '#create' do
+      test 'should create downtime' do
+        post :create
+        assert_response :success
+      end
+    end
+
+    context '#create with duration' do
+      test 'should create downtime with given duration' do
+        Host::Managed.any_instance.expects(:downtime_host).with { |params| params[:end_time] - params[:start_time] == 3600 }
+        post :create, params: { duration: 3600 }
+        assert_response :success
+      end
+
+      test 'should create downtime with given duration as string' do
+        Host::Managed.any_instance.expects(:downtime_host).with { |params| params[:end_time] - params[:start_time] == 3600 }
+        post :create, params: { duration: '3600' }
+        assert_response :success
+      end
+    end
+
+    context '#create with reason' do
+      test 'should create downtime with given reason' do
+        Host::Managed.any_instance.expects(:downtime_host).with { |params| params[:comment] == 'In testing' }
+        post :create, params: { reason: 'In testing' }
+        assert_response :success
+      end
+    end
+  end
+
+  context 'without any credentials' do
+    setup do
+      User.current = nil
+      reset_api_credentials
+    end
+
+    context '#create' do
+      test 'should deny access' do
+        post :create
+        assert_response :unauthorized
+      end
+    end
+  end
+end

data/test/factories/feature.rb

@@ -1,7 +1,9 @@
-FactoryGirl.modify do
+# frozen_string_literal: true
+
+FactoryBot.modify do
   factory :feature do
     trait :monitoring do
-      name 'Monitoring'
+      name { 'Monitoring' }
     end
   end
 end

data/test/factories/host.rb

@@ -1,18 +1,20 @@
-FactoryGirl.modify do
+# frozen_string_literal: true
+
+FactoryBot.modify do
   factory :host do
     trait :with_monitoring do
       monitoring_proxy do
-        FactoryGirl.create(:smart_proxy, :monitoring)
+        FactoryBot.create(:smart_proxy, :monitoring)
       end
     end
 
     trait :with_monitoring_results do
       transient do
-        monitoring_result_count 20
+        monitoring_result_count { 20 }
       end
       after(:create) do |host, evaluator|
         evaluator.monitoring_result_count.times do
-          FactoryGirl.create(:monitoring_result, :host => host)
+          FactoryBot.create(:monitoring_result, :host => host)
         end
       end
     end

data/test/factories/monitoring_results.rb

@@ -1,30 +1,32 @@
-FactoryGirl.define do
+# frozen_string_literal: true
+
+FactoryBot.define do
   factory :monitoring_result do
     sequence(:service) { |n| "Service #{n}" }
     result { rand(0..3) }
 
     trait :ok do
-      result 0
+      result { 0 }
     end
 
     trait :warning do
-      result 1
+      result { 1 }
     end
 
     trait :critical do
-      result 2
+      result { 2 }
     end
 
     trait :unknown do
-      result 3
+      result { 3 }
     end
 
     trait :downtime do
-      downtime true
+      downtime { true }
     end
 
     trait :acknowledged do
-      acknowledged true
+      acknowledged { true }
     end
   end
 end

data/test/factories/smart_proxy.rb

@@ -1,4 +1,6 @@
-FactoryGirl.modify do
+# frozen_string_literal: true
+
+FactoryBot.modify do
   factory :smart_proxy do
     trait :monitoring do
       features { |sp| [sp.association(:feature, :monitoring)] }

data/test/functional/hosts_controller_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class HostsControllerExtensionsTest < ActionController::TestCase
@@ -8,7 +10,7 @@ class HostsControllerExtensionsTest < ActionController::TestCase
     ProxyAPI::Monitoring.stubs(:create_host).returns(true)
     ProxyAPI::Monitoring.stubs(:update_host).returns(true)
     ProxyAPI::Monitoring.stubs(:delete_host).returns(true)
-    @host = FactoryGirl.create(:host, :managed)
+    @host = FactoryBot.create(:host, :managed)
   end
 
   context 'when setting a host downtime' do
@@ -18,23 +20,25 @@ class HostsControllerExtensionsTest < ActionController::TestCase
 
     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 => Time.current,
-          :endtime => Time.current.advance(:hours => 2)
-        }
-      }, set_session_user
+      put :downtime,
+          params: {
+            :id => @host.name,
+            :downtime => {
+              :comment => 'Maintenance work.',
+              :starttime => Time.current,
+              :endtime => Time.current.advance(:hours => 2)
+            }
+          },
+          session: 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]
+      assert_not_nil flash[:success]
+      assert_equal "Created downtime for #{@host}", flash[:success]
     end
 
     test 'with missing comment param the flash should inform it' do
-      put :downtime, { :id => @host.name }, set_session_user
+      put :downtime, params: { :id => @host.name }, session: set_session_user
       assert_response :found
       assert_redirected_to host_path(:id => @host)
       assert_not_nil flash[:error]
@@ -42,7 +46,9 @@ class HostsControllerExtensionsTest < ActionController::TestCase
     end
 
     test 'with missing date params the flash should inform it' do
-      put :downtime, { :id => @host.name, :downtime => { :comment => 'Maintenance work.' } }, set_session_user
+      put :downtime,
+          params: { :id => @host.name, :downtime => { :comment => 'Maintenance work.' } },
+          session: set_session_user
       assert_response :found
       assert_redirected_to host_path(:id => @host)
       assert_not_nil flash[:error]
@@ -50,14 +56,16 @@ class HostsControllerExtensionsTest < ActionController::TestCase
     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
+      put :downtime,
+          params: {
+            :id => @host.name,
+            :downtime => {
+              :comment => 'Maintenance work.',
+              :starttime => 'invalid',
+              :endtime => 'invalid'
+            }
+          },
+          session: set_session_user
       assert_response :found
       assert_redirected_to host_path(:id => @host)
       assert_not_nil flash[:error]
@@ -65,28 +73,34 @@ class HostsControllerExtensionsTest < ActionController::TestCase
     end
 
     test 'should parse the times in the correct time zone' do
-      User.current.update_attribute(:timezone, 'Berlin')
+      User.current.timezone = 'Berlin'
+      User.current.save
       Host::Managed.any_instance.expects(:downtime_host).with(has_entries(:start_time => 1_492_676_100, :end_time => 1_492_683_300))
-      put :downtime, {
-        :id => @host.name,
-        :downtime => {
-          :comment => 'Maintenance work.',
-          :starttime => '2017-04-20T10:15',
-          :endtime => '2017-04-20T12:15'
-        }
-      }, set_session_user
+      put :downtime,
+          params: {
+            :id => @host.name,
+            :downtime => {
+              :comment => 'Maintenance work.',
+              :starttime => '2017-04-20T10:15',
+              :endtime => '2017-04-20T12:15'
+            }
+          },
+          session: set_session_user
     end
   end
 
   describe 'setting a downtime on multiple hosts' do
     before do
-      @hosts = FactoryGirl.create_list(:host, 2, :with_monitoring)
+      @hosts = FactoryBot.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
+      post :select_multiple_downtime,
+           params: { :host_ids => host_ids },
+           session: set_session_user,
+           xhr: true
       assert_response :success
       assert_includes response.body, @hosts.first.name
       assert_includes response.body, @hosts.last.name
@@ -103,20 +117,19 @@ class HostsControllerExtensionsTest < ActionController::TestCase
         }
       }
 
-      post :update_multiple_downtime, params,
-           set_session_user
+      post :update_multiple_downtime, params: params, session: 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]
+      assert_not_nil flash[:success]
+      assert_equal 'A downtime was set for the selected hosts.', flash[:success]
     end
   end
 
   describe 'changing the power state on multiple hosts' do
     before do
-      @hosts = FactoryGirl.create_list(:host, 2, :with_monitoring)
+      @hosts = FactoryBot.create_list(:host, 2, :with_monitoring)
       @request.env['HTTP_REFERER'] = hosts_path
 
       power_mock = mock('power')
@@ -135,14 +148,13 @@ class HostsControllerExtensionsTest < ActionController::TestCase
         }
       }
 
-      post :update_multiple_power_state, params,
-           set_session_user
+      post :update_multiple_power_state, params: params, session: 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]
+      assert_not_nil flash[:success]
+      assert_equal 'The power state of the selected hosts will be set to poweroff', flash[:success]
     end
 
     test 'should not set a downtime if not selected' do
@@ -155,27 +167,29 @@ class HostsControllerExtensionsTest < ActionController::TestCase
         }
       }
 
-      post :update_multiple_power_state, params,
-           set_session_user
+      post :update_multiple_power_state, params: params, session: 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]
+      assert_not_nil flash[:success]
+      assert_equal 'The power state of the selected hosts will be set to poweroff', flash[:success]
     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]) }
+    let(:hosts) { FactoryBot.create_list(:host, 2, :with_monitoring) }
+    let(:monitoring_proxy) { FactoryBot.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
+      post :select_multiple_monitoring_proxy,
+           params: { :host_ids => host_ids },
+           session: set_session_user,
+           xhr: true
       assert_response :success
       hosts.each do |host|
         assert response.body =~ /#{host.name}/m
@@ -184,7 +198,7 @@ class HostsControllerExtensionsTest < ActionController::TestCase
 
     test 'should change the proxy' do
       hosts.each do |host|
-        refute_equal monitoring_proxy, host.monitoring_proxy
+        assert_not_equal monitoring_proxy, host.monitoring_proxy
       end
 
       params = {
@@ -192,13 +206,12 @@ class HostsControllerExtensionsTest < ActionController::TestCase
         :proxy => { :proxy_id => monitoring_proxy.id }
       }
 
-      post :update_multiple_monitoring_proxy, params,
-           set_session_user
+      post :update_multiple_monitoring_proxy, params: params, session: 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]
+      assert_equal "The Monitoring proxy of the selected hosts was set to #{monitoring_proxy.name}", flash[:success]
 
       hosts.each do |host|
         as_admin do

data/test/lib/proxy_api/monitoring_test.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
-class ProxyApiDhcpTest < ActiveSupport::TestCase
+class ProxyApiMonitoringTest < ActiveSupport::TestCase
   def setup
     @url = 'http://localhost:8443'
-    @monitoring = ProxyAPI::Monitoring.new({ :url => @url })
+    @monitoring = ProxyAPI::Monitoring.new(:url => @url)
   end
 
   test 'constructor should complete' do
@@ -15,38 +17,38 @@ class ProxyApiDhcpTest < ActiveSupport::TestCase
   end
 
   test 'create_host_downtime should do post' do
-    @monitoring.expects(:post).with({}, 'downtime/host/example.com').
-      returns(fake_rest_client_response({ 'result' => {} }))
+    @monitoring.expects(:post).with({}, 'downtime/host/example.com')
+               .returns(fake_rest_client_response('result' => {}))
     assert_equal({ 'result' => {} }, @monitoring.create_host_downtime('example.com'))
   end
 
   test 'remove_host_downtime should do delete' do
-    @monitoring.expects(:delete).with('downtime/host/example.com?comment=bla').
-      returns(fake_rest_client_response({ 'result' => {} }))
+    @monitoring.expects(:delete).with('downtime/host/example.com?comment=bla')
+               .returns(fake_rest_client_response('result' => {}))
     assert_equal({ 'result' => {} }, @monitoring.remove_host_downtime('example.com', :comment => 'bla'))
   end
 
   test 'create_host should do put' do
-    @monitoring.expects(:put).with({ :attributes => { :ip => '1.1.1.1' } }, 'host/example.com').
-      returns(fake_rest_client_response({ 'result' => {} }))
+    @monitoring.expects(:put).with({ :attributes => { :ip => '1.1.1.1' } }, 'host/example.com')
+               .returns(fake_rest_client_response('result' => {}))
     assert_equal({ 'result' => {} }, @monitoring.create_host('example.com', :ip => '1.1.1.1'))
   end
 
   test 'update_host should do post' do
-    @monitoring.expects(:post).with({ :attributes => { :ip => '1.1.1.1' } }, 'host/example.com').
-      returns(fake_rest_client_response({ 'result' => {} }))
+    @monitoring.expects(:post).with({ :attributes => { :ip => '1.1.1.1' } }, 'host/example.com')
+               .returns(fake_rest_client_response('result' => {}))
     assert_equal({ 'result' => {} }, @monitoring.update_host('example.com', :ip => '1.1.1.1'))
   end
 
   test 'delete_host should do delete' do
-    @monitoring.expects(:delete).with('host/example.com').
-      returns(fake_rest_client_response({ 'result' => {} }))
+    @monitoring.expects(:delete).with('host/example.com')
+               .returns(fake_rest_client_response('result' => {}))
     assert_equal({ 'result' => {} }, @monitoring.delete_host('example.com'))
   end
 
   test 'query_host should do get' do
-    @monitoring.expects(:get).with('host/example.com').
-      returns(fake_rest_client_response({ 'result' => {} }))
+    @monitoring.expects(:get).with('host/example.com')
+               .returns(fake_rest_client_response('result' => {}))
     assert_equal({ 'result' => {} }, @monitoring.query_host('example.com'))
   end
 end