foreman_maintain 1.6.11 → 1.6.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 251038c33fba4faa2abf9c839937e229a664703c9b3003376b4d88aa7eca7d02
-  data.tar.gz: 72f4bb7fe9e7a9862df58accbfa190019a3356e99917d884242ad90259743291
+  metadata.gz: 75ad50dc1e0bbb3221aad7844236ac97467d5b12c07a17a0ae5f2bb09448d010
+  data.tar.gz: 310cbf63bbe5c3fc98efa58219bbcaee680c55580ca27415f9636bea85e637ed
 SHA512:
-  metadata.gz: 140782d6ee833f07a64b2310fd94901f42991dc9babb2368cdc48c904fe78122c6e8ae6584bdb7c2818883e6c425035288d9f2859b7983d5957a5366c7c1a13a
-  data.tar.gz: 127c879d335e5dc46151d31e02d9fb72c4f45bcaff5ffcd83dee2ae1552877952a2b7128b28e45c69cab779df7055025e9bfdfa014bc484ae17ef2ffdd595ad3
+  metadata.gz: 2a5036c9138cf2b219366c33e535cdb917e2bfe8fee87d03351a73b2e515cf4b4278d0ab4b34d9f799bb31d5ae01f5903261ada5aa4f7acccac6294b29e63f3d
+  data.tar.gz: e965c5451c169bb386d4b3239c3a57cb78e279d49c327ae80de7ab878982783752054ca53032e5d2a67acb6759b7f969e68970a610686232399b95d2f08fc28d

data/definitions/checks/backup/incremental_parent_type.rb

@@ -0,0 +1,33 @@
+module Checks::Backup
+  class IncrementalParentType < ForemanMaintain::Check
+    metadata do
+      description 'Check if the incremental backup has the right type'
+      tags :backup
+      param :incremental_dir, 'Path to existing backup directory'
+      param :online_backup, 'Select for online backup', :flag => true, :default => false
+      manual_detection
+    end
+
+    def run
+      return unless @incremental_dir
+
+      backup = ForemanMaintain::Utils::Backup.new(@incremental_dir)
+
+      existing_type = backup.backup_type
+      new_type = if @online_backup
+                   ForemanMaintain::Utils::Backup::ONLINE_BACKUP
+                 else
+                   ForemanMaintain::Utils::Backup::OFFLINE_BACKUP
+                 end
+      msg = "The existing backup is an #{existing_type} backup, "\
+        "but an #{new_type} backup was requested."
+      assert(existing_type == new_type, msg)
+
+      unless @online_backup
+        msg = "The existing backup has PostgreSQL as a tarball, "\
+          "but the new one will have a dump."
+        assert(!backup.sql_tar_files_exist?, msg)
+      end
+    end
+  end
+end

data/definitions/checks/foreman/check_tuning_requirements.rb

@@ -70,8 +70,8 @@ module Checks
       end
 
       def failure_message(tuning_profile)
-        <<-MESSAGE.strip_heredoc
-        \nERROR: The installer is configured to use the #{tuning_profile} tuning profile and does not meet the requirements.
+        <<~MESSAGE
+          \nERROR: The installer is configured to use the #{tuning_profile} tuning profile and does not meet the requirements.
         MESSAGE
       end
     end

data/definitions/checks/restore/validate_postgresql_dump_permissions.rb

@@ -11,7 +11,7 @@ module Checks::Restore
 
     def run
       backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
-      if feature(:instance).postgresql_local? && backup.online_backup?
+      if feature(:instance).postgresql_local?
         errors = []
         [:candlepin_dump, :foreman_dump, :pulpcore_dump].each do |dump|
           next unless backup.file_map[dump][:present]

data/definitions/checks/system_registration.rb

@@ -5,7 +5,7 @@ class Checks::SystemRegistration < ForemanMaintain::Check
     tags :default
 
     confine do
-      file_exists?('/etc/rhsm/rhsm.conf') && feature(:instance).downstream
+      feature(:instance).downstream
     end
   end
 

data/definitions/features/foreman_database.rb

@@ -35,7 +35,12 @@ class Features::ForemanDatabase < ForemanMaintain::Feature
   private
 
   def load_configuration
-    config = YAML.load(File.read(FOREMAN_DB_CONFIG))
+    config = if File.exist?('/etc/foreman/database.yml')
+               YAML.load(File.read(FOREMAN_DB_CONFIG))
+             else
+               { 'production' => {} }
+             end
+
     @configuration = config['production']
     @configuration['host'] ||= 'localhost'
     @configuration

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

@@ -2,7 +2,7 @@ module Procedures::Backup
   module Online
     class CandlepinDB < ForemanMaintain::Procedure
       metadata do
-        description 'Backup Candlepin database online'
+        description 'Backup Candlepin database'
         tags :backup
         label :backup_online_candlepin_db
         for_feature :candlepin_database

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

@@ -2,7 +2,7 @@ module Procedures::Backup
   module Online
     class ForemanDB < ForemanMaintain::Procedure
       metadata do
-        description 'Backup Foreman database online'
+        description 'Backup Foreman database'
         tags :backup
         label :backup_online_foreman_db
         for_feature :foreman_database

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

@@ -2,7 +2,7 @@ module Procedures::Backup
   module Online
     class PulpcoreDB < ForemanMaintain::Procedure
       metadata do
-        description 'Backup Pulpcore database online'
+        description 'Backup Pulpcore database'
         tags :backup
         label :backup_online_pulpcore_db
         for_feature :pulpcore_database

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

@@ -4,23 +4,20 @@ module Procedures::Backup
       metadata do
         description 'Data consistency warning'
         tags :backup
-        param :include_db_dumps, 'Are database dumps included in backup', :flag => true,
-          :default => false
       end
 
       def run
-        answer = ask_decision(warning_message(@include_db_dumps), actions_msg: 'y(yes), q(quit)')
+        answer = ask_decision(warning_message, actions_msg: 'y(yes), q(quit)')
         abort! unless answer == :yes
       end
 
-      def warning_message(include_db_dumps)
-        substr = include_db_dumps ? 'database dump' : 'online backup'
-        "*** WARNING: The #{substr} is intended for making a copy of the data\n" \
+      def warning_message
+        "*** WARNING: The online backup is intended for making a copy of the data\n" \
           '*** for debugging purposes only.' \
           " The backup routine can not ensure 100% consistency while the\n" \
           "*** backup is taking place as there is a chance there may be data mismatch between\n" \
           '*** the databases while the services are live.' \
-          " If you wish to utilize the #{substr}\n" \
+          " If you wish to utilize the online backup\n" \
           '*** for production use you need to ensure that there are' \
           " no modifications occurring during\n" \
           "*** your backup run.\n\nDo you want to proceed?"

data/definitions/procedures/backup/prepare_directory.rb

@@ -6,7 +6,6 @@ module Procedures::Backup
       param :backup_dir, 'Directory where to backup to', :required => true
       param :preserve_dir, 'Directory where to backup to', :flag => true
       param :incremental_dir, 'Changes since specified backup only'
-      param :online_backup, 'Select for online backup', :flag => true, :default => false
     end
 
     # rubocop:disable Metrics/MethodLength
@@ -17,7 +16,7 @@ module Procedures::Backup
         FileUtils.mkdir_p @backup_dir
         FileUtils.chmod_R 0o770, @backup_dir
 
-        if feature(:instance).postgresql_local? && @online_backup
+        if feature(:instance).postgresql_local?
           begin
             FileUtils.chown_R(nil, 'postgres', @backup_dir)
           rescue Errno::EPERM

data/definitions/procedures/foreman_tasks/ui_investigate.rb

@@ -10,7 +10,7 @@ module Procedures::ForemanTasks
     attr_reader :search_query
 
     def run
-      ask(<<-MESSAGE.strip_heredoc)
+      ask(<<~MESSAGE)
         Go to https://#{hostname}/foreman_tasks/tasks?search=#{CGI.escape(@search_query.to_s)}
         press ENTER after the tasks are resolved.
       MESSAGE

data/definitions/procedures/knowledge_base_article.rb

@@ -12,7 +12,7 @@ class Procedures::KnowledgeBaseArticle < ForemanMaintain::Procedure
   end
 
   def run
-    ask(<<-MESSAGE.strip_heredoc)
+    ask(<<~MESSAGE)
       Go to #{kcs_documents[@doc]}
       please follow steps from above article to resolve this issue
       press ENTER once done.

data/definitions/procedures/packages/update_all_confirmation.rb

@@ -20,7 +20,7 @@ module Procedures::Packages
           the recommendations?
         MSG
 
-        answer = ask_decision(question, actions_msg: 'y(yes), q(quit)')
+        answer = ask_decision(question.strip, actions_msg: 'y(yes), q(quit)')
         abort! unless answer == :yes
       end
     end

data/definitions/procedures/sync_plans/disable.rb

@@ -4,7 +4,6 @@ module Procedures::SyncPlans
     metadata do
       for_feature :sync_plans
       description 'disable active sync plans'
-      tags :pre_migrations, :maintenance_mode_on
 
       confine do
         feature(:katello)

data/definitions/procedures/sync_plans/enable.rb

@@ -4,8 +4,6 @@ module Procedures::SyncPlans
     metadata do
       for_feature :sync_plans
       description 're-enable sync plans'
-      tags :post_migrations, :maintenance_mode_off
-      before :disk_io
 
       confine do
         feature(:katello)

data/definitions/scenarios/backup.rb

@@ -8,7 +8,6 @@ module ForemanMaintain::Scenarios
       param :strategy, 'Backup strategy. One of [:online, :offline]',
         :required => true
       param :backup_dir, 'Directory where to backup to', :required => true
-      param :include_db_dumps, 'Include dumps of local dbs as part of offline'
       param :preserve_dir, 'Directory where to backup to'
       param :incremental_dir, 'Changes since specified backup only'
       param :proxy_features, 'List of proxy features to backup (default: all)', :array => true
@@ -18,10 +17,11 @@ module ForemanMaintain::Scenarios
 
     def compose
       check_valid_strategy
+      add_step_with_context(Checks::Backup::IncrementalParentType,
+        :online_backup => strategy == :online)
       safety_confirmation
       add_step_with_context(Procedures::Backup::AccessibilityConfirmation) if strategy == :offline
-      add_step_with_context(Procedures::Backup::PrepareDirectory,
-        :online_backup => strategy == :online)
+      add_step_with_context(Procedures::Backup::PrepareDirectory)
       add_step_with_context(Procedures::Backup::Metadata, :online_backup => strategy == :online)
 
       case strategy
@@ -44,13 +44,11 @@ module ForemanMaintain::Scenarios
         Procedures::Backup::Pulp => :backup_dir,
         Procedures::Backup::Online::CandlepinDB => :backup_dir,
         Procedures::Backup::Online::ForemanDB => :backup_dir,
-        Procedures::Backup::Online::PulpcoreDB => :backup_dir,
-        Procedures::Backup::Offline::CandlepinDB => :backup_dir,
-        Procedures::Backup::Offline::ForemanDB => :backup_dir,
-        Procedures::Backup::Offline::PulpcoreDB => :backup_dir)
+        Procedures::Backup::Online::PulpcoreDB => :backup_dir)
       context.map(:preserve_dir,
         Procedures::Backup::PrepareDirectory => :preserve_dir)
       context.map(:incremental_dir,
+        Checks::Backup::IncrementalParentType => :incremental_dir,
         Procedures::Backup::PrepareDirectory => :incremental_dir,
         Procedures::Backup::Metadata => :incremental_dir)
       context.map(:proxy_features,
@@ -59,15 +57,13 @@ module ForemanMaintain::Scenarios
         Procedures::Backup::Pulp => :skip)
       context.map(:tar_volume_size,
         Procedures::Backup::Pulp => :tar_volume_size)
-      context.map(:include_db_dumps,
-        Procedures::Backup::Online::SafetyConfirmation => :include_db_dumps)
     end
     # rubocop:enable  Metrics/MethodLength
 
     private
 
     def safety_confirmation
-      if strategy == :online || include_db_dumps?
+      if strategy == :online
         add_step_with_context(Procedures::Backup::Online::SafetyConfirmation)
       end
     end
@@ -79,35 +75,30 @@ module ForemanMaintain::Scenarios
     end
 
     def add_offline_backup_steps
-      include_dumps if include_db_dumps?
       add_step_with_context(Procedures::ForemanProxy::Features, :load_only => true)
       add_steps_with_context(
         Procedures::Service::Stop,
         Procedures::Backup::ConfigFiles,
-        Procedures::Backup::Pulp,
-        Procedures::Backup::Offline::CandlepinDB,
-        Procedures::Backup::Offline::ForemanDB,
-        Procedures::Backup::Offline::PulpcoreDB,
-        Procedures::Service::Start
+        Procedures::Backup::Pulp
       )
-    end
 
-    def include_dumps
-      if feature(:instance).database_local?(:candlepin_database)
-        add_step_with_context(Procedures::Backup::Online::CandlepinDB)
-      end
-      if feature(:instance).database_local?(:foreman_database)
-        add_step_with_context(Procedures::Backup::Online::ForemanDB)
-      end
-      if feature(:instance).database_local?(:pulpcore_database)
-        add_step_with_context(Procedures::Backup::Online::PulpcoreDB)
+      if feature(:instance).postgresql_local?
+        add_step(Procedures::Service::Start.new(:only => ['postgresql']))
       end
+
+      add_database_backup_steps
+
+      add_steps_with_context(Procedures::Service::Start)
     end
 
     def add_online_backup_steps
       add_step_with_context(Procedures::Backup::ConfigFiles, :ignore_changed_files => true,
         :online_backup => true)
       add_step_with_context(Procedures::Backup::Pulp, :ensure_unchanged => true)
+      add_database_backup_steps
+    end
+
+    def add_database_backup_steps
       add_steps_with_context(
         Procedures::Backup::Online::CandlepinDB,
         Procedures::Backup::Online::ForemanDB,
@@ -118,10 +109,6 @@ module ForemanMaintain::Scenarios
     def strategy
       context.get(:strategy)
     end
-
-    def include_db_dumps?
-      !!context.get(:include_db_dumps)
-    end
   end
 
   class BackupRescueCleanup < ForemanMaintain::Scenario

data/definitions/scenarios/foreman_upgrade.rb

@@ -1,4 +1,4 @@
-module Scenarios::ForemanUpgrade
+module Scenarios::Foreman
   class Abstract < ForemanMaintain::Scenario
     def self.upgrade_metadata(&block)
       metadata do
@@ -38,6 +38,7 @@ module Scenarios::ForemanUpgrade
         Checks::CheckUpstreamRepository,
         Checks::Disk::AvailableSpace,
         Checks::Disk::AvailableSpaceCandlepin, # if candlepin
+        Checks::Disk::AvailableSpacePostgresql13,
         Checks::Foreman::ValidateExternalDbVersion, # if external database
         Checks::Foreman::CheckCorruptedRoles,
         Checks::Foreman::CheckDuplicatePermissions,
@@ -50,6 +51,7 @@ module Scenarios::ForemanUpgrade
         Checks::NonRhPackages,
         Checks::PackageManager::Dnf::ValidateDnfConfig,
         Checks::Repositories::CheckNonRhRepository,
+        Checks::CheckOrganizationContentAccessMode,
         Checks::Repositories::Validate
       )
     end

data/definitions/scenarios/restore.rb

@@ -14,7 +14,7 @@ module ForemanMaintain::Scenarios
     def compose
       backup = ForemanMaintain::Utils::Backup.new(context.get(:backup_dir))
 
-      add_steps(find_checks(:root_user))
+      add_step(Checks::RootUser)
       add_steps_with_context(Checks::Restore::ValidateBackup,
         Checks::Restore::ValidateHostname,
         Checks::Restore::ValidateInterfaces,

data/definitions/scenarios/satellite_upgrade.rb

@@ -23,14 +23,41 @@ module Scenarios::Satellite
       run_strategy :fail_slow
     end
 
+    # rubocop:disable Metrics/MethodLength
     def compose
-      add_steps(find_checks(:default))
-      add_steps(find_checks(:pre_upgrade))
-      add_step(Checks::CheckIpv6Disable)
-      add_step(Checks::Disk::AvailableSpacePostgresql13)
-      add_step(Checks::Repositories::Validate.new(:version => target_version))
-      add_step(Checks::CheckOrganizationContentAccessMode)
+      add_steps(
+        Checks::Foreman::FactsNames, # if Foreman database present
+        Checks::ForemanProxy::CheckTftpStorage, # if Satellite with foreman-proxy+tftp
+        Checks::ForemanProxy::VerifyDhcpConfigSyntax, # if foreman-proxy+dhcp-isc
+        Checks::ForemanTasks::NotPaused, # if foreman-tasks present
+        Checks::Puppet::VerifyNoEmptyCacertRequests, # if puppetserver
+        Checks::ServerPing,
+        Checks::ServicesUp,
+        Checks::SystemRegistration,
+        Checks::CheckHotfixInstalled,
+        Checks::CheckTmout,
+        Checks::CheckUpstreamRepository,
+        Checks::Disk::AvailableSpace,
+        Checks::Disk::AvailableSpaceCandlepin, # if candlepin
+        Checks::Foreman::ValidateExternalDbVersion, # if external database
+        Checks::Foreman::CheckCorruptedRoles,
+        Checks::Foreman::CheckDuplicatePermissions,
+        Checks::Foreman::TuningRequirements, # if katello present
+        Checks::ForemanOpenscap::InvalidReportAssociations, # if foreman-openscap
+        Checks::ForemanTasks::Invalid::CheckOld, # if foreman-tasks
+        Checks::ForemanTasks::Invalid::CheckPendingState, # if foreman-tasks
+        Checks::ForemanTasks::Invalid::CheckPlanningState, # if foreman-tasks
+        Checks::ForemanTasks::NotRunning, # if foreman-tasks
+        Checks::NonRhPackages,
+        Checks::PackageManager::Dnf::ValidateDnfConfig,
+        Checks::Repositories::CheckNonRhRepository,
+        Checks::CheckIpv6Disable,
+        Checks::Disk::AvailableSpacePostgresql13,
+        Checks::CheckOrganizationContentAccessMode,
+        Checks::Repositories::Validate.new(:version => target_version),
+      )
     end
+    # rubocop:enable Metrics/MethodLength
   end
 
   class PreMigrations < Abstract
@@ -40,7 +67,11 @@ module Scenarios::Satellite
     end
 
     def compose
-      add_steps(find_procedures(:pre_migrations))
+      add_steps(
+        Procedures::MaintenanceMode::EnableMaintenanceMode,
+        Procedures::Crond::Stop,
+        Procedures::SyncPlans::Disable,
+      )
     end
   end
 
@@ -63,12 +94,14 @@ module Scenarios::Satellite
         modules_to_enable = ["#{feature(:instance).downstream.module_name}:#{el_short_name}"]
         add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
       end
-      add_step(Procedures::Packages::Update.new(
-        :assumeyes => true,
-        :download_only => true
-      ))
-      add_step(Procedures::Service::Stop.new)
-      add_step(Procedures::Packages::Update.new(:assumeyes => true, :clean_cache => false))
+      add_steps(
+        Procedures::Packages::Update.new(
+          :assumeyes => true,
+          :download_only => true
+        ),
+        Procedures::Service::Stop,
+        Procedures::Packages::Update.new(:assumeyes => true, :clean_cache => false),
+      )
       add_step_with_context(Procedures::Installer::Run)
       add_step(Procedures::Installer::UpgradeRakeTask)
     end
@@ -81,9 +114,13 @@ module Scenarios::Satellite
     end
 
     def compose
-      add_step(Procedures::RefreshFeatures)
-      add_step(Procedures::Service::Start.new)
-      add_steps(find_procedures(:post_migrations))
+      add_steps(
+        Procedures::RefreshFeatures,
+        Procedures::Service::Start,
+        Procedures::Crond::Start,
+        Procedures::SyncPlans::Enable,
+        Procedures::MaintenanceMode::DisableMaintenanceMode,
+      )
     end
   end
 
@@ -95,11 +132,19 @@ module Scenarios::Satellite
     end
 
     def compose
-      add_steps(find_checks(:default))
-      add_steps(find_checks(:post_upgrade))
-      add_step(Procedures::Packages::CheckForReboot)
-      add_step(Procedures::Pulpcore::ContainerHandleImageMetadata)
-      add_step(Procedures::Repositories::IndexKatelloRepositoriesContainerMetatdata)
+      add_steps(
+        Checks::Foreman::FactsNames, # if Foreman database present
+        Checks::ForemanProxy::CheckTftpStorage, # if Satellite with foreman-proxy+tftp
+        Checks::ForemanProxy::VerifyDhcpConfigSyntax, # if foreman-proxy+dhcp-isc
+        Checks::ForemanTasks::NotPaused, # if foreman-tasks present
+        Checks::Puppet::VerifyNoEmptyCacertRequests, # if puppetserver
+        Checks::ServerPing,
+        Checks::ServicesUp,
+        Checks::SystemRegistration,
+        Procedures::Packages::CheckForReboot,
+        Procedures::Pulpcore::ContainerHandleImageMetadata,
+        Procedures::Repositories::IndexKatelloRepositoriesContainerMetatdata,
+      )
     end
   end
 end

data/definitions/scenarios/services.rb

@@ -8,7 +8,7 @@ module ForemanMaintain::Scenarios
     end
 
     def compose
-      add_steps(find_checks(:root_user))
+      add_step(Checks::RootUser)
       add_steps_with_context(Procedures::Service::Restart)
     end
 
@@ -33,7 +33,7 @@ module ForemanMaintain::Scenarios
     end
 
     def compose
-      add_steps(find_checks(:root_user))
+      add_step(Checks::RootUser)
       add_steps_with_context(Procedures::Service::Stop)
     end
 
@@ -55,7 +55,7 @@ module ForemanMaintain::Scenarios
     end
 
     def compose
-      add_steps(find_checks(:root_user))
+      add_step(Checks::RootUser)
       add_steps_with_context(Procedures::Service::Start)
     end
 
@@ -98,7 +98,7 @@ module ForemanMaintain::Scenarios
     end
 
     def compose
-      add_steps(find_checks(:root_user))
+      add_step(Checks::RootUser)
       add_steps_with_context(Procedures::Service::Enable)
     end
 
@@ -120,7 +120,7 @@ module ForemanMaintain::Scenarios
     end
 
     def compose
-      add_steps(find_checks(:root_user))
+      add_step(Checks::RootUser)
       add_steps_with_context(Procedures::Service::Disable)
     end
 

data/lib/foreman_maintain/cli/backup_command.rb

@@ -119,11 +119,9 @@ module ForemanMaintain
       include BackupCommon
       interactive_option
       common_backup_options
-      option '--include-db-dumps', :flag, 'Also dump full database schema before offline backup'
 
       def execute
-        perform_backup(:offline,
-          :include_db_dumps => include_db_dumps?)
+        perform_backup(:offline)
       end
     end
 

data/lib/foreman_maintain/cli/upgrade_command.rb

@@ -30,7 +30,7 @@ module ForemanMaintain
                           else
                             '--target-version not specified'
                           end
-          message = <<-MESSAGE.strip_heredoc
+          message = <<~MESSAGE
             #{message_start}
             Possible target versions are:
           MESSAGE

data/lib/foreman_maintain/concerns/base_database.rb

@@ -42,7 +42,7 @@ module ForemanMaintain
       end
 
       def local?(config = configuration)
-        ['localhost', '127.0.0.1', `hostname`.strip].include? config['host']
+        ['localhost', '127.0.0.1', `hostname`.strip].include?(config['host'])
       end
 
       def query(sql, config = configuration)

data/lib/foreman_maintain/concerns/finders.rb

@@ -13,10 +13,6 @@ module ForemanMaintain
         ensure_one_object(:check, label)
       end
 
-      def find_checks(conditions)
-        detector.available_checks(conditions)
-      end
-
       def procedure(label)
         ensure_one_object(:procedure, label)
       end

data/lib/foreman_maintain/config.rb

@@ -25,6 +25,11 @@ module ForemanMaintain
       @foreman_port = @options.fetch(:foreman_port, 443)
     end
 
+    def use_color?
+      ENV['TERM'] && ENV.fetch('NO_COLOR', '') == '' && \
+        system('command -v tput', out: File.open('/dev/null')) && `tput colors`.to_i > 0
+    end
+
     private
 
     def load_log_configs

data/lib/foreman_maintain/core_ext.rb

@@ -1,17 +1,5 @@
 module ForemanMaintain
   module CoreExt
-    module StripHeredoc
-      def strip_heredoc
-        indent = 0
-        indented_lines = scan(/^[ \t]+(?=\S)/)
-        unless indented_lines.empty?
-          indent = indented_lines.min.size
-        end
-        gsub(/^[ \t]{#{indent}}/, '')
-      end
-    end
-    String.include StripHeredoc
-
     module ValidateOptions
       def validate_options!(*valid_keys)
         valid_keys.flatten!

data/lib/foreman_maintain/detector.rb

@@ -24,6 +24,7 @@ module ForemanMaintain
       @all_features_scanned = false
       @available_checks = nil
       @available_scenarios = nil
+      @available_procedures = nil
       @scenarios ||= Scenario.all_sub_classes.select(&:autodetect?)
     end
 

data/lib/foreman_maintain/reporter/cli_reporter.rb

@@ -301,17 +301,17 @@ module ForemanMaintain
         return if scenario.passed? && !scenario.warning?
 
         message = []
-        message << <<-MESSAGE.strip_heredoc
+        message << <<~MESSAGE
           Scenario [#{scenario.description}] failed.
         MESSAGE
         recommend = []
 
         steps_with_abort = scenario.steps_with_abort(:whitelisted => false)
         unless steps_with_abort.empty?
-          message << format(<<-MESSAGE.strip_heredoc, format_steps(steps_with_abort, "\n", 2))
-          The processing was aborted by user during the following steps:
+          message << format(<<~MESSAGE, format_steps(steps_with_abort, "\n", 2))
+            The processing was aborted by user during the following steps:
 
-          %s
+            %s
           MESSAGE
         end
 
@@ -323,28 +323,28 @@ module ForemanMaintain
 
         steps_to_whitelist = steps_with_error + steps_with_skipped - not_skippable_steps
         unless steps_with_error.empty?
-          message << format(<<-MESSAGE.strip_heredoc, format_steps(steps_with_error, "\n", 2))
-          The following steps ended up in failing state:
+          message << format(<<~MESSAGE, format_steps(steps_with_error, "\n", 2))
+            The following steps ended up in failing state:
 
-          %s
+            %s
           MESSAGE
           whitelist_labels = steps_to_whitelist.map(&:label_dashed).join(',')
           unless whitelist_labels.empty?
             recommend << if scenario.detector.feature(:instance).downstream
-                           format(<<-MESSAGE.strip_heredoc)
-              Resolve the failed steps and rerun the command.
+                           format(<<~MESSAGE)
+                             Resolve the failed steps and rerun the command.
 
-              If the situation persists and, you are unclear what to do next,
-              contact #{scenario.detector.feature(:instance).project_support_entity}.
+                             If the situation persists and, you are unclear what to do next,
+                             contact #{scenario.detector.feature(:instance).project_support_entity}.
 
-              In case the failures are false positives, use
-              --whitelist="#{whitelist_labels}"
+                             In case the failures are false positives, use
+                             --whitelist="#{whitelist_labels}"
                            MESSAGE
                          else
-                           format(<<-MESSAGE.strip_heredoc)
-              Resolve the failed steps and rerun the command.
-              In case the failures are false positives, use
-              --whitelist="#{whitelist_labels}"
+                           format(<<~MESSAGE)
+                             Resolve the failed steps and rerun the command.
+                             In case the failures are false positives, use
+                             --whitelist="#{whitelist_labels}"
                            MESSAGE
                          end
           end
@@ -352,15 +352,15 @@ module ForemanMaintain
 
         steps_with_warning = scenario.steps_with_warning(:whitelisted => false)
         unless steps_with_warning.empty?
-          message << format(<<-MESSAGE.strip_heredoc, format_steps(steps_with_warning, "\n", 2))
-          The following steps ended up in warning state:
+          message << format(<<~MESSAGE, format_steps(steps_with_warning, "\n", 2))
+            The following steps ended up in warning state:
 
-          %s
+            %s
           MESSAGE
 
-          recommend << <<-MESSAGE.strip_heredoc
-          The steps in warning state itself might not mean there is an error,
-          but it should be reviewed to ensure the behavior is expected
+          recommend << <<~MESSAGE
+            The steps in warning state itself might not mean there is an error,
+            but it should be reviewed to ensure the behavior is expected
           MESSAGE
         end
         puts((message + recommend).join("\n"))

data/lib/foreman_maintain/reporter.rb

@@ -67,7 +67,7 @@ module ForemanMaintain
       end
 
       until_valid_decision do
-        filter_decision(ask("#{message}, [#{actions_msg}]"))
+        filter_decision(ask("#{message}\n[#{actions_msg}]"))
       end
     end
     # rubocop:enable Metrics/LineLength

data/lib/foreman_maintain/update_runner.rb

@@ -133,10 +133,10 @@ module ForemanMaintain
       decision = super(scenario)
       # we have not asked the user already about next steps
       if decision.nil? && @ask_to_confirm_update
-        response = reporter.ask_decision(<<-MESSAGE.strip_heredoc.strip)
-            The pre-update checks indicate that the system is ready for update.
-            It's recommended to perform a backup at this stage.
-            Confirm to continue with the modification part of the update
+        response = reporter.ask_decision(<<~MESSAGE.strip)
+          The pre-update checks indicate that the system is ready for update.
+          It's recommended to perform a backup at this stage.
+          Confirm to continue with the modification part of the update
         MESSAGE
         if [:no, :quit].include?(response)
           ask_to_quit

data/lib/foreman_maintain/upgrade_runner.rb

@@ -94,7 +94,7 @@ module ForemanMaintain
     def finish_upgrade
       @finished = true
       @reporter.hline
-      @reporter.puts <<-MESSAGE.strip_heredoc
+      @reporter.puts <<~MESSAGE
         Upgrade finished.
       MESSAGE
     end
@@ -136,7 +136,7 @@ module ForemanMaintain
     def skip_phase(skipped_phase)
       with_non_empty_scenario(skipped_phase) do |scenario|
         @reporter.before_scenario_starts(scenario)
-        @reporter.puts <<-MESSAGE.strip_heredoc
+        @reporter.puts <<~MESSAGE
           Skipping #{skipped_phase} phase as it was already run before.
           To enforce to run the phase, use `upgrade run --phase #{skipped_phase}`
         MESSAGE
@@ -164,7 +164,7 @@ module ForemanMaintain
         end
       end
       self.phase = :pre_upgrade_checks # rollback finished
-      @reporter.puts <<-MESSAGE.strip_heredoc
+      @reporter.puts <<~MESSAGE
         The upgrade failed and system was restored to pre-upgrade state.
       MESSAGE
     end
@@ -199,10 +199,10 @@ module ForemanMaintain
       decision = super(scenario)
       # we have not asked the user already about next steps
       if decision.nil? && @ask_to_confirm_upgrade
-        response = reporter.ask_decision(<<-MESSAGE.strip_heredoc.strip)
-            The pre-upgrade checks indicate that the system is ready for upgrade.
-            It's recommended to perform a backup at this stage.
-            Confirm to continue with the modification part of the upgrade
+        response = reporter.ask_decision(<<~MESSAGE.strip)
+          The pre-upgrade checks indicate that the system is ready for upgrade.
+          It's recommended to perform a backup at this stage.
+          Confirm to continue with the modification part of the upgrade
         MESSAGE
         if [:no, :quit].include?(response)
           ask_to_quit

data/lib/foreman_maintain/utils/backup.rb

@@ -11,6 +11,9 @@ module ForemanMaintain
         :foreman_online_files, :foreman_offline_files, :fpc_offline_files,
         :fpc_online_files
 
+      ONLINE_BACKUP = 'online'.freeze
+      OFFLINE_BACKUP = 'offline'.freeze
+
       def initialize(backup_dir)
         # fpc stands for foreman proxy w/ content
         @backup_dir = backup_dir
@@ -260,6 +263,10 @@ module ForemanMaintain
       def different_source_os?
         source_os_version != "#{os_name} #{os_version}"
       end
+
+      def backup_type
+        online_backup? ? ONLINE_BACKUP : OFFLINE_BACKUP
+      end
     end
   end
 end

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

@@ -50,11 +50,7 @@ module ForemanMaintain::Utils
       end
 
       def exist?
-        if @sys.systemd_installed?
-          ['enabled', 'disabled'].include?(service_enabled_status)
-        else
-          File.exist?("/etc/init.d/#{@name}")
-        end
+        ['enabled', 'disabled'].include?(service_enabled_status)
       end
 
       def enabled?

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '1.6.11'.freeze
+  VERSION = '1.6.13'.freeze
 end

data/lib/foreman_maintain.rb

@@ -1,7 +1,3 @@
-if RUBY_VERSION <= '1.8.7'
-  require 'rubygems'
-end
-
 require 'forwardable'
 require 'json'
 require 'logger'
@@ -68,6 +64,7 @@ module ForemanMaintain
 
       # using a queue, we can log the messages which are generated before initializing logger
       self.config = Config.new(options)
+      configure_highline
       load_definitions
       init_logger
       update_path
@@ -102,6 +99,10 @@ module ForemanMaintain
       end
     end
 
+    def configure_highline
+      HighLine.use_color = config.use_color?
+    end
+
     def cache
       ObjectCache.instance
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 1.6.11
+  version: 1.6.13
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-26 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -158,6 +158,7 @@ files:
 - config/foreman_maintain.yml.packaging
 - config/hammer.yml.example
 - definitions/checks/backup/certs_tar_exist.rb
+- definitions/checks/backup/incremental_parent_type.rb
 - definitions/checks/candlepin/db_up.rb
 - definitions/checks/check_hotfix_installed.rb
 - definitions/checks/check_ipv6_disable.rb
@@ -234,9 +235,6 @@ files:
 - definitions/procedures/backup/compress_data.rb
 - definitions/procedures/backup/config_files.rb
 - definitions/procedures/backup/metadata.rb
-- definitions/procedures/backup/offline/candlepin_db.rb
-- definitions/procedures/backup/offline/foreman_db.rb
-- definitions/procedures/backup/offline/pulpcore_db.rb
 - definitions/procedures/backup/online/candlepin_db.rb
 - definitions/procedures/backup/online/foreman_db.rb
 - definitions/procedures/backup/online/pulpcore_db.rb
@@ -275,7 +273,6 @@ files:
 - definitions/procedures/packages/update.rb
 - definitions/procedures/packages/update_all_confirmation.rb
 - definitions/procedures/pulpcore/container_handle_image_metadata.rb
-- definitions/procedures/pulpcore/trim_rpm_changelogs.rb
 - definitions/procedures/puppet/delete_empty_ca_cert_request_files.rb
 - definitions/procedures/puppet/remove_puppet.rb
 - definitions/procedures/puppet/remove_puppet_data.rb

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

@@ -1,53 +0,0 @@
-module Procedures::Backup
-  module Offline
-    class CandlepinDB < ForemanMaintain::Procedure
-      metadata do
-        description 'Backup Candlepin DB offline'
-        tags :backup
-        label :backup_offline_candlepin_db
-        for_feature :candlepin_database
-        preparation_steps { Checks::Candlepin::DBUp.new unless feature(:candlepin_database).local? }
-        param :backup_dir, 'Directory where to backup to', :required => true
-        param :tar_volume_size, 'Size of tar volume (indicates splitting)'
-      end
-
-      def run
-        if feature(:candlepin_database).local?
-          if File.exist?(pg_backup_file)
-            puts 'Already done'
-          else
-            local_backup
-          end
-        else
-          puts "Backup of #{pg_data_dir} is not supported for remote databases." \
-            ' Doing postgres dump instead...'
-          with_spinner('Getting Candlepin DB dump') do
-            feature(:candlepin_database).dump_db(File.join(@backup_dir, 'candlepin.dump'))
-          end
-        end
-      end
-
-      private
-
-      def local_backup
-        with_spinner("Collecting data from #{pg_data_dir}") do
-          feature(:candlepin_database).backup_local(
-            pg_backup_file,
-            :listed_incremental => File.join(@backup_dir, '.postgres.snar'),
-            :volume_size => @tar_volume_size,
-            :data_dir => pg_data_dir,
-            :restore_dir => feature(:candlepin_database).data_dir
-          )
-        end
-      end
-
-      def pg_backup_file
-        File.join(@backup_dir, 'pgsql_data.tar')
-      end
-
-      def pg_data_dir
-        feature(:candlepin_database).data_dir
-      end
-    end
-  end
-end

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

@@ -1,73 +0,0 @@
-module Procedures::Backup
-  module Offline
-    class ForemanDB < ForemanMaintain::Procedure
-      metadata do
-        description 'Backup Foreman DB offline'
-        tags :backup
-        label :backup_offline_foreman_db
-        for_feature :foreman_database
-        preparation_steps { Checks::Foreman::DBUp.new unless feature(:foreman_database).local? }
-        param :backup_dir, 'Directory where to backup to', :required => true
-        param :tar_volume_size, 'Size of tar volume (indicates splitting)'
-      end
-
-      def run
-        if feature(:foreman_database).local?
-          if File.exist?(pg_backup_file)
-            puts 'Already done'
-          else
-            local_backup
-          end
-        else
-          puts "Backup of #{pg_data_dirs.join(',')} is not supported for remote databases." \
-            ' Doing postgres dump instead...'
-          with_spinner('Getting Foreman DB dump') do
-            feature(:foreman_database).dump_db(File.join(@backup_dir, 'foreman.dump'))
-          end
-        end
-      end
-
-      private
-
-      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')
-          end
-        end
-      end
-
-      def do_backup(pg_dir, cmd)
-        restore_dir = el? ? feature(:foreman_database).data_dir : pg_dir
-        feature(:foreman_database).backup_local(
-          pg_backup_file,
-          :listed_incremental => File.join(@backup_dir, '.postgres.snar'),
-          :volume_size => @tar_volume_size,
-          :data_dir => pg_dir,
-          :restore_dir => restore_dir,
-          :command => cmd
-        )
-      end
-
-      def pg_backup_file
-        File.join(@backup_dir, 'pgsql_data.tar')
-      end
-
-      def pg_data_dirs
-        el? ? [pg_data_dir_el] : pg_data_dirs_deb
-      end
-
-      def pg_data_dirs_deb
-        # The Debian based OSes support multiple installations of Postgresql
-        # There could be situations where Foreman db is either of these versions
-        # To be sure we backup the system correctly without missing anything
-        # we backup all of the Postgresql dirs
-        feature(:foreman_database).data_dir
-      end
-
-      def pg_data_dir_el
-        feature(:foreman_database).data_dir
-      end
-    end
-  end
-end

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

@@ -1,53 +0,0 @@
-module Procedures::Backup
-  module Offline
-    class PulpcoreDB < ForemanMaintain::Procedure
-      metadata do
-        description 'Backup Pulpcore DB offline'
-        tags :backup
-        label :backup_offline_pulpcore_db
-        for_feature :pulpcore_database
-        preparation_steps { Checks::Pulpcore::DBUp.new unless feature(:pulpcore_database).local? }
-        param :backup_dir, 'Directory where to backup to', :required => true
-        param :tar_volume_size, 'Size of tar volume (indicates splitting)'
-      end
-
-      def run
-        if feature(:pulpcore_database).local?
-          if File.exist?(pg_backup_file)
-            puts 'Already done'
-          else
-            local_backup
-          end
-        else
-          puts "Backup of #{pg_data_dir} is not supported for remote databases." \
-            ' Doing postgres dump instead...'
-          with_spinner('Getting Pulpcore DB dump') do
-            feature(:pulpcore_database).dump_db(File.join(@backup_dir, 'pulpcore.dump'))
-          end
-        end
-      end
-
-      private
-
-      def local_backup
-        with_spinner("Collecting data from #{pg_data_dir}") do
-          feature(:pulpcore_database).backup_local(
-            pg_backup_file,
-            :listed_incremental => File.join(@backup_dir, '.postgres.snar'),
-            :volume_size => @tar_volume_size,
-            :data_dir => pg_data_dir,
-            :restore_dir => feature(:pulpcore_database).data_dir
-          )
-        end
-      end
-
-      def pg_backup_file
-        File.join(@backup_dir, 'pgsql_data.tar')
-      end
-
-      def pg_data_dir
-        feature(:pulpcore_database).data_dir
-      end
-    end
-  end
-end

data/definitions/procedures/pulpcore/trim_rpm_changelogs.rb

@@ -1,22 +0,0 @@
-module Procedures::Pulpcore
-  class TrimRpmChangelogs < ForemanMaintain::Procedure
-    include ForemanMaintain::Concerns::SystemService
-    include ForemanMaintain::Concerns::PulpCommon
-
-    metadata do
-      description 'Trim RPM changelogs in the pulpcore db'
-      for_feature :pulpcore
-    end
-
-    def run
-      with_spinner('Trimming RPM changelogs in the pulpcore db') do |spinner|
-        necessary_services = feature(:pulpcore_database).services
-
-        feature(:service).handle_services(spinner, 'start', :only => necessary_services)
-
-        spinner.update('Trimming RPM changelogs')
-        execute!(pulpcore_manager('rpm-trim-changelogs'))
-      end
-    end
-  end
-end