foreman_expire_hosts 6.0.1 → 7.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66c086d3dc04916321804be89e8d5f027691b5aa5dc10b0cef317b7ac5d4ee9e
-  data.tar.gz: 84e16983231ab5651c03c5d56484c8645bd1c6910bd677aa7bcacefb139b06d2
+  metadata.gz: b5afc13d619d302e3e05ae902ff90f65d5eefd05e03b00369c7e3ca538260555
+  data.tar.gz: 9cdf5ad3a41cdc45a2fe0d4f5c0dc850e0a658abc72e20c83a436b5279a19268
 SHA512:
-  metadata.gz: b2990701bc9efa238f25f6a6a7def12d87e9403e4b6cf0f41b477c1d5cc16a467f2edcb211fabd724034b3c149d00d654087a42e4a8e323fd403a2030ac81492
-  data.tar.gz: 60a5e736f9e54223e5c62bcf426514e10aec9569708d3f58b672da60e41667b3537848c8fa6f00c8904c3c36aa87038304cdf44bc7d51e6a087d5c906ff3302d
+  metadata.gz: e65dddbebf6e2140e12fd05adf1b4584284c7e422a5399642eaf7e59e423b86561dbc9a7c0071835fbbffa50d3e34985ce31b1d1d3f955147e0849b2d8ea0d50
+  data.tar.gz: 4786bb290163e8f868dbe81d377d3747143cd5bcf3e00194625ea7f1c88f2ef0f6840fb2ccce7f5561a005140cacd6ea625a98b1b9fb45da4bf3444387a6047e

data/README.md

@@ -18,6 +18,7 @@ This plugin will send two warning notifications before host expiry (see Settings
 | >= 1.16         | ~> 4.0         |
 | >= 1.17         | ~> 5.0         |
 | >= 1.18         | ~> 6.0         |
+| >= 1.24         | ~> 7.0         |
 
 # Screenshots
 ![Expiry date field in host form](https://raw.githubusercontent.com/ingenico-group/screenshots/master/foreman_host_expiry/expiry-date-field-in-host-form.png)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Api
     module V2

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module HostControllerExtensions
     def self.prepended(base)
@@ -11,23 +13,20 @@ module ForemanExpireHosts
     def select_multiple_expiration; end
 
     def update_multiple_expiration
-      expiration_date = params[:host][:expired_on]
-      expiration_date = Date.parse(expiration_date) if expiration_date.present?
-
       failed_hosts = {}
 
       @hosts.each do |host|
         begin
           host.expired_on = expiration_date
           host.save!
-        rescue StandardError => error
-          failed_hosts[host.name] = error
+        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, error)
+          Foreman::Logging.exception(message, e)
         end
       end
 
@@ -48,15 +47,21 @@ module ForemanExpireHosts
     private
 
     def validate_multiple_expiration
-      if params[:host].nil? || (expiration_date = params[:host][:expired_on]).nil?
-        error _('No expiration date selected!')
-        redirect_to(select_multiple_expiration_hosts_path) && (return false)
-      end
-      begin
-        Date.parse(expiration_date) if expiration_date.present?
-      rescue ArgumentError
-        error _('Invalid expiration date!')
-        redirect_to(select_multiple_expiration_hosts_path) && (return false)
+      expiration_date
+    rescue ArgumentError
+      error _('Invalid expiration date!')
+      redirect_to(hosts_path) && (return false)
+    end
+
+    def expiration_date
+      @expiration_date ||= begin
+        year = params['host']['expired_on(1i)']
+        month = params['host']['expired_on(2i)']
+        day = params['host']['expired_on(3i)']
+
+        return if year.empty? && month.empty? && day.empty?
+
+        Date.parse("#{year}-#{month}-#{day}")
       end
     end
 

data/app/helpers/concerns/foreman_expire_hosts/audits_helper_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module AuditsHelperExtensions
     extend ActiveSupport::Concern

data/app/helpers/concerns/foreman_expire_hosts/hosts_helper_extensions.rb

@@ -1,19 +1,9 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module HostsHelperExtensions
     extend ActiveSupport::Concern
 
-    module Overrides
-      def multiple_actions
-        actions = super
-        actions << [_('Change Expiration'), select_multiple_expiration_hosts_path] if authorized_for(:controller => :hosts, :action => :select_multiple_expiration)
-        actions
-      end
-    end
-
-    included do
-      prepend Overrides
-    end
-
     def host_expiry_warning_message(host)
       return nil unless host.expires?
 
@@ -33,18 +23,10 @@ module ForemanExpireHosts
       distance_of_time_in_words(to_time, Time.current, options)
     end
 
-    def input_group_addon(content, options = {})
-      content_tag :span, class: 'input-group-addon' do
-        content_tag :span, content, options
-      end
-    end
-
-    def datepicker_f(form, attr, options = {})
+    def datepicker_f(form, attr, options = {}, html_options = {})
       field(form, attr, options) do
         addClass options, 'form-control'
-        date = form.text_field attr, options
-        addon = input_group_addon('', :class => 'glyphicon glyphicon-calendar')
-        input_group date, addon
+        form.date_select(attr, options, html_options)
       end
     end
   end

data/app/helpers/expire_hosts_mailer_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExpireHostsMailerHelper
   def relative_date(date, opts = {})
     return _('N/A') if date.blank?

data/app/helpers/foreman_expire_hosts/hosts_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ForemanExpireHosts
+  module HostsHelper
+    def expire_hosts_host_multiple_actions
+      actions = []
+      if authorized_for(:controller => :hosts, :action => :select_multiple_expiration)
+        actions << {
+          action: [_('Change Expiration'), select_multiple_expiration_hosts_path],
+          priority: 200
+        }
+      end
+      actions
+    end
+  end
+end

data/app/mailers/expire_hosts_mailer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ExpireHostsMailer < ApplicationMailer
   default :content_type => 'text/html', :from => Setting[:email_reply_address] || 'noreply@your-foreman.com'
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module HostExt
     extend ActiveSupport::Concern
@@ -13,7 +15,7 @@ module ForemanExpireHosts
 
       scope :expiring, -> { where('expired_on IS NOT NULL') }
       scope :with_expire_date, ->(date) { expiring.where('expired_on = ?', date) }
-      scope :expired, -> { expiring.where('expired_on < ?', Date.today) }
+      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) }
 

data/app/models/host_status/expiration_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HostStatus
   class ExpirationStatus < HostStatus::Status
     OK = 0

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,3 +1,5 @@
+# frozen_string_literal: true
+
 Deface::Override.new(
   :virtual_path => 'hosts/_form',
   :name => 'host_form_expired_on_field',

data/app/overrides/add_expired_on_field_to_host_show.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Deface::Override.new(
   :virtual_path => 'hosts/show',
   :name => 'host_expiry_waring_in_show',

data/app/overrides/deleted_expired_host_comment_in_audits.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Deface::Override.new(
   :virtual_path => 'audits/_list',
   :name => 'deleted_expired_host_audit_comment_in_list',

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Action
     class Base
@@ -21,8 +23,10 @@ module ForemanExpireHosts
           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
@@ -54,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
@@ -11,7 +13,7 @@ module ForemanExpireHosts
         return false unless host.supports_power?
         return unless host.power.ready?
 
-        logger.info "Powering down expired host in grace period #{host}"
+        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
@@ -26,22 +28,25 @@ module ForemanExpireHosts
       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')

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
@@ -46,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/lib/expire_hosts_notifications.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExpireHostsNotifications
   class << self
     def delete_expired_hosts

data/lib/foreman_expire_hosts.rb

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

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.1'.freeze
+  VERSION = '7.0.4'
 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

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

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'
 
@@ -117,6 +119,23 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
       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
@@ -150,7 +169,7 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
         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
+        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

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
@@ -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
 

data/test/unit/expire_hosts_mailer_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class ExpireHostMailerTest < ActionMailer::TestCase
@@ -35,6 +37,10 @@ class ExpireHostMailerTest < ActionMailer::TestCase
       assert_includes mail.subject, 'Stopped expired hosts in Foreman'
     end
 
+    test 'should include a deletion date' do
+      assert_includes mail.body, "These hosts will be destroyed on #{Date.today}."
+    end
+
     test 'should show mitigation text if authorized' do
       ForemanExpireHosts::ExpiryEditAuthorizer.any_instance.stubs(:authorized?).returns(true)
       assert_includes mail.body.to_s, 'Please change their expiry date'

data/test/unit/expiry_edit_authorizer_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 module ForemanExpireHosts

data/test/unit/host_status/expiration_status_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class ExpirationStatusTest < ActiveSupport::TestCase

data/test/unit/safe_destroy_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 module ForemanExpireHosts

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: foreman_expire_hosts
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 7.0.4
 platform: ruby
 authors:
 - Nagarjuna Rachaneni
 - Timo Goebel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bootstrap-datepicker-rails
+  name: deface
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -26,13 +26,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: deface
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -40,65 +40,85 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.80.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.80.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 2.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
-description: This Plugin will add new column expired_on to hosts to limit the lifetime
-  of a host.
+        version: 2.4.2
+description: |
+  A Foreman plugin that allows hosts to expire at a configurable date.
+  Hosts will be shut down and automatically deleted after a grace period.
 email:
 - nn.nagarjuna@gmail.com
 - mail@timogoebel.name
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
-- LICENSE
+extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- Gemfile
 - LICENSE
 - README.md
-- app/assets/javascripts/foreman_expire_hosts/application.js
-- app/assets/javascripts/foreman_expire_hosts/datepicker_for_host_expired_on_field.js
-- app/assets/stylesheets/foreman_expire_hosts/application.scss
 - app/controllers/concerns/foreman_expire_hosts/api/v2/hosts_controller_extensions.rb
 - app/controllers/concerns/foreman_expire_hosts/host_controller_extensions.rb
 - app/helpers/concerns/foreman_expire_hosts/audits_helper_extensions.rb
 - app/helpers/concerns/foreman_expire_hosts/hosts_helper_extensions.rb
 - app/helpers/expire_hosts_mailer_helper.rb
+- app/helpers/foreman_expire_hosts/hosts_helper.rb
 - app/mailers/expire_hosts_mailer.rb
 - app/models/concerns/foreman_expire_hosts/host_ext.rb
 - app/models/host_status/expiration_status.rb
 - app/models/setting/expire_hosts.rb
 - app/overrides/add_expired_on_field_to_host_form.rb
 - app/overrides/add_expired_on_field_to_host_show.rb
-- app/overrides/add_js_to_host_index.rb
 - app/overrides/deleted_expired_host_comment_in_audits.rb
 - app/services/foreman_expire_hosts/action/base.rb
 - app/services/foreman_expire_hosts/action/delete_expired_hosts.rb
@@ -127,7 +147,7 @@ files:
 - config/routes.rb
 - db/migrate/20150427101516_add_expiry_on_to_hosts.rb
 - db/seeds.d/80_expire_hosts_ui_notification.rb
-- foreman_expire_hosts.gemspec
+- extra/foreman_expire_hosts.cron
 - lib/expire_hosts_notifications.rb
 - lib/foreman_expire_hosts.rb
 - lib/foreman_expire_hosts/engine.rb
@@ -148,7 +168,7 @@ homepage: https://github.com/theforeman/foreman_expire_hosts
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,20 +183,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Foreman plugin for limiting host lifetime
 test_files:
-- test/factories/foreman_expire_hosts_factories.rb
-- test/functional/api/v2/hosts_controller_test.rb
-- test/functional/concerns/hosts_controller_extensions_test.rb
-- test/helpers/hosts_helper_test.rb
-- test/lib/expire_hosts_notifications_test.rb
-- test/test_plugin_helper.rb
-- test/unit/concerns/host_extensions_test.rb
 - test/unit/expire_hosts_mailer_test.rb
-- test/unit/expiry_edit_authorizer_test.rb
 - test/unit/host_status/expiration_status_test.rb
 - test/unit/safe_destroy_test.rb
+- test/unit/expiry_edit_authorizer_test.rb
+- test/unit/concerns/host_extensions_test.rb
+- test/factories/foreman_expire_hosts_factories.rb
+- test/lib/expire_hosts_notifications_test.rb
+- test/test_plugin_helper.rb
+- test/helpers/hosts_helper_test.rb
+- test/functional/api/v2/hosts_controller_test.rb
+- test/functional/concerns/hosts_controller_extensions_test.rb

data/.gitignore

@@ -1,15 +0,0 @@
-*.sw?
-.idea
-.bundle/
-log/*.log
-pkg/
-test/dummy/db/*.sqlite3
-test/dummy/log/*.log
-test/dummy/tmp/
-test/dummy/.sass-cache
-locale/*.mo
-locale/*/*.pox
-locale/*/*.edit.po
-locale/*/*.po.time_stamp
-Gemfile.lock
-*.gem

data/.rubocop.yml

@@ -1,73 +0,0 @@
-inherit_from:
-  - .rubocop_todo.yml
-
-AllCops:
-  TargetRubyVersion: 2.2
-  TargetRailsVersion: 5.1
-  Exclude:
-    - 'Rakefile'
-
-Rails:
-  Enabled: true
-
-Rails/Date:
-  Enabled: false
-
-# Don't enforce documentation
-Style/Documentation:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 40
-
-Naming/AccessorMethodName:
-  Enabled: false
-
-Style/RedundantSelf:
-  Enabled: false
-
-Metrics/ClassLength:
-  Max: 500
-
-Naming/FileName:
-  Exclude:
-      - 'db/seeds.d/*'
-
-Style/WordArray:
-  Enabled: false
-
-Style/BracesAroundHashParameters:
-  Enabled: false
-
-Style/RescueModifier:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/EachWithObject:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Enabled: false
-
-Style/SymbolArray:
-  Enabled: false
-
-Style/FormatString:
-  Enabled: false
-
-Style/FormatStringToken:
-  Enabled: false
-
-Style/HashSyntax:
-  Enabled: false
-
-Rails/HasManyOrHasOneDependent:
-  Enabled: false
-
-Style/CommentedKeyword:
-  Enabled: false
-
-Rails/LexicallyScopedActionFilter:
-  Enabled: false

data/.rubocop_todo.yml

@@ -1,42 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2017-08-01 16:36:14 +0200 using RuboCop version 0.49.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 12
-Metrics/AbcSize:
-  Max: 51
-
-# Offense count: 4
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 35
-  Exclude:
-    - 'test/**/*.rb'
-
-# Offense count: 3
-Metrics/CyclomaticComplexity:
-  Max: 11
-
-# Offense count: 89
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 362
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ModuleLength:
-  Max: 110
-
-# Offense count: 3
-Metrics/PerceivedComplexity:
-  Max: 11
-
-# Offense count: 2
-Rails/OutputSafety:
-  Exclude:
-    - 'app/helpers/concerns/foreman_expire_hosts/audits_helper_extensions.rb'

data/Gemfile

@@ -1,3 +0,0 @@
-source 'http://rubygems.org'
-
-gemspec

data/app/assets/javascripts/foreman_expire_hosts/application.js

@@ -1,3 +0,0 @@
-//= require bootstrap-datepicker
-//= require foreman_expire_hosts/datepicker_for_host_expired_on_field
-

data/app/assets/javascripts/foreman_expire_hosts/datepicker_for_host_expired_on_field.js

@@ -1,27 +0,0 @@
-var shortcuts = {"1 day": 1, "1 week": 7, "1 month": 30, "1 year": 365, "3 days": 3, "3 weeks": 21, "3 months": 90};
-function append_shortcuts() {
-  if ($(".datepicker-days #datepicker_shortcuts").length == 0) {
-    var shortcuts_html = "<div id='datepicker_shortcuts'><div>";
-    var shortcut_item = 1;
-    $.each(shortcuts, function (lable, days) {
-      var today = new Date();
-      today.setDate(today.getDate() + days);
-      if (shortcut_item == 5) {
-        shortcuts_html += "</div><div style='padding-top: 3px'>"
-      }
-      shortcuts_html += "<a style='width: 65px;' class='btn btn-default btn-xs' role='button' title='" + $.fn.datepicker.dates.en.monthsShort[today.getMonth()] + " " + today.getDate() + " " + today.getFullYear() + "' onclick='populate_date_from_days(" + days + ")'>" + lable + "</a>&nbsp;";
-      shortcut_item += 1
-    });
-    shortcuts_html += "</div></div>";
-    $(".datepicker-days table").before(shortcuts_html)
-  }
-}
-
-function populate_date_from_days(shortcut_days) {
-  var today = new Date();
-  today.setDate(today.getDate() + shortcut_days);
-  $('#host_expired_on').datepicker('setDate', today);
-  $('#host_expired_on').datepicker('remove');
-  //$('#host_expired_on').val(today.getDate()+'/'+(today.getMonth()+1)+'/'+today.getFullYear())
-  //$('#host_expired_on').datepicker('hide')
-}

data/app/assets/stylesheets/foreman_expire_hosts/application.scss

@@ -1,4 +0,0 @@
-/*
- *= require_self
- *= require bootstrap-datepicker3
- */

data/app/overrides/add_js_to_host_index.rb

@@ -1,6 +0,0 @@
-Deface::Override.new(
-  :virtual_path => 'hosts/_list',
-  :name => 'host_list_expiration_js',
-  :insert_before => '#confirmation-modal',
-  :text => "<%= stylesheet 'foreman_expire_hosts/application' %><%= javascript 'foreman_expire_hosts/application' %>"
-)

data/foreman_expire_hosts.gemspec

@@ -1,26 +0,0 @@
-require File.expand_path('lib/foreman_expire_hosts/version', __dir__)
-require 'date'
-
-Gem::Specification.new do |s|
-  s.name        = 'foreman_expire_hosts'
-  s.version     = ForemanExpireHosts::VERSION
-  s.date        = Date.today.to_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.homepage    = 'https://github.com/theforeman/foreman_expire_hosts'
-  s.licenses    = ['GPL-3.0']
-
-  s.files =            `git ls-files`.split("\n")
-  s.test_files =       `git ls-files test`.split("\n")
-  s.extra_rdoc_files = `git ls-files doc`.split("\n") + Dir['README*', 'LICENSE']
-
-  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.59.2'
-end