foreman_maintain 0.6.13 → 0.7.4

data/definitions/scenarios/upgrade_to_satellite_6_9_z.rb

@@ -0,0 +1,89 @@
+module Scenarios::Satellite_6_9_z
+  class Abstract < ForemanMaintain::Scenario
+    def self.upgrade_metadata(&block)
+      metadata do
+        tags :upgrade_scenario
+        confine do
+          feature(:satellite) &&
+            (feature(:satellite).current_minor_version == '6.9' || \
+            ForemanMaintain.upgrade_in_progress == '6.9.z')
+        end
+        instance_eval(&block)
+      end
+    end
+
+    def target_version
+      '6.9.z'
+    end
+  end
+
+  class PreUpgradeCheck < Abstract
+    upgrade_metadata do
+      description 'Checks before upgrading to Satellite 6.9.z'
+      tags :pre_upgrade_checks
+      run_strategy :fail_slow
+    end
+
+    def compose
+      add_steps(find_checks(:default))
+      add_steps(find_checks(:pre_upgrade))
+      add_step(Checks::Repositories::Validate.new(:version => '6.9'))
+    end
+  end
+
+  class PreMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures before migrating to Satellite 6.9.z'
+      tags :pre_migrations
+    end
+
+    def compose
+      add_steps(find_procedures(:pre_migrations))
+      add_step(Procedures::Service::Stop.new)
+    end
+  end
+
+  class Migrations < Abstract
+    upgrade_metadata do
+      description 'Migration scripts to Satellite 6.9.z'
+      tags :migrations
+    end
+
+    def set_context_mapping
+      context.map(:assumeyes, Procedures::Installer::Upgrade => :assumeyes)
+    end
+
+    def compose
+      add_step(Procedures::Repositories::Setup.new(:version => '6.9'))
+      add_step(Procedures::Packages::UnlockVersions.new)
+      add_step(Procedures::Packages::Update.new(:assumeyes => true))
+      add_step_with_context(Procedures::Installer::Upgrade)
+      add_step(Procedures::Installer::UpgradeRakeTask)
+    end
+  end
+
+  class PostMigrations < Abstract
+    upgrade_metadata do
+      description 'Procedures after migrating to Satellite 6.9.z'
+      tags :post_migrations
+    end
+
+    def compose
+      add_step(Procedures::Service::Start.new)
+      add_steps(find_procedures(:post_migrations))
+    end
+  end
+
+  class PostUpgradeChecks < Abstract
+    upgrade_metadata do
+      description 'Checks after upgrading to Satellite 6.9.z'
+      tags :post_upgrade_checks
+      run_strategy :fail_slow
+    end
+
+    def compose
+      add_steps(find_checks(:default))
+      add_steps(find_checks(:post_upgrade))
+    end
+  end
+end

data/lib/foreman_maintain.rb

@@ -21,6 +21,7 @@ module ForemanMaintain
   require 'foreman_maintain/concerns/base_database'
   require 'foreman_maintain/concerns/directory_marker'
   require 'foreman_maintain/concerns/downstream'
+  require 'foreman_maintain/concerns/primary_checks'
   require 'foreman_maintain/top_level_modules'
   require 'foreman_maintain/yaml_storage'
   require 'foreman_maintain/config'
@@ -41,6 +42,7 @@ module ForemanMaintain
   require 'foreman_maintain/error'
 
   class << self
+    include ForemanMaintain::Concerns::PrimaryChecks
     attr_accessor :config, :logger
 
     LOGGER_LEVEL_MAPPING = {
@@ -153,7 +155,7 @@ module ForemanMaintain
     def pkg_and_cmd_name
       instance_feature = ForemanMaintain.available_features(:label => :instance).first
       if instance_feature.downstream
-        return %w[satellite-maintain satellite-maintain]
+        return instance_feature.downstream.fm_pkg_and_cmd_name
       end
 
       [main_package_name, 'foreman-maintain']

data/lib/foreman_maintain/cli.rb

@@ -27,6 +27,14 @@ module ForemanMaintain
       subcommand 'content', 'Content related commands', ContentCommand
       subcommand 'maintenance-mode', 'Control maintenance-mode for application',
                  MaintenanceModeCommand
+      if ForemanMaintain.detector.feature(:satellite) &&
+         ForemanMaintain.detector.feature(:satellite).current_minor_version == '6.9'
+        subcommand 'prep-6.10-upgrade', 'Preparations for the Satellite 6.10 upgrade' do
+          def execute
+            run_scenarios_and_exit(Scenarios::Prep610Upgrade.new)
+          end
+        end
+      end
 
       def run(*arguments)
         logger.info("Running foreman-maintain command with arguments #{arguments.inspect}")

data/lib/foreman_maintain/cli/content_command.rb

@@ -7,9 +7,24 @@ module ForemanMaintain
         end
       end
 
-      subcommand 'switchover', 'Switch support for certain content from Pulp 2 to Pulp 3' do
+      unless ForemanMaintain.detector.feature(:satellite) ||
+             ForemanMaintain.detector.feature(:capsule)
+        subcommand 'switchover', 'Switch support for certain content from Pulp 2 to Pulp 3' do
+          def execute
+            run_scenarios_and_exit(Scenarios::Content::Switchover.new)
+          end
+        end
+      end
+
+      subcommand 'prepare-abort', 'Abort all running Pulp 2 to Pulp 3 migration tasks' do
+        def execute
+          run_scenarios_and_exit(Scenarios::Content::PrepareAbort.new)
+        end
+      end
+
+      subcommand 'migration-stats', 'Retrieve Pulp 2 to Pulp 3 migration statistics' do
         def execute
-          run_scenarios_and_exit(Scenarios::Content::Switchover.new)
+          run_scenarios_and_exit(Scenarios::Content::MigrationStats.new)
         end
       end
     end

data/lib/foreman_maintain/cli/upgrade_command.rb

@@ -67,6 +67,7 @@ module ForemanMaintain
         disable_self_upgrade_option
 
         def execute
+          ForemanMaintain.validate_downstream_packages
           ForemanMaintain.perform_self_upgrade unless disable_self_upgrade?
           upgrade_runner.run_phase(:pre_upgrade_checks)
           exit upgrade_runner.exit_code
@@ -86,6 +87,7 @@ module ForemanMaintain
         end
 
         def execute
+          ForemanMaintain.validate_downstream_packages
           ForemanMaintain.perform_self_upgrade unless disable_self_upgrade?
           if phase
             upgrade_runner.run_phase(phase.to_sym)

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/concerns/primary_checks.rb

@@ -0,0 +1,23 @@
+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

data/lib/foreman_maintain/package_manager/dnf.rb

@@ -8,6 +8,7 @@ module ForemanMaintain::PackageManager
     private
 
     def dnf_action(action, packages, with_status: false, assumeyes: false)
+      packages = [packages].flatten(1)
       yum_options = []
       yum_options << '-y' if assumeyes
       if with_status

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

@@ -67,6 +67,7 @@ module ForemanMaintain
         end
       end
 
+      attr_accessor :select_option_counter
       attr_reader :last_line, :max_length
 
       def initialize(stdout = STDOUT, stdin = STDIN, options = {})
@@ -81,6 +82,7 @@ module ForemanMaintain
         @spinner = Spinner.new(self)
         @spinner.start_spinner if @stdout.tty?
         @last_line = ''
+        @select_option_counter = 0
       end
 
       def before_scenario_starts(scenario)
@@ -167,8 +169,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 +179,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 +212,17 @@ 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
+          step = steps[@select_option_counter]
+          @select_option_counter += 1
+          puts("(assuming option #{@select_option_counter})")
+          return step
         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 +287,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 +304,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

@@ -18,6 +18,7 @@ module ForemanMaintain
       @last_scenario = nil
       @last_scenario_continuation_confirmed = false
       @exit_code = 0
+      @procedure_step_counter = 0
     end
 
     def quit?
@@ -70,7 +71,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 +133,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,15 +143,18 @@ module ForemanMaintain
     end
 
     # rubocop:disable  Metrics/MethodLength
-    def ask_about_offered_steps(step)
-      if assumeyes? && rerun_check?(step)
-        @reporter.puts 'Check still failing after attempt to fix. Skipping'
-        return :no
-      end
+    def ask_about_offered_steps(step, scenario)
       if step.next_steps && !step.next_steps.empty?
         @last_decision_step = step
+        @procedure_step_counter += 1
         steps = step.next_steps.map(&:ensure_instance)
-        decision = @reporter.on_next_steps(steps)
+        if assumeyes? && @procedure_step_counter > steps.length
+          @procedure_step_counter = 0
+          @reporter.select_option_counter = 0
+          @reporter.puts 'Check still failing after attempt to fix. Skipping'
+          return :no
+        end
+        decision = @reporter.on_next_steps(steps, scenario.run_strategy)
         case decision
         when :quit
           ask_to_quit