foreman_maintain 1.4.2 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d37937d8bc4cbf619ea0e654e6826ae92a96ecd74f1b260e5b402df7bcbdc68
-  data.tar.gz: a0fcf7a0f6802f7547c26d640650ac29cafa3568f7fdbc648f31d3dbdbcf6a72
+  metadata.gz: b1c667552795ef78c81447baaad773108b77669a36ee84858e710634d4d51690
+  data.tar.gz: b45c8ff19cd462003a01b82114021c81ebc1891fbdb00e42b2fc48f07aeed2a1
 SHA512:
-  metadata.gz: 2bab8216e974e96128a5f0fb88a201d1c8dd9da13d71b89efea76337c242f6459285e8af8a8dbcacbaa318f402c1b26cc7056e5e1d976946b8939f13bbaa4fda
-  data.tar.gz: 59772c9b2ec381408458383f4e06bafb8bb3998f5c4cea60be7a2dc2a254803896a05aa2858aad48f34e54185b7db6a455534cafa5f671b6a52a69bbe0b07e74
+  metadata.gz: eeb24ce08dd3d3cf2dfddb3116719bc11365ab902111a8bc62a887bb3054c74ae062fa6028f8fdddce2b2153359cb8f4a290e4e300fd295e3f1ba87f0c9b22b5
+  data.tar.gz: 98bd38fda86ed2cf459f6bb3a404f13b9f078650301ef89e4e6872ca32e234313f4f8d12bf819bb8b8af57710226d5528cc0fa59ec0b9593fc56a18c8a1245ac

data/definitions/checks/foreman_tasks/not_paused.rb

@@ -9,7 +9,7 @@ module Checks::ForemanTasks
     end
 
     def run
-      paused_tasks_count = feature(:foreman_tasks).paused_tasks_count()
+      paused_tasks_count = feature(:foreman_tasks).paused_tasks_count
       assert(paused_tasks_count == 0,
         "There are currently #{paused_tasks_count} paused tasks in the system",
         :next_steps => next_procedures)

data/definitions/checks/katello_agent.rb

@@ -0,0 +1,39 @@
+class Checks::CheckKatelloAgentEnabled < ForemanMaintain::Check
+  metadata do
+    label :check_katello_agent_enabled
+    description 'Check whether the katello-agent feature is enabled before upgrading'
+    tags :pre_upgrade
+
+    confine do
+      !feature(:capsule)
+    end
+  end
+
+  def run
+    instance_name = feature(:instance).downstream ? "Satellite" : "Katello"
+    instance_version = feature(:instance).downstream ? "6.15" : "4.10"
+    installer_command = feature(:instance).downstream ? "satellite-installer" : "foreman-installer"
+    maintain_command = feature(:instance).downstream ? "satellite-maintain" : "foreman-maintain"
+
+    assert(
+      !katello_agent_enabled?,
+      "The katello-agent feature is enabled on this system. As of #{instance_name}"\
+      " #{instance_version}, katello-agent is removed and will no longer function."\
+      " Before proceeding with the upgrade, you should ensure that you have deployed"\
+      " and configured an alternative tool for remote package management and patching"\
+      " for content hosts, such as Remote Execution (REX) with pull-based transport."\
+      " See the Managing Hosts guide in the #{instance_name} documentation for more info."\
+      " Disable katello-agent with the command"\
+      " `#{installer_command} --foreman-proxy-content-enable-katello-agent false`"\
+      " before proceeding with the upgrade. Alternatively, you may skip this check and proceed by"\
+      " running #{maintain_command} again with the `--whitelist` option, which will automatically"\
+      " uninstall katello-agent."
+    )
+  end
+
+  private
+
+  def katello_agent_enabled?
+    feature(:installer).answers['foreman_proxy_content']['enable_katello_agent']
+  end
+end

data/definitions/checks/package_manager/dnf/validate_dnf_config.rb

@@ -19,7 +19,7 @@ module Checks::PackageManager
 
       # rubocop:disable Metrics/LineLength
       def failure_message(final_result)
-        verb_string = final_result[:matched_keys].length > 1 ? 'are' : 'is'
+        verb_string = (final_result[:matched_keys].length > 1) ? 'are' : 'is'
 
         "#{final_result[:matched_keys].join(',')} #{verb_string} set in /etc/dnf/dnf.conf as below:"\
         "\n#{final_result[:grep_output]}"\

data/definitions/features/candlepin_database.rb

@@ -14,7 +14,7 @@ class Features::CandlepinDatabase < ForemanMaintain::Feature
   def services
     [
       system_service('postgresql', 10, :component => 'candlepin',
-                                       :db_feature => feature(:candlepin_database)),
+        :db_feature => feature(:candlepin_database)),
     ]
   end
 

data/definitions/features/foreman_database.rb

@@ -28,7 +28,7 @@ class Features::ForemanDatabase < ForemanMaintain::Feature
   def services
     [
       system_service('postgresql', 10, :component => 'foreman',
-                                       :db_feature => feature(:foreman_database)),
+        :db_feature => feature(:foreman_database)),
     ]
   end
 

data/definitions/features/installer.rb

@@ -30,7 +30,6 @@ class Features::Installer < ForemanMaintain::Feature
   def config_files
     Dir.glob(File.join(config_directory, '**/*')) +
       [
-        '/usr/local/bin/validate_postgresql_connection.sh',
         '/opt/puppetlabs/puppet/cache/foreman_cache_data',
         '/opt/puppetlabs/puppet/cache/pulpcore_cache_data',
       ]

data/definitions/features/pulpcore.rb

@@ -19,7 +19,7 @@ class Features::Pulpcore < ForemanMaintain::Feature
     names = names.map { |f| File.basename(f) }
     names.map do |name|
       system_service(name, 20, :skip_enablement => true,
-                               :instance_parent_unit => 'pulpcore-worker@')
+        :instance_parent_unit => 'pulpcore-worker@')
     end
   end
 

data/definitions/features/pulpcore_database.rb

@@ -20,7 +20,7 @@ class Features::PulpcoreDatabase < ForemanMaintain::Feature
   def services
     [
       system_service('postgresql', 10, :component => 'pulpcore',
-                                       :db_feature => feature(:pulpcore_database)),
+        :db_feature => feature(:pulpcore_database)),
     ]
   end
 

data/definitions/features/service.rb

@@ -15,7 +15,7 @@ class Features::Service < ForemanMaintain::Feature
     ForemanMaintain.available_features.flat_map(&:services).
       sort.
       inject([]) do |pool, service| # uniq(&:to_s) for ruby 1.8.7
-        pool.last.nil? || !pool.last.matches?(service) ? pool << service : pool
+        (pool.last.nil? || !pool.last.matches?(service)) ? pool << service : pool
       end.
       select(&:exist?)
   end
@@ -109,7 +109,7 @@ class Features::Service < ForemanMaintain::Feature
   end
 
   def format_brief_status(exit_code)
-    result = exit_code == 0 ? reporter.status_label(:success) : reporter.status_label(:fail)
+    result = (exit_code == 0) ? reporter.status_label(:success) : reporter.status_label(:fail)
     padding = reporter.max_length - reporter.last_line.to_s.length - 30
     "#{' ' * padding} #{result}"
   end

data/definitions/procedures/backup/offline/foreman_db.rb

@@ -33,7 +33,7 @@ module Procedures::Backup
       def local_backup
         with_spinner("Collecting data from #{pg_data_dirs.join(',')}") do
           pg_data_dirs.each_with_index do |pg_dir, index|
-            do_backup(pg_dir, index == 0 ? 'create' : 'append')
+            do_backup(pg_dir, (index == 0) ? 'create' : 'append')
           end
         end
       end

data/definitions/procedures/backup/online/safety_confirmation.rb

@@ -5,7 +5,7 @@ module Procedures::Backup
         description 'Data consistency warning'
         tags :backup
         param :include_db_dumps, 'Are database dumps included in backup', :flag => true,
-                                                                          :default => false
+          :default => false
       end
 
       def run

data/definitions/procedures/backup/snapshot/mount_base.rb

@@ -14,7 +14,7 @@ module Procedures::Backup
 
       def mount_snapshot(database, lv_type)
         FileUtils.mkdir_p(mount_location(database))
-        options = lv_type == 'xfs' ? '-onouuid,ro' : '-oro'
+        options = (lv_type == 'xfs') ? '-onouuid,ro' : '-oro'
         lv_name = "#{database}-snap"
         execute!("mount #{get_lv_path(lv_name)} #{mount_location(database)} #{options}")
       end

data/definitions/procedures/foreman/fix_corrupted_roles.rb

@@ -26,7 +26,7 @@ module Procedures::Foreman
 
     def find_records_to_update(inconsistent_sets)
       largest_set = inconsistent_sets.reduce([]) do |memo, set|
-        set.count > memo.count ? set : memo
+        (set.count > memo.count) ? set : memo
       end
 
       inconsistent_sets.reject do |set|

data/definitions/procedures/maintenance_mode/is_enabled.rb

@@ -12,7 +12,7 @@ module Procedures::MaintenanceMode
 
     def run
       @status_code = feature(:instance).firewall.maintenance_mode_status? ? 0 : 1
-      puts "Maintenance mode is #{@status_code == 1 ? 'Off' : 'On'}"
+      puts "Maintenance mode is #{(@status_code == 1) ? 'Off' : 'On'}"
     end
   end
 end

data/definitions/procedures/packages/check_for_reboot.rb

@@ -7,7 +7,7 @@ module Procedures::Packages
     def run
       status, output = execute_with_status('dnf needs-restarting --reboothint')
       if status == 1
-        set_status(:warning, output)
+        set_info_warn(output)
       else
         set_status(:success, output)
       end

data/definitions/scenarios/backup.rb

@@ -195,7 +195,7 @@ module ForemanMaintain::Scenarios
 
     def add_online_backup_steps
       add_step_with_context(Procedures::Backup::ConfigFiles, :ignore_changed_files => true,
-                                                             :online_backup => true)
+        :online_backup => true)
       add_step_with_context(Procedures::Backup::Pulp, :ensure_unchanged => true)
       add_steps_with_context(
         Procedures::Backup::Online::CandlepinDB,

data/lib/foreman_maintain/concerns/base_database.rb

@@ -90,7 +90,7 @@ module ForemanMaintain
                      ' --no-privileges --clean --disable-triggers -n public ' \
                      "-d #{config['database']} #{file}"
           execute!(dump_cmd, :hidden_patterns => [config['password']],
-                             :valid_exit_statuses => [0, 1])
+            :valid_exit_statuses => [0, 1])
         end
       end
 

data/lib/foreman_maintain/concerns/primary_checks.rb

@@ -2,7 +2,8 @@ module ForemanMaintain
   module Concerns
     module PrimaryChecks
       def validate_downstream_packages
-        return unless detector.feature(:installer)&.with_scenarios?
+        return unless detector.feature(:installer)
+
         if (package = package_name) && !package_manager.installed?(package)
           raise ForemanMaintain::Error::Fail,
             "Error: Important rpm package #{package} is not installed!"\

data/lib/foreman_maintain/concerns/system_helpers.rb

@@ -106,7 +106,7 @@ module ForemanMaintain
           package_manager.install(packages, :assumeyes => options[:assumeyes])
         when :update
           package_manager.update(packages, :assumeyes => options[:assumeyes],
-                                           :dnf_options => options[:dnf_options])
+            :dnf_options => options[:dnf_options])
         when :remove
           package_manager.remove(packages, :assumeyes => options[:assumeyes])
         else

data/lib/foreman_maintain/executable.rb

@@ -5,7 +5,7 @@ module ForemanMaintain
     attr_reader :options
 
     def_delegators :execution,
-      :success?, :skipped?, :fail?, :aborted?, :warning?, :output,
+      :success?, :skipped?, :fail?, :aborted?, :warning?, :info_warning?, :output,
       :assumeyes?, :whitelisted?, :ask_decision,
       :execution, :puts, :print, :with_spinner, :ask, :storage
 
@@ -91,6 +91,10 @@ module ForemanMaintain
       set_status(:warning, message)
     end
 
+    def set_info_warn(message)
+      set_status(:info_warning, message)
+    end
+
     def set_skip(message)
       set_status(:skipped, message)
     end
@@ -173,7 +177,7 @@ module ForemanMaintain
       raise "The step is not matching the hash #{hash.inspect}" unless matches_hash?(hash)
       raise "Can't update step that was already executed" if @_execution
       @_execution = Runner::StoredExecution.new(self, :status => hash[:status],
-                                                      :output => hash[:output])
+        :output => hash[:output])
     end
 
     def inspect

data/lib/foreman_maintain/reporter/cli_reporter.rb

@@ -228,7 +228,7 @@ module ForemanMaintain
         end
 
         until_valid_decision do
-          actions = run_strategy == :fail_slow ? 'n(next)' : 'n(next), q(quit)'
+          actions = (run_strategy == :fail_slow) ? 'n(next)' : 'n(next), q(quit)'
           answer = ask("#{message}, [#{actions}]")
           if answer =~ /^\d+$/ && (answer.to_i - 1) < steps.size
             steps[answer.to_i - 1]
@@ -276,7 +276,8 @@ module ForemanMaintain
                     :running => { :label => '[RUNNING]', :color => :blue },
                     :skipped => { :label => '[SKIPPED]', :color => :yellow },
                     :already_run => { :label => '[ALREADY RUN]', :color => :yellow },
-                    :warning => { :label => '[WARNING]', :color => :yellow } }
+                    :warning => { :label => '[WARNING]', :color => :yellow },
+                    :info_warning => { :label => '[WARNING]', :color => :yellow } }
         properties = mapping[status]
         if @plaintext
           properties[:label]

data/lib/foreman_maintain/reporter.rb

@@ -113,7 +113,7 @@ module ForemanMaintain
         return steps.first
       end
       until_valid_decision do
-        actions = run_strategy == :fail_slow ? 'n(next)' : 'n(next), q(quit)'
+        actions = (run_strategy == :fail_slow) ? 'n(next)' : 'n(next), q(quit)'
 
         answer = ask("#{message}, [#{actions}]")
         if answer =~ /^\d+$/ && (answer.to_i - 1) < steps.size

data/lib/foreman_maintain/runner/execution.rb

@@ -63,6 +63,10 @@ module ForemanMaintain
         @status == :warning
       end
 
+      def info_warning?
+        @status == :info_warning
+      end
+
       # yaml storage to preserve key/value pairs between runs.
       def storage
         @storage || ForemanMaintain.storage(:default)

data/lib/foreman_maintain/scenario.rb

@@ -119,6 +119,10 @@ module ForemanMaintain
       filter_whitelisted(executed_steps.find_all(&:warning?), options)
     end
 
+    def steps_with_info_warning(options = {})
+      filter_whitelisted(executed_steps.find_all(&:info_warning?), options)
+    end
+
     def steps_with_skipped(options = {})
       filter_whitelisted(executed_steps.find_all(&:skipped?), options)
     end
@@ -143,6 +147,10 @@ module ForemanMaintain
       !steps_with_warning(:whitelisted => false).empty?
     end
 
+    def info_warning?
+      !steps_with_info_warning(:whitelisted => false).empty?
+    end
+
     def failed?
       !passed?
     end

data/lib/foreman_maintain/utils/service/abstract.rb

@@ -18,7 +18,7 @@ module ForemanMaintain::Utils
 
       def <=>(other)
         prio_cmp = @priority <=> other.priority
-        prio_cmp == 0 ? @name <=> other.name : prio_cmp
+        (prio_cmp == 0) ? @name <=> other.name : prio_cmp
       end
 
       def to_s

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '1.4.2'.freeze
+  VERSION = '1.4.4'.freeze
 end

data/lib/foreman_maintain/yaml_storage.rb

@@ -47,7 +47,7 @@ module ForemanMaintain
       end
 
       def save_all
-        storage_register.values.each(&:save)
+        storage_register.each_value(&:save)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.4
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -181,6 +181,7 @@ files:
 - definitions/checks/foreman_tasks/invalid/check_planning_state.rb
 - definitions/checks/foreman_tasks/not_paused.rb
 - definitions/checks/foreman_tasks/not_running.rb
+- definitions/checks/katello_agent.rb
 - definitions/checks/maintenance_mode/check_consistency.rb
 - definitions/checks/non_rh_packages.rb
 - definitions/checks/package_manager/dnf/validate_dnf_config.rb