foreman_expire_hosts 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6fe2409547a823dfd323178e3d0919eac77bebc
-  data.tar.gz: 87226ce69f178e588ca451eef22a0d8982bc1f99
+  metadata.gz: 4a6df2938b1dd23bcc51ceeec5b038f7b4cbbb86
+  data.tar.gz: 5d0d5c9d10dc61ca98425b68eb012bc06f4dea3d
 SHA512:
-  metadata.gz: 815773fd3b98e15221daca80534cbf0ab0cc376ae4328409df26564a19bcfac2bea34d4aad22095e42439c7273726d909a005b8a6ae70ca7e4ede080e4436eea
-  data.tar.gz: e556d4c3b0ff806fd126551cc7af2d36af1bc033e0ed0946cc947f64c8470a87cd3ce60555fd5f14d792bd99139df3c416e44f980df37db1c74dc2d41d4787bf
+  metadata.gz: 473e5e92b4df667cd758a6abb628cbf8d47a4521e8de5b184b792a41110a91c0c402a5e27876598d9e7c15e317a0b1e06637d6eda2ba219627a327ebadf3a9b0
+  data.tar.gz: 4070af0f6b9ab0703edba57c4fe6c086496c62abce17386906f122ae6f929557b28c1f1907579016e8cc6a69e7975a489f415c1bf44026c78870050a56efeae5

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

@@ -7,6 +7,7 @@ module ForemanExpireHosts
     end
 
     def multiple_actions_with_expire_hosts
+      return multiple_actions_without_expire_hosts unless authorized_for(:controller => :hosts, :action => :edit)
       multiple_actions_without_expire_hosts + [[_('Change Expiration'), select_multiple_expiration_hosts_path]]
     end
 

data/app/mailers/expire_hosts_mailer.rb

@@ -4,25 +4,25 @@ class ExpireHostsMailer < ApplicationMailer
 
   def deleted_hosts_notification(emails, hosts)
     @hosts = hosts
-    mail(:to => emails, :subject => 'Deleted expired hosts in Foreman', :importance => 'High')
+    mail(:to => emails, :subject => _('Deleted expired hosts in Foreman'), :importance => 'High')
   end
 
   def failed_to_delete_hosts_notification(emails, hosts)
     @hosts = hosts
-    mail(:to => emails, :subject => 'Failed to delete expired hosts in Foreman', :importance => 'High')
+    mail(:to => emails, :subject => _('Failed to delete expired hosts in Foreman'), :importance => 'High')
   end
 
   def stopped_hosts_notification(emails, delete_date, hosts)
     @hosts       = hosts
     @delete_date = delete_date
-    mail(:to => emails, :subject => 'Stopped expired hosts in Foreman', :importance => 'High') do |format|
+    mail(:to => emails, :subject => _('Stopped expired hosts in Foreman'), :importance => 'High') do |format|
       format.html { render :layout => 'application_mailer' }
     end
   end
 
   def failed_to_stop_hosts_notification(emails, hosts)
     @hosts = hosts
-    mail(:to => emails, :subject => 'Failed to stop expired hosts in Foreman', :importance => 'High') do |format|
+    mail(:to => emails, :subject => _('Failed to stop expired hosts in Foreman'), :importance => 'High') do |format|
       format.html { render :layout => 'application_mailer' }
     end
   end
@@ -30,7 +30,7 @@ class ExpireHostsMailer < ApplicationMailer
   def expiry_warning_notification(emails, expiry_date, hosts)
     @hosts       = hosts
     @expiry_date = expiry_date
-    mail(:to => emails, :subject => 'Expiring hosts in foreman', :importance => 'High') do |format|
+    mail(:to => emails, :subject => _('Expiring hosts in foreman'), :importance => 'High') do |format|
       format.html { render :layout => 'application_mailer' }
     end
   end

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

@@ -16,7 +16,7 @@ module ForemanExpireHosts
       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, -> { 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
     end
@@ -60,7 +60,7 @@ module ForemanExpireHosts
 
     def expired_past_grace_period?
       return false unless expires?
-      expiration_grace_period_end_date < Date.today
+      expiration_grace_period_end_date <= Date.today
     end
 
     def pending_expiration_start_date

data/app/models/host_status/expiration_status.rb

@@ -11,9 +11,9 @@ module HostStatus
     end
 
     def to_status(_options = {})
+      return EXPIRES_TODAY if host.expires_today?
       return EXPIRED if host.expired_past_grace_period?
       return IN_GRACE_PERIOD if host.expired?
-      return EXPIRES_TODAY if host.expires_today?
       return PENDING if host.pending_expiration?
       OK
     end
@@ -24,12 +24,12 @@ module HostStatus
         HostStatus::Global::OK
       when EXPIRES_TODAY
         HostStatus::Global::WARN
+      when PENDING
+        HostStatus::Global::WARN
       when IN_GRACE_PERIOD
         HostStatus::Global::ERROR
       when EXPIRED
         HostStatus::Global::ERROR
-      when PENDING
-        HostStatus::Global::ERROR
       else
         HostStatus::Global::OK
       end

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

@@ -1,4 +1,4 @@
-<%= _('The following hosts have been expired in Foreman and will be stopped for now. These hosts will be destroyed on %s. Please change their expiry date and power them on if you want to keep the hosts.') % l @delete_date %>
+<%= _('The following hosts have been expired in Foreman and will be stopped for now. These hosts will be destroyed on %s. Please change their expiry date and power them on if you want to keep the hosts.') % l(@delete_date) %>
 <br/><br/>
 
 <%= render 'hosts_table', :hosts => @hosts, :link_to_hosts => true %>

data/lib/expire_hosts_notifications.rb

@@ -12,7 +12,7 @@ module ExpireHostsNotifications
     def catch_delivery_errors(message, hosts = [])
       yield
     rescue => error
-      message = "#{message} for Hosts #{hosts.map(&:name).to_sentence}"
+      message = _("%{message} for Hosts %{hosts}") % {:message => message, :hosts => hosts.map(&:name).to_sentence}
       Foreman::Logging.exception(message, error)
     end
 
@@ -24,7 +24,7 @@ module ExpireHostsNotifications
       deletable_hosts.each do |deletable_host|
         Rails.logger.info "Deleting expired host #{deletable_host}"
         deletable_host.audit_comment = _('Destroyed since it got expired on %s') % deletable_host.expired_on
-        if deletable_host # .destroy
+        if deletable_host.destroy
           deleted_hosts << deletable_host
         else
           failed_delete_hosts << deletable_host

data/lib/foreman_expire_hosts/version.rb

@@ -1,3 +1,3 @@
 module ForemanExpireHosts
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.0.2'.freeze
 end

data/test/factories/foreman_expire_hosts_factories.rb

@@ -1,14 +1,26 @@
 FactoryGirl.modify do
   factory :host do
+    trait :without_validation do
+      # Turn off validation so we can create a host with an expiry date in the past
+      to_create {|instance| instance.save(validate: false) }
+    end
+
+    trait :expires_in_a_week do
+      expired_on Date.today + 7
+    end
+
     trait :expires_today do
+      without_validation
       expired_on Date.today
     end
 
     trait :expired_grace do
+      without_validation
       expired_on Date.today - 1
     end
 
     trait :expired do
+      without_validation
       expired_on Date.today - 356
     end
   end

data/test/lib/expire_hosts_notifications_test.rb

@@ -0,0 +1,76 @@
+require 'test_plugin_helper'
+
+class ExpireHostsNotificationsTest < ActiveSupport::TestCase
+  setup do
+    setup_settings
+    @owner = FactoryGirl.create(:user, :with_mail)
+  end
+
+  context '#delete_expired_hosts' do
+    setup do
+      @hosts = FactoryGirl.create_list(:host, 2, :expired, :owner => @owner)
+      @unaffected_hosts = FactoryGirl.create_list(:host, 2, :owner => @owner)
+    end
+
+    test 'should delete expired hosts' do
+      ExpireHostsMailer.expects(:deleted_hosts_notification).once
+      assert_difference 'Host.count', -2 do
+        ExpireHostsNotifications.delete_expired_hosts
+      end
+    end
+  end
+
+  context '#stop_expired_hosts' do
+    setup do
+      @power_mock = mock('power')
+      @power_mock.stubs(:ready?).returns(true)
+      @host = FactoryGirl.create(:host, :expired, :on_compute_resource, :owner => @owner)
+      @host.unstub(:queue_compute)
+      Host.any_instance.stubs(:power).returns(@power_mock)
+      @unaffected_hosts = FactoryGirl.create_list(:host, 2, :owner => @owner)
+    end
+
+    test 'should stop expired hosts' do
+      @power_mock.expects(:stop).returns(true)
+      ExpireHostsMailer.expects(:stopped_hosts_notification).once
+      ExpireHostsNotifications.stop_expired_hosts
+    end
+
+    test 'should send failure message if host cannot be stopped' do
+      @power_mock.expects(:stop).returns(false)
+      ExpireHostsMailer.expects(:failed_to_stop_hosts_notification).once
+      ExpireHostsNotifications.stop_expired_hosts
+    end
+  end
+
+  context '#deliver_expiry_warning_notification' do
+    setup do
+      Setting['notify1_days_before_host_expiry'] = 7
+      @hosts = FactoryGirl.create_list(:host, 2, :expires_in_a_week, :owner => @owner)
+    end
+
+    test 'should send a single notification' do
+      ExpireHostsMailer.expects(:expiry_warning_notification).once
+      ExpireHostsNotifications.deliver_expiry_warning_notification
+    end
+
+    test 'should send two notifications for two users' do
+      owner2 = FactoryGirl.create(:user, :with_mail)
+      host2 = FactoryGirl.create(:host, :expires_in_a_week, :owner => owner2)
+      ExpireHostsMailer.expects(:expiry_warning_notification).twice
+      ExpireHostsNotifications.deliver_expiry_warning_notification
+    end
+  end
+
+  context '#catch_delivery_errors' do
+    test 'should catch and log errors' do
+      host1 = OpenStruct.new(:name => 'Alpha')
+      host2 = OpenStruct.new(:name => 'Bravo')
+      hosts = [host1, host2]
+      Foreman::Logging.expects(:exception).with('failure for Hosts Alpha and Bravo', anything)
+      ExpireHostsNotifications.catch_delivery_errors('failure', hosts) do
+        raise "Test"
+      end
+    end
+  end
+end

data/test/test_plugin_helper.rb

@@ -1,10 +1,24 @@
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
+require 'database_cleaner'
 
 # Add plugin to FactoryGirl's paths
 FactoryGirl.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
 FactoryGirl.reload
 
+# 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
+  end
+
+  after :each do
+    DatabaseCleaner.clean
+  end
+end

data/test/unit/concerns/host_extensions_test.rb

@@ -1,6 +1,8 @@
 require 'test_plugin_helper'
 
 class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
+  EXPIRATION_SCOPES = ['expiring', 'expired', 'expiring_today', 'expired_past_grace_period']
+
   setup do
     User.current = FactoryGirl.build(:user, :admin)
     setup_settings
@@ -53,6 +55,10 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     test 'should not be pending expiration' do
       refute @host.pending_expiration?
     end
+
+    test 'should not be in any expiration scopes' do
+      exists_only_in_scopes(@host, [])
+    end
   end
 
   context 'a expired host' do
@@ -79,6 +85,10 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     test 'should not be pending expiration' do
       refute @host.pending_expiration?
     end
+
+    test 'should only exist in correct scopes' do
+      exists_only_in_scopes(@host, ['expiring', 'expired', 'expired_past_grace_period'])
+    end
   end
 
   context 'a host expiring today' do
@@ -106,6 +116,10 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     test 'should be pending expiration' do
       assert @host.pending_expiration?
     end
+
+    test 'should only exist in correct scopes' do
+      exists_only_in_scopes(@host, ['expiring', 'expiring_today'])
+    end
   end
 
   context 'a host in grace period' do
@@ -132,5 +146,21 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     test 'should not be pending expiration' do
       refute @host.pending_expiration?
     end
+
+    test 'should only exist in correct scopes' do
+      exists_only_in_scopes(@host, ['expiring', 'expired'])
+    end
+  end
+
+  private
+
+  def exists_only_in_scopes(host, valid_scopes)
+      host.save(validate: false)
+      (EXPIRATION_SCOPES - valid_scopes).each do |scope|
+        refute Host::Managed.send(scope).exists?(host.id), "Host should not exist in #{scope} scope"
+      end
+      valid_scopes.each do |scope|
+        assert Host::Managed.send(scope).exists?(host.id), "Host should exist in #{scope} scope"
+      end
   end
 end

data/test/unit/expire_hosts_mailer_test.rb

@@ -0,0 +1,64 @@
+require 'test_plugin_helper'
+
+class ExpireHostMailerTest < ActionMailer::TestCase
+  setup do
+    setup_settings
+    @emails = ['test@example.com']
+    @hosts = FactoryGirl.create_list(:host, 2, :managed)
+  end
+
+  context 'deleted hosts notification' do
+    setup do
+      @mail = ExpireHostsMailer.deleted_hosts_notification(@emails, @hosts).deliver
+    end
+
+    test 'subject should be set' do
+      refute_nil @mail.subject
+      assert_includes @mail.subject, 'Deleted expired hosts in Foreman'
+    end
+  end
+
+  context 'failed to delete hosts notification' do
+    setup do
+      @mail = ExpireHostsMailer.failed_to_delete_hosts_notification(@emails, @hosts).deliver
+    end
+
+    test 'subject should be set' do
+      refute_nil @mail.subject
+      assert_includes @mail.subject, 'Failed to delete expired hosts in Foreman'
+    end
+  end
+
+  context 'stopped hosts notification' do
+    setup do
+      @mail = ExpireHostsMailer.stopped_hosts_notification(@emails, Date.today, @hosts).deliver
+    end
+
+    test 'subject should be set' do
+      refute_nil @mail.subject
+      assert_includes @mail.subject, 'Stopped expired hosts in Foreman'
+    end
+  end
+
+  context 'failed to stop hosts notification' do
+    setup do
+      @mail = ExpireHostsMailer.failed_to_stop_hosts_notification(@emails, @hosts).deliver
+    end
+
+    test 'subject should be set' do
+      refute_nil @mail.subject
+      assert_includes @mail.subject, 'Failed to stop expired hosts in Foreman'
+    end
+  end
+
+  context 'expiry warning notification' do
+    setup do
+      @mail = ExpireHostsMailer.expiry_warning_notification(@emails, Date.today, @hosts).deliver
+    end
+
+    test 'subject should be set' do
+      refute_nil @mail.subject
+      assert_includes @mail.subject, 'Expiring hosts in foreman'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_expire_hosts
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Nagarjuna Rachaneni
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -118,8 +118,10 @@ files:
 - lib/tasks/expired_hosts.rake
 - test/factories/foreman_expire_hosts_factories.rb
 - test/functional/concerns/hosts_controller_extensions_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/host_status/expiration_status_test.rb
 homepage: https://github.com/theforeman/foreman_expire_hosts
 licenses:
@@ -148,7 +150,9 @@ summary: Foreman plugin for limiting host lifetime
 test_files:
 - test/factories/foreman_expire_hosts_factories.rb
 - test/functional/concerns/hosts_controller_extensions_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/host_status/expiration_status_test.rb
 has_rdoc: