foreman_expire_hosts 6.0.0 → 7.0.2

data/lib/foreman_expire_hosts/engine.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 require 'deface'
-require 'bootstrap-datepicker-rails'
 
 module ForemanExpireHosts
   class Engine < ::Rails::Engine
@@ -24,7 +25,7 @@ module ForemanExpireHosts
 
     initializer 'foreman_expire_hosts.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_expire_hosts do
-        requires_foreman '>= 1.18'
+        requires_foreman '>= 1.24'
         register_custom_status HostStatus::ExpirationStatus
 
         # strong parameters
@@ -34,22 +35,29 @@ module ForemanExpireHosts
           permission :edit_host_expiry,
                      {},
                      :resource_type => 'Host'
-          permission :edit_hosts,
-                     { :hosts => [:select_multiple_expiration, :update_multiple_expiration] },
-                     :resource_type => 'Host'
         end
 
+        # Extend built in permissions
+        Foreman::AccessControl.permission(:edit_hosts).actions.concat [
+          'hosts/select_multiple_expiration',
+          'hosts/update_multiple_expiration'
+        ]
+
         extend_rabl_template 'api/v2/hosts/main', 'api/v2/hosts/expiration'
+
+        describe_host do
+          multiple_actions_provider :expire_hosts_host_multiple_actions
+        end
       end
     end
 
     config.to_prepare do
       begin
-        Host::Managed.send :include, ForemanExpireHosts::HostExt
-        HostsHelper.send :include, ForemanExpireHosts::HostsHelperExtensions
-        HostsController.send :prepend, ForemanExpireHosts::HostControllerExtensions
-        AuditsHelper.send :include, ForemanExpireHosts::AuditsHelperExtensions
-        ::Api::V2::HostsController.send :include, ForemanExpireHosts::Api::V2::HostsControllerExtensions
+        ::Host::Managed.include ForemanExpireHosts::HostExt
+        ::HostsHelper.include ForemanExpireHosts::HostsHelperExtensions
+        ::HostsController.prepend ForemanExpireHosts::HostControllerExtensions
+        ::AuditsHelper.include ForemanExpireHosts::AuditsHelperExtensions
+        ::Api::V2::HostsController.include ForemanExpireHosts::Api::V2::HostsControllerExtensions
       rescue StandardError => e
         Rails.logger.warn "ForemanExpireHosts: skipping engine hook (#{e})"
       end
@@ -61,4 +69,8 @@ module ForemanExpireHosts
       end
     end
   end
+
+  def self.logger
+    Foreman::Logging.logger('foreman_expire_hosts')
+  end
 end

data/lib/foreman_expire_hosts/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
-  VERSION = '6.0.0'.freeze
+  VERSION = '7.0.2'
 end

data/lib/tasks/expired_hosts.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tasks
 namespace :expired_hosts do
   desc 'Delete all expired hosts, send notification email about expiring hosts'
@@ -24,7 +26,7 @@ namespace :test do
 end
 
 namespace :foreman_expire_hosts do
-  task :rubocop do
+  task :rubocop => :environment do
     begin
       require 'rubocop/rake_task'
       RuboCop::RakeTask.new(:rubocop_foreman_expire_hosts) do |task|

data/test/factories/foreman_expire_hosts_factories.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.modify do
   factory :host do
     trait :without_validation do
@@ -6,26 +8,26 @@ FactoryBot.modify do
     end
 
     trait :expires_in_a_year do
-      expired_on Date.today + 365
+      expired_on { Date.today + 365 }
     end
 
     trait :expires_in_a_week do
-      expired_on Date.today + 7
+      expired_on { Date.today + 7 }
     end
 
     trait :expires_today do
       without_validation
-      expired_on Date.today
+      expired_on { Date.today }
     end
 
     trait :expired_grace do
       without_validation
-      expired_on Date.today - 1
+      expired_on { Date.today - 1 }
     end
 
     trait :expired do
       without_validation
-      expired_on Date.today - 356
+      expired_on { Date.today - 356 }
     end
   end
 end

data/test/functional/api/v2/hosts_controller_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class Api::V2::HostsControllerTest < ActionController::TestCase
@@ -11,7 +13,7 @@ class Api::V2::HostsControllerTest < ActionController::TestCase
     get :show, params: { :id => host.to_param }
     assert_response :success
     show_response = ActiveSupport::JSON.decode(@response.body)
-    assert !show_response.empty?
+    assert_not_empty show_response
     assert_equal host.expired_on, show_response['expired_on'].to_date
   end
 end

data/test/functional/concerns/hosts_controller_extensions_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class HostsControllerTest < ActionController::TestCase
@@ -68,7 +70,7 @@ class HostsControllerTest < ActionController::TestCase
     test 'should set expiration date' do
       expiration_date = Date.today + 14
       params = { :host_ids => @hosts.map(&:id),
-                 :host => { :expired_on => expiration_date } }
+                 :host => { 'expired_on(1i)' => expiration_date.day.to_s, 'expired_on(2i)' => expiration_date.month.to_s, 'expired_on(3i)' => expiration_date.year.to_s } }
 
       post :update_multiple_expiration, params: params, session: set_session_user.merge(:user => users(:admin).id)
 

data/test/helpers/hosts_helper_test.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class HostsHelperTest < ActionView::TestCase
   include HostsHelper
+  include HostDescriptionHelper
+  include PuppetRelatedHelper
+  include ForemanExpireHosts::HostsHelper
   include ApplicationHelper
 
   describe '#multiple_actions' do

data/test/lib/expire_hosts_notifications_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 require 'notifications_test_helper'
 
@@ -61,17 +63,22 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
     context 'with additional recipients' do
       setup do
         Setting[:host_expiry_email_recipients] = 'test@example.com, test2.example.com'
-        FactoryBot.create_list(:host, 2, :expired, :owner => user)
       end
 
       test 'should deliver notification to additional recipients' do
+        FactoryBot.create_list(:host, 2, :expired, :owner => user)
         ExpireHostsNotifications.delete_expired_hosts
-        assert_equal 3, ActionMailer::Base.deliveries.count
+        assert_equal 2, ActionMailer::Base.deliveries.count
         assert_includes ActionMailer::Base.deliveries.first.subject, 'Deleted expired hosts'
         assert_includes ActionMailer::Base.deliveries.flat_map(&:to), user.mail
         assert_includes ActionMailer::Base.deliveries.flat_map(&:to), 'test@example.com'
         assert_includes ActionMailer::Base.deliveries.flat_map(&:to), 'test2.example.com'
       end
+
+      test 'should not deliver a mail notification for empty host list' do
+        ExpireHostsNotifications.delete_expired_hosts
+        assert_equal 0, ActionMailer::Base.deliveries.count
+      end
     end
   end
 
@@ -100,12 +107,35 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
       end
     end
 
+    test 'should send no message if host is already be stopped' do
+      power_mock.stubs(:ready?).returns(false)
+      ExpireHostsNotifications.stop_expired_hosts
+      assert_equal 0, ActionMailer::Base.deliveries.count
+    end
+
     test 'should send failure message if host cannot be stopped' do
       power_mock.expects(:stop).returns(false)
       ExpireHostsNotifications.stop_expired_hosts
       assert_equal 1, ActionMailer::Base.deliveries.count
       assert_includes ActionMailer::Base.deliveries.first.subject, 'Failed to stop expired hosts'
     end
+
+    context 'with a host expiring today' do
+      let(:host) { FactoryBot.create(:host, :expires_today, :on_compute_resource, :owner => user) }
+      let(:delete_date) { Date.today + Setting[:days_to_delete_after_host_expiration].to_i }
+
+      it 'should stop the host and show the correct delete date' do
+        power_mock.expects(:stop).returns(true)
+        ExpireHostsNotifications.stop_expired_hosts
+        assert_equal 1, ActionMailer::Base.deliveries.count
+        assert_includes ActionMailer::Base.deliveries.first.subject, 'Stopped expired hosts'
+        assert_includes ActionMailer::Base.deliveries.first.body, "These hosts will be destroyed on #{delete_date}."
+
+        travel_to delete_date do
+          assert_includes Host.expired_past_grace_period, host
+        end
+      end
+    end
   end
 
   context '#deliver_expiry_warning_notification' do
@@ -114,59 +144,75 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
 
     setup do
       Setting['notify1_days_before_host_expiry'] = 7
-      hosts
     end
 
-    test 'should send a ui notification per host' do
-      assert_difference('blueprint.notifications.count', 2) do
+    context 'with expired hosts' do
+      setup do
+        hosts
+      end
+
+      test 'should send a ui notification per host' do
+        assert_difference('blueprint.notifications.count', 2) do
+          ExpireHostsNotifications.deliver_expiry_warning_notification
+        end
+        hosts.each do |host|
+          notification = Notification.find_by(
+            notification_blueprint_id: blueprint.id,
+            subject_id: host.id,
+            subject_type: 'Host::Base'
+          )
+          assert_equal 1, notification.notification_recipients.where(user_id: user.id).count
+        end
+      end
+
+      test 'should redisplay read ui notification' do
+        ExpireHostsNotifications.deliver_expiry_warning_notification
+        notification = Notification.find_by(notification_blueprint_id: blueprint.id, subject_id: hosts.first.id)
+        assert_not_nil notification
+        assert_equal 1, NotificationRecipient.where(notification_id: notification.id).update_all(seen: true)
         ExpireHostsNotifications.deliver_expiry_warning_notification
+        assert_equal 1, NotificationRecipient.where(notification_id: notification.id, seen: false).count
       end
-      hosts.each do |host|
-        notification = Notification.find_by(
-          notification_blueprint_id: blueprint.id,
-          subject_id: host.id,
-          subject_type: 'Host::Base'
-        )
-        assert_equal 1, notification.notification_recipients.where(user_id: user.id).count
+
+      test 'should send a single notification' do
+        ExpireHostsNotifications.deliver_expiry_warning_notification
+        assert_equal 1, ActionMailer::Base.deliveries.count
+        assert_includes ActionMailer::Base.deliveries.first.subject, 'Expiring hosts in foreman'
       end
-    end
 
-    test 'should redisplay read ui notification' do
-      ExpireHostsNotifications.deliver_expiry_warning_notification
-      notification = Notification.find_by(notification_blueprint_id: blueprint.id, subject_id: hosts.first.id)
-      assert_not_nil notification
-      assert_equal 1, NotificationRecipient.where(notification_id: notification.id).update_all(seen: true) # rubocop:disable Rails/SkipsModelValidations
-      ExpireHostsNotifications.deliver_expiry_warning_notification
-      assert_equal 1, NotificationRecipient.where(notification_id: notification.id, seen: false).count
-    end
+      test 'should send two notifications for two users' do
+        owner2 = FactoryBot.create(:user, :with_mail)
+        FactoryBot.create(:host, :expires_in_a_week, :owner => owner2)
+        ExpireHostsNotifications.deliver_expiry_warning_notification
+        assert_equal 2, ActionMailer::Base.deliveries.count
+        assert_includes ActionMailer::Base.deliveries.first.subject, 'Expiring hosts in foreman'
+        assert_includes ActionMailer::Base.deliveries.last.subject, 'Expiring hosts in foreman'
+      end
 
-    test 'should send a single notification' do
-      ExpireHostsNotifications.deliver_expiry_warning_notification
-      assert_equal 1, ActionMailer::Base.deliveries.count
-      assert_includes ActionMailer::Base.deliveries.first.subject, 'Expiring hosts in foreman'
+      test 'should send three notifications for three users' do
+        user2 = FactoryBot.create(:user, :with_mail)
+        user3 = FactoryBot.create(:user, :with_mail, :usergroups => [usergroup])
+        FactoryBot.create(:host, :expires_in_a_week, :owner => user2)
+        FactoryBot.create(:host, :expires_in_a_week, :owner => usergroup)
+        ExpireHostsNotifications.deliver_expiry_warning_notification
+        assert_equal 3, ActionMailer::Base.deliveries.count
+        assert_includes ActionMailer::Base.deliveries.first.subject, 'Expiring hosts in foreman'
+        assert_includes ActionMailer::Base.deliveries.flat_map(&:to), user.mail
+        assert_includes ActionMailer::Base.deliveries.flat_map(&:to), user2.mail
+        assert_includes ActionMailer::Base.deliveries.flat_map(&:to), user3.mail
+        assert_equal 1, ActionMailer::Base.deliveries.flat_map(&:subject).uniq.count
+      end
     end
 
-    test 'should send two notifications for two users' do
-      owner2 = FactoryBot.create(:user, :with_mail)
-      FactoryBot.create(:host, :expires_in_a_week, :owner => owner2)
-      ExpireHostsNotifications.deliver_expiry_warning_notification
-      assert_equal 2, ActionMailer::Base.deliveries.count
-      assert_includes ActionMailer::Base.deliveries.first.subject, 'Expiring hosts in foreman'
-      assert_includes ActionMailer::Base.deliveries.last.subject, 'Expiring hosts in foreman'
-    end
+    context 'with additional recipients' do
+      setup do
+        Setting[:host_expiry_email_recipients] = 'test@example.com, test2.example.com'
+      end
 
-    test 'should send three notifications for three users' do
-      user2 = FactoryBot.create(:user, :with_mail)
-      user3 = FactoryBot.create(:user, :with_mail, :usergroups => [usergroup])
-      FactoryBot.create(:host, :expires_in_a_week, :owner => user2)
-      FactoryBot.create(:host, :expires_in_a_week, :owner => usergroup)
-      ExpireHostsNotifications.deliver_expiry_warning_notification
-      assert_equal 3, ActionMailer::Base.deliveries.count
-      assert_includes ActionMailer::Base.deliveries.first.subject, 'Expiring hosts in foreman'
-      assert_includes ActionMailer::Base.deliveries.flat_map(&:to), user.mail
-      assert_includes ActionMailer::Base.deliveries.flat_map(&:to), user2.mail
-      assert_includes ActionMailer::Base.deliveries.flat_map(&:to), user3.mail
-      assert_equal 1, ActionMailer::Base.deliveries.flat_map(&:subject).uniq.count
+      test 'should not send empty reminders' do
+        ExpireHostsNotifications.deliver_expiry_warning_notification
+        assert_equal 0, ActionMailer::Base.deliveries.count
+      end
     end
   end
 end

data/test/test_plugin_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
 require 'database_cleaner'

data/test/unit/concerns/host_extensions_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
@@ -26,7 +28,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
 
     test 'should require expired on' do
       host = FactoryBot.build(:host)
-      refute host.valid?, "Can not be valid without expiration date: #{host.errors.messages}"
+      assert_not host.valid?, "Can not be valid without expiration date: #{host.errors.messages}"
       assert_includes host.errors.messages.keys, :expired_on
     end
   end
@@ -99,23 +101,23 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should not expire' do
-      refute @host.expires?
+      assert_not @host.expires?
     end
 
     test 'should not expire today' do
-      refute @host.expires_today?
+      assert_not @host.expires_today?
     end
 
     test 'should not be expired' do
-      refute @host.expired?
+      assert_not @host.expired?
     end
 
     test 'should not be expired past grace period' do
-      refute @host.expired_past_grace_period?
+      assert_not @host.expired_past_grace_period?
     end
 
     test 'should not be pending expiration' do
-      refute @host.pending_expiration?
+      assert_not @host.pending_expiration?
     end
 
     test 'should not be in any expiration scopes' do
@@ -133,7 +135,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should not expire today' do
-      refute @host.expires_today?
+      assert_not @host.expires_today?
     end
 
     test 'should be expired' do
@@ -145,7 +147,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should not be pending expiration' do
-      refute @host.pending_expiration?
+      assert_not @host.pending_expiration?
     end
 
     test 'should only exist in correct scopes' do
@@ -168,11 +170,11 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should not be expired' do
-      refute @host.expired?
+      assert_not @host.expired?
     end
 
     test 'should not be expired past grace period' do
-      refute @host.expired_past_grace_period?
+      assert_not @host.expired_past_grace_period?
     end
 
     test 'should be pending expiration' do
@@ -180,7 +182,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should only exist in correct scopes' do
-      exists_only_in_scopes(@host, ['expiring', 'expiring_today'])
+      exists_only_in_scopes(@host, ['expiring', 'expired', 'expiring_today'])
     end
   end
 
@@ -195,19 +197,19 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should not expire today' do
-      refute @host.expires_today?
+      assert_not @host.expires_today?
     end
 
     test 'should not be expired' do
-      refute @host.expired?
+      assert_not @host.expired?
     end
 
     test 'should not be expired past grace period' do
-      refute @host.expired_past_grace_period?
+      assert_not @host.expired_past_grace_period?
     end
 
     test 'should not be pending expiration' do
-      refute @host.pending_expiration?
+      assert_not @host.pending_expiration?
     end
 
     test 'should only exist in correct scopes' do
@@ -225,7 +227,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should not expire today' do
-      refute @host.expires_today?
+      assert_not @host.expires_today?
     end
 
     test 'should be expired' do
@@ -233,11 +235,11 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should not be expired past grace period' do
-      refute @host.expired_past_grace_period?
+      assert_not @host.expired_past_grace_period?
     end
 
     test 'should not be pending expiration' do
-      refute @host.pending_expiration?
+      assert_not @host.pending_expiration?
     end
 
     test 'should only exist in correct scopes' do
@@ -250,7 +252,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
   def exists_only_in_scopes(host, valid_scopes)
     host.save(validate: false)
     (EXPIRATION_SCOPES - valid_scopes).each do |scope|
-      refute Host::Managed.send(scope).exists?(host.id), "Host should not exist in #{scope} scope"
+      assert_not Host::Managed.send(scope).exists?(host.id), "Host should not exist in #{scope} scope"
     end
     valid_scopes.each do |scope|
       assert Host::Managed.send(scope).exists?(host.id), "Host should exist in #{scope} scope"