foreman_expire_hosts 3.0.0 → 4.0.0

data/foreman_expire_hosts.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |s|
 
   s.require_paths = ['lib']
 
-  s.add_dependency 'deface'
   s.add_dependency 'bootstrap-datepicker-rails'
+  s.add_dependency 'deface'
 
-  s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'rubocop', '0.51.0'
 end

data/lib/expire_hosts_notifications.rb

@@ -1,120 +1,23 @@
 module ExpireHostsNotifications
   class << self
-
-    def admin_email
-      [(Setting[:host_expiry_email_recipients] || Setting[:administrator])]
-    end
-
-    def days_to_delete_after_expired
-      Setting[:days_to_delete_after_host_expiration].to_i
-    end
-
-    def catch_delivery_errors(message, hosts = [])
-      yield
-    rescue => error
-      message = _('%{message} for Hosts %{hosts}') % {:message => message, :hosts => hosts.map(&:name).to_sentence}
-      Foreman::Logging.exception(message, error)
-    end
-
-    # This method to deliver deleted host details to its owner
     def delete_expired_hosts
-      deletable_hosts     = Host.expired_past_grace_period
-      failed_delete_hosts = []
-      deleted_hosts       = []
-      deletable_hosts.each do |deletable_host|
-        Rails.logger.info "Deleting expired host #{deletable_host}"
-        deletable_host.audit_comment = _('Destroyed since it got expired on %s') % deletable_host.expired_on
-        if deletable_host.destroy
-          deleted_hosts << deletable_host
-        else
-          failed_delete_hosts << deletable_host
-        end
-      end
-      unless deleted_hosts.empty?
-        ExpireHostsNotifications.hosts_by_user(deleted_hosts).each do |user_id, hosts_hash|
-          catch_delivery_errors(_('Failed to deliver deleted hosts notification'), deleted_hosts) do
-            ExpireHostsMailer.deleted_hosts_notification(hosts_hash['email'], hosts_hash['hosts']).deliver_now
-          end
-        end
-      end
-      return if failed_delete_hosts.empty?
-      catch_delivery_errors(_('Failed to deliver deleted hosts notification failed status'), failed_delete_hosts) do
-        ExpireHostsMailer.failed_to_delete_hosts_notification(self.admin_email, failed_delete_hosts).deliver_now
-      end
+      ForemanExpireHosts::Action::DeleteExpiredHosts.new.engage
     end
 
     def stop_expired_hosts
-      stoppable_hosts   = Host.expired
-      failed_stop_hosts = []
-      stopped_hosts     = []
-      stoppable_hosts.each do |stoppable_host|
-        next unless stoppable_host.supports_power_and_running?
-        Rails.logger.info "Powering down expired host in grace period #{stoppable_host}"
-        host_status = begin
-          stoppable_host.power.stop
-        rescue
-          false
-        end
-        if host_status
-          stopped_hosts << stoppable_host
-        else
-          failed_stop_hosts << stoppable_host
-        end
-      end
-      unless stopped_hosts.empty?
-        delete_date = (Date.today + self.days_to_delete_after_expired.to_i)
-        hosts_by_user(stopped_hosts).each do |user_id, hosts_hash|
-          catch_delivery_errors(_('Failed to deliver stopped hosts notification'), stopped_hosts) do
-            ExpireHostsMailer.stopped_hosts_notification(hosts_hash['email'], delete_date, hosts_hash['hosts']).deliver_now
-          end
-        end
-      end
-      return if failed_stop_hosts.empty?
-      catch_delivery_errors(_('Failed to deliver stopped hosts notification failed status'), failed_stop_hosts) do
-        ExpireHostsMailer.failed_to_stop_hosts_notification(self.admin_email, failed_stop_hosts).deliver_now
-      end
+      ForemanExpireHosts::Action::StopExpiredHosts.new.engage
     end
 
     def deliver_expiry_warning_notification(num = 1) # notify1_days_before_expiry
       return unless [1, 2].include?(num)
       days_before_expiry = Setting["notify#{num}_days_before_host_expiry"].to_i
       expiry_date        = (Date.today + days_before_expiry)
-      notifiable_hosts   = Host.with_expire_date(expiry_date)
-      return if notifiable_hosts.empty?
-      hosts_by_user(notifiable_hosts).each do |user_id, hosts_hash|
-        catch_delivery_errors(_('Failed to deliver expiring hosts notification'), notifiable_hosts) do
-          ExpireHostsMailer.expiry_warning_notification(hosts_hash['email'], expiry_date, hosts_hash['hosts']).deliver_now
-        end
-      end
-    end
+      notifiable_hosts   = Host.with_expire_date(expiry_date).preload(:owner)
 
-    def hosts_by_user(hosts)
-      emails     = self.admin_email
-      hosts_hash = {}
-      hosts.each do |host|
-        if host.owner_type == 'User'
-          unless hosts_hash.key?(host.owner_id.to_s)
-            email_recipients = emails + [host.owner.mail]
-            hosts_hash[host.owner_id.to_s] = { 'id' => host.owner_id, 'name' => host.owner.name, 'email' => email_recipients, 'hosts' => [] }
-          end
-          hosts_hash[host.owner_id.to_s]['hosts'] << host
-        elsif host.owner_type == 'Usergroup'
-          host.owner.users.each do |owner|
-            unless hosts_hash.key?(owner.id.to_s)
-              email_recipients = emails + [owner.mail]
-              hosts_hash[owner.id.to_s] = { 'id' => owner.id, 'name' => owner.name, 'email' => email_recipients, 'hosts' => [] }
-            end
-            hosts_hash[owner.id.to_s]['hosts'] << host
-          end
-        else
-          email = (!emails.empty? ? emails : [Setting[:administrator]])
-          unless hosts_hash.key?(owner.id.to_s)
-            hosts_hash['admin'] = { 'id' => nil, 'name' => 'Admin', 'email' => email, 'hosts' => [] }
-          end
-          hosts_hash['admin']['hosts'] << host
-        end
-      end
-      hosts_hash
+      ForemanExpireHosts::Notification::ExpiryWarning.new(
+        :hosts => notifiable_hosts,
+        :expiry_date => expiry_date
+      ).deliver
     end
   end
 end

data/lib/foreman_expire_hosts/engine.rb

@@ -9,6 +9,7 @@ module ForemanExpireHosts
     config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
     config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
     config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/services"]
 
     # Add any db migrations
     initializer 'foreman_plugin_template.load_app_instance_data' do |app|
@@ -21,22 +22,21 @@ module ForemanExpireHosts
       require_dependency File.expand_path('../../../app/models/setting/expire_hosts.rb', __FILE__) if (Setting.table_exists? rescue(false))
     end
 
-    initializer 'foreman_expire_hosts.register_plugin', :before => :finisher_hook do |app|
+    initializer 'foreman_expire_hosts.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_expire_hosts do
-        requires_foreman '>= 1.15'
+        requires_foreman '>= 1.16'
         register_custom_status HostStatus::ExpirationStatus
 
         # strong parameters
         parameter_filter Host::Managed, :expired_on
 
-        security_block :hosts do
-          permission :edit_hosts, {:hosts => [:select_multiple_expiration, :update_multiple_expiration]}
-        end
-
         security_block :foreman_expire_hosts do
           permission :edit_host_expiry,
                      {},
                      :resource_type => 'Host'
+          permission :edit_hosts,
+                     { :hosts => [:select_multiple_expiration, :update_multiple_expiration] },
+                     :resource_type => 'Host'
         end
       end
     end
@@ -45,13 +45,19 @@ module ForemanExpireHosts
       begin
         Host::Managed.send :include, ForemanExpireHosts::HostExt
         HostsHelper.send :include, ForemanExpireHosts::HostsHelperExtensions
-        HostsController.send :include, ForemanExpireHosts::HostControllerExtensions
+        HostsController.send :prepend, ForemanExpireHosts::HostControllerExtensions
         AuditsHelper.send :include, ForemanExpireHosts::AuditsHelperExtensions
-      rescue => e
+      rescue StandardError => e
         Rails.logger.warn "ForemanExpireHosts: skipping engine hook (#{e})"
       end
     end
 
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanExpireHosts::Engine.load_seed
+      end
+    end
+
     # Precompile any JS or CSS files under app/assets/
     # If requiring files from each other, list them explicitly here to avoid precompiling the same
     # content twice.

data/lib/foreman_expire_hosts/version.rb

@@ -1,3 +1,3 @@
 module ForemanExpireHosts
-  VERSION = '3.0.0'.freeze
+  VERSION = '4.0.0'.freeze
 end

data/lib/tasks/expired_hosts.rake

@@ -2,10 +2,12 @@
 namespace :expired_hosts do
   desc 'Delete all expired hosts, send notification email about expiring hosts'
   task :deliver_notifications => :environment do
-    ExpireHostsNotifications.delete_expired_hosts
-    ExpireHostsNotifications.stop_expired_hosts
-    ExpireHostsNotifications.deliver_expiry_warning_notification(1)
-    ExpireHostsNotifications.deliver_expiry_warning_notification(2)
+    User.as_anonymous_admin do
+      ExpireHostsNotifications.delete_expired_hosts
+      ExpireHostsNotifications.stop_expired_hosts
+      ExpireHostsNotifications.deliver_expiry_warning_notification(1)
+      ExpireHostsNotifications.deliver_expiry_warning_notification(2)
+    end
   end
 end
 
@@ -30,7 +32,7 @@ namespace :foreman_expire_hosts do
                          "#{ForemanExpireHosts::Engine.root}/lib/**/*.rb",
                          "#{ForemanExpireHosts::Engine.root}/test/**/*.rb"]
       end
-    rescue
+    rescue StandardError
       puts 'Rubocop not loaded.'
     end
 

data/test/factories/foreman_expire_hosts_factories.rb

@@ -1,4 +1,4 @@
-FactoryGirl.modify do
+FactoryBot.modify do
   factory :host do
     trait :without_validation do
       # Turn off validation so we can create a host with an expiry date in the past

data/test/functional/concerns/hosts_controller_extensions_test.rb

@@ -40,11 +40,11 @@ class HostsControllerTest < ActionController::TestCase
   end
 
   describe 'updating a host' do
-    let(:host) { FactoryGirl.create(:host) }
+    let(:host) { FactoryBot.create(:host) }
 
     test 'should add expiration date to host' do
       expiration_date = Date.today + 14
-      put :update, { :id => host.name, :host => {:expired_on => expiration_date} }, set_session_user
+      put :update, { :id => host.name, :host => { :expired_on => expiration_date } }, set_session_user
       h = Host.find(host.id)
       assert_equal expiration_date, h.expired_on
     end
@@ -53,16 +53,18 @@ class HostsControllerTest < ActionController::TestCase
   describe 'setting expiration date on multiple hosts' do
     before do
       as_admin do
-        @hosts = FactoryGirl.create_list(:host, 2, :with_puppet)
+        @hosts = FactoryBot.create_list(:host, 2, :with_puppet)
       end
       @request.env['HTTP_REFERER'] = hosts_path
     end
 
     test 'show a host selection' do
       host_ids = @hosts.map(&:id)
-      xhr :post, :select_multiple_expiration, {:host_ids => host_ids}, set_session_user
+      xhr :post, :select_multiple_expiration, { :host_ids => host_ids }, set_session_user
       assert_response :success
-      assert response.body =~ /#{@hosts.first.name}.*#{@hosts.last.name}/m
+      @hosts.each do |host|
+        assert response.body =~ /#{host.name}/m
+      end
     end
 
     test 'should set expiration date' do
@@ -90,7 +92,7 @@ class HostsControllerTest < ActionController::TestCase
       assert_empty flash[:error]
 
       @hosts.each do |host|
-        assert_equal nil, host.reload.expired_on
+        assert_nil host.reload.expired_on
       end
     end
   end

data/test/lib/expire_hosts_notifications_test.rb

@@ -1,76 +1,172 @@
 require 'test_plugin_helper'
+require 'notifications_test_helper'
 
 class ExpireHostsNotificationsTest < ActiveSupport::TestCase
+  include NotificationBlueprintSeeds
+
   setup do
     setup_settings
-    @owner = FactoryGirl.create(:user, :with_mail)
+    ActionMailer::Base.deliveries.clear
   end
 
+  let(:user) { FactoryBot.create(:user, :with_usergroup, :with_mail) }
+  let(:usergroup) { user.usergroups.first }
+
   context '#delete_expired_hosts' do
-    setup do
-      @hosts = FactoryGirl.create_list(:host, 2, :expired, :owner => @owner)
-      @unaffected_hosts = FactoryGirl.create_list(:host, 2, :owner => @owner)
+    context 'with single owner' do
+      setup do
+        FactoryBot.create_list(:host, 2, :expired, :owner => user)
+        FactoryBot.create_list(:host, 2, :owner => user)
+      end
+
+      test 'should delete expired hosts' do
+        assert_difference 'Host.count', -2 do
+          ExpireHostsNotifications.delete_expired_hosts
+        end
+        assert_equal 1, ActionMailer::Base.deliveries.count
+        assert_includes ActionMailer::Base.deliveries.first.subject, 'Deleted expired hosts'
+      end
     end
 
-    test 'should delete expired hosts' do
-      ExpireHostsMailer.expects(:deleted_hosts_notification).once
-      assert_difference 'Host.count', -2 do
+    context 'with usergroup owner' do
+      setup do
+        FactoryBot.create_list(:host, 2, :expired, :owner => usergroup)
+        FactoryBot.create_list(:host, 2, :owner => usergroup)
+      end
+
+      test 'should delete expired hosts' do
+        assert_difference 'Host.count', -2 do
+          ExpireHostsNotifications.delete_expired_hosts
+        end
+        assert_equal 1, ActionMailer::Base.deliveries.count
+        assert_includes ActionMailer::Base.deliveries.first.subject, 'Deleted expired hosts'
+      end
+    end
+
+    context 'without owner' do
+      setup do
+        FactoryBot.create_list(:host, 2, :expired, :without_owner)
+        FactoryBot.create_list(:host, 2, :without_owner)
+      end
+
+      test 'should delete expired hosts' do
+        assert_difference 'Host.count', -2 do
+          ExpireHostsNotifications.delete_expired_hosts
+        end
+        assert_equal 1, ActionMailer::Base.deliveries.count
+        assert_includes ActionMailer::Base.deliveries.first.subject, 'Deleted expired hosts'
+      end
+    end
+
+    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
         ExpireHostsNotifications.delete_expired_hosts
+        assert_equal 3, 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
     end
   end
 
   context '#stop_expired_hosts' do
+    let(:power_mock) { mock('power') }
+    let(:host) { FactoryBot.create(:host, :expired, :on_compute_resource, :owner => user) }
+    let(:blueprint) { NotificationBlueprint.find_by(name: 'expire_hosts_stopped_host') }
     setup do
-      @power_mock = mock('power')
-      @power_mock.stubs(:ready?).returns(true)
-      @host = FactoryGirl.create(:host, :expired, :on_compute_resource, :owner => @owner)
-      @host.unstub(:queue_compute)
-      Host.any_instance.stubs(:power).returns(@power_mock)
-      @unaffected_hosts = FactoryGirl.create_list(:host, 2, :owner => @owner)
+      power_mock.stubs(:ready?).returns(true)
+      host.unstub(:queue_compute)
+      Host.any_instance.stubs(:power).returns(power_mock)
+      FactoryBot.create_list(:host, 2, :owner => user)
     end
 
     test 'should stop expired hosts' do
-      @power_mock.expects(:stop).returns(true)
-      ExpireHostsMailer.expects(:stopped_hosts_notification).once
+      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'
+    end
+
+    test 'should send a ui notification per stopped host' do
+      power_mock.expects(:stop).returns(true)
+      assert_difference('blueprint.notifications.count', 1) do
+        ExpireHostsNotifications.stop_expired_hosts
+      end
     end
 
     test 'should send failure message if host cannot be stopped' do
-      @power_mock.expects(:stop).returns(false)
-      ExpireHostsMailer.expects(:failed_to_stop_hosts_notification).once
+      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
   end
 
   context '#deliver_expiry_warning_notification' do
+    let(:blueprint) { NotificationBlueprint.find_by(name: 'expire_hosts_expiry_warning') }
+    let(:hosts) { FactoryBot.create_list(:host, 2, :expires_in_a_week, :owner => user) }
+
     setup do
       Setting['notify1_days_before_host_expiry'] = 7
-      @hosts = FactoryGirl.create_list(:host, 2, :expires_in_a_week, :owner => @owner)
+      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) # 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 a single notification' do
-      ExpireHostsMailer.expects(:expiry_warning_notification).once
       ExpireHostsNotifications.deliver_expiry_warning_notification
+      assert_equal 1, ActionMailer::Base.deliveries.count
+      assert_includes ActionMailer::Base.deliveries.first.subject, 'Expiring hosts in foreman'
     end
 
     test 'should send two notifications for two users' do
-      owner2 = FactoryGirl.create(:user, :with_mail)
-      FactoryGirl.create(:host, :expires_in_a_week, :owner => owner2)
-      ExpireHostsMailer.expects(:expiry_warning_notification).twice
+      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
-  end
 
-  context '#catch_delivery_errors' do
-    test 'should catch and log errors' do
-      host1 = OpenStruct.new(:name => 'Alpha')
-      host2 = OpenStruct.new(:name => 'Bravo')
-      hosts = [host1, host2]
-      Foreman::Logging.expects(:exception).with('failure for Hosts Alpha and Bravo', anything)
-      ExpireHostsNotifications.catch_delivery_errors('failure', hosts) do
-        raise 'Test'
-      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
     end
   end
 end