foreman_rescue 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55de93b62e157091d65fcab30cb1874ec5ac90a2f26ee581330942907c2a8b2f
-  data.tar.gz: 13649843d4c4a7fe195c109851e839c627f205c8a12294a1837299f5daed79da
+  metadata.gz: 30d69cfe2978f5b7b6a4f3604151d8d83ab5fcee0a5245ce845798ada48ea10c
+  data.tar.gz: 37cbc08534f2b5cada7d57f8988a5f36a60ae38b244e1ee7c6c076487e51d9fc
 SHA512:
-  metadata.gz: 535f2a6efd573bb1127a731eee765cfc233b9e37b41bbc8a63a9cb8cb99aaaef92e0ddc547b006aae92a9fd1a9892dad9924dfb459759033d27cb1d832f26bb4
-  data.tar.gz: 8de3049f0f3634be135618fb79f109f1bf047c8e752f5519757d4ba682aa5280a91257d000afef65cee9cb702574d303ae0914fefb99f6e59f3fe959c833044a
+  metadata.gz: cf8c408b71e8d5369c027d11909369152f1ece087658579b3874b55d6e3306448597f17cadab4cba0ee47ae15da5acf8f854dcece077acdd1dcdabf84101bcdc
+  data.tar.gz: fc5b71b96991fd3f42b66bdb8dc2fac9b3173214420273c4d76f5b3bd3b6bbdb7f570a11540cbdca268305983799432656b3ada028fd04d838edbf7cc060124f

data/README.md

@@ -12,6 +12,7 @@ This plugin allows a user to boot a Foreman host into a rescue system via PXE.
 | >= 1.17         | ~> 1.0         |
 | >= 1.20         | ~> 2.0         |
 | >= 1.21         | ~> 3.0         |
+| >= 3.9          | ~> 4.0         |
 
 ## Installation
 

data/Rakefile

@@ -20,7 +20,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 
 Bundler::GemHelper.install_tasks
 
@@ -38,7 +38,7 @@ task default: :test
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
-rescue => _
+rescue StandardError
   puts 'Rubocop not loaded.'
 end
 

data/app/controllers/foreman_rescue/hosts_controller.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module ForemanRescue
   class HostsController < ::HostsController
     before_action :find_resource, :only => [:rescue, :set_rescue, :cancel_rescue]
     define_action_permission ['rescue', 'set_rescue', 'cancel_rescue'], :rescue
 
-    def rescue; end
+    def rescue
+    end
 
     def set_rescue
       forward_url_options
@@ -16,10 +19,10 @@ module ForemanRescue
                         _('Enabled %s for boot into rescue system on next boot, but failed to power cycle the host.')
                       end
             process_success :success_msg => message % @host, :success_redirect => :back
-          rescue StandardError => error
+          rescue StandardError => e
             message = _('Failed to reboot %s.') % @host
             warning(message)
-            Foreman::Logging.exception(message, error)
+            Foreman::Logging.exception(message, e)
             process_success :success_msg => _('Enabled %s for rescue system on next boot.') % @host, :success_redirect => :back
           end
         else
@@ -35,8 +38,10 @@ module ForemanRescue
         process_success :success_msg => _('Canceled booting into rescue system for %s.') % @host.name, :success_redirect => :back
       else
         process_error :redirect => :back,
-                      :error_msg => _('Failed to cancel booting into rescue system for %{hostname} with the following errors: %{errors}') %
-                                    { :hostname => @host.name, :errors => @host.errors.full_messages.to_sentence }
+          :error_msg => _('Failed to cancel booting into rescue system for %{hostname} with the following errors: %{errors}') % {
+            :hostname => @host.name,
+            :errors => @host.errors.full_messages.to_sentence,
+          }
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanRescue
   module HostsHelperExtensions
     def host_title_actions(host)
@@ -5,15 +7,15 @@ module ForemanRescue
         button_group(
           if host.rescue_mode?
             link_to_if_authorized(_('Cancel rescue'), hash_for_cancel_rescue_host_path(:id => host).merge(:auth_object => host, :permission => 'rescue_hosts'),
-                                  :disabled => host.can_be_rescued?,
-                                  :title    => _('Cancel rescue system for this host.'),
-                                  :class => 'btn btn-default',
-                                  :method => :put)
+              :disabled => host.can_be_rescued?,
+              :title => _('Cancel rescue system for this host.'),
+              :class => 'btn btn-default',
+              :method => :put)
           else
             link_to_if_authorized(_('Rescue'), hash_for_rescue_host_path(:id => host).merge(:auth_object => host, :permission => 'rescue_hosts'),
-                                  :disabled => !host.can_be_rescued?,
-                                  :title    => _('Activate rescue mode for this host.'),
-                                  :class    => 'btn btn-default')
+              :disabled => !host.can_be_rescued?,
+              :title => _('Activate rescue mode for this host.'),
+              :class => 'btn btn-default')
           end
         )
       )

data/app/models/concerns/foreman_rescue/host_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanRescue
   module HostExtensions
     def self.prepended(base)

data/app/models/concerns/foreman_rescue/orchestration/tftp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanRescue
   module Orchestration
     module TFTP

data/app/models/concerns/foreman_rescue/provisioning_template_extensions.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ForemanRescue
+  module ProvisioningTemplateExtensions
+    def self.templates_by_kind(kind)
+      template_kind = TemplateKind.find_by(name: kind)
+      ProvisioningTemplate.where(:template_kind => template_kind).pluck(:name, :name).to_h
+    end
+  end
+end

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Rails.application.routes.draw do
   constraints(:id => /[^\/]+/) do
     resources :hosts, controller: 'foreman_rescue/hosts', :only => [] do

data/db/migrate/20170901131321_add_rescue_mode_to_host.foreman_rescue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddRescueModeToHost < ActiveRecord::Migration[4.2]
   def change
     add_column :hosts, :rescue_mode, :boolean, default: false, index: true

data/db/migrate/20240506132712_migrate_rescue_settings_category_to_dsl.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class MigrateRescueSettingsCategoryToDsl < ActiveRecord::Migration[6.0]
+  class MigrationSettings < ApplicationRecord
+    self.table_name = :settings
+  end
+
+  def up
+    MigrationSettings.where(category: 'Setting::Rescue').update_all(category: 'Setting') if column_exists?(
+      :settings, :category
+    )
+  end
+end

data/db/seeds.d/103-provisioning_templates.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 User.as_anonymous_admin do
   templates = [
-    { :name => 'Kickstart rescue PXELinux', :source => 'PXELinux/kickstart_rescue_pxelinux.erb', :template_kind => TemplateKind.find_by(:name => 'PXELinux') }
+    { :name => 'Kickstart rescue PXELinux', :source => 'PXELinux/kickstart_rescue_pxelinux.erb', :template_kind => TemplateKind.find_by(:name => 'PXELinux') },
   ]
 
   templates.each do |template|

data/lib/foreman_rescue/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanRescue
   class Engine < ::Rails::Engine
     engine_name 'foreman_rescue'
@@ -12,20 +14,34 @@ module ForemanRescue
       end
     end
 
-    initializer 'foreman_monitoring.load_default_settings',
-                :before => :load_config_initializers do |_app|
-      if begin
-        Setting.table_exists?
-      rescue StandardError
-        false
-      end
-        require_dependency File.expand_path('../../../app/models/setting/rescue.rb', __FILE__)
-      end
-    end
+    initializer 'foreman_rescue.register_plugin', :before => :finisher_hook do |_app| # rubocop:disable Metrics/BlockLength
+      Foreman::Plugin.register :foreman_rescue do # rubocop:disable Metrics/BlockLength
+        requires_foreman '>= 3.9'
 
-    initializer 'foreman_rescue.register_plugin', :before => :finisher_hook do |_app|
-      Foreman::Plugin.register :foreman_rescue do
-        requires_foreman '>= 1.21'
+        settings do
+          category :rescue, N_('Rescue') do
+            setting('rescue_pxelinux_tftp_template',
+              type: :string,
+              default: 'Kickstart rescue PXELinux',
+              full_name: N_('PXELinux rescue template'),
+              description: N_('PXELinux template used when booting rescue system'),
+              collection: proc { ProvisioningTemplate.templates_by_kind('PXELinux') })
+
+            setting('rescue_pxegrub_tftp_template',
+              type: :string,
+              default: '',
+              full_name: N_('PXEGrub rescue template'),
+              description: N_('PXEGrub template used when booting rescue system'),
+              collection: proc { ProvisioningTemplate.templates_by_kind('PXEGrub') })
+
+            setting('rescue_pxegrub2_tftp_template',
+              type: :string,
+              default: '',
+              full_name: N_('PXEGrub2 rescue template'),
+              description: N_('PXEGrub2 template used when booting rescue system'),
+              collection: proc { ProvisioningTemplate.templates_by_kind('PXEGrub2') })
+          end
+        end
 
         # Add permissions
         security_block :foreman_rescue do
@@ -35,13 +51,12 @@ module ForemanRescue
     end
 
     config.to_prepare do
-      begin
-        Host::Managed.send(:prepend, ForemanRescue::HostExtensions)
-        HostsHelper.send(:prepend, ForemanRescue::HostsHelperExtensions)
-        Nic::Managed.send(:prepend, ForemanRescue::Orchestration::TFTP)
-      rescue StandardError => e
-        Rails.logger.warn "ForemanRescue: skipping engine hook (#{e})"
-      end
+      Host::Managed.prepend ForemanRescue::HostExtensions
+      HostsHelper.prepend ForemanRescue::HostsHelperExtensions
+      Nic::Managed.prepend ForemanRescue::Orchestration::TFTP
+      ProvisioningTemplate.prepend ForemanRescue::ProvisioningTemplateExtensions
+    rescue StandardError => e
+      Rails.logger.warn "ForemanRescue: skipping engine hook (#{e})"
     end
 
     rake_tasks do
@@ -51,7 +66,7 @@ module ForemanRescue
     end
 
     initializer 'foreman_rescue.register_gettext', after: :load_config_initializers do |_app|
-      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
       locale_domain = 'foreman_rescue'
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end

data/lib/foreman_rescue/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanRescue
-  VERSION = '3.0.0'.freeze
+  VERSION = '4.0.0'
 end

data/lib/foreman_rescue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'foreman_rescue/engine'
 
 module ForemanRescue

data/lib/tasks/foreman_rescue_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 
 # Tests
@@ -12,24 +14,4 @@ namespace :test do
   end
 end
 
-namespace :foreman_rescue do
-  task :rubocop do
-    begin
-      require 'rubocop/rake_task'
-      RuboCop::RakeTask.new(:rubocop_foreman_rescue) do |task|
-        task.patterns = ["#{ForemanRescue::Engine.root}/app/**/*.rb",
-                         "#{ForemanRescue::Engine.root}/lib/**/*.rb",
-                         "#{ForemanRescue::Engine.root}/test/**/*.rb"]
-      end
-    rescue StandardError
-      puts 'Rubocop not loaded.'
-    end
-
-    Rake::Task['rubocop_foreman_rescue'].invoke
-  end
-end
-
 Rake::Task[:test].enhance ['test:foreman_rescue']
-
-load 'tasks/jenkins.rake'
-Rake::Task['jenkins:unit'].enhance ['test:foreman_rescue', 'foreman_rescue:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')

data/locale/gemspec.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # Matches foreman_rescue.gemspec
-_('TODO: Description of ForemanRescue.')
+_('Foreman Plugin to provide the ability to boot a host into a rescue system.')

data/test/controllers/hosts_controller_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 module ForemanRescue

data/test/factories/host.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.modify do
   factory :host do
     trait :rescue_mode do

data/test/lib/tasks/seeds_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 module ForemanRescue
@@ -27,7 +29,7 @@ module ForemanRescue
     def seed
       User.current = FactoryBot.build(:user, :admin => true,
                                              :organizations => [], :locations => [])
-      load Rails.root.join('db', 'seeds.rb')
+      load Rails.root.join('db/seeds.rb')
     end
   end
 end

data/test/models/host_test.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class HostTest < ActiveSupport::TestCase
   setup do
     User.current = FactoryBot.build(:user, :admin)
-    setup_settings
     disable_orchestration
   end
 

data/test/test_plugin_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
 require 'database_cleaner'
@@ -9,10 +11,6 @@ FactoryBot.reload
 # Foreman's setup doesn't handle cleaning up for Minitest::Spec
 DatabaseCleaner.strategy = :transaction
 
-def setup_settings
-  Setting::Rescue.load_defaults
-end
-
 module Minitest
   class Spec
     before :each do

data/test/unit/foreman_rescue/access_permissions_test.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+require 'unit/shared/access_permissions_test_base'
+
+# Permissions are added in AccessPermissions with lists of controllers and
+# actions that they enable access to.  For non-admin users, we need to test
+# that there are permissions available that cover every controller action, else
+# it can't be delegated and this will lead to parts of the application that
+# aren't functional for non-admin users.
+#
+# In particular, it's important that actions for AJAX requests are added to
+# an appropriate permission so views using those requests function.
+class AccessPermissionsTest < ActiveSupport::TestCase
+  include AccessPermissionsTestBase
+
+  check_routes(ForemanRescue::Engine.routes, [])
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_rescue
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Timo Goebel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2024-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: theforeman-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.1.2
 description: Foreman Plugin to provide the ability to boot a host into a rescue system.
 email:
 - timo.goebel@dm.de
@@ -52,11 +52,12 @@ files:
 - app/helpers/concerns/foreman_rescue/hosts_helper_extensions.rb
 - app/models/concerns/foreman_rescue/host_extensions.rb
 - app/models/concerns/foreman_rescue/orchestration/tftp.rb
-- app/models/setting/rescue.rb
+- app/models/concerns/foreman_rescue/provisioning_template_extensions.rb
 - app/views/foreman/unattended/provisioning_templates/PXELinux/kickstart_rescue_pxelinux.erb
 - app/views/foreman_rescue/hosts/rescue.html.erb
 - config/routes.rb
 - db/migrate/20170901131321_add_rescue_mode_to_host.foreman_rescue.rb
+- db/migrate/20240506132712_migrate_rescue_settings_category_to_dsl.rb
 - db/seeds.d/103-provisioning_templates.rb
 - lib/foreman_rescue.rb
 - lib/foreman_rescue/engine.rb
@@ -71,11 +72,12 @@ files:
 - test/lib/tasks/seeds_test.rb
 - test/models/host_test.rb
 - test/test_plugin_helper.rb
+- test/unit/foreman_rescue/access_permissions_test.rb
 homepage: https://github.com/dm-drogeriemarkt/foreman_rescue
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,21 +85,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Provides the ability to boot a host into a rescue system.
 test_files:
-- test/models/host_test.rb
+- test/controllers/hosts_controller_test.rb
 - test/factories/host.rb
 - test/lib/tasks/seeds_test.rb
+- test/models/host_test.rb
 - test/test_plugin_helper.rb
-- test/controllers/hosts_controller_test.rb
+- test/unit/foreman_rescue/access_permissions_test.rb

data/app/models/setting/rescue.rb

@@ -1,45 +0,0 @@
-class Setting
-  class Rescue < ::Setting
-    BLANK_ATTRS.concat ['rescue_pxegrub_tftp_template', 'rescue_pxegrub2_tftp_template']
-
-    def self.default_settings
-      [
-        set('rescue_pxelinux_tftp_template',
-            N_('PXELinux template used when booting rescue system'),
-            'Kickstart rescue PXELinux', N_('PXELinux rescue template'), nil,
-            :collection => proc { Setting::Rescue.templates('PXELinux') }),
-        set('rescue_pxegrub_tftp_template',
-            N_('PXEGrub template used when booting rescue system'),
-            '', N_('PXEGrub rescue template'), nil,
-            :collection => proc { Setting::Rescue.templates('PXEGrub') }),
-        set('rescue_pxegrub2_tftp_template',
-            N_('PXEGrub2 template used when booting rescue system'),
-            '', N_('PXEGrub2 rescue template'), nil,
-            :collection => proc { Setting::Rescue.templates('PXEGrub2') })
-      ]
-    end
-
-    def self.load_defaults
-      # Check the table exists
-      return unless super
-
-      transaction do
-        default_settings.each { |s| create! s.update(:category => 'Setting::Rescue') }
-      end
-
-      true
-    end
-
-    def self.templates(kind)
-      template_kind = TemplateKind.find_by(name: kind)
-      templates = ProvisioningTemplate.where(:template_kind => template_kind)
-      templates.each_with_object({}) do |template, hsh|
-        hsh[template.name] = template.name
-      end
-    end
-
-    def self.humanized_category
-      N_('Rescue System')
-    end
-  end
-end