foreman_expire_hosts 7.0.4 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5afc13d619d302e3e05ae902ff90f65d5eefd05e03b00369c7e3ca538260555
-  data.tar.gz: 9cdf5ad3a41cdc45a2fe0d4f5c0dc850e0a658abc72e20c83a436b5279a19268
+  metadata.gz: 74607c8b578a2549b16b8858c186dec33519fbec2f21c946e30d3b01b8c8ee13
+  data.tar.gz: d07c8068f7a85eb297d95c461abf65c1951409ba483c6bc5329c8abee318def5
 SHA512:
-  metadata.gz: e65dddbebf6e2140e12fd05adf1b4584284c7e422a5399642eaf7e59e423b86561dbc9a7c0071835fbbffa50d3e34985ce31b1d1d3f955147e0849b2d8ea0d50
-  data.tar.gz: 4786bb290163e8f868dbe81d377d3747143cd5bcf3e00194625ea7f1c88f2ef0f6840fb2ccce7f5561a005140cacd6ea625a98b1b9fb45da4bf3444387a6047e
+  metadata.gz: 2c214dc0b884be13b4195ef443079db7a524839279aee288addace26dbd61e3d170e984f3468377dfba59cb89bb8521f4c18fa8667ad133bbb6b364e4514f1ab
+  data.tar.gz: 1e68621e1fb15baa5a94d40f080daecc55ad2fcbec4aedfd97b70fc5ec750c3198a3ff4e227743fe03e5cb95c603189dee628de2b265da8cb4d8ac7627643b07

data/README.md

@@ -19,6 +19,7 @@ This plugin will send two warning notifications before host expiry (see Settings
 | >= 1.17         | ~> 5.0         |
 | >= 1.18         | ~> 6.0         |
 | >= 1.24         | ~> 7.0         |
+| >= 3.0          | ~> 8.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/host_controller_extensions.rb

@@ -55,13 +55,8 @@ module ForemanExpireHosts
 
     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}")
+        expired_on = params[:host][:expired_on]
+        expired_on.present? ? Date.parse(expired_on) : nil
       end
     end
 

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

@@ -22,12 +22,5 @@ module ForemanExpireHosts
     def future_time_in_words(to_time, options = {})
       distance_of_time_in_words(to_time, Time.current, options)
     end
-
-    def datepicker_f(form, attr, options = {}, html_options = {})
-      field(form, attr, options) do
-        addClass options, 'form-control'
-        form.date_select(attr, options, html_options)
-      end
-    end
   end
 end

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

@@ -55,7 +55,7 @@ module ForemanExpireHosts
     def expiration_grace_period_end_date
       return nil unless expires?
 
-      expired_on + Setting[:days_to_delete_after_host_expiration].to_i
+      expired_on.to_date + Setting[:days_to_delete_after_host_expiration].to_i
     end
 
     def expired_past_grace_period?

data/app/models/host_status/expiration_status.rb

@@ -41,15 +41,15 @@ module HostStatus
     def to_label(_options = {})
       case to_status
       when OK
-        N_('Expires on %s') % I18n.l(host.expired_on)
+        N_('Expires on %s') % I18n.l(host.expired_on.to_date)
       when EXPIRES_TODAY
         N_('Expires today')
       when IN_GRACE_PERIOD
-        N_('Expired on %s, in grace period') % I18n.l(host.expired_on)
+        N_('Expired on %s, in grace period') % I18n.l(host.expired_on.to_date)
       when EXPIRED
-        N_('Expired on %s') % I18n.l(host.expired_on)
+        N_('Expired on %s') % I18n.l(host.expired_on.to_date)
       else
-        N_('Pending expiration on %s') % I18n.l(host.expired_on)
+        N_('Pending expiration on %s') % I18n.l(host.expired_on.to_date)
       end
     end
 

data/app/services/foreman_expire_hosts/safe_destroy.rb

@@ -33,7 +33,7 @@ module ForemanExpireHosts
     private
 
     def with_katello?
-      Katello # rubocop:disable Lint/Void
+      Katello::VERSION # rubocop:disable Lint/Void
       true
     rescue StandardError
       false

data/app/views/expire_hosts_mailer/_hosts_table.html.erb

@@ -7,9 +7,6 @@
       <th>
         <%= _('Host group') %>
       </th>
-      <th>
-        <%= _('Environment') %>
-      </th>
       <th>
         <%= _('Expiration Date') %>
       </th>
@@ -28,9 +25,6 @@
         <td class="hosts-rows">
           <%= host.hostgroup %>
         </td>
-        <td class="hosts-rows">
-          <%= host.environment %>
-        </td>
         <td class="hosts-rows">
           <%= "#{l(host.expired_on)} (#{relative_date(host.expired_on)})" if host.expires? %>
         </td>

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

@@ -1,13 +1,12 @@
-<%= datepicker_f f, :expired_on,
-           {
-             :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.'))
-           }
-%>
+<div class="form-group">
+  <label class="col-md-2 control-label"><%= _('Expires on') %></label>
+  <% if @host.can_modify_expiry_date? %>
+    <div class="col-md-4">
+      <%= react_component('DatePicker', { value: @host.expired_on, name: 'host[expired_on]', placement: 'bottom' }.to_json) %>
+      <%= content_tag(:span, _('Expired hosts will be deleted automatically after the grace period has passed. If you do not want this host to expire and do not want it to be deleted automatically, do not specify an expiry date.'), class: 'help-block help-inline') %>
+    </div>
+  <% else %>
+    <%= content_tag(:span, @host.expired_on&.to_s(:long), class: 'col-md-4') %>
+    <%= content_tag(:span, _('You are not allowed to change the expiry date of this host.'), class: 'help-block help-inline') %>
+  <% end %>
+</div>

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

@@ -1,18 +1,9 @@
 <%= render 'selected_hosts', :hosts => @hosts %>
 
-<%= form_for :host, :url => update_multiple_expiration_hosts_path(:host_ids => params[:host_ids]) do |f| %>
-
-<%= _('Hosts will be deleted automatically on the given expiry date. Leave blank to clear expiration date.') %>
-
-<%= datepicker_f f, :expired_on,
-  {
-    :autocomplete => false,
-    :include_blank => true,
-    :use_month_numbers => false,
-    :start_year => Date.today.year
-  },
-  {
-    :onchange => 'tfm.hosts.table.toggleMultipleOkButton(this);'
-  }
-%>
+<%= form_for :host, html: { style: 'padding-bottom: 250px;' }, :url => update_multiple_expiration_hosts_path(:host_ids => params[:host_ids]) do |f| %>
+  <%= date_local_f f, :expired_on,
+    label: _('Expired on'),
+    label_help: _('Hosts will be deleted automatically on the given expiry date. Leave blank to clear expiration date.'),
+    placement: 'bottom'
+  %>
 <% end %>

data/db/migrate/20220923181700_fix_settings_category_to_dsl.rb

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

data/db/migrate/20230112104438_change_expired_on_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ChangeExpiredOnType < ActiveRecord::Migration[6.0]
+  def up
+    change_column :hosts, :expired_on, :datetime
+  end
+
+  def down
+    change_column :hosts, :expired_on, :date
+  end
+end

data/lib/foreman_expire_hosts/engine.rb

@@ -19,13 +19,9 @@ module ForemanExpireHosts
       end
     end
 
-    initializer 'foreman_expire_hosts.load_default_settings', :before => :load_config_initializers do
-      require_dependency File.expand_path('../../app/models/setting/expire_hosts.rb', __dir__) if (Setting.table_exists? rescue(false))
-    end
-
     initializer 'foreman_expire_hosts.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_expire_hosts do
-        requires_foreman '>= 1.24'
+        requires_foreman '>= 3.0.0'
         register_custom_status HostStatus::ExpirationStatus
 
         # strong parameters
@@ -43,6 +39,43 @@ module ForemanExpireHosts
           'hosts/update_multiple_expiration'
         ]
 
+        Setting::BLANK_ATTRS << 'host_expiry_email_recipients'
+
+        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'))
+            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'))
+            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'))
+            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'))
+            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'))
+            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.'),
+                    default: nil,
+                    full_name: N_('Expiry e-mail recipients'))
+          end
+        end
+
         extend_rabl_template 'api/v2/hosts/main', 'api/v2/hosts/expiration'
 
         describe_host do

data/lib/foreman_expire_hosts/version.rb

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

data/lib/tasks/expired_hosts.rake

@@ -25,24 +25,9 @@ namespace :test do
   end
 end
 
-namespace :foreman_expire_hosts do
-  task :rubocop => :environment do
-    begin
-      require 'rubocop/rake_task'
-      RuboCop::RakeTask.new(:rubocop_foreman_expire_hosts) do |task|
-        task.patterns = ["#{ForemanExpireHosts::Engine.root}/app/**/*.rb",
-                         "#{ForemanExpireHosts::Engine.root}/lib/**/*.rb",
-                         "#{ForemanExpireHosts::Engine.root}/test/**/*.rb"]
-      end
-    rescue StandardError
-      puts 'Rubocop not loaded.'
-    end
-
-    Rake::Task['rubocop_foreman_expire_hosts'].invoke
-  end
-end
-
 Rake::Task[:test].enhance ['test:foreman_expire_hosts']
 
 load 'tasks/jenkins.rake'
-Rake::Task['jenkins:unit'].enhance ['test:foreman_expire_hosts', 'foreman_expire_hosts:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_expire_hosts']
+end

data/test/functional/concerns/hosts_controller_extensions_test.rb

@@ -4,9 +4,9 @@ require 'test_plugin_helper'
 
 class HostsControllerTest < ActionController::TestCase
   setup do
+    Setting['host_details_ui'] = false if Setting['host_details_ui']
     User.current = users(:admin)
     disable_orchestration
-    setup_settings
   end
 
   describe 'host creation' do
@@ -20,13 +20,11 @@ class HostsControllerTest < ActionController::TestCase
           :domain_id => domains(:mydomain).id,
           :operatingsystem_id => operatingsystems(:redhat).id,
           :architecture_id => architectures(:x86_64).id,
-          :environment_id => environments(:production).id,
           :subnet_id => subnets(:one).id,
           :medium_id => media(:one).id,
           :pxe_loader => 'Grub2 UEFI',
           :realm_id => realms(:myrealm).id,
           :disk => 'empty partition',
-          :puppet_proxy_id => smart_proxies(:puppetmaster).id,
           :root_pass => 'xybxa6JUkz63w',
           :location_id => taxonomies(:location1).id,
           :organization_id => taxonomies(:organization1).id,
@@ -53,7 +51,7 @@ class HostsControllerTest < ActionController::TestCase
   describe 'setting expiration date on multiple hosts' do
     before do
       as_admin do
-        @hosts = FactoryBot.create_list(:host, 2, :with_puppet)
+        @hosts = FactoryBot.create_list(:host, 2)
       end
       @request.env['HTTP_REFERER'] = hosts_path
     end
@@ -70,7 +68,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(1i)' => expiration_date.day.to_s, 'expired_on(2i)' => expiration_date.month.to_s, 'expired_on(3i)' => expiration_date.year.to_s } }
+                 :host => { 'expired_on' => expiration_date.strftime('%Y-%m-%d') } }
 
       post :update_multiple_expiration, params: params, session: set_session_user.merge(:user => users(:admin).id)
 

data/test/lib/expire_hosts_notifications_test.rb

@@ -7,7 +7,6 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
   include NotificationBlueprintSeeds
 
   setup do
-    setup_settings
     ActionMailer::Base.deliveries.clear
   end
 

data/test/test_plugin_helper.rb

@@ -16,10 +16,6 @@ require File.join(
 # Foreman's setup doesn't handle cleaning up for Minitest::Spec
 DatabaseCleaner.strategy = :transaction
 
-def setup_settings
-  Setting::ExpireHosts.load_defaults
-end
-
 class Minitest::Spec
   before :each do
     DatabaseCleaner.start

data/test/unit/concerns/host_extensions_test.rb

@@ -7,7 +7,6 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
 
   setup do
     User.current = FactoryBot.build(:user, :admin)
-    setup_settings
   end
 
   context 'without required expiration date' do

data/test/unit/expire_hosts_mailer_test.rb

@@ -3,10 +3,6 @@
 require 'test_plugin_helper'
 
 class ExpireHostMailerTest < ActionMailer::TestCase
-  setup do
-    setup_settings
-  end
-
   let(:recipient) { FactoryBot.create(:user, :with_mail) }
   let(:hosts) { FactoryBot.create_list(:host, 2, :managed) }
 
@@ -84,7 +80,7 @@ class ExpireHostMailerTest < ActionMailer::TestCase
 
     test 'mail is delivered to admin address' do
       assert_nil recipient.mail
-      assert_equal ['root@some.host.fqdn'], mail.to
+      assert_equal [Setting[:administrator]], mail.to
     end
   end
 end

data/test/unit/expiry_edit_authorizer_test.rb

@@ -30,7 +30,6 @@ module ForemanExpireHosts
 
       context 'with edit_hosts and owner permission' do
         setup do
-          setup_settings
           FactoryBot.create(:filter, :role => role, :permissions => [edit_permission])
         end
         let(:hosts) { FactoryBot.create_list(:host, 2, :owner => user) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_expire_hosts
 version: !ruby/object:Gem::Version
-  version: 7.0.4
+  version: 8.1.0
 platform: ruby
 authors:
 - Nagarjuna Rachaneni
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -39,62 +39,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.80.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.80.0
-- !ruby/object:Gem::Dependency
-  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: 2.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        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.
@@ -116,7 +60,6 @@ files:
 - 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/deleted_expired_host_comment_in_audits.rb
@@ -146,6 +89,8 @@ files:
 - app/views/hosts/select_multiple_expiration.html.erb
 - config/routes.rb
 - db/migrate/20150427101516_add_expiry_on_to_hosts.rb
+- 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/expire_hosts_notifications.rb
@@ -183,19 +128,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Foreman plugin for limiting host lifetime
 test_files:
-- test/unit/expire_hosts_mailer_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
+- 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

data/app/models/setting/expire_hosts.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-class Setting::ExpireHosts < Setting
-  Setting::BLANK_ATTRS.push('host_expiry_email_recipients')
-
-  def self.load_defaults
-    # Check the table exists
-    return unless super
-
-    self.transaction do
-      [
-        self.set('is_host_expiry_date_mandatory', N_('Make expiry date field mandatory on host creation/update'), false, N_('Require host expiry date')),
-        self.set('can_owner_modify_host_expiry_date', N_('Allow host owner to modify host expiry date field. If the field is false then admin only can edit expiry field'), false, N_('Host owner can modify host expiry date')),
-        self.set('notify1_days_before_host_expiry', N_('Send first notification to owner of hosts about his hosts expiring in given days. Must be integer only'), 7, N_('First expiry notification')),
-        self.set('notify2_days_before_host_expiry', N_('Send second notification to owner of hosts about his hosts expiring in given days. Must be integer only'), 1, N_('Second expiry notification')),
-        self.set('days_to_delete_after_host_expiration', N_('Delete expired hosts after given days of hosts expiry date. Must be integer only'), 3, N_('Expiry grace period in days')),
-        self.set('host_expiry_email_recipients', 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.'), nil, N_('Expiry e-mail recipients'))
-      ].each { |s| self.create! s.update(:category => 'Setting::ExpireHosts') }
-    end
-
-    true
-  end
-end