foreman_maintain 0.1.6 → 0.2.0

data/lib/foreman_maintain/executable.rb

@@ -4,8 +4,8 @@ module ForemanMaintain
     extend Concerns::Finders
     attr_reader :options
     def_delegators :execution,
-                   :success?, :skipped?, :fail?, :warning?, :output,
-                   :assumeyes?, :whitelisted?,
+                   :success?, :skipped?, :fail?, :aborted?, :warning?, :output,
+                   :assumeyes?, :whitelisted?, :ask_decision,
                    :execution, :puts, :print, :with_spinner, :ask, :storage
 
     def initialize(options = {})
@@ -72,15 +72,34 @@ module ForemanMaintain
       raise Error::Warn, message
     end
 
+    def skip(message = '')
+      raise Error::Skip, message
+    end
+
+    def abort!(message = '')
+      raise Error::Abort, message
+    end
+
     # rubocop:disable Naming/AccessorMethodName
     def set_fail(message)
-      execution.status = :fail
-      execution.output << message
+      set_status(:fail, message)
     end
 
     def set_warn(message)
-      execution.status = :warning
-      execution.output << message
+      set_status(:warning, message)
+    end
+
+    def set_skip(message)
+      set_status(:skipped, message)
+    end
+
+    def set_abort(message)
+      set_status(:abort, message)
+    end
+
+    def set_status(status, message)
+      execution.status = status
+      execution.output << message if message && !message.empty?
     end
     # rubocop:enable Naming/AccessorMethodName
 
@@ -119,6 +138,10 @@ module ForemanMaintain
       unless skipped?
         run
       end
+    rescue Error::Skip => e
+      set_skip(e.message)
+    rescue Error::Abort => e
+      set_abort(e.message)
     end
 
     # method defined both on object and class to ensure we work always with object

data/lib/foreman_maintain/feature.rb

@@ -1,6 +1,7 @@
 module ForemanMaintain
   class Feature
     include Concerns::Logger
+    include Concerns::Reporter
     include Concerns::SystemHelpers
     include Concerns::Metadata
     include Concerns::Finders
@@ -14,10 +15,24 @@ module ForemanMaintain
       "#{self.class.metadata[:label]}<#{self.class.name}>"
     end
 
+    # Override method with hash of applicable services for feature.
+    # Services have a number for priority in order to ensure
+    # they are started and stopped in the correct order.
+    # example:
+    # { :foo_service => 10, :bar_service => 20 }
+    def services
+      {}
+    end
+
     # Override to generate additional feature instances that can't be
     # autodetected directly
     def additional_features
       []
     end
+
+    # list of config files the feature uses
+    def config_files
+      []
+    end
   end
 end

data/lib/foreman_maintain/param.rb

@@ -3,7 +3,7 @@ module ForemanMaintain
     attr_reader :name, :description, :options
 
     def initialize(name, description, options, &block)
-      options.validate_options!(:description, :required, :flag, :array, :allowed_values)
+      options.validate_options!(:description, :required, :flag, :array, :allowed_values, :default)
       @name = name
       @description = description || options[:description] || ''
       @options = options
@@ -12,6 +12,7 @@ module ForemanMaintain
       @block = block
       @allowed_values = @options.fetch(:allowed_values, [])
       @array = @options.fetch(:array, false)
+      @default = @options.fetch(:default, nil)
     end
 
     def flag?
@@ -26,8 +27,9 @@ module ForemanMaintain
       @array
     end
 
-    # rubocop:disable Metrics/PerceivedComplexity,Metrics/CyclomaticComplexity
     def process(value)
+      # default values imply we can not pass nil if there is non-nil default
+      value = @default if value.nil?
       value = process_array(value) if array?
       value = @block.call(value) if @block
       if value.nil? && required?
@@ -38,7 +40,6 @@ module ForemanMaintain
       validate_with_allowed_values(value)
       value
     end
-    # rubocop:enable Metrics/PerceivedComplexity,Metrics/CyclomaticComplexity
 
     def process_array(value)
       if value.is_a?(Array)

data/lib/foreman_maintain/reporter.rb

@@ -58,6 +58,10 @@ module ForemanMaintain
       end
     end
 
+    def assumeyes=(assume)
+      @assumeyes = !!assume
+    end
+
     private
 
     def single_step_decision(step)
@@ -85,7 +89,7 @@ module ForemanMaintain
       decision
     end
 
-    # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def ask_to_select(message, steps)
       if assumeyes?
         puts('(assuming first option)')
@@ -105,7 +109,7 @@ module ForemanMaintain
         end
       end
     end
-    # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
     # loop over the block until it returns some non-false value
     def until_valid_decision

data/lib/foreman_maintain/reporter/cli_reporter.rb

@@ -4,6 +4,7 @@ require 'highline'
 module ForemanMaintain
   class Reporter
     class CLIReporter < Reporter
+      include Concerns::Logger
       # Simple spinner able to keep updating current line
       class Spinner
         def initialize(reporter, interval = 0.1)
@@ -81,11 +82,13 @@ module ForemanMaintain
       end
 
       def before_scenario_starts(scenario)
+        logger.info("=== Scenario '#{scenario.description || scenario.class}' started ===")
         puts "Running #{scenario.description || scenario.class}"
         hline('=')
       end
 
       def before_execution_starts(execution)
+        logger.info("--- Execution step '#{execution.name}' started ---")
         puts(execution_info(execution, ''))
       end
 
@@ -141,19 +144,16 @@ module ForemanMaintain
       def after_execution_finishes(execution)
         puts_status(execution.status)
         puts(execution.output) unless execution.output.empty?
-        if execution.status == :already_run
-          puts(<<-MESSAGE.strip_heredoc)
-            The step was skipped as it was already run and it is marked
-            as run_once. Use --force to enforce the execution.
-          MESSAGE
-        end
+        puts(already_run_msg) if execution.status == :already_run
         hline
         new_line_if_needed
+        logger.info("--- Execution step '#{execution.name}' finished ---")
       end
 
       def after_scenario_finishes(scenario)
         scenario_failure_message(scenario)
         puts "\n"
+        logger.info("=== Scenario '#{scenario.description || scenario.class}' finished ===")
       end
 
       def clear_line
@@ -181,13 +181,13 @@ module ForemanMaintain
         ask_to_select('Select step to continue', steps, &:runtime_message)
       end
 
-      def ask_decision(message)
+      def ask_decision(message, options = 'y(yes), n(no), q(quit)')
         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}, [#{options}]"))
         end
       ensure
         clear_line
@@ -202,7 +202,7 @@ module ForemanMaintain
         decision
       end
 
-      # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
       def ask_to_select(message, steps)
         if assumeyes?
           puts('(assuming first option)')
@@ -224,7 +224,7 @@ module ForemanMaintain
       ensure
         clear_line
       end
-      # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
 
       # loop over the block until it returns some non-false value
       def until_valid_decision
@@ -252,6 +252,7 @@ module ForemanMaintain
       def status_label(status)
         mapping = { :success => { :label => '[OK]', :color => :green },
                     :fail => { :label => '[FAIL]', :color => :red },
+                    :abort => { :label => '[ABORTED]', :color => :red },
                     :running => { :label => '[RUNNING]', :color => :blue },
                     :skipped => { :label => '[SKIPPED]', :color => :yellow },
                     :already_run => { :label => '[ALREADY RUN]', :color => :yellow },
@@ -278,6 +279,16 @@ module ForemanMaintain
           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:
+
+          %s
+          MESSAGE
+        end
+
         steps_with_error = scenario.steps_with_error(:whitelisted => false)
         unless steps_with_error.empty?
           message << format(<<-MESSAGE.strip_heredoc, format_steps(steps_with_error, "\n", 2))
@@ -313,6 +324,11 @@ module ForemanMaintain
       def format_steps(steps, join_with = ', ', indent = 0)
         steps.map { |s| "#{' ' * indent}[#{s.label_dashed}]" }.join(join_with)
       end
+
+      def already_run_msg
+        'The step was skipped as it was already run and it is marked' \
+        ' as run_once. Use --force to enforce the execution.'
+      end
     end
   end
 end

data/lib/foreman_maintain/runner.rb

@@ -1,15 +1,17 @@
 module ForemanMaintain
   # Class responsible for running the scenario
   class Runner
+    include Concerns::Logger
     attr_reader :reporter, :exit_code
 
     require 'foreman_maintain/runner/execution'
     require 'foreman_maintain/runner/stored_execution'
     def initialize(reporter, scenarios, options = {})
-      options.validate_options!(:assumeyes, :whitelist, :force)
+      options.validate_options!(:assumeyes, :whitelist, :force, :rescue_scenario)
       @assumeyes = options.fetch(:assumeyes, false)
       @whitelist = options.fetch(:whitelist, [])
       @force = options.fetch(:force, false)
+      @rescue_scenario = options.fetch(:rescue_scenario, nil)
       @reporter = reporter
       @scenarios = Array(scenarios)
       @quit = false
@@ -28,11 +30,15 @@ module ForemanMaintain
     def run
       @scenarios.each do |scenario|
         run_scenario(scenario)
-        break if @quit
+        next unless @quit
+        if @rescue_scenario
+          logger.debug('=== Rescue scenario found. Executing ===')
+          execute_scenario_steps(@rescue_scenario, true)
+        end
+        break
       end
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def run_scenario(scenario, confirm = true)
       return if scenario.steps.empty?
       raise 'The runner is already in quit state' if quit?
@@ -47,7 +53,6 @@ module ForemanMaintain
       @last_scenario = scenario unless scenario.steps.empty?
       @exit_code = 1 if scenario.failed?
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     def whitelisted_step?(step)
       @whitelist.include?(step.label_dashed.to_s)
@@ -55,7 +60,8 @@ module ForemanMaintain
 
     def confirm_scenario(scenario)
       return unless @last_scenario
-      decision = if @last_scenario.steps_with_error(:whitelisted => false).any?
+      decision = if @last_scenario.steps_with_error(:whitelisted => false).any? ||
+                    @last_scenario.steps_with_abort(:whitelisted => false).any?
                    :quit
                  elsif @last_scenario.steps_with_warning(:whitelisted => false).any?
                    reporter.ask_decision("Continue with [#{scenario.description}]")
@@ -84,9 +90,10 @@ module ForemanMaintain
 
     private
 
-    def execute_scenario_steps(scenario)
+    def execute_scenario_steps(scenario, force = false)
       scenario.before_scenarios.flatten.each { |before_scenario| run_scenario(before_scenario) }
-      return if quit? # the before scenarios caused the stop of the execution
+      confirm_scenario(scenario)
+      return if !force && quit? # the before scenarios caused the stop of the execution
       @reporter.before_scenario_starts(scenario)
       run_steps(scenario, scenario.steps)
       @reporter.after_scenario_finishes(scenario)
@@ -94,9 +101,9 @@ module ForemanMaintain
 
     def run_steps(scenario, steps)
       @steps_to_run = ForemanMaintain::DependencyGraph.sort(steps)
-      while !@quit && !@steps_to_run.empty?
+      while (scenario.run_strategy == :fail_slow || !@quit) && !@steps_to_run.empty?
         execution = run_step(@steps_to_run.shift)
-        post_step_decisions(scenario, execution)
+        post_step_decisions(scenario, execution) unless execution.success?
       end
     end
 
@@ -114,15 +121,19 @@ module ForemanMaintain
 
     def post_step_decisions(scenario, execution)
       step = execution.step
-      next_steps_decision = ask_about_offered_steps(step)
-      if next_steps_decision != :yes &&
-         execution.fail? && !execution.whitelisted? &&
-         scenario.run_strategy == :fail_fast
+      if execution.aborted?
         ask_to_quit
+      else
+        next_steps_decision = ask_about_offered_steps(step)
+        if next_steps_decision != :yes &&
+           execution.fail? && !execution.whitelisted? &&
+           scenario.run_strategy == :fail_fast
+          ask_to_quit
+        end
       end
     end
 
-    # rubocop:disable  Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # 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'
@@ -143,7 +154,7 @@ module ForemanMaintain
         end
       end
     end
-    # rubocop:enable  Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:enable  Metrics/MethodLength
 
     def rerun_check?(step)
       @last_decision_step == step

data/lib/foreman_maintain/runner/execution.rb

@@ -4,7 +4,7 @@ module ForemanMaintain
     class Execution
       include Concerns::Logger
       extend Forwardable
-      def_delegators :reporter, :with_spinner, :puts, :print, :ask, :assumeyes?
+      def_delegators :reporter, :with_spinner, :puts, :print, :ask, :assumeyes?, :ask_decision
 
       # Step performed as part of the execution
       attr_reader :step
@@ -47,6 +47,10 @@ module ForemanMaintain
         @status == :fail
       end
 
+      def aborted?
+        @status == :abort
+      end
+
       def skipped?
         @status == :skipped
       end

data/lib/foreman_maintain/scenario.rb

@@ -108,6 +108,10 @@ module ForemanMaintain
       filter_whitelisted(executed_steps.find_all(&:fail?), options)
     end
 
+    def steps_with_abort(options = {})
+      filter_whitelisted(executed_steps.find_all(&:aborted?), options)
+    end
+
     def steps_with_warning(options = {})
       filter_whitelisted(executed_steps.find_all(&:warning?), options)
     end
@@ -124,7 +128,9 @@ module ForemanMaintain
     end
 
     def passed?
-      (steps_with_error(:whitelisted => false) + steps_with_warning(:whitelisted => false)).empty?
+      (steps_with_abort(:whitelisted => false) +
+        steps_with_error(:whitelisted => false) +
+        steps_with_warning(:whitelisted => false)).empty?
     end
 
     def failed?
@@ -149,8 +155,10 @@ module ForemanMaintain
       add_steps([step]) unless step.nil?
     end
 
-    def add_step_with_context(definition)
-      add_step(definition.send(:new, context.params_for(definition))) if definition.present?
+    def add_step_with_context(definition, extra_params = {})
+      if definition.present?
+        add_step(definition.send(:new, context.params_for(definition).merge(extra_params)))
+      end
     end
 
     def add_steps_with_context(*definitions)

data/lib/foreman_maintain/upgrade_runner.rb

@@ -155,7 +155,6 @@ module ForemanMaintain
 
     private
 
-    # rubocop:disable Metrics/AbcSize
     def rollback_pre_migrations
       raise "Unexpected phase #{phase}, expecting pre_migrations" unless phase == :pre_migrations
       rollback_needed = scenario(:pre_migrations).steps.any? { |s| s.executed? && s.success? }
@@ -175,7 +174,6 @@ module ForemanMaintain
         The upgrade failed and system was restored to pre-upgrade state.
       MESSAGE
     end
-    # rubocop:enable Metrics/AbcSize
 
     def with_non_empty_scenario(phase)
       next_scenario = scenario(phase)