foreman_expire_hosts 9.0.1 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 839f503c394a7967c2a50c93f13197c83b4b9a7a304fbff46721f9416936c8f7
-  data.tar.gz: 916041f719b68174a64b3337cfcecbbfd2c0552ae60a5c235cff3701c977331f
+  metadata.gz: 704970044c55500da0bcca9ef42066764812aa84b64725c76a432ddea9f21b41
+  data.tar.gz: 9825c6fac28b05e41c8697eaa9b5c328774c3f551c5b629ccd199fe2c2ca0ccc
 SHA512:
-  metadata.gz: cc344d2888bdc7df2471cbdaba3b9236c40e74ae24b2f96cfa38d49188d574beff34ec25d1028b60607083159d99463c2a7916b3dbc212a5f40b962ccf3ff75b
-  data.tar.gz: ff4a9af4cba0aaee10361997aa5b714240e83da4d1bb6b17bc2a421867615d1562821c6e6508a0212bdf2abb4673c4f430598375cd0252d74ef97170b0c5031a
+  metadata.gz: fec4331e4a2fc0d952474e47d1de508716245e41c87c63c0b5ed4d9375f4888ccc9673adbfbd8742d0ffbf700512df64aa86505c400854f26cfb78aee38e21ee
+  data.tar.gz: dbbc883d8537ac7d40509f35f9c8877174f73f230e4bbe3eeb2fde0786ebdcf7e41926bca755558ec384446496d9e6673421fe78eed3101ab63cf5e7c987e260

data/app/controllers/concerns/foreman_expire_hosts/api/v2/hosts_controller_extensions.rb

@@ -8,7 +8,7 @@ module ForemanExpireHosts
 
         update_api(:create, :update) do
           param :host, Hash do
-            param :expired_on, String, :desc => 'Expiry date'
+            param :expired_on, String, desc: 'Expiry date'
           end
         end
       end

data/app/controllers/concerns/foreman_expire_hosts/host_controller_extensions.rb

@@ -4,30 +4,31 @@ module ForemanExpireHosts
   module HostControllerExtensions
     def self.prepended(base)
       base.class_eval do
-        before_action :validate_multiple_expiration, :only => :update_multiple_expiration
-        before_action :find_multiple_with_expire_hosts, :only => [:select_multiple_expiration, :update_multiple_expiration]
+        before_action :validate_multiple_expiration, only: :update_multiple_expiration
+        before_action :find_multiple_with_expire_hosts,
+          only: %i[select_multiple_expiration update_multiple_expiration]
         alias_method :find_multiple_with_expire_hosts, :find_multiple
       end
     end
 
-    def select_multiple_expiration; end
+    def select_multiple_expiration
+    end
 
     def update_multiple_expiration
       failed_hosts = {}
 
       @hosts.each do |host|
-        begin
-          host.expired_on = expiration_date
-          host.save!
-        rescue StandardError => e
-          failed_hosts[host.name] = e
-          message = if expiration_date.present?
-                      _('Failed to set expiration date for %{host} to %{expiration_date}.') % { :host => host, :expiration_date => l(expiration_date) }
-                    else
-                      _('Failed to clear expiration date for %s.') % host
-                    end
-          Foreman::Logging.exception(message, e)
-        end
+        host.expired_on = expiration_date
+        host.save!
+      rescue StandardError => e
+        failed_hosts[host.name] = e
+        message = if expiration_date.present?
+                    format(_('Failed to set expiration date for %{host} to %{expiration_date}.'), host: host,
+                                                                                                  expiration_date: l(expiration_date))
+                  else
+                    _('Failed to clear expiration date for %s.') % host
+                  end
+        Foreman::Logging.exception(message, e)
       end
 
       if failed_hosts.empty?
@@ -38,8 +39,8 @@ module ForemanExpireHosts
         end
       else
         error n_('The expiration date could not be set for host: %s.',
-                 'The expiration date could not be set for hosts: %s.',
-                 failed_hosts.count) % failed_hosts.map { |h, err| "#{h} (#{err})" }.to_sentence
+          'The expiration date could not be set for hosts: %s.',
+          failed_hosts.count) % failed_hosts.map { |h, err| "#{h} (#{err})" }.to_sentence
       end
       redirect_back_or_to hosts_path
     end

data/app/helpers/foreman_expire_hosts/hosts_helper.rb

@@ -4,10 +4,10 @@ module ForemanExpireHosts
   module HostsHelper
     def expire_hosts_host_multiple_actions
       actions = []
-      if authorized_for(:controller => :hosts, :action => :select_multiple_expiration)
+      if authorized_for(controller: :hosts, action: :select_multiple_expiration)
         actions << {
           action: [_('Change Expiration'), select_multiple_expiration_hosts_path],
-          priority: 200
+          priority: 200,
         }
       end
       actions
@@ -19,11 +19,13 @@ module ForemanExpireHosts
       if host.expired_past_grace_period?
         message = _('This host has expired %s ago and needs to be deleted manually.') % time_ago_in_words(host.expired_on)
       elsif host.expired?
-        message = _('This host has expired %{time_ago} ago and will be deleted on %{delete_date}.') % { :delete_date => l(host.expiration_grace_period_end_date), :time_ago => time_ago_in_words(host.expired_on) }
+        message = format(_('This host has expired %{time_ago} ago and will be deleted on %{delete_date}.'),
+          delete_date: l(host.expiration_grace_period_end_date), time_ago: time_ago_in_words(host.expired_on))
       elsif host.expires_today?
         message = _('This host will expire today.')
       elsif host.pending_expiration?
-        message = _('This host will expire in %{distance_of_time} (on %{expire_date}).') % { :expire_date => l(host.expired_on), :distance_of_time => future_time_in_words(host.expired_on) }
+        message = format(_('This host will expire in %{distance_of_time} (on %{expire_date}).'),
+          expire_date: l(host.expired_on), distance_of_time: future_time_in_words(host.expired_on))
       end
       message
     end

data/app/lib/expire_hosts_notifications.rb

@@ -19,8 +19,8 @@ module ExpireHostsNotifications
       notifiable_hosts   = Host.with_expire_date(expiry_date).preload(:owner)
 
       ForemanExpireHosts::Notification::ExpiryWarning.new(
-        :hosts => notifiable_hosts,
-        :expiry_date => expiry_date
+        hosts: notifiable_hosts,
+        expiry_date: expiry_date
       ).deliver
     end
   end

data/app/mailers/expire_hosts_mailer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class ExpireHostsMailer < ApplicationMailer
-  default :content_type => 'text/html', :from => Setting[:email_reply_address] || 'noreply@your-foreman.com'
+  default content_type: 'text/html', from: Setting[:email_reply_address] || 'noreply@your-foreman.com'
 
   def deleted_hosts_notification(recipient, hosts)
     build_mail(
@@ -54,16 +54,16 @@ class ExpireHostsMailer < ApplicationMailer
     user = user_for_recipient(recipient)
     @hosts = hosts
     @authorized_for_expiry_date_change = ForemanExpireHosts::ExpiryEditAuthorizer.new(
-      :user => user,
-      :hosts => hosts
+      user: user,
+      hosts: hosts
     ).authorized?
     set_locale_for(user) do
       mail(
-        :to => recipient_mail(recipient),
-        :subject => _(subject),
-        :importance => 'High'
+        to: recipient_mail(recipient),
+        subject: _(subject),
+        importance: 'High'
       ) do |format|
-        format.html { render :layout => 'application_mailer' }
+        format.html { render layout: 'application_mailer' }
       end
     end
   end

data/app/models/concerns/foreman_expire_hosts/host_ext.rb

@@ -7,32 +7,33 @@ module ForemanExpireHosts
     included do
       after_validation :validate_expired_on
 
-      validates :expired_on, :presence => true, :if => -> { Setting[:is_host_expiry_date_mandatory] }
+      validates :expired_on, presence: true, if: -> { Setting[:is_host_expiry_date_mandatory] }
 
-      has_one :expiration_status_object, :class_name => 'HostStatus::ExpirationStatus', :foreign_key => 'host_id', :inverse_of => :host
+      has_one :expiration_status_object, class_name: 'HostStatus::ExpirationStatus', foreign_key: 'host_id',
+                                         inverse_of: :host
 
       before_validation :refresh_expiration_status
 
-      scope :expiring, -> { where('expired_on IS NOT NULL') }
-      scope :with_expire_date, ->(date) { expiring.where('expired_on = ?', date) }
+      scope :expiring, -> { where.not(expired_on: nil) }
+      scope :with_expire_date, ->(date) { expiring.where(expired_on: date) }
       scope :expired, -> { expiring.where('expired_on <= ?', Date.today) }
       scope :expiring_today, -> { expiring.with_expire_date(Date.today) }
-      scope :expired_past_grace_period, -> { expiring.where('expired_on <= ?', Date.today - Setting[:days_to_delete_after_host_expiration].to_i) }
+      scope :expired_past_grace_period, lambda {
+                                          expiring.where('expired_on <= ?', Date.today - Setting[:days_to_delete_after_host_expiration].to_i)
+                                        }
 
-      scoped_search :on => :expired_on, :complete_value => true, :rename => :expires, :only_explicit => true
+      scoped_search on: :expired_on, complete_value: true, rename: :expires, only_explicit: true
     end
 
     def validate_expired_on
-      if self.expires?
+      if expires?
         begin
           errors.add(:expired_on, _('must be in the future')) unless expired_on.to_s.to_date > Date.today
         rescue StandardError
           errors.add(:expired_on, _('is invalid'))
         end
       end
-      if self.changed.include?('expired_on')
-        errors.add(:expired_on, _('no permission to edit')) unless can_modify_expiry_date?
-      end
+      errors.add(:expired_on, _('no permission to edit')) if changed.include?('expired_on') && !can_modify_expiry_date?
       true
     end
 
@@ -76,17 +77,17 @@ module ForemanExpireHosts
       return true if defined?(Rails::Console)
       return true unless User.current
       return true if Authorizer.new(User.current).can?(:edit_host_expiry, self)
-      return true if self.owner_type.nil? || self.owner.nil?
+      return true if owner_type.nil? || owner.nil?
 
       Setting[:can_owner_modify_host_expiry_date] &&
-        ((self.owner_type == 'User' && self.owner == User.current) ||
-         (self.owner_type == 'Usergroup' && self.owner.all_users.include?(User.current)))
+        ((owner_type == 'User' && owner == User.current) ||
+         (owner_type == 'Usergroup' && owner.all_users.include?(User.current)))
     end
 
     private
 
     def refresh_expiration_status
-      self.get_status(HostStatus::ExpirationStatus).refresh
+      get_status(HostStatus::ExpirationStatus).refresh
     end
   end
 end

data/app/overrides/add_expired_on_field_to_host_form.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 Deface::Override.new(
-  :virtual_path => 'hosts/_form',
-  :name => 'host_form_expired_on_field',
-  :insert_after => 'div#model_name',
-  :partial => 'hosts/expired_on_field'
+  virtual_path: 'hosts/_form',
+  name: 'host_form_expired_on_field',
+  insert_after: 'div#model_name',
+  partial: 'hosts/expired_on_field'
 )

data/app/overrides/add_expired_on_field_to_host_show.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 Deface::Override.new(
-  :virtual_path => 'hosts/show',
-  :name => 'host_expiry_warning_in_show',
-  :insert_before => '#host-show',
-  :partial => 'hosts/expired_message'
+  virtual_path: 'hosts/show',
+  name: 'host_expiry_warning_in_show',
+  insert_before: '#host-show',
+  partial: 'hosts/expired_message'
 )

data/app/overrides/deleted_expired_host_comment_in_audits.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 Deface::Override.new(
-  :virtual_path => 'audits/_list',
-  :name => 'deleted_expired_host_audit_comment_in_list',
-  :insert_bottom => 'div.row div.audit-content',
-  :text => "\n <%= destroyed_expired_host_audit_comment_in_list(audit) %>"
+  virtual_path: 'audits/_list',
+  name: 'deleted_expired_host_audit_comment_in_list',
+  insert_bottom: 'div.row div.audit-content',
+  text: "\n <%= destroyed_expired_host_audit_comment_in_list(audit) %>"
 )
 
 Deface::Override.new(
-  :virtual_path => 'audits/show',
-  :name => 'deleted_expired_host_audit_comment_in_show',
-  :insert_bottom => 'div#tab1 table',
-  :text => "\n <%= destroyed_expired_host_audit_comment_in_show(@audit) %>"
+  virtual_path: 'audits/show',
+  name: 'deleted_expired_host_audit_comment_in_show',
+  insert_bottom: 'div#tab1 table',
+  text: "\n <%= destroyed_expired_host_audit_comment_in_show(@audit) %>"
 )

data/app/services/foreman_expire_hosts/action/base.rb

@@ -24,10 +24,10 @@ module ForemanExpireHosts
 
           if result
             logger.info "Action #{self.class.name} for host #{host.name} was successful."
-            self.successful_hosts << host
+            successful_hosts << host
           else
             logger.info "Action #{self.class.name} for host #{host.name} failed."
-            self.failed_hosts << host
+            failed_hosts << host
           end
         end
       end
@@ -47,18 +47,18 @@ module ForemanExpireHosts
 
       def success_notification_options
         {
-          :hosts => successful_hosts
+          hosts: successful_hosts,
         }
       end
 
       def failure_notification_options
         {
-          :hosts => failed_hosts,
-          :to => User.anonymous_admin
+          hosts: failed_hosts,
+          to: User.anonymous_admin,
         }
       end
 
-      delegate :logger, :to => :ForemanExpireHosts
+      delegate :logger, to: :ForemanExpireHosts
     end
   end
 end

data/app/services/foreman_expire_hosts/action/stop_expired_hosts.rb

@@ -29,7 +29,7 @@ module ForemanExpireHosts
 
       def success_notification_options
         super.merge(
-          :delete_date => (Date.today + days_to_delete_after_expired)
+          delete_date: (Date.today + days_to_delete_after_expired)
         )
       end
 

data/app/services/foreman_expire_hosts/notification/base.rb

@@ -32,10 +32,8 @@ module ForemanExpireHosts
 
         build_mail_notification(recipient, hosts).deliver_now
       rescue SocketError, Net::SMTPError => e
-        message = _('Failed to deliver %{notification_name} for Hosts %{hosts}') % {
-          :notification_name => humanized_name,
-          :hosts => hosts.map(&:name).to_sentence
-        }
+        message = format(_('Failed to deliver %{notification_name} for Hosts %{hosts}'),
+          notification_name: humanized_name, hosts: hosts.map(&:name).to_sentence)
         Foreman::Logging.exception(message, e)
       end
 
@@ -46,7 +44,7 @@ module ForemanExpireHosts
         end
       end
 
-      delegate :logger, :to => :ForemanExpireHosts
+      delegate :logger, to: :ForemanExpireHosts
 
       def humanized_name
         _('Notification')

data/app/services/foreman_expire_hosts/safe_destroy.rb

@@ -20,12 +20,8 @@ module ForemanExpireHosts
         subject.destroy!
       end
     rescue ActiveRecord::RecordNotDestroyed => e
-      message = _('Failed to delete %{class_name} %{subject}: %{message} - Errors: %{errors}') % {
-        :class_name => subject.class.name,
-        :subject => subject,
-        :message => e.message,
-        :errors => e.record.errors.full_messages.to_sentence
-      }
+      message = format(_('Failed to delete %{class_name} %{subject}: %{message} - Errors: %{errors}'),
+        class_name: subject.class.name, subject: subject, message: e.message, errors: e.record.errors.full_messages.to_sentence)
       Foreman::Logging.exception(message, e)
       false
     end

data/app/services/foreman_expire_hosts/ui_notifications/hosts/base.rb

@@ -37,13 +37,13 @@ module ForemanExpireHosts
         def message_variables
           {
             subject: subject,
-            initator: initiator
+            initator: initiator,
           }
         end
 
         def update_notification
           find_notification
-            .update(expired_at: blueprint.expired_at, :message => parsed_message)
+            .update(expired_at: blueprint.expired_at, message: parsed_message)
         end
 
         def redeliver!

data/app/services/foreman_expire_hosts/ui_notifications/hosts/expiry_warning.rb

@@ -22,7 +22,7 @@ module ForemanExpireHosts
         end
 
         def message_variables
-          super.merge(:relative_expiry_time => time_ago_in_words(subject.expired_on))
+          super.merge(relative_expiry_time: time_ago_in_words(subject.expired_on))
         end
       end
     end

data/config/routes.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 Foreman::Application.routes.draw do
-  post 'expired_hosts/select_multiple_expiration' => 'hosts#select_multiple_expiration', as: 'select_multiple_expiration_hosts'
-  post 'expired_hosts/update_multiple_expiration' => 'hosts#update_multiple_expiration', as: 'update_multiple_expiration_hosts'
+  post 'expired_hosts/select_multiple_expiration' => 'hosts#select_multiple_expiration',
+    :as => 'select_multiple_expiration_hosts'
+  post 'expired_hosts/update_multiple_expiration' => 'hosts#update_multiple_expiration',
+    :as => 'update_multiple_expiration_hosts'
 end

data/db/migrate/20220923181700_fix_settings_category_to_dsl.rb

@@ -2,6 +2,7 @@
 
 class FixSettingsCategoryToDsl < ActiveRecord::Migration[6.0]
   def up
-    Setting.where(category: 'Setting::ExpireHost').update_all(category: 'Setting') if column_exists?(:settings, :category)
+    Setting.where(category: 'Setting::ExpireHost').update_all(category: 'Setting') if column_exists?(:settings,
+      :category)
   end
 end

data/db/seeds.d/80_expire_hosts_ui_notification.rb

@@ -11,9 +11,9 @@
       links:
       [
         path_method: :host_path,
-        title: _('Details')
-      ]
-    }
+        title: _('Details'),
+      ],
+    },
   },
   {
     group: _('Hosts'),
@@ -25,8 +25,8 @@
       links:
       [
         path_method: :host_path,
-        title: _('Details')
-      ]
-    }
-  }
+        title: _('Details'),
+      ],
+    },
+  },
 ].each { |blueprint| UINotifications::Seed.new(blueprint).configure }

data/lib/foreman_expire_hosts/engine.rb

@@ -13,10 +13,12 @@ module ForemanExpireHosts
       end
     end
 
-    initializer 'foreman_expire_hosts.register_plugin', :before => :finisher_hook do |app|
+    initializer 'foreman_expire_hosts.register_plugin', before: :finisher_hook do |app|
       app.reloader.to_prepare do
+        require 'foreman/cron'
+
         Foreman::Plugin.register :foreman_expire_hosts do
-          requires_foreman '>= 3.13.0'
+          requires_foreman '>= 3.18.0'
           register_custom_status HostStatus::ExpirationStatus
 
           # strong parameters
@@ -24,14 +26,14 @@ module ForemanExpireHosts
 
           security_block :foreman_expire_hosts do
             permission :edit_host_expiry,
-                       {},
-                       :resource_type => 'Host'
+              {},
+              resource_type: 'Host'
           end
 
           # Extend built in permissions
           Foreman::AccessControl.permission(:edit_hosts).actions.concat [
             'hosts/select_multiple_expiration',
-            'hosts/update_multiple_expiration'
+            'hosts/update_multiple_expiration',
           ]
 
           Setting::BLANK_ATTRS << 'host_expiry_email_recipients'
@@ -39,35 +41,35 @@ module ForemanExpireHosts
           settings do
             category(:expire_hosts, N_('Expire Hosts')) do
               setting('is_host_expiry_date_mandatory',
-                      type: :boolean,
-                      description: N_('Make expiry date field mandatory on host creation/update'),
-                      default: false,
-                      full_name: N_('Require host expiry date'))
+                type: :boolean,
+                description: N_('Make expiry date field mandatory on host creation/update'),
+                default: false,
+                full_name: N_('Require host expiry date'))
               setting('can_owner_modify_host_expiry_date',
-                      type: :boolean,
-                      description: N_('Allow host owner to modify host expiry date field. If the field is false then admin only can edit expiry field'),
-                      default: false,
-                      full_name: N_('Host owner can modify host expiry date'))
+                type: :boolean,
+                description: N_('Allow host owner to modify host expiry date field. If the field is false then admin only can edit expiry field'),
+                default: false,
+                full_name: N_('Host owner can modify host expiry date'))
               setting('notify1_days_before_host_expiry',
-                      type: :integer,
-                      description: N_('Send first notification to owner of hosts about his hosts expiring in given days. Must be integer only'),
-                      default: 7,
-                      full_name: N_('First expiry notification'))
+                type: :integer,
+                description: N_('Send first notification to owner of hosts about his hosts expiring in given days. Must be integer only'),
+                default: 7,
+                full_name: N_('First expiry notification'))
               setting('notify2_days_before_host_expiry',
-                      type: :integer,
-                      description: N_('Send second notification to owner of hosts about his hosts expiring in given days. Must be integer only'),
-                      default: 1,
-                      full_name: N_('Second expiry notification'))
+                type: :integer,
+                description: N_('Send second notification to owner of hosts about his hosts expiring in given days. Must be integer only'),
+                default: 1,
+                full_name: N_('Second expiry notification'))
               setting('days_to_delete_after_host_expiration',
-                      type: :integer,
-                      description: N_('Delete expired hosts after given days of hosts expiry date. Must be integer only'),
-                      default: 3,
-                      full_name: N_('Expiry grace period in days'))
+                type: :integer,
+                description: N_('Delete expired hosts after given days of hosts expiry date. Must be integer only'),
+                default: 3,
+                full_name: N_('Expiry grace period in days'))
               setting('host_expiry_email_recipients',
-                      type: :string,
-                      description: N_('All notifications will be delivered to its owner. If any other users/admins need to receive those expiry warning notifications then those emails can be configured comma separated here.'), # rubocop:disable Layout/LineLength
-                      default: nil,
-                      full_name: N_('Expiry e-mail recipients'))
+                type: :string,
+                description: N_('All notifications will be delivered to its owner. If any other users/admins need to receive those expiry warning notifications then those emails can be configured comma separated here.'),
+                default: nil,
+                full_name: N_('Expiry e-mail recipients'))
             end
           end
 
@@ -76,19 +78,20 @@ module ForemanExpireHosts
           describe_host do
             multiple_actions_provider :expire_hosts_host_multiple_actions
           end
+
+          # Register recurring task with Foreman::Cron framework
+          Foreman::Cron.register(:daily, 'expired_hosts:deliver_notifications')
         end
       end
     end
 
     config.to_prepare do
-      begin
-        ::Host::Managed.include ForemanExpireHosts::HostExt
-        ::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
+      ::Host::Managed.include ForemanExpireHosts::HostExt
+      ::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
 
     rake_tasks do

data/lib/foreman_expire_hosts/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanExpireHosts
-  VERSION = '9.0.1'
+  VERSION = '9.1.0'
 end

data/lib/tasks/expired_hosts.rake

@@ -3,7 +3,7 @@
 # Tasks
 namespace :expired_hosts do
   desc 'Delete all expired hosts, send notification email about expiring hosts'
-  task :deliver_notifications => :environment do
+  task deliver_notifications: :environment do
     User.as_anonymous_admin do
       ExpireHostsNotifications.delete_expired_hosts
       ExpireHostsNotifications.stop_expired_hosts
@@ -28,6 +28,4 @@ end
 Rake::Task[:test].enhance ['test:foreman_expire_hosts']
 
 load 'tasks/jenkins.rake'
-if Rake::Task.task_defined?(:'jenkins:unit')
-  Rake::Task['jenkins:unit'].enhance ['test:foreman_expire_hosts']
-end
+Rake::Task['jenkins:unit'].enhance ['test:foreman_expire_hosts'] if Rake::Task.task_defined?(:'jenkins:unit')

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

@@ -10,7 +10,7 @@ class Api::V2::HostsControllerTest < ActionController::TestCase
   end
 
   test 'should show individual record with expiry data' do
-    get :show, params: { :id => host.to_param }
+    get :show, params: { id: host.to_param }
     assert_response :success
     show_response = ActiveSupport::JSON.decode(@response.body)
     assert_not_empty show_response

data/test/functional/concerns/hosts_controller_extensions_test.rb

@@ -13,22 +13,22 @@ class HostsControllerTest < ActionController::TestCase
     test 'new host with expiration date' do
       expiration_date = Date.today + 14
       assert_difference 'Host.count' do
-        post :create, params: { :host => {
-          :name => 'myotherfullhost',
-          :mac => 'aabbecddee06',
-          :ip => '2.3.4.125',
-          :domain_id => domains(:mydomain).id,
-          :operatingsystem_id => operatingsystems(:redhat).id,
-          :architecture_id => architectures(:x86_64).id,
-          :subnet_id => subnets(:one).id,
-          :medium_id => media(:one).id,
-          :pxe_loader => 'Grub2 UEFI',
-          :realm_id => realms(:myrealm).id,
-          :disk => 'empty partition',
-          :root_pass => 'xybxa6JUkz63w',
-          :location_id => taxonomies(:location1).id,
-          :organization_id => taxonomies(:organization1).id,
-          :expired_on => expiration_date
+        post :create, params: { host: {
+          name: 'myotherfullhost',
+          mac: 'aabbecddee06',
+          ip: '2.3.4.125',
+          domain_id: domains(:mydomain).id,
+          operatingsystem_id: operatingsystems(:redhat).id,
+          architecture_id: architectures(:x86_64).id,
+          subnet_id: subnets(:one).id,
+          medium_id: media(:one).id,
+          pxe_loader: 'Grub2 UEFI',
+          realm_id: realms(:myrealm).id,
+          disk: 'empty partition',
+          root_pass: 'xybxa6JUkz63w',
+          location_id: taxonomies(:location1).id,
+          organization_id: taxonomies(:organization1).id,
+          expired_on: expiration_date,
         } }, session: set_session_user
       end
       h = Host.search_for('myotherfullhost').first
@@ -42,7 +42,7 @@ class HostsControllerTest < ActionController::TestCase
 
     test 'should add expiration date to host' do
       expiration_date = Date.today + 14
-      put :update, params: { :id => host.name, :host => { :expired_on => expiration_date } }, session: set_session_user
+      put :update, params: { id: host.name, host: { expired_on: expiration_date } }, session: set_session_user
       h = Host.find(host.id)
       assert_equal expiration_date, h.expired_on
     end
@@ -58,7 +58,7 @@ class HostsControllerTest < ActionController::TestCase
 
     test 'show a host selection' do
       host_ids = @hosts.map(&:id)
-      post :select_multiple_expiration, params: { :host_ids => host_ids }, session: set_session_user, xhr: true
+      post :select_multiple_expiration, params: { host_ids: host_ids }, session: set_session_user, xhr: true
       assert_response :success
       @hosts.each do |host|
         assert response.body =~ /#{host.name}/m
@@ -67,10 +67,10 @@ 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.strftime('%Y-%m-%d') } }
+      params = { host_ids: @hosts.map(&:id),
+                 host: { 'expired_on' => expiration_date.strftime('%Y-%m-%d') } }
 
-      post :update_multiple_expiration, params: params, session: set_session_user.merge(:user => users(:admin).id)
+      post :update_multiple_expiration, params: params, session: set_session_user.merge(user: users(:admin).id)
 
       assert_empty flash[:error]
 
@@ -80,10 +80,10 @@ class HostsControllerTest < ActionController::TestCase
     end
 
     test 'should clear the expiration date of multiple hosts' do
-      params = { :host_ids => @hosts.map(&:id),
-                 :host => { :expired_on => '' } }
+      params = { host_ids: @hosts.map(&:id),
+                 host: { expired_on: '' } }
 
-      post :update_multiple_expiration, params: params, session: set_session_user.merge(:user => users(:admin).id)
+      post :update_multiple_expiration, params: params, session: set_session_user.merge(user: users(:admin).id)
 
       assert_empty flash[:error]
 

data/test/lib/expire_hosts_notifications_test.rb

@@ -16,8 +16,8 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
   context '#delete_expired_hosts' do
     context 'with single owner' do
       setup do
-        FactoryBot.create_list(:host, 2, :expired, :owner => user)
-        FactoryBot.create_list(:host, 2, :owner => user)
+        FactoryBot.create_list(:host, 2, :expired, owner: user)
+        FactoryBot.create_list(:host, 2, owner: user)
       end
 
       test 'should delete expired hosts' do
@@ -31,8 +31,8 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
 
     context 'with usergroup owner' do
       setup do
-        FactoryBot.create_list(:host, 2, :expired, :owner => usergroup)
-        FactoryBot.create_list(:host, 2, :owner => usergroup)
+        FactoryBot.create_list(:host, 2, :expired, owner: usergroup)
+        FactoryBot.create_list(:host, 2, owner: usergroup)
       end
 
       test 'should delete expired hosts' do
@@ -65,7 +65,7 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
       end
 
       test 'should deliver notification to additional recipients' do
-        FactoryBot.create_list(:host, 2, :expired, :owner => user)
+        FactoryBot.create_list(:host, 2, :expired, owner: user)
         ExpireHostsNotifications.delete_expired_hosts
         assert_equal 2, ActionMailer::Base.deliveries.count
         assert_includes ActionMailer::Base.deliveries.first.subject, 'Deleted expired hosts'
@@ -83,13 +83,13 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
 
   context '#stop_expired_hosts' do
     let(:power_mock) { mock('power') }
-    let(:host) { FactoryBot.create(:host, :expired, :on_compute_resource, :owner => user) }
+    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.stubs(:ready?).returns(true)
       host.unstub(:queue_compute)
       Host.any_instance.stubs(:power).returns(power_mock)
-      FactoryBot.create_list(:host, 2, :owner => user)
+      FactoryBot.create_list(:host, 2, owner: user)
     end
 
     test 'should stop expired hosts' do
@@ -120,7 +120,7 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
     end
 
     context 'with a host expiring today' do
-      let(:host) { FactoryBot.create(:host, :expires_today, :on_compute_resource, :owner => user) }
+      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
@@ -139,7 +139,7 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
 
   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) }
+    let(:hosts) { FactoryBot.create_list(:host, 2, :expires_in_a_week, owner: user) }
 
     setup do
       Setting['notify1_days_before_host_expiry'] = 7
@@ -181,7 +181,7 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
 
       test 'should send two notifications for two users' do
         owner2 = FactoryBot.create(:user, :with_mail)
-        FactoryBot.create(:host, :expires_in_a_week, :owner => owner2)
+        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'
@@ -190,9 +190,9 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
 
       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)
+        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'

data/test/unit/concerns/host_extensions_test.rb

@@ -3,7 +3,7 @@
 require 'test_plugin_helper'
 
 class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
-  EXPIRATION_SCOPES = ['expiring', 'expired', 'expiring_today', 'expired_past_grace_period'].freeze
+  EXPIRATION_SCOPES = %w[expiring expired expiring_today expired_past_grace_period].freeze
 
   setup do
     User.current = FactoryBot.build(:user, :admin)
@@ -35,7 +35,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
   context 'changing expiration date for user owned host' do
     setup do
       @user = FactoryBot.create(:user)
-      @host = FactoryBot.create(:host, :expired, :owner => @user)
+      @host = FactoryBot.create(:host, :expired, owner: @user)
     end
 
     test 'admin should be able to change expiration date' do
@@ -72,23 +72,25 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
 
     context 'with edit_host_expiry permission' do
       let(:permission) { Permission.find_by(name: 'edit_host_expiry') }
-      let(:filter) { FactoryBot.create(:filter, :permissions => [permission]) }
-      let(:role) { FactoryBot.create(:role, :filters => [filter]) }
-      let(:user) { FactoryBot.create(:user, :organizations => [host.organization], :locations => [host.location], :roles => [role]) }
+      let(:filter) { FactoryBot.create(:filter, permissions: [permission]) }
+      let(:role) { FactoryBot.create(:role, filters: [filter]) }
+      let(:user) do
+        FactoryBot.create(:user, organizations: [host.organization], locations: [host.location], roles: [role])
+      end
 
       test 'user can change expiry date' do
         as_user user do
-          assert_equal true, host.can_modify_expiry_date?
+          assert host.can_modify_expiry_date?
         end
       end
     end
 
     context 'without edit_host_expiry permission' do
-      let(:user) { FactoryBot.build(:user, :organizations => [host.organization], :locations => [host.location]) }
+      let(:user) { FactoryBot.build(:user, organizations: [host.organization], locations: [host.location]) }
 
       test 'user can not change expiry date' do
         as_user user do
-          assert_equal false, host.can_modify_expiry_date?
+          assert_not host.can_modify_expiry_date?
         end
       end
     end
@@ -150,7 +152,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should only exist in correct scopes' do
-      exists_only_in_scopes(@host, ['expiring', 'expired', 'expired_past_grace_period'])
+      exists_only_in_scopes(@host, %w[expiring expired expired_past_grace_period])
     end
   end
 
@@ -181,7 +183,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should only exist in correct scopes' do
-      exists_only_in_scopes(@host, ['expiring', 'expired', 'expiring_today'])
+      exists_only_in_scopes(@host, %w[expiring expired expiring_today])
     end
   end
 
@@ -242,7 +244,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should only exist in correct scopes' do
-      exists_only_in_scopes(@host, ['expiring', 'expired'])
+      exists_only_in_scopes(@host, %w[expiring expired])
     end
   end
 

data/test/unit/expiry_edit_authorizer_test.rb

@@ -10,7 +10,7 @@ module ForemanExpireHosts
     context 'with admin user' do
       let(:user) { FactoryBot.create(:user, :admin) }
       test 'should be authorized' do
-        assert_equal true, authorizer.authorized?
+        assert authorizer.authorized?
       end
     end
 
@@ -23,25 +23,25 @@ module ForemanExpireHosts
 
       context 'with edit_hosts and edit_host_expiry permission' do
         test 'should be authorized' do
-          FactoryBot.create(:filter, :role => role, :permissions => [edit_permission, edit_expiry_permission])
-          assert_equal true, authorizer.authorized?
+          FactoryBot.create(:filter, role: role, permissions: [edit_permission, edit_expiry_permission])
+          assert authorizer.authorized?
         end
       end
 
       context 'with edit_hosts and owner permission' do
         setup do
-          FactoryBot.create(:filter, :role => role, :permissions => [edit_permission])
+          FactoryBot.create(:filter, role: role, permissions: [edit_permission])
         end
-        let(:hosts) { FactoryBot.create_list(:host, 2, :owner => user) }
+        let(:hosts) { FactoryBot.create_list(:host, 2, owner: user) }
 
         test 'should be authorized if setting allows owner' do
           Setting[:can_owner_modify_host_expiry_date] = true
-          assert_equal true, authorizer.authorized?
+          assert authorizer.authorized?
         end
 
         test 'should not be authorized if setting does not allow owner' do
           Setting[:can_owner_modify_host_expiry_date] = false
-          assert_equal false, authorizer.authorized?
+          assert_not authorizer.authorized?
         end
       end
     end
@@ -49,7 +49,7 @@ module ForemanExpireHosts
     context 'with unauthorized user' do
       let(:user) { FactoryBot.create(:user) }
       test 'should not be authorized' do
-        assert_equal false, authorizer.authorized?
+        assert_not authorizer.authorized?
       end
     end
   end

data/test/unit/host_status/expiration_status_test.rb

@@ -5,7 +5,7 @@ require 'test_plugin_helper'
 class ExpirationStatusTest < ActiveSupport::TestCase
   def setup
     @host = FactoryBot.build(:host)
-    @status = HostStatus::ExpirationStatus.new(:host => @host)
+    @status = HostStatus::ExpirationStatus.new(host: @host)
   end
 
   test 'is valid' do

data/test/unit/safe_destroy_test.rb

@@ -19,8 +19,8 @@ module ForemanExpireHosts
 
     describe 'model with failing callbacks' do
       test 'return false on record delete' do
-        h = HostWithFailingCallbacks.create!(:name => 'test')
-        assert_equal false, SafeDestroy.new(h).destroy!
+        h = HostWithFailingCallbacks.create!(name: 'test')
+        assert_not SafeDestroy.new(h).destroy!
         assert_equal 1, HostWithFailingCallbacks.all.count
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_expire_hosts
 version: !ruby/object:Gem::Version
-  version: 9.0.1
+  version: 9.1.0
 platform: ruby
 authors:
 - Nagarjuna Rachaneni
 - Timo Goebel
 bindir: bin
 cert_chain: []
-date: 2025-06-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -91,7 +91,6 @@ files:
 - db/migrate/20220923181700_fix_settings_category_to_dsl.rb
 - db/migrate/20230112104438_change_expired_on_type.rb
 - db/seeds.d/80_expire_hosts_ui_notification.rb
-- extra/foreman_expire_hosts.cron
 - lib/foreman_expire_hosts.rb
 - lib/foreman_expire_hosts/engine.rb
 - lib/foreman_expire_hosts/version.rb
@@ -125,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Foreman plugin for limiting host lifetime
 test_files:

data/extra/foreman_expire_hosts.cron

@@ -1,8 +0,0 @@
-SHELL=/bin/sh
-PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
-
-RAILS_ENV=production
-FOREMAN_HOME=/usr/share/foreman
-
-# Send out notifications about expired hosts
-45 7 * * *      foreman    /usr/sbin/foreman-rake expired_hosts:deliver_notifications >>/var/log/foreman/expired_hosts.log 2>&1