foreman_expire_hosts 6.0.0 → 7.0.2

data/app/models/host_status/expiration_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HostStatus
   class ExpirationStatus < HostStatus::Status
     OK = 0
@@ -15,6 +17,7 @@ module HostStatus
       return EXPIRED if host.expired_past_grace_period?
       return IN_GRACE_PERIOD if host.expired?
       return PENDING if host.pending_expiration?
+
       OK
     end
 

data/app/models/setting/expire_hosts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Setting::ExpireHosts < Setting
   Setting::BLANK_ATTRS.push('host_expiry_email_recipients')
 

data/app/overrides/add_expired_on_field_to_host_form.rb

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

data/app/overrides/add_expired_on_field_to_host_show.rb

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

data/app/overrides/deleted_expired_host_comment_in_audits.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 Deface::Override.new(
-  :virtual_path  => 'audits/_list',
-  :name          => 'deleted_expired_host_audit_comment_in_list',
+  :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) %>"
+  :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',
+  :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) %>"
+  :text => "\n <%= destroyed_expired_host_audit_comment_in_show(@audit) %>"
 )

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Action
     class Base
@@ -17,9 +19,14 @@ module ForemanExpireHosts
 
       def process
         hosts.each do |host|
-          if action(host)
+          result = action(host)
+          next if result.nil?
+
+          if result
+            logger.info "Action #{self.class.name} for host #{host.name} was successful."
             self.successful_hosts << host
           else
+            logger.info "Action #{self.class.name} for host #{host.name} failed."
             self.failed_hosts << host
           end
         end
@@ -51,7 +58,7 @@ module ForemanExpireHosts
         }
       end
 
-      delegate :logger, :to => :Rails
+      delegate :logger, :to => :ForemanExpireHosts
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Action
     class DeleteExpiredHosts < Base
@@ -8,6 +10,7 @@ module ForemanExpireHosts
       end
 
       def action(host)
+        logger.info "Destroying expired host #{host}."
         SafeDestroy.new(host).destroy!
       end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Action
     class StopExpiredHosts < Base
@@ -8,8 +10,10 @@ module ForemanExpireHosts
       end
 
       def action(host)
-        return true unless host.supports_power_and_running?
-        logger.info "Powering down expired host in grace period #{host}"
+        return false unless host.supports_power?
+        return unless host.power.ready?
+
+        logger.info "Powering down expired host in grace period #{host}."
         host.power.stop
       rescue StandardError
         false

data/app/services/foreman_expire_hosts/expiry_edit_authorizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   class ExpiryEditAuthorizer
     attr_accessor :user, :hosts

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Notification
     class Base
@@ -24,22 +26,27 @@ module ForemanExpireHosts
       end
 
       def deliver_mail_notification(recipient, hosts)
+        return true if hosts.empty?
+
+        logger.info "Deliving mail notification '#{humanized_name}' for hosts #{hosts.to_sentence} to #{recipient}."
+
         build_mail_notification(recipient, hosts).deliver_now
-      rescue SocketError, Net::SMTPError => error
+      rescue SocketError, Net::SMTPError => e
         message = _('Failed to deliver %{notification_name} for Hosts %{hosts}') % {
           :notification_name => humanized_name,
           :hosts => hosts.map(&:name).to_sentence
         }
-        Foreman::Logging.exception(message, error)
+        Foreman::Logging.exception(message, e)
       end
 
       def deliver_ui_notifications
         all_hosts.each do |host|
+          logger.info "Deliving UI notification '#{humanized_name}' for host '#{host}'."
           build_ui_notification(host).deliver!
         end
       end
 
-      delegate :logger, :to => :Rails
+      delegate :logger, :to => :ForemanExpireHosts
 
       def humanized_name
         _('Notification')
@@ -59,11 +66,13 @@ module ForemanExpireHosts
         return global_recipients if global_recipients.present?
         return [User.anonymous_admin] if host.owner.blank?
         return [host.owner] if host.owner_type == 'User'
+
         host.owner.all_users
       end
 
       def additional_recipients
         return [] if Setting[:host_expiry_email_recipients].nil?
+
         Setting[:host_expiry_email_recipients].split(',').compact.map(&:strip)
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Notification
     class DeletedHosts < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Notification
     class ExpiryWarning < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Notification
     class FailedDeletedHosts < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Notification
     class FailedStoppedHosts < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Notification
     class StoppedHosts < Base

data/app/services/foreman_expire_hosts/safe_destroy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   class SafeDestroy
     # See http://projects.theforeman.org/issues/14702 for reasoning.
@@ -13,18 +15,18 @@ module ForemanExpireHosts
       # See https://community.theforeman.org/t/how-to-properly-destroy-a-content-host/8621
       # for reasoning.
       if subject.is_a?(Host::Base) && with_katello?
-        Katello::RegistrationManager.unregister_host(host)
+        Katello::RegistrationManager.unregister_host(subject)
       else
         subject.destroy!
       end
-    rescue ActiveRecord::RecordNotDestroyed => invalid
+    rescue ActiveRecord::RecordNotDestroyed => e
       message = _('Failed to delete %{class_name} %{subject}: %{message} - Errors: %{errors}') % {
         :class_name => subject.class.name,
         :subject => subject,
-        :message => invalid.message,
-        :errors => invalid.record.errors.full_messages.to_sentence
+        :message => e.message,
+        :errors => e.record.errors.full_messages.to_sentence
       }
-      Foreman::Logging.exception(message, invalid)
+      Foreman::Logging.exception(message, e)
       false
     end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module UINotifications
     module Hosts
@@ -6,6 +8,7 @@ module ForemanExpireHosts
 
         def create
           return add_notification unless find_notification
+
           redeliver! if redeliver?
           find_notification
         end
@@ -45,7 +48,7 @@ module ForemanExpireHosts
 
         def redeliver!
           recipients = find_notification.notification_recipients
-          recipients.update_all(seen: false) # rubocop:disable Rails/SkipsModelValidations
+          recipients.update_all(seen: false)
           recipients.pluck(:user_id).each do |user_id|
             ::UINotifications::CacheHandler.new(user_id).clear
           end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module UINotifications
     module Hosts

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module UINotifications
     module Hosts

data/app/views/api/v2/hosts/expiration.json.rabl

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 attributes :expired_on

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

@@ -1,22 +1,13 @@
-<% if @host.can_modify_expiry_date? %>
-  <%= stylesheet 'foreman_expire_hosts/application' %>
-  <%= javascript 'foreman_expire_hosts/application' %>
-<% end %>
 <%= datepicker_f f, :expired_on,
-           :value        => @host.expired_on.try(:strftime, '%d/%m/%Y'),
-           :data         => { provide:              @host.can_modify_expiry_date? ? 'datepicker' : 'readonly',
-                              orientation:          'top left',
-                              date_autoclose:       true,
-                              date_clear_btn:       true,
-                              date_format:          'dd/mm/yyyy',
-                              date_start_date:      Date.tomorrow.strftime('%d/%m/%Y'),
-                              date_today_highlight: true
-           },
-           :autocomplete => false,
-           :placeholder  => 'dd/mm/yyyy',
-           :help_block => ('<span class="pficon-warning-triangle-o"></span> '.html_safe + _('You are not allowed to change the expiry date of this host.') unless @host.can_modify_expiry_date?),
-           :readonly => !@host.can_modify_expiry_date?,
-           :help_inline  => popover('Auto Expiry', _('Host will be deleted automatically on given expiry date.') + '<br>'.html_safe +
-                                    _('Leave blank to keep the host until deleted manually')),
-           :onfocus      => 'append_shortcuts()'
+           {
+             :label => _('Expires on'),
+             :autocomplete => false,
+             :include_blank => true,
+             :use_month_numbers => false,
+             :start_year => Date.today.year,
+             :help_block => ('<span class="pficon-warning-triangle-o"></span> '.html_safe + _('You are not allowed to change the expiry date of this host.') unless @host.can_modify_expiry_date?),
+             :disabled => !@host.can_modify_expiry_date?,
+             :help_inline  => popover('Auto Expiry', _('Expired hosts will be deleted automatically after the grace period has passed.') + '<br>'.html_safe +
+                                      _('If you do not want this host to expire and do not want it to be deleted automatically, do not specify an expiry date.'))
+           }
 %>

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

@@ -1,23 +1,18 @@
-<%= stylesheet 'foreman_expire_hosts/application' %>
-<%= javascript 'foreman_expire_hosts/application' %>
 <%= render 'selected_hosts', :hosts => @hosts %>
 
 <%= form_for :host, :url => update_multiple_expiration_hosts_path(:host_ids => params[:host_ids]) do |f| %>
 
-<%= _('Host will be deleted automatically on given expired date. Leave blank to clear expiration date.') %>
+<%= _('Hosts will be deleted automatically on the given expiry date. Leave blank to clear expiration date.') %>
 
 <%= datepicker_f f, :expired_on,
-     :value        => (Date.today + 14).strftime('%d/%m/%Y'),
-     :data         => { provide:              'datepicker',
-                        orientation:          'top left',
-                        date_autoclose:       true,
-                        date_clear_btn:       true,
-                        date_format:          'dd/mm/yyyy',
-                        date_start_date:      Date.tomorrow.strftime('%d/%m/%Y'),
-                        date_today_highlight: true
-     },
-     :autocomplete => false,
-     :placeholder  => 'dd/mm/yyyy',
-     :onfocus      => 'append_shortcuts()'
+  {
+    :autocomplete => false,
+    :include_blank => true,
+    :use_month_numbers => false,
+    :start_year => Date.today.year
+  },
+  {
+    :onchange => 'tfm.hosts.table.toggleMultipleOkButton(this);'
+  }
 %>
 <% end %>

data/config/routes.rb

@@ -1,3 +1,5 @@
+# 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'

data/db/migrate/20150427101516_add_expiry_on_to_hosts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddExpiryOnToHosts < ActiveRecord::Migration[4.2]
   def change
     add_column :hosts, :expired_on, :date unless column_exists? :hosts, :expired_on

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 [
   {
     group: _('Hosts'),

data/extra/foreman_expire_hosts.cron

@@ -0,0 +1,8 @@
+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

data/foreman_expire_hosts.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('lib/foreman_expire_hosts/version', __dir__)
 require 'date'
 
@@ -8,7 +10,10 @@ Gem::Specification.new do |s|
   s.authors     = ['Nagarjuna Rachaneni', 'Timo Goebel']
   s.email       = ['nn.nagarjuna@gmail.com', 'mail@timogoebel.name']
   s.summary     = 'Foreman plugin for limiting host lifetime'
-  s.description = 'This Plugin will add new column expired_on to hosts to limit the lifetime of a host.'
+  s.description = <<~DESC
+    A Foreman plugin that allows hosts to expire at a configurable date.
+    Hosts will be shut down and automatically deleted after a grace period.
+  DESC
   s.homepage    = 'https://github.com/theforeman/foreman_expire_hosts'
   s.licenses    = ['GPL-3.0']
 
@@ -18,9 +23,11 @@ Gem::Specification.new do |s|
 
   s.require_paths = ['lib']
 
-  s.add_dependency 'bootstrap-datepicker-rails'
   s.add_dependency 'deface'
 
   s.add_development_dependency 'rdoc'
-  s.add_development_dependency 'rubocop', '0.54.0'
+  s.add_development_dependency 'rubocop', '~> 0.80.0'
+  s.add_development_dependency 'rubocop-minitest', '~> 0.7.0'
+  s.add_development_dependency 'rubocop-performance', '~> 1.5.2'
+  s.add_development_dependency 'rubocop-rails', '~> 2.4.2'
 end

data/lib/expire_hosts_notifications.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExpireHostsNotifications
   class << self
     def delete_expired_hosts
@@ -10,6 +12,7 @@ module ExpireHostsNotifications
 
     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).preload(:owner)

data/lib/foreman_expire_hosts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'foreman_expire_hosts/engine'
 module ForemanExpireHosts
 end