foreman_maintain 0.6.16 → 0.7.0

data/lib/foreman_maintain/concerns/downstream.rb

@@ -54,6 +54,10 @@ module ForemanMaintain
         raise NotImplementedError
       end
 
+      def fm_pkg_and_cmd_name
+        %w[satellite-maintain satellite-maintain]
+      end
+
       private
 
       def rh_repos(server_version)

data/lib/foreman_maintain/reporter.rb

@@ -22,12 +22,13 @@ module ForemanMaintain
 
     def after_scenario_finishes(_scenario); end
 
-    def on_next_steps(steps)
+    def on_next_steps(steps, run_strategy = :fail_fast)
       return if steps.empty?
+
       if steps.size > 1
-        multiple_steps_decision(steps)
+        multiple_steps_decision(steps, run_strategy)
       else
-        single_step_decision(steps.first)
+        single_step_decision(steps.first, run_strategy)
       end
     end
 
@@ -46,17 +47,19 @@ module ForemanMaintain
     end
 
     # simple yes/no question, returns :yes, :no or :quit
-    def ask_decision(message, options = {})
-      options.validate_options!(:assumeyes)
-      assumeyes = options.fetch(:assumeyes, assumeyes?)
+    # rubocop:disable Metrics/LineLength
+    def ask_decision(message, actions_msg: 'y(yes), n(no), q(quit)', assumeyes: assumeyes?, run_strategy: :fail_fast)
+      actions_msg = 'y(yes), n(no)' if run_strategy == :fail_slow
       if assumeyes
         print("#{message} (assuming yes)")
         return :yes
       end
+
       until_valid_decision do
-        filter_decision(ask("#{message}, [y(yes), n(no), q(quit)]"))
+        filter_decision(ask("#{message}, [#{actions_msg}]"))
       end
     end
+    # rubocop:enable Metrics/LineLength
 
     def assumeyes=(assume)
       @assumeyes = !!assume
@@ -64,8 +67,8 @@ module ForemanMaintain
 
     private
 
-    def single_step_decision(step)
-      answer = ask_decision("Continue with step [#{step.description}]?")
+    def single_step_decision(step, run_strategy)
+      answer = ask_decision("Continue with step [#{step.description}]?", run_strategy: run_strategy)
       if answer == :yes
         step
       else
@@ -73,12 +76,12 @@ module ForemanMaintain
       end
     end
 
-    def multiple_steps_decision(steps)
+    def multiple_steps_decision(steps, run_strategy)
       puts 'There are multiple steps to proceed:'
       steps.each_with_index do |step, index|
         puts "#{index + 1}) #{step.description}"
       end
-      ask_to_select('Select step to continue', steps, &:description)
+      ask_to_select('Select step to continue', steps, run_strategy)
     end
 
     def filter_decision(answer)
@@ -90,13 +93,15 @@ module ForemanMaintain
     end
 
     # rubocop:disable Metrics/MethodLength
-    def ask_to_select(message, steps)
+    def ask_to_select(message, steps, run_strategy)
       if assumeyes?
         puts('(assuming first option)')
         return steps.first
       end
       until_valid_decision do
-        answer = ask("#{message}, [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]
         else

data/lib/foreman_maintain/reporter/cli_reporter.rb

@@ -167,8 +167,9 @@ module ForemanMaintain
         @assumeyes
       end
 
-      def single_step_decision(step)
-        answer = ask_decision("Continue with step [#{step.runtime_message}]?")
+      def single_step_decision(step, run_strategy)
+        answer = ask_decision("Continue with step [#{step.runtime_message}]?",
+                              run_strategy: run_strategy)
         if answer == :yes
           step
         else
@@ -176,25 +177,28 @@ module ForemanMaintain
         end
       end
 
-      def multiple_steps_decision(steps)
+      def multiple_steps_decision(steps, run_strategy)
         puts 'There are multiple steps to proceed:'
         steps.each_with_index do |step, index|
           puts "#{index + 1}) #{step.runtime_message}"
         end
-        ask_to_select('Select step to continue', steps, &:runtime_message)
+        ask_to_select('Select step to continue', steps, run_strategy)
       end
 
-      def ask_decision(message, options = 'y(yes), n(no), q(quit)', ignore_assumeyes: false)
+      # rubocop:disable Metrics/LineLength
+      def ask_decision(message, actions_msg: 'y(yes), n(no), q(quit)', ignore_assumeyes: false, run_strategy: :fail_fast)
+        actions_msg = 'y(yes), n(no)' if run_strategy == :fail_slow
         if !ignore_assumeyes && assumeyes?
           print("#{message} (assuming yes)\n")
           return :yes
         end
         until_valid_decision do
-          filter_decision(ask("#{message}, [#{options}]"))
+          filter_decision(ask("#{message}, [#{actions_msg}]"))
         end
       ensure
         clear_line
       end
+      # rubocop:enable Metrics/LineLength
 
       def filter_decision(answer)
         decision = nil
@@ -206,13 +210,15 @@ module ForemanMaintain
       end
 
       # rubocop:disable Metrics/MethodLength
-      def ask_to_select(message, steps)
+      def ask_to_select(message, steps, run_strategy)
         if assumeyes?
           puts('(assuming first option)')
           return steps.first
         end
+
         until_valid_decision do
-          answer = ask("#{message}, [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]
           else
@@ -277,6 +283,7 @@ module ForemanMaintain
       # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       def scenario_failure_message(scenario)
         return if scenario.passed? && !scenario.warning?
+
         message = []
         message << <<-MESSAGE.strip_heredoc
           Scenario [#{scenario.description}] failed.
@@ -293,13 +300,15 @@ module ForemanMaintain
         end
 
         steps_with_error = scenario.steps_with_error(:whitelisted => false)
+        steps_with_skipped = scenario.steps_with_skipped(:whitelisted => true)
+        steps_to_whitelist = steps_with_error + steps_with_skipped
         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:
 
           %s
           MESSAGE
-          whitelist_labels = steps_with_error.map(&:label_dashed).join(',')
+          whitelist_labels = steps_to_whitelist.map(&:label_dashed).join(',')
           recommend << format(<<-MESSAGE.strip_heredoc, whitelist_labels)
           Resolve the failed steps and rerun
           the command. In case the failures are false positives,

data/lib/foreman_maintain/runner.rb

@@ -70,7 +70,8 @@ module ForemanMaintain
                    :quit
                  elsif @last_scenario.steps_with_warning(:whitelisted => false).any?
                    @last_scenario_continuation_confirmed = true
-                   reporter.ask_decision("Continue with [#{scenario.description}]")
+                   reporter.ask_decision("Continue with [#{scenario.description}]",
+                                         run_strategy: scenario.run_strategy)
                  end
 
       ask_to_quit if [:quit, :no].include?(decision)
@@ -131,7 +132,7 @@ module ForemanMaintain
       if execution.aborted?
         ask_to_quit
       else
-        next_steps_decision = ask_about_offered_steps(step)
+        next_steps_decision = ask_about_offered_steps(step, scenario)
         if next_steps_decision != :yes &&
            execution.fail? && !execution.whitelisted? &&
            scenario.run_strategy == :fail_fast
@@ -141,7 +142,7 @@ module ForemanMaintain
     end
 
     # rubocop:disable  Metrics/MethodLength
-    def ask_about_offered_steps(step)
+    def ask_about_offered_steps(step, scenario)
       if assumeyes? && rerun_check?(step)
         @reporter.puts 'Check still failing after attempt to fix. Skipping'
         return :no
@@ -149,7 +150,8 @@ module ForemanMaintain
       if step.next_steps && !step.next_steps.empty?
         @last_decision_step = step
         steps = step.next_steps.map(&:ensure_instance)
-        decision = @reporter.on_next_steps(steps)
+
+        decision = @reporter.on_next_steps(steps, scenario.run_strategy)
         case decision
         when :quit
           ask_to_quit

data/lib/foreman_maintain/scenario.rb

@@ -116,6 +116,10 @@ module ForemanMaintain
       filter_whitelisted(executed_steps.find_all(&:warning?), options)
     end
 
+    def steps_with_skipped(options = {})
+      filter_whitelisted(executed_steps.find_all(&:skipped?), options)
+    end
+
     def filter_whitelisted(steps, options)
       options.validate_options!(:whitelisted)
       if options.key?(:whitelisted)

data/lib/foreman_maintain/utils/disk/io_device.rb

@@ -22,10 +22,6 @@ module ForemanMaintain
           convert_kb_to_mb(execute!("df #{dir}|awk {'print $4'}|tail -1").to_i)
         end
 
-        def space_used_in_percent
-          execute!("df #{dir}|awk {'print $5'}|tail -1").to_i
-        end
-
         private
 
         # In fio command, --direct option bypass the cache page

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

@@ -1,17 +1,16 @@
 module ForemanMaintain::Utils
   module Service
     class Systemd < Abstract
-      attr_reader :instance_parent_unit
       def initialize(name, priority, options = {})
         super
         @sys = SystemHelpers.new
-        @instance_parent_unit = options.fetch(:instance_parent_unit, nil)
       end
 
       def command(action, options = {})
         do_wait = options.fetch(:wait, true) # wait for service to start
         all = @options.fetch(:all, false)
         skip_enablement = @options.fetch(:skip_enablement, false)
+
         if skip_enablement && %w[enable disable].include?(action)
           return skip_enablement_message(action, @name)
         end
@@ -51,19 +50,29 @@ module ForemanMaintain::Utils
 
       def exist?
         if @sys.systemd_installed?
-          systemd = @sys.execute("systemctl is-enabled #{@name} 2>&1 | tail -1").strip
+          systemd = service_enabled_status
           systemd == 'enabled' || systemd == 'disabled'
         else
           File.exist?("/etc/init.d/#{@name}")
         end
       end
 
+      def enabled?
+        if @sys.systemd_installed?
+          service_enabled_status == 'enabled'
+        end
+      end
+
       private
 
       def execute(action, options = {})
         @sys.execute_with_status(command(action, options))
       end
 
+      def service_enabled_status
+        @sys.execute("systemctl is-enabled #{@name} 2>&1 | tail -1").strip
+      end
+
       def skip_enablement_message(action, name)
         # Enable and disable does not work well with globs since they treat them literally.
         # We are skipping the pulpcore-workers@* for these actions until they are configured in

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.6.16'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.6.16
+  version: 0.7.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -125,7 +125,6 @@ files:
 - definitions/checks/check_hotfix_installed.rb
 - definitions/checks/check_tmout.rb
 - definitions/checks/disk/available_space.rb
-- definitions/checks/disk/available_space_candlepin.rb
 - definitions/checks/disk/performance.rb
 - definitions/checks/env_proxy.rb
 - definitions/checks/foreman/check_checkpoint_segments.rb
@@ -148,6 +147,7 @@ files:
 - definitions/checks/mongo/db_up.rb
 - definitions/checks/mongo/tools_installed.rb
 - definitions/checks/original_assets.rb
+- definitions/checks/package_manager/yum/validate_yum_config.rb
 - definitions/checks/pulpcore/db_up.rb
 - definitions/checks/puppet/provide_upgrade_guide.rb
 - definitions/checks/puppet/verify_no_empty_cacert_requests.rb
@@ -162,7 +162,6 @@ files:
 - definitions/checks/services_up.rb
 - definitions/checks/system_registration.rb
 - definitions/checks/version_locking_enabled.rb
-- definitions/checks/yum_exclude.rb
 - definitions/features/apache.rb
 - definitions/features/candlepin.rb
 - definitions/features/candlepin_database.rb
@@ -221,7 +220,9 @@ files:
 - definitions/procedures/backup/snapshot/mount_pulpcore_db.rb
 - definitions/procedures/backup/snapshot/prepare_mount.rb
 - definitions/procedures/candlepin/delete_orphaned_records_from_env_content.rb
+- definitions/procedures/content/migration_stats.rb
 - definitions/procedures/content/prepare.rb
+- definitions/procedures/content/prepare_abort.rb
 - definitions/procedures/content/switchover.rb
 - definitions/procedures/crond/start.rb
 - definitions/procedures/crond/stop.rb
@@ -254,6 +255,7 @@ files:
 - definitions/procedures/packages/update.rb
 - definitions/procedures/packages/update_all_confirmation.rb
 - definitions/procedures/passenger_recycler.rb
+- definitions/procedures/prep_6_10_upgrade.rb
 - definitions/procedures/pulp/migrate.rb
 - definitions/procedures/pulpcore/migrate.rb
 - definitions/procedures/puppet/delete_empty_ca_cert_request_files.rb
@@ -289,10 +291,13 @@ files:
 - definitions/scenarios/content.rb
 - definitions/scenarios/maintenance_mode.rb
 - definitions/scenarios/packages.rb
+- definitions/scenarios/prep_6_10_upgrade.rb
 - definitions/scenarios/restore.rb
 - definitions/scenarios/services.rb
 - definitions/scenarios/upgrade_to_capsule_6_8.rb
 - definitions/scenarios/upgrade_to_capsule_6_8_z.rb
+- definitions/scenarios/upgrade_to_capsule_6_9.rb
+- definitions/scenarios/upgrade_to_capsule_6_9_z.rb
 - definitions/scenarios/upgrade_to_satellite_6_2.rb
 - definitions/scenarios/upgrade_to_satellite_6_2_z.rb
 - definitions/scenarios/upgrade_to_satellite_6_3.rb
@@ -307,6 +312,8 @@ files:
 - definitions/scenarios/upgrade_to_satellite_6_7_z.rb
 - definitions/scenarios/upgrade_to_satellite_6_8.rb
 - definitions/scenarios/upgrade_to_satellite_6_8_z.rb
+- definitions/scenarios/upgrade_to_satellite_6_9.rb
+- definitions/scenarios/upgrade_to_satellite_6_9_z.rb
 - extras/foreman-maintain.sh
 - extras/foreman_protector/foreman-protector.conf
 - extras/foreman_protector/foreman-protector.py
@@ -339,7 +346,6 @@ files:
 - lib/foreman_maintain/concerns/hammer.rb
 - lib/foreman_maintain/concerns/logger.rb
 - lib/foreman_maintain/concerns/metadata.rb
-- lib/foreman_maintain/concerns/primary_checks.rb
 - lib/foreman_maintain/concerns/reporter.rb
 - lib/foreman_maintain/concerns/scenario_metadata.rb
 - lib/foreman_maintain/concerns/system_helpers.rb

data/definitions/checks/disk/available_space_candlepin.rb

@@ -1,27 +0,0 @@
-module Checks
-  module Disk
-    class AvailableSpaceCandlepin < ForemanMaintain::Check
-      metadata do
-        label :available_space_cp
-        description 'Check to make sure /var/lib/candlepin has enough space'
-        tags :pre_upgrade
-        confine do
-          feature(:candlepin) && check_min_version('candlepin', '3.1')
-        end
-      end
-
-      MAX_USAGE_IN_PERCENT = 90
-
-      def run
-        assert(enough_space?, "System has more than #{MAX_USAGE_IN_PERCENT}% space used"\
-               " on #{feature(:candlepin).work_dir}.\n"\
-               'See https://bugzilla.redhat.com/show_bug.cgi?id=1898605')
-      end
-
-      def enough_space?
-        io_obj = ForemanMaintain::Utils::Disk::IODevice.new(feature(:candlepin).work_dir)
-        io_obj.space_used_in_percent < MAX_USAGE_IN_PERCENT
-      end
-    end
-  end
-end

data/definitions/checks/yum_exclude.rb

@@ -1,21 +0,0 @@
-class Checks::YumExclude < ForemanMaintain::Check
-  metadata do
-    label :check_yum_exclude_list
-    description 'Check if yum exclude list is configured'
-    tags :pre_upgrade
-  end
-
-  EXCLUDE_SET_RE = /^exclude\s*=\s*\S+.*$/
-
-  def run
-    grep_result = grep_yum_exclude
-    assert(!grep_result.match(EXCLUDE_SET_RE),
-           'The /etc/yum.conf has exclude list configured as below,'\
-          "\n  #{grep_result}"\
-          "\nUnset this as it can cause yum update or upgrade failures !")
-  end
-
-  def grep_yum_exclude
-    execute_with_status('grep -w exclude /etc/yum.conf')[1]
-  end
-end

data/lib/foreman_maintain/concerns/primary_checks.rb

@@ -1,23 +0,0 @@
-module ForemanMaintain
-  module Concerns
-    module PrimaryChecks
-      def validate_downstream_packages
-        return unless detector.feature(:installer) && detector.feature(:installer).with_scenarios?
-        if (package = package_name) && !package_manager.installed?(package)
-          raise ForemanMaintain::Error::Fail,
-                "Error: Important rpm package #{package} is not installed!"\
-                "\nInstall #{package} rpm to ensure system consistency."
-        end
-      end
-
-      def package_name
-        installed_scenario = detector.feature(:installer).last_scenario
-        if installed_scenario == 'satellite'
-          'satellite'
-        elsif installed_scenario == 'capsule'
-          'satellite-capsule'
-        end
-      end
-    end
-  end
-end