foreman_expire_hosts 6.0.0 → 7.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d016e02f798e790c84d0ff29badd0fbfbaf122b941787842dce237f19fcb0d9
-  data.tar.gz: 361195ee1b65ac38de1bad8e9ff7ecd6172202f52d524c3729bfbff022fe0a85
+  metadata.gz: f2f0094dacc9c70e393e1bf88b942e63e03d61ad43f9279dac3bc55dc8796d0f
+  data.tar.gz: f9768b9ad368199ed8b8d8965664788797cf59db5c0888cf4f846c324105d889
 SHA512:
-  metadata.gz: 55d8ac2d1ddb0b96effb841ce5b897ef3c583b3b5bd619b337015c35a0f4744f7db57e70919ec8c946ad0a2d3a424263d1fad0e01ded37e540ca220d258158c7
-  data.tar.gz: 94c8f531186c1c55b70297e8c3905f17fb823326e3cf06c94c221aa7daa675deefc9f017161d8b0070d48164b58c8a6f8031eebf951d839990da24beeb656676
+  metadata.gz: e2093d7a71c66e85f18b2712e0bd9c39397d1f731e8cdd229a1b7e55805d97d7b751694760b2f4912b169e3110a6a9847bdff8a7d43595b6d7904f35100bd1b9
+  data.tar.gz: 6d24cb1a6fe7c1704680a95e06b90ebffeb8636e752e007a5bd8be48d5101fa5b25c169396ed61f7ff2320f77f46083115b78798626d371ed540fcaee632c143

data/.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+name: CI
+on: [push, pull_request]
+env:
+  RAILS_ENV: test
+  DATABASE_URL: postgresql://postgres:@localhost/test
+  DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL: true
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.3
+      - name: Setup
+        run: |
+          gem install bundler
+          bundle install --jobs=3 --retry=3
+      - name: Run rubocop
+        run: bundle exec rubocop
+  test:
+    runs-on: ubuntu-latest
+    needs: rubocop
+    services:
+      postgres:
+        image: postgres:12.1
+        ports: ['5432:5432']
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    strategy:
+      fail-fast: false
+      matrix:
+        foreman-core-branch: [1.24-stable, 2.0-stable, 2.1-stable, develop]
+        ruby-version: [2.3, 2.5, 2.6]
+        node-version: [10]
+        exclude:
+          - foreman-core-branch: 2.0-stable
+            ruby-version: 2.3
+          - foreman-core-branch: 2.1-stable
+            ruby-version: 2.3
+          - foreman-core-branch: develop
+            ruby-version: 2.3
+    steps:
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install build-essential libcurl4-openssl-dev libvirt-dev ruby-libvirt zlib1g-dev libpq-dev
+      - uses: actions/checkout@v2
+        with:
+          repository: theforeman/foreman
+          ref: ${{ matrix.foreman-core-branch }}
+      - uses: actions/checkout@v2
+        with:
+          path: foreman_expire_hosts
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version:  ${{ matrix.node-version }}
+      - name: Setup Plugin
+        run: |
+          echo "gem 'foreman_expire_hosts', path: './foreman_expire_hosts'" > bundler.d/foreman_expire_hosts.local.rb
+          gem install bundler
+          bundle config set without journald development console mysql2 sqlite
+          bundle install --jobs=3 --retry=3
+          bundle exec rake db:create
+          bundle exec rake db:migrate
+          npm install
+          bundle exec rake webpack:compile
+      - name: Run plugin tests
+        run: bundle exec rake test:foreman_expire_hosts
+      - name: Precompile plugin assets
+        run: bundle exec rake 'plugin:assets:precompile[foreman_expire_hosts]'
+        env:
+          RAILS_ENV: production

data/.rubocop.yml

@@ -1,8 +1,13 @@
 inherit_from:
   - .rubocop_todo.yml
 
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rails
+
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.3
   TargetRailsVersion: 5.1
   Exclude:
     - 'Rakefile'
@@ -17,18 +22,12 @@ Rails/Date:
 Style/Documentation:
   Enabled: false
 
-Metrics/MethodLength:
-  Max: 40
-
 Naming/AccessorMethodName:
   Enabled: false
 
 Style/RedundantSelf:
   Enabled: false
 
-Metrics/ClassLength:
-  Max: 500
-
 Naming/FileName:
   Exclude:
       - 'db/seeds.d/*'
@@ -36,9 +35,6 @@ Naming/FileName:
 Style/WordArray:
   Enabled: false
 
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 Style/RescueModifier:
   Enabled: false
 
@@ -48,9 +44,6 @@ Style/ClassAndModuleChildren:
 Style/EachWithObject:
   Enabled: false
 
-Metrics/ParameterLists:
-  Enabled: false
-
 Style/SymbolArray:
   Enabled: false
 
@@ -71,3 +64,15 @@ Style/CommentedKeyword:
 
 Rails/LexicallyScopedActionFilter:
   Enabled: false
+
+Rails/OutputSafety:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,42 +1,22 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-08-01 16:36:14 +0200 using RuboCop version 0.49.1.
+# on 2019-12-04 09:30:58 +0100 using RuboCop version 0.75.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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 12
-Metrics/AbcSize:
-  Max: 51
+Minitest/RefuteFalse:
+  Enabled: false
 
-# Offense count: 4
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 35
-  Exclude:
-    - 'test/**/*.rb'
+Minitest/AssertTruthy:
+  Enabled: false
 
-# Offense count: 3
-Metrics/CyclomaticComplexity:
-  Max: 11
+Style/HashEachMethods:
+  Enabled: false
 
-# Offense count: 89
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 362
+Style/HashTransformKeys:
+  Enabled: false
 
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ModuleLength:
-  Max: 110
-
-# Offense count: 3
-Metrics/PerceivedComplexity:
-  Max: 11
-
-# Offense count: 2
-Rails/OutputSafety:
-  Exclude:
-    - 'app/helpers/concerns/foreman_expire_hosts/audits_helper_extensions.rb'
+Style/HashTransformValues:
+  Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec

data/README.md

@@ -18,6 +18,7 @@ This plugin will send two warning notifications before host expiry (see Settings
 | >= 1.16         | ~> 4.0         |
 | >= 1.17         | ~> 5.0         |
 | >= 1.18         | ~> 6.0         |
+| >= 1.24         | ~> 7.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/api/v2/hosts_controller_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module Api
     module V2

data/app/controllers/concerns/foreman_expire_hosts/host_controller_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module HostControllerExtensions
     def self.prepended(base)
@@ -11,23 +13,20 @@ module ForemanExpireHosts
     def select_multiple_expiration; end
 
     def update_multiple_expiration
-      expiration_date = params[:host][:expired_on]
-      expiration_date = Date.parse(expiration_date) if expiration_date.present?
-
       failed_hosts = {}
 
       @hosts.each do |host|
         begin
           host.expired_on = expiration_date
           host.save!
-        rescue StandardError => error
-          failed_hosts[host.name] = error
+        rescue StandardError => e
+          failed_hosts[host.name] = e
           message = if expiration_date.present?
                       _('Failed to set expiration date for %{host} to %{expiration_date}.') % { :host => host, :expiration_date => l(expiration_date) }
                     else
                       _('Failed to clear expiration date for %s.') % host
                     end
-          Foreman::Logging.exception(message, error)
+          Foreman::Logging.exception(message, e)
         end
       end
 
@@ -48,15 +47,21 @@ module ForemanExpireHosts
     private
 
     def validate_multiple_expiration
-      if params[:host].nil? || (expiration_date = params[:host][:expired_on]).nil?
-        error _('No expiration date selected!')
-        redirect_to(select_multiple_expiration_hosts_path) && (return false)
-      end
-      begin
-        Date.parse(expiration_date) if expiration_date.present?
-      rescue ArgumentError
-        error _('Invalid expiration date!')
-        redirect_to(select_multiple_expiration_hosts_path) && (return false)
+      expiration_date
+    rescue ArgumentError
+      error _('Invalid expiration date!')
+      redirect_to(hosts_path) && (return false)
+    end
+
+    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}")
       end
     end
 

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

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module AuditsHelperExtensions
     extend ActiveSupport::Concern
 
     def destroyed_expired_host_audit_comment_in_list(audit)
       return unless audit.auditable_type.to_s == 'Host' && audit.action == 'destroy' && audit.comment.present?
+
       "<div style='color: #737373;font-size: 14px'>Comment: #{audit.comment}</div>".html_safe
     end
 
     def destroyed_expired_host_audit_comment_in_show(audit)
       return unless audit.auditable_type.to_s == 'Host' && audit.action == 'destroy' && audit.comment.present?
+
       "<tr><td>Comment</td><td>#{audit.comment}</td></tr>".html_safe
     end
   end

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

@@ -1,21 +1,12 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module HostsHelperExtensions
     extend ActiveSupport::Concern
 
-    module Overrides
-      def multiple_actions
-        actions = super
-        actions << [_('Change Expiration'), select_multiple_expiration_hosts_path] if authorized_for(:controller => :hosts, :action => :select_multiple_expiration)
-        actions
-      end
-    end
-
-    included do
-      prepend Overrides
-    end
-
     def host_expiry_warning_message(host)
       return nil unless host.expires?
+
       if host.expired_past_grace_period?
         message = _('This host has expired %s ago and needs to be deleted manually.') % time_ago_in_words(host.expired_on)
       elsif host.expired?
@@ -32,18 +23,10 @@ module ForemanExpireHosts
       distance_of_time_in_words(to_time, Time.current, options)
     end
 
-    def input_group_addon(content, options = {})
-      content_tag :span, class: 'input-group-addon' do
-        content_tag :span, content, options
-      end
-    end
-
-    def datepicker_f(form, attr, options = {})
+    def datepicker_f(form, attr, options = {}, html_options = {})
       field(form, attr, options) do
         addClass options, 'form-control'
-        date = form.text_field attr, options
-        addon = input_group_addon('', :class => 'glyphicon glyphicon-calendar')
-        input_group date, addon
+        form.date_select(attr, options, html_options)
       end
     end
   end

data/app/helpers/expire_hosts_mailer_helper.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module ExpireHostsMailerHelper
   def relative_date(date, opts = {})
     return _('N/A') if date.blank?
+
     opts[:tense] ||= :future if Date.today < date
     opts[:tense] ||= :past if Date.today > date
 

data/app/helpers/foreman_expire_hosts/hosts_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ForemanExpireHosts
+  module HostsHelper
+    def expire_hosts_host_multiple_actions
+      actions = []
+      if authorized_for(:controller => :hosts, :action => :select_multiple_expiration)
+        actions << {
+          action: [_('Change Expiration'), select_multiple_expiration_hosts_path],
+          priority: 200
+        }
+      end
+      actions
+    end
+  end
+end

data/app/mailers/expire_hosts_mailer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ExpireHostsMailer < ApplicationMailer
   default :content_type => 'text/html', :from => Setting[:email_reply_address] || 'noreply@your-foreman.com'
 
@@ -80,6 +82,7 @@ class ExpireHostsMailer < ApplicationMailer
   def recipient_mail(recipient)
     return recipient if recipient.is_a?(Array)
     return recipient.mail if recipient.mail.present?
+
     admin_email
   end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanExpireHosts
   module HostExt
     extend ActiveSupport::Concern
@@ -13,7 +15,7 @@ module ForemanExpireHosts
 
       scope :expiring, -> { where('expired_on IS NOT NULL') }
       scope :with_expire_date, ->(date) { expiring.where('expired_on = ?', date) }
-      scope :expired, -> { expiring.where('expired_on < ?', Date.today) }
+      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) }
 
@@ -40,27 +42,32 @@ module ForemanExpireHosts
 
     def expires_today?
       return false unless expires?
+
       expired_on.to_date == Date.today
     end
 
     def expired?
       return false unless expires?
+
       expired_on.to_date < Date.today
     end
 
     def expiration_grace_period_end_date
       return nil unless expires?
+
       expired_on + Setting[:days_to_delete_after_host_expiration].to_i
     end
 
     def expired_past_grace_period?
       return false unless expires?
+
       expiration_grace_period_end_date <= Date.today
     end
 
     def pending_expiration?
       return false unless expires?
       return false if expired?
+
       expired_on - Setting['notify1_days_before_host_expiry'].to_i <= Date.today
     end
 
@@ -70,6 +77,7 @@ module ForemanExpireHosts
       return true unless User.current
       return true if Authorizer.new(User.current).can?(:edit_host_expiry, self)
       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.all_users.include?(User.current)))