foreman_expire_hosts 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dff569ea01095e51ec33f834ac418f0727562f74
-  data.tar.gz: 0ee7ddb292e6c9939363cbc11d1e824b137b30af
+  metadata.gz: bf158e1beab470ea6dc171ed30d7e11b7194dcd4
+  data.tar.gz: 026d9ba320a50dc94c2cb336e869ce5b22a1b912
 SHA512:
-  metadata.gz: 6ec7cc032b18d3f485060ecad97a57a2de20355b9ed719380f7a9b425155f18b0aa4f276649bb06e138822fcc3f7a8eb3604180f2b8d4b61dd69564ee0b3ea66
-  data.tar.gz: 6c62884427e54bc0900810558e346534685ae53942799138e0f97c65353b594ee8a2e4e9fe6d8baac42e4f16324d5aa9886f973e9351828585351e545e2b05ee
+  metadata.gz: 777d04912617e0a33c2dc932e3456b73a7b7fbf9d3a4ffee980f5bcba33b1cca574f4a18c7c5c8a74dd9d50cd5aa345bea75403f3043f56940cf7b06f06dff3e
+  data.tar.gz: d99b1ac558856087474aa314e433ed54ca584b2411d12ad3c0697465febdc6defd9743ab35a79cb913312b89c1c0bb7f9d5a2d66709b708e5f1dd33d09c51c8c

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-06-07 15:24:39 +0200 using RuboCop version 0.39.0.
+# on 2016-10-20 20:55:41 +0200 using RuboCop version 0.42.0.
 # 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
@@ -8,7 +8,7 @@
 
 # Offense count: 4
 # Cop supports --auto-correct.
-# Configuration parameters: IgnoreEmptyBlocks.
+# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
 Lint/UnusedBlockArgument:
   Exclude:
     - 'lib/expire_hosts_notifications.rb'
@@ -32,9 +32,9 @@ Metrics/AbcSize:
 
 # Offense count: 3
 Metrics/CyclomaticComplexity:
-  Max: 9
+  Max: 11
 
-# Offense count: 69
+# Offense count: 86
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
 # URISchemes: http, https
 Metrics/LineLength:
@@ -43,11 +43,16 @@ Metrics/LineLength:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 111
+  Max: 110
 
 # Offense count: 3
 Metrics/PerceivedComplexity:
-  Max: 9
+  Max: 11
+
+# Offense count: 2
+Rails/OutputSafety:
+  Exclude:
+    - 'app/helpers/concerns/foreman_expire_hosts/audits_helper_extensions.rb'
 
 # Offense count: 4
 # Cop supports --auto-correct.
@@ -59,16 +64,21 @@ Style/EmptyLinesAroundClassBody:
     - 'app/models/setting/expire_hosts.rb'
     - 'lib/expire_hosts_notifications.rb'
 
-# Offense count: 69
+# Offense count: 105
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
 # SupportedStyles: ruby19, ruby19_no_mixed_keys, hash_rockets
 Style/HashSyntax:
   Enabled: false
 
-# Offense count: 8
+# Offense count: 12
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
-# SupportedStyles: space, no_space
+# SupportedStyles: space, no_space, compact
 Style/SpaceInsideHashLiteralBraces:
-  Enabled: false
+  Exclude:
+    - 'app/controllers/concerns/foreman_expire_hosts/host_controller_extensions.rb'
+    - 'app/helpers/concerns/foreman_expire_hosts/hosts_helper_extensions.rb'
+    - 'lib/expire_hosts_notifications.rb'
+    - 'lib/foreman_expire_hosts/engine.rb'
+    - 'test/functional/concerns/hosts_controller_extensions_test.rb'

data/README.md

@@ -2,11 +2,11 @@
 
 # Context
 
-Foreman makes host creation extremely simple for a sysadmin or a user.  However this simplicity leads to wasteful usage of compute resources. foreman_expiry plugin allows to specify an expiry date for the host. On this date the host will be deleted.
+Foreman makes host creation extremely simple for a sysadmin or a user. However this simplicity leads to wasteful usage of compute resources. The foreman_expire_hosts plugin allows to specify an expiry date for the host. The host will be shutdown first and then automatically deleted after a grace period.
 
-This plugin add expired on(date) field to host form under Additional Information section. If we create any host with expiry date, then that host will be stopped on given date and then deleted. If a host has no expiration date set then that host will live forever (until it is deleted manually).
+This plugin adds an expired on (date) field to the host form (Additional Information tab). If we create a host with expiry date, then that host will be stopped on the day after the given date and then deleted. If a host has no expiration date set then that host will live forever (until it is deleted manually).
 
-This plugin will send two warning notification before host expiry (see Settings). It also sends notifications when the host stopped on its expiry date and when host is deleted after few days (configured in settings).
+This plugin will send two warning notifications before host expiry (see Settings). It also sends notifications when the host is stopped on its expiry date and when the host is deleted after the grace period (configured in settings).
 
 ## Compatibility
 
@@ -24,18 +24,11 @@ This plugin will send two warning notification before host expiry (see Settings)
 
 
 # Installation
-Please see the Foreman manual for appropriate instructions:
-
-* [Foreman: How to Install a Plugin](http://theforeman.org/manuals/latest/index.html#6.Plugins)
-
-The gem name is "foreman_expire_hosts".
-
-RPM users can install the "tfm-rubygem-foreman_expire_hosts" or
-"rubygem-foreman_expire_hosts" packages.
+See [Plugins install instructions](https://theforeman.org/plugins/) for how to install Foreman plugins.
+TLDR: You need to install the package `tfm-rubygem-foreman_expire_hosts` on RPM-based systems or use foreman-installer.
 
 This plugin has not been packeged for Debian, yet.
 
-
 # Post installation
 
 This plugin needs additional column in hosts table. Please run migration with below command

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

@@ -37,7 +37,7 @@ module ForemanExpireHosts
 
     def datepicker_f(f, attr, options = {})
       field(f, attr, options) do
-        addClass options, "form-control"
+        addClass options, 'form-control'
         date = f.text_field attr, options
         addon = input_group_addon('', :class => 'glyphicon glyphicon-calendar')
         input_group date, addon

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

@@ -35,7 +35,7 @@ module ForemanExpireHosts
           errors.add(:expired_on, _('no permission to edit'))
         end
       end
-      errors[:expired_on].empty?
+      true
     end
 
     def expires?
@@ -73,7 +73,14 @@ module ForemanExpireHosts
     end
 
     def can_modify_expiry_date?
-      (new_record? || (defined?(Rails::Console) || (User.current && (User.current.admin || (Setting[:can_owner_modify_host_expiry_date] || ((owner_type == 'User' && owner.id == User.current.id) || (owner_type == 'Usergroup' && owner.users.map(&:id).include?(User.current.id))))))))
+      return true if new_record?
+      return true if defined?(Rails::Console)
+      return true unless User.current
+      return true if User.current.admin?
+      return true if self.owner_type.nil? || self.owner.nil?
+      Setting[:can_owner_modify_host_expiry_date] &&
+        ((self.owner_type == 'User' && self.owner == User.current) ||
+         (self.owner_type == 'Usergroup' && self.owner.users.include?(User.current)))
     end
 
     private

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}") % {:message => message, :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
 
@@ -80,11 +80,10 @@ module ExpireHostsNotifications
       days_before_expiry = Setting["notify#{num}_days_before_host_expiry"].to_i
       expiry_date        = (Date.today + days_before_expiry)
       notifiable_hosts   = Host.with_expire_date(expiry_date)
-      unless notifiable_hosts.empty?
-        hosts_by_user(notifiable_hosts).each do |user_id, hosts_hash|
-          catch_delivery_errors(_('Failed to deliver expiring hosts notification'), notifiable_hosts) do
-            ExpireHostsMailer.expiry_warning_notification(hosts_hash['email'], expiry_date, hosts_hash['hosts']).deliver_now
-          end
+      return if notifiable_hosts.empty?
+      hosts_by_user(notifiable_hosts).each do |user_id, hosts_hash|
+        catch_delivery_errors(_('Failed to deliver expiring hosts notification'), notifiable_hosts) do
+          ExpireHostsMailer.expiry_warning_notification(hosts_hash['email'], expiry_date, hosts_hash['hosts']).deliver_now
         end
       end
     end

data/lib/foreman_expire_hosts/engine.rb

@@ -27,7 +27,7 @@ module ForemanExpireHosts
         register_custom_status HostStatus::ExpirationStatus
 
         # strong parameters
-        parameter_filter Host::Managed, :expires_on
+        parameter_filter Host::Managed, :expired_on
 
         security_block :hosts do
           permission :edit_hosts, {:hosts => [:select_multiple_expiration, :update_multiple_expiration]}

data/lib/foreman_expire_hosts/version.rb

@@ -1,3 +1,3 @@
 module ForemanExpireHosts
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.1.1'.freeze
 end

data/test/factories/foreman_expire_hosts_factories.rb

@@ -2,7 +2,7 @@ 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) }
+      to_create { |instance| instance.save(validate: false) }
     end
 
     trait :expires_in_a_week do

data/test/functional/concerns/hosts_controller_extensions_test.rb

@@ -2,9 +2,54 @@ require 'test_plugin_helper'
 
 class HostsControllerTest < ActionController::TestCase
   setup do
+    User.current = FactoryGirl.build(:user, :admin)
+    disable_orchestration
     setup_settings
   end
 
+  describe 'host creation' do
+    test 'new host with expiration date' do
+      expiration_date = Date.today + 14
+      assert_difference 'Host.count' do
+        post :create, {
+          :host => {
+            :name => 'myotherfullhost',
+            :mac => 'aabbecddee06',
+            :ip => '2.3.4.125',
+            :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,
+            :expired_on => expiration_date
+          }
+        }, set_session_user
+      end
+      h = Host.search_for('myotherfullhost').first
+      assert_equal expiration_date, h.expired_on
+      assert_redirected_to host_url(assigns['host'])
+    end
+  end
+
+  describe 'updating a host' do
+    let(:host) { FactoryGirl.create(:host) }
+
+    test 'should add expiration date to host' do
+      expiration_date = Date.today + 14
+      put :update, { :id => host.name, :host => {:expired_on => expiration_date} }, set_session_user
+      h = Host.find(host.id)
+      assert_equal expiration_date, h.expired_on
+    end
+  end
+
   describe 'setting expiration date on multiple hosts' do
     before do
       as_admin do

data/test/lib/expire_hosts_notifications_test.rb

@@ -56,7 +56,7 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
 
     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)
+      FactoryGirl.create(:host, :expires_in_a_week, :owner => owner2)
       ExpireHostsMailer.expects(:expiry_warning_notification).twice
       ExpireHostsNotifications.deliver_expiry_warning_notification
     end
@@ -69,7 +69,7 @@ class ExpireHostsNotificationsTest < ActiveSupport::TestCase
       hosts = [host1, host2]
       Foreman::Logging.expects(:exception).with('failure for Hosts Alpha and Bravo', anything)
       ExpireHostsNotifications.catch_delivery_errors('failure', hosts) do
-        raise "Test"
+        raise 'Test'
       end
     end
   end

data/test/unit/concerns/host_extensions_test.rb

@@ -1,7 +1,7 @@
 require 'test_plugin_helper'
 
 class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
-  EXPIRATION_SCOPES = ['expiring', 'expired', 'expiring_today', 'expired_past_grace_period']
+  EXPIRATION_SCOPES = ['expiring', 'expired', 'expiring_today', 'expired_past_grace_period'].freeze
 
   setup do
     User.current = FactoryGirl.build(:user, :admin)
@@ -31,6 +31,41 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
     end
   end
 
+  context 'changing expiration date for user owned host' do
+    setup do
+      @user = FactoryGirl.create(:user)
+      @host = FactoryGirl.create(:host, :expired, :owner => @user)
+    end
+
+    test 'admin should be able to change expiration date' do
+      @host.expired_on = Date.today + 5
+      assert_valid @host
+    end
+
+    test 'user should not be able to change expiration date' do
+      as_user FactoryGirl.build(:user) do
+        @host.expired_on = Date.today + 5
+        refute_valid @host
+      end
+    end
+
+    test 'owner should not be able to change expiration date if forbidden in settings' do
+      Setting[:can_owner_modify_host_expiry_date] = false
+      as_user @user do
+        @host.expired_on = Date.today + 5
+        refute_valid @host
+      end
+    end
+
+    test 'owner should be able to change expiration date if allowed in settings' do
+      Setting[:can_owner_modify_host_expiry_date] = true
+      as_user @user do
+        @host.expired_on = Date.today + 5
+        assert_valid @host
+      end
+    end
+  end
+
   context 'a host without expiration' do
     setup do
       @host = FactoryGirl.build(:host)
@@ -155,12 +190,12 @@ class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
   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
+    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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_expire_hosts
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Nagarjuna Rachaneni
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface