foreman_expire_hosts 2.0.0

data/db/migrate/20150427101516_add_expiry_on_to_hosts.rb

@@ -0,0 +1,5 @@
+class AddExpiryOnToHosts < ActiveRecord::Migration
+  def change
+    add_column :hosts, :expired_on, :date unless column_exists? :hosts, :expired_on
+  end
+end

data/foreman_expire_hosts.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path('../lib/foreman_expire_hosts/version', __FILE__)
+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 'deface'
+  s.add_dependency 'bootstrap-datepicker-rails'
+
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rdoc'
+end

data/lib/expire_hosts_notifications.rb

@@ -0,0 +1,121 @@
+module ExpireHostsNotifications
+  class << self
+
+    def admin_email
+      [(Setting[:host_expiry_email_recipients] || Setting[:administrator])]
+    end
+
+    def days_to_delete_after_expired
+      Setting[:days_to_delete_after_host_expiration].to_i
+    end
+
+    def catch_delivery_errors(message, hosts = [])
+      yield
+    rescue => error
+      message = "#{message} for Hosts #{hosts.map(&:name).to_sentence}"
+      Foreman::Logging.exception(message, error)
+    end
+
+    # This method to deliver deleted host details to its owner
+    def delete_expired_hosts
+      deletable_hosts     = Host.expired_past_grace_period
+      failed_delete_hosts = []
+      deleted_hosts       = []
+      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
+          deleted_hosts << deletable_host
+        else
+          failed_delete_hosts << deletable_host
+        end
+      end
+      unless deleted_hosts.empty?
+        ExpireHostsNotifications.hosts_by_user(deleted_hosts).each do |user_id, hosts_hash|
+          catch_delivery_errors(_('Failed to deliver deleted hosts notification'), deleted_hosts) do
+            ExpireHostsMailer.deleted_hosts_notification(hosts_hash['email'], hosts_hash['hosts']).deliver_now
+          end
+        end
+      end
+      return if failed_delete_hosts.empty?
+      catch_delivery_errors(_('Failed to deliver deleted hosts notification failed status'), failed_delete_hosts) do
+        ExpireHostsMailer.failed_to_delete_hosts_notification(self.admin_email, failed_delete_hosts).deliver_now
+      end
+    end
+
+    def stop_expired_hosts
+      stoppable_hosts   = Host.expired
+      failed_stop_hosts = []
+      stopped_hosts     = []
+      stoppable_hosts.each do |stoppable_host|
+        next unless stoppable_host.supports_power_and_running?
+        Rails.logger.info "Powering down expired host in grace period #{stoppable_host}"
+        host_status = begin
+          stoppable_host.power.stop
+        rescue
+          false
+        end
+        if host_status
+          stopped_hosts << stoppable_host
+        else
+          failed_stop_hosts << stoppable_host
+        end
+      end
+      unless stopped_hosts.empty?
+        delete_date = (Date.today + self.days_to_delete_after_expired.to_i)
+        hosts_by_user(stopped_hosts).each do |user_id, hosts_hash|
+          catch_delivery_errors(_('Failed to deliver stopped hosts notification'), stopped_hosts) do
+            ExpireHostsMailer.stopped_hosts_notification(hosts_hash['email'], delete_date, hosts_hash['hosts']).deliver_now
+          end
+        end
+      end
+      return if failed_stop_hosts.empty?
+      catch_delivery_errors(_('Failed to deliver stopped hosts notification failed status'), failed_stop_hosts) do
+        ExpireHostsMailer.failed_to_stop_hosts_notification(self.admin_email, failed_stop_hosts).deliver_now
+      end
+    end
+
+    def deliver_expiry_warning_notification(num = 1) # notify1_days_before_expiry
+      return unless [1, 2].include?(num)
+      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
+        end
+      end
+    end
+
+    def hosts_by_user(hosts)
+      emails     = self.admin_email
+      hosts_hash = {}
+      hosts.each do |host|
+        if host.owner_type == 'User'
+          unless hosts_hash.key?(host.owner_id.to_s)
+            email_recipients = emails + [host.owner.mail]
+            hosts_hash[host.owner_id.to_s] = { 'id' => host.owner_id, 'name' => host.owner.name, 'email' => email_recipients, 'hosts' => [] }
+          end
+          hosts_hash[host.owner_id.to_s]['hosts'] << host
+        elsif host.owner_type == 'Usergroup'
+          host.owner.users.each do |owner|
+            unless hosts_hash.key?(owner.id.to_s)
+              email_recipients = emails + [owner.mail]
+              hosts_hash[owner.id.to_s] = { 'id' => owner.id, 'name' => owner.name, 'email' => email_recipients, 'hosts' => [] }
+            end
+            hosts_hash[owner.id.to_s]['hosts'] << host
+          end
+        else
+          email = (!emails.empty? ? emails : [Setting[:administrator]])
+          unless hosts_hash.key?(owner.id.to_s)
+            hosts_hash['admin'] = { 'id' => nil, 'name' => 'Admin', 'email' => email, 'hosts' => [] }
+          end
+          hosts_hash['admin']['hosts'] << host
+        end
+      end
+      hosts_hash
+    end
+  end
+end

data/lib/foreman_expire_hosts/engine.rb

@@ -0,0 +1,61 @@
+require 'deface'
+require 'bootstrap-datepicker-rails'
+
+module ForemanExpireHosts
+  class Engine < ::Rails::Engine
+    engine_name 'foreman_expire_hosts'
+
+    config.autoload_paths += Dir["#{config.root}/lib"]
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
+
+    # Add any db migrations
+    initializer 'foreman_plugin_template.load_app_instance_data' do |app|
+      ForemanExpireHosts::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      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', __FILE__) 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.10'
+        register_custom_status HostStatus::ExpirationStatus
+
+        security_block :hosts do
+          permission :edit_hosts, {:hosts => [:select_multiple_expiration, :update_multiple_expiration]}
+        end
+      end
+    end
+
+    config.to_prepare do
+      begin
+        Host::Managed.send :include, ForemanExpireHosts::HostExt
+        HostsHelper.send :include, ForemanExpireHosts::HostsHelperExtensions
+        HostsController.send :include, ForemanExpireHosts::HostControllerExtensions
+      rescue => e
+        Rails.logger.warn "ForemanExpireHosts: skipping engine hook (#{e})"
+      end
+    end
+
+    # Precompile any JS or CSS files under app/assets/
+    # If requiring files from each other, list them explicitly here to avoid precompiling the same
+    # content twice.
+    assets_to_precompile =
+      Dir.chdir(root) do
+        Dir['app/assets/javascripts/**/*', 'app/assets/stylesheets/**/*'].map do |f|
+          f.split(File::SEPARATOR, 4).last
+        end
+      end
+    initializer 'foreman_expire_hosts.assets.precompile' do |app|
+      app.config.assets.precompile += assets_to_precompile
+    end
+    initializer 'foreman_expire_hosts.configure_assets', group: :assets do
+      SETTINGS[:foreman_expire_hosts] = { assets: { precompile: assets_to_precompile } }
+    end
+  end
+end

data/lib/foreman_expire_hosts/version.rb

@@ -0,0 +1,3 @@
+module ForemanExpireHosts
+  VERSION = '2.0.0'.freeze
+end

data/lib/foreman_expire_hosts.rb

@@ -0,0 +1,3 @@
+require 'foreman_expire_hosts/engine'
+module ForemanExpireHosts
+end

data/lib/tasks/expired_hosts.rake

@@ -0,0 +1,46 @@
+# Tasks
+namespace :expired_hosts do
+  desc 'Delete all expired hosts, send notification email about expiring hosts'
+  task :deliver_notifications => :environment do
+    ExpireHostsNotifications.delete_expired_hosts
+    ExpireHostsNotifications.stop_expired_hosts
+    ExpireHostsNotifications.deliver_expiry_warning_notification(1)
+    ExpireHostsNotifications.deliver_expiry_warning_notification(2)
+  end
+end
+
+# Tests
+namespace :test do
+  desc 'Test ForemanExpireHosts'
+  Rake::TestTask.new(:foreman_expire_hosts) do |t|
+    test_dir = File.join(File.dirname(__FILE__), '../..', 'test')
+    t.libs << ['test', test_dir]
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+namespace :foreman_expire_hosts do
+  task :rubocop 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
+      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'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_expire_hosts', 'foreman_expire_hosts:rubocop']
+end

data/test/factories/foreman_expire_hosts_factories.rb

@@ -0,0 +1,15 @@
+FactoryGirl.modify do
+  factory :host do
+    trait :expires_today do
+      expired_on Date.today
+    end
+
+    trait :expired_grace do
+      expired_on Date.today - 1
+    end
+
+    trait :expired do
+      expired_on Date.today - 356
+    end
+  end
+end

data/test/functional/concerns/hosts_controller_extensions_test.rb

@@ -0,0 +1,45 @@
+require 'test_plugin_helper'
+
+class HostsControllerTest < ActionController::TestCase
+  setup do
+    setup_settings
+  end
+
+  describe 'setting expiration date on multiple hosts' do
+    before do
+      as_admin do
+        @hosts = FactoryGirl.create_list(:host, 2, :with_puppet)
+      end
+      @request.env['HTTP_REFERER'] = hosts_path
+    end
+
+    test 'should set expiration date' do
+      expiration_date = Date.today + 14
+      params = { :host_ids => @hosts.map(&:id),
+                 :host => { :expired_on => expiration_date } }
+
+      post :update_multiple_expiration, params,
+           set_session_user.merge(:user => users(:admin).id)
+
+      assert_empty flash[:error]
+
+      @hosts.each do |host|
+        assert_equal expiration_date, host.reload.expired_on
+      end
+    end
+
+    test 'should clear the expiration date of multiple hosts' do
+      params = { :host_ids => @hosts.map(&:id),
+                 :host => { :expired_on => '' } }
+
+      post :update_multiple_expiration, params,
+           set_session_user.merge(:user => users(:admin).id)
+
+      assert_empty flash[:error]
+
+      @hosts.each do |host|
+        assert_equal nil, host.reload.expired_on
+      end
+    end
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,10 @@
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+
+# Add plugin to FactoryGirl's paths
+FactoryGirl.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryGirl.reload
+
+def setup_settings
+  Setting::ExpireHosts.load_defaults
+end

data/test/unit/concerns/host_extensions_test.rb

@@ -0,0 +1,136 @@
+require 'test_plugin_helper'
+
+class ForemanExpireHostsHostExtTest < ActiveSupport::TestCase
+  setup do
+    User.current = FactoryGirl.build(:user, :admin)
+    setup_settings
+  end
+
+  context 'without required expiration date' do
+    setup do
+      Setting[:is_host_expiry_date_mandatory] = false
+    end
+
+    test 'should not require expired on' do
+      host = FactoryGirl.build(:host)
+      assert host.valid?, "Should be valid without expiration date: : #{host.errors.messages}"
+    end
+  end
+
+  context 'with required expiration date' do
+    setup do
+      Setting[:is_host_expiry_date_mandatory] = true
+    end
+
+    test 'should require expired on' do
+      host = FactoryGirl.build(:host)
+      refute host.valid?, "Can not be valid without expiration date: #{host.errors.messages}"
+      assert_includes host.errors.messages.keys, :expired_on
+    end
+  end
+
+  context 'a host without expiration' do
+    setup do
+      @host = FactoryGirl.build(:host)
+    end
+
+    test 'should not expire' do
+      refute @host.expires?
+    end
+
+    test 'should not expire today' do
+      refute @host.expires_today?
+    end
+
+    test 'should not be expired' do
+      refute @host.expired?
+    end
+
+    test 'should not be expired past grace period' do
+      refute @host.expired_past_grace_period?
+    end
+
+    test 'should not be pending expiration' do
+      refute @host.pending_expiration?
+    end
+  end
+
+  context 'a expired host' do
+    setup do
+      @host = FactoryGirl.build(:host, :expired)
+    end
+
+    test 'should expire' do
+      assert @host.expires?
+    end
+
+    test 'should not expire today' do
+      refute @host.expires_today?
+    end
+
+    test 'should be expired' do
+      assert @host.expired?
+    end
+
+    test 'should be expired past grace period' do
+      assert @host.expired_past_grace_period?
+    end
+
+    test 'should not be pending expiration' do
+      refute @host.pending_expiration?
+    end
+  end
+
+  context 'a host expiring today' do
+    setup do
+      @host = FactoryGirl.build(:host, :expires_today)
+    end
+
+    test 'should expire' do
+      assert_equal Date.today, @host.expired_on
+      assert @host.expires?
+    end
+
+    test 'should expire today' do
+      assert @host.expires_today?
+    end
+
+    test 'should not be expired' do
+      refute @host.expired?
+    end
+
+    test 'should not be expired past grace period' do
+      refute @host.expired_past_grace_period?
+    end
+
+    test 'should be pending expiration' do
+      assert @host.pending_expiration?
+    end
+  end
+
+  context 'a host in grace period' do
+    setup do
+      @host = FactoryGirl.build(:host, :expired_grace)
+    end
+
+    test 'should expire' do
+      assert @host.expires?
+    end
+
+    test 'should not expire today' do
+      refute @host.expires_today?
+    end
+
+    test 'should be expired' do
+      assert @host.expired?
+    end
+
+    test 'should not be expired past grace period' do
+      refute @host.expired_past_grace_period?
+    end
+
+    test 'should not be pending expiration' do
+      refute @host.pending_expiration?
+    end
+  end
+end

data/test/unit/host_status/expiration_status_test.rb

@@ -0,0 +1,28 @@
+require 'test_plugin_helper'
+
+class ExpirationStatusTest < ActiveSupport::TestCase
+  def setup
+    @host = FactoryGirl.build(:host)
+    @status = HostStatus::ExpirationStatus.new(:host => @host)
+  end
+
+  test 'is valid' do
+    assert_valid @status
+  end
+
+  test '#to_label changes based on expiration date' do
+    @host.expired_on = '23/11/1900'
+    assert_equal 'Expired on 1900-11-23', @status.to_label
+
+    @host.expired_on = Date.today
+    assert_equal 'Expires today', @status.to_label
+  end
+
+  test '#relevant? is only for expiring hosts' do
+    @host.expired_on = '23/11/1900'
+    assert @status.relevant?
+
+    @host.expired_on = nil
+    refute @status.relevant?
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: foreman_expire_hosts
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Nagarjuna Rachaneni
+- Timo Goebel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bootstrap-datepicker-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This Plugin will add new column expired_on to hosts to limit the lifetime
+  of a host.
+email:
+- nn.nagarjuna@gmail.com
+- mail@timogoebel.name
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+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/host_controller_extensions.rb
+- app/helpers/concerns/foreman_expire_hosts/hosts_helper_extensions.rb
+- app/helpers/expire_hosts_mailer_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/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
+- app/views/expire_hosts_mailer/failed_to_delete_hosts_notification.html.erb
+- app/views/expire_hosts_mailer/failed_to_stop_hosts_notification.html.erb
+- app/views/expire_hosts_mailer/stopped_hosts_notification.html.erb
+- app/views/hosts/_expired_message.html.erb
+- app/views/hosts/_expired_on_field.html.erb
+- app/views/hosts/select_multiple_expiration.html.erb
+- config/routes.rb
+- db/migrate/20150427101516_add_expiry_on_to_hosts.rb
+- foreman_expire_hosts.gemspec
+- lib/expire_hosts_notifications.rb
+- lib/foreman_expire_hosts.rb
+- lib/foreman_expire_hosts/engine.rb
+- lib/foreman_expire_hosts/version.rb
+- lib/tasks/expired_hosts.rake
+- test/factories/foreman_expire_hosts_factories.rb
+- test/functional/concerns/hosts_controller_extensions_test.rb
+- test/test_plugin_helper.rb
+- test/unit/concerns/host_extensions_test.rb
+- test/unit/host_status/expiration_status_test.rb
+homepage: https://github.com/theforeman/foreman_expire_hosts
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+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/test_plugin_helper.rb
+- test/unit/concerns/host_extensions_test.rb
+- test/unit/host_status/expiration_status_test.rb
+has_rdoc: