foreman_expire_hosts 3.0.0 → 4.0.0

data/test/test_plugin_helper.rb

@@ -2,9 +2,14 @@
 require 'test_helper'
 require 'database_cleaner'
 
-# Add plugin to FactoryGirl's paths
-FactoryGirl.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
-FactoryGirl.reload
+# Add plugin to FactoryBot's paths
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryBot.reload
+
+# load notification seeds.
+require File.join(
+  File.dirname(__FILE__), '..', 'db', 'seeds.d', '80_expire_hosts_ui_notification'
+)
 
 # Foreman's setup doesn't handle cleaning up for Minitest::Spec
 DatabaseCleaner.strategy = :transaction

data/test/unit/concerns/host_extensions_test.rb

@@ -4,7 +4,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
   EXPIRATION_SCOPES = ['expiring', 'expired', 'expiring_today', 'expired_past_grace_period'].freeze
 
   setup do
-    User.current = FactoryGirl.build(:user, :admin)
+    User.current = FactoryBot.build(:user, :admin)
     setup_settings
   end
 
@@ -14,7 +14,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should not require expired on' do
-      host = FactoryGirl.build(:host)
+      host = FactoryBot.build(:host)
       assert host.valid?, "Should be valid without expiration date: : #{host.errors.messages}"
     end
   end
@@ -25,7 +25,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'should require expired on' do
-      host = FactoryGirl.build(:host)
+      host = FactoryBot.build(:host)
       refute host.valid?, "Can not be valid without expiration date: #{host.errors.messages}"
       assert_includes host.errors.messages.keys, :expired_on
     end
@@ -33,8 +33,8 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
 
   context 'changing expiration date for user owned host' do
     setup do
-      @user = FactoryGirl.create(:user)
-      @host = FactoryGirl.create(:host, :expired, :owner => @user)
+      @user = FactoryBot.create(:user)
+      @host = FactoryBot.create(:host, :expired, :owner => @user)
     end
 
     test 'admin should be able to change expiration date' do
@@ -43,7 +43,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     test 'user should not be able to change expiration date' do
-      as_user FactoryGirl.build(:user) do
+      as_user FactoryBot.build(:user) do
         @host.expired_on = Date.today + 5
         refute_valid @host
       end
@@ -67,13 +67,13 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
   end
 
   context 'changing expiration date for user' do
-    let(:host) { FactoryGirl.create(:host, :managed) }
+    let(:host) { FactoryBot.create(:host, :managed) }
 
     context 'with edit_host_expiry permission' do
-      let(:permission) { Permission.find_by_name('edit_host_expiry') }
-      let(:filter) { FactoryGirl.create(:filter, :permissions => [permission]) }
-      let(:role) { FactoryGirl.create(:role, :filters => [filter]) }
-      let(:user) { FactoryGirl.create(:user, :organizations => [host.organization], :locations => [host.location], :roles => [role]) }
+      let(:permission) { Permission.find_by(name: 'edit_host_expiry') }
+      let(:filter) { FactoryBot.create(:filter, :permissions => [permission]) }
+      let(:role) { FactoryBot.create(:role, :filters => [filter]) }
+      let(:user) { FactoryBot.create(:user, :organizations => [host.organization], :locations => [host.location], :roles => [role]) }
 
       test 'user can change expiry date' do
         as_user user do
@@ -83,7 +83,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
 
     context 'without edit_host_expiry permission' do
-      let(:user) { FactoryGirl.build(:user, :organizations => [host.organization], :locations => [host.location]) }
+      let(:user) { FactoryBot.build(:user, :organizations => [host.organization], :locations => [host.location]) }
 
       test 'user can not change expiry date' do
         as_user user do
@@ -95,7 +95,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
 
   context 'a host without expiration' do
     setup do
-      @host = FactoryGirl.build(:host)
+      @host = FactoryBot.build(:host)
     end
 
     test 'should not expire' do
@@ -125,7 +125,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
 
   context 'a expired host' do
     setup do
-      @host = FactoryGirl.build(:host, :expired)
+      @host = FactoryBot.build(:host, :expired)
     end
 
     test 'should expire' do
@@ -155,7 +155,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
 
   context 'a host expiring today' do
     setup do
-      @host = FactoryGirl.build(:host, :expires_today)
+      @host = FactoryBot.build(:host, :expires_today)
     end
 
     test 'should expire' do
@@ -186,7 +186,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
 
   context 'a host expiring in a year' do
     setup do
-      @host = FactoryGirl.build(:host, :expires_in_a_year)
+      @host = FactoryBot.build(:host, :expires_in_a_year)
     end
 
     test 'should expire' do
@@ -217,7 +217,7 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
 
   context 'a host in grace period' do
     setup do
-      @host = FactoryGirl.build(:host, :expired_grace)
+      @host = FactoryBot.build(:host, :expired_grace)
     end
 
     test 'should expire' do

data/test/unit/expire_hosts_mailer_test.rb

@@ -3,62 +3,82 @@ require 'test_plugin_helper'
 class ExpireHostMailerTest < ActionMailer::TestCase
   setup do
     setup_settings
-    @emails = ['test@example.com']
-    @hosts = FactoryGirl.create_list(:host, 2, :managed)
   end
 
+  let(:recipient) { FactoryBot.create(:user, :with_mail) }
+  let(:hosts) { FactoryBot.create_list(:host, 2, :managed) }
+
   context 'deleted hosts notification' do
-    setup do
-      @mail = ExpireHostsMailer.deleted_hosts_notification(@emails, @hosts).deliver_now
-    end
+    let(:mail) { ExpireHostsMailer.deleted_hosts_notification(recipient, hosts).deliver_now }
 
     test 'subject should be set' do
-      refute_nil @mail.subject
-      assert_includes @mail.subject, 'Deleted expired hosts in Foreman'
+      assert_includes mail.subject, 'Deleted expired hosts in Foreman'
+    end
+
+    test 'recipient should be user mail address' do
+      assert_equal [recipient.mail], mail.to
     end
   end
 
   context 'failed to delete hosts notification' do
-    setup do
-      @mail = ExpireHostsMailer.failed_to_delete_hosts_notification(@emails, @hosts).deliver_now
-    end
+    let(:mail) { ExpireHostsMailer.failed_to_delete_hosts_notification(recipient, hosts).deliver_now }
 
     test 'subject should be set' do
-      refute_nil @mail.subject
-      assert_includes @mail.subject, 'Failed to delete expired hosts in Foreman'
+      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_now
-    end
+    let(:mail) { ExpireHostsMailer.stopped_hosts_notification(recipient, Date.today, hosts).deliver_now }
 
     test 'subject should be set' do
-      refute_nil @mail.subject
-      assert_includes @mail.subject, 'Stopped expired hosts in Foreman'
+      assert_includes mail.subject, 'Stopped expired hosts in Foreman'
+    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'
+    end
+
+    test 'should not show mitigation text if not authorized' do
+      ForemanExpireHosts::ExpiryEditAuthorizer.any_instance.stubs(:authorized?).returns(false)
+      assert_not_includes mail.body.to_s, 'Please change their expiry date'
     end
   end
 
   context 'failed to stop hosts notification' do
-    setup do
-      @mail = ExpireHostsMailer.failed_to_stop_hosts_notification(@emails, @hosts).deliver_now
-    end
+    let(:mail) { ExpireHostsMailer.failed_to_stop_hosts_notification(recipient, hosts).deliver_now }
 
     test 'subject should be set' do
-      refute_nil @mail.subject
-      assert_includes @mail.subject, 'Failed to stop expired hosts in Foreman'
+      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_now
-    end
+    let(:mail) { ExpireHostsMailer.expiry_warning_notification(recipient, Date.today, hosts).deliver_now }
 
     test 'subject should be set' do
-      refute_nil @mail.subject
-      assert_includes @mail.subject, 'Expiring hosts in foreman'
+      assert_includes mail.subject, 'Expiring hosts in foreman'
+    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'
+    end
+
+    test 'should not show mitigation text if not authorized' do
+      ForemanExpireHosts::ExpiryEditAuthorizer.any_instance.stubs(:authorized?).returns(false)
+      assert_not_includes mail.body.to_s, 'Please change their expiry date'
+    end
+  end
+
+  context 'user without mail address' do
+    let(:recipient) { FactoryBot.create(:user) }
+    let(:mail) { ExpireHostsMailer.expiry_warning_notification(recipient, Date.today, hosts).deliver_now }
+
+    test 'mail is delivered to admin address' do
+      assert_nil recipient.mail
+      assert_equal ['root@some.host.fqdn'], mail.to
     end
   end
 end

data/test/unit/expiry_edit_authorizer_test.rb

@@ -0,0 +1,55 @@
+require 'test_plugin_helper'
+
+module ForemanExpireHosts
+  class ExpiryEditAuthorizerTest < ActiveSupport::TestCase
+    let(:hosts) { FactoryBot.create_list(:host, 2) }
+    let(:authorizer) { ExpiryEditAuthorizer.new(hosts: hosts, user: user) }
+
+    context 'with admin user' do
+      let(:user) { FactoryBot.create(:user, :admin) }
+      test 'should be authorized' do
+        assert_equal true, authorizer.authorized?
+      end
+    end
+
+    context 'with limited permissions' do
+      let(:user_role) { FactoryBot.create(:user_user_role) }
+      let(:user) { user_role.owner }
+      let(:role) { user_role.role }
+      let(:edit_expiry_permission) { Permission.find_by(name: 'edit_host_expiry') }
+      let(:edit_permission) { Permission.find_by(name: 'edit_hosts') }
+
+      context 'with edit_hosts and edit_host_expiry permission' do
+        test 'should be authorized' do
+          FactoryBot.create(:filter, :role => role, :permissions => [edit_permission, edit_expiry_permission])
+          assert_equal true, authorizer.authorized?
+        end
+      end
+
+      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) }
+
+        test 'should be authorized if setting allows owner' do
+          Setting[:can_owner_modify_host_expiry_date] = true
+          assert_equal true, authorizer.authorized?
+        end
+
+        test 'should not be authorized if setting does not allow owner' do
+          Setting[:can_owner_modify_host_expiry_date] = false
+          assert_equal false, authorizer.authorized?
+        end
+      end
+    end
+
+    context 'with unauthorized user' do
+      let(:user) { FactoryBot.create(:user) }
+      test 'should not be authorized' do
+        assert_equal false, authorizer.authorized?
+      end
+    end
+  end
+end

data/test/unit/host_status/expiration_status_test.rb

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

data/test/unit/safe_destroy_test.rb

@@ -0,0 +1,26 @@
+require 'test_plugin_helper'
+
+module ForemanExpireHosts
+  class SafeDestroyTest < ActiveSupport::TestCase
+    class HostWithFailingCallbacks < ActiveRecord::Base
+      self.table_name = 'hosts'
+      self.inheritance_column = nil
+
+      before_destroy :cancel
+
+      private
+
+      def cancel
+        false
+      end
+    end
+
+    describe 'model with failing callbacks' do
+      test 'return false on record delete' do
+        h = HostWithFailingCallbacks.create!(:name => 'test')
+        assert_equal false, SafeDestroy.new(h).destroy!
+        assert_equal 1, HostWithFailingCallbacks.all.count
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_expire_hosts
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Nagarjuna Rachaneni
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-24 00:00:00.000000000 Z
+date: 2017-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: deface
+  name: bootstrap-datepicker-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -26,7 +26,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bootstrap-datepicker-rails
+  name: deface
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,19 +54,19 @@ 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.51.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.51.0
 description: This Plugin will add new column expired_on to hosts to limit the lifetime
   of a host.
 email:
@@ -99,6 +99,20 @@ files:
 - 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
+- app/services/foreman_expire_hosts/action/stop_expired_hosts.rb
+- app/services/foreman_expire_hosts/expiry_edit_authorizer.rb
+- app/services/foreman_expire_hosts/notification/base.rb
+- app/services/foreman_expire_hosts/notification/deleted_hosts.rb
+- app/services/foreman_expire_hosts/notification/expiry_warning.rb
+- app/services/foreman_expire_hosts/notification/failed_deleted_hosts.rb
+- app/services/foreman_expire_hosts/notification/failed_stopped_hosts.rb
+- app/services/foreman_expire_hosts/notification/stopped_hosts.rb
+- app/services/foreman_expire_hosts/safe_destroy.rb
+- app/services/foreman_expire_hosts/ui_notifications/hosts/base.rb
+- app/services/foreman_expire_hosts/ui_notifications/hosts/expiry_warning.rb
+- app/services/foreman_expire_hosts/ui_notifications/hosts/stopped_host.rb
 - app/views/expire_hosts_mailer/_hosts_table.html.erb
 - app/views/expire_hosts_mailer/deleted_hosts_notification.html.erb
 - app/views/expire_hosts_mailer/expiry_warning_notification.html.erb
@@ -110,6 +124,7 @@ files:
 - app/views/hosts/select_multiple_expiration.html.erb
 - 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
 - lib/expire_hosts_notifications.rb
 - lib/foreman_expire_hosts.rb
@@ -122,7 +137,9 @@ files:
 - 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
 homepage: https://github.com/theforeman/foreman_expire_hosts
 licenses:
 - GPL-3.0
@@ -143,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Foreman plugin for limiting host lifetime
@@ -154,4 +171,6 @@ test_files:
 - 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