foreman_maintain 0.0.6 → 0.0.7

data/lib/foreman_maintain/upgrade_runner.rb

@@ -0,0 +1,194 @@
+module ForemanMaintain
+  class UpgradeRunner < Runner
+    include Concerns::Finders
+
+    # Phases of the upgrade, see README.md for more info
+    PHASES = [:pre_upgrade_checks,
+              :pre_migrations,
+              :migrations,
+              :post_migrations,
+              :post_upgrade_checks].freeze
+
+    class << self
+      include Concerns::Finders
+
+      def available_targets
+        versions_to_tags.inject([]) do |available_targets, (version, tag)|
+          if !find_scenarios(:tags => [tag]).empty?
+            available_targets << version
+          else
+            available_targets
+          end
+        end
+      end
+
+      def versions_to_tags
+        @versions_to_tags ||= {}
+      end
+
+      # registers target version to specific tag
+      def register_version(version, tag)
+        if versions_to_tags.key?(version) && versions_to_tags[version] != tag
+          raise "Version #{version} already registered to tag #{versions_to_tags[version]}"
+        end
+        @versions_to_tags[version] = tag
+      end
+
+      def clear_register
+        versions_to_tags.lear
+      end
+    end
+
+    attr_reader :version, :tag, :phase
+
+    def initialize(version, reporter, options = {})
+      super(reporter, [], options)
+      @tag = self.class.versions_to_tags[version]
+      raise "Unknown version #{version}" unless tag
+      @version = version
+      @scenario_cache = {}
+      self.phase = :pre_upgrade_checks
+    end
+
+    def scenario(phase)
+      return @scenario_cache[phase] if @scenario_cache.key?(phase)
+      condition = { :tags => [tag, phase] }
+      matching_scenarios = find_scenarios(condition)
+      raise "Too many scenarios match #{condition.inspect}" if matching_scenarios.size > 1
+      @scenario_cache[phase] = matching_scenarios.first
+    end
+
+    def run
+      PHASES.each do |phase|
+        return run_rollback if quit?
+        if skip?(phase)
+          skip_phase(phase)
+        else
+          run_phase(phase)
+        end
+      end
+    end
+
+    def run_rollback
+      # we only are able to rollback from pre_migrations phase
+      if phase == :pre_migrations
+        rollback_pre_migrations
+      end
+    end
+
+    def storage
+      ForemanMaintain.storage("upgrade_#{version}")
+    end
+
+    # serializes the state of the run to storage
+    def save
+      storage[:serialized] = to_hash
+      storage.save
+    end
+
+    # deserializes the state of the run from the storage
+    def load
+      return unless storage[:serialized]
+      load_from_hash(storage[:serialized])
+    end
+
+    def run_phase(phase)
+      with_non_empty_scenario(phase) do |scenario|
+        confirm_scenario(scenario)
+        return if quit?
+        self.phase = phase
+        run_scenario(scenario, false)
+        # if we started from the :pre_upgrade_checks, ensure to ask before
+        # continuing with the rest of the upgrade
+        @ask_to_confirm_upgrade = phase == :pre_upgrade_checks
+      end
+    end
+
+    def skip_phase(skipped_phase)
+      with_non_empty_scenario(skipped_phase) do |scenario|
+        @reporter.before_scenario_starts(scenario)
+        @reporter.puts <<-MESSAGE.strip_heredoc
+          Skipping #{skipped_phase} phase as it was already run before.
+          To enforce to run the phase, use `upgrade advanced run --phase #{phase}`
+        MESSAGE
+        @reporter.after_scenario_finishes(scenario)
+      end
+    end
+
+    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? }
+      if rollback_needed
+        @quit = false
+        @last_scenario = nil # to prevent the unnecessary confirmation questions
+        [:post_migrations, :post_upgrade_checks].each do |phase|
+          if quit? && phase == :post_upgrade_checks
+            self.phase = :pre_migrations
+            return # rubocop:disable Lint/NonLocalExitFromIterator
+          end
+          run_phase(phase)
+        end
+      end
+      self.phase = :pre_upgrade_checks # rollback finished
+      @reporter.puts <<-MESSAGE.strip_heredoc
+        The upgrade failed and system was restored to pre-upgrade state.
+      MESSAGE
+    end
+
+    def with_non_empty_scenario(phase)
+      next_scenario = scenario(phase)
+      unless next_scenario.nil? || next_scenario.steps.empty?
+        yield next_scenario
+      end
+    end
+
+    def to_hash
+      ret = { :phase => phase, :scenarios => {} }
+      @scenario_cache.each do |key, scenario|
+        ret[:scenarios][key] = scenario.to_hash
+      end
+      ret
+    end
+
+    def load_from_hash(hash)
+      unless @scenario_cache.empty?
+        raise "Some scenarios are already initialized: #{@scenario_cache.keys}"
+      end
+      self.phase = hash[:phase]
+      hash[:scenarios].each do |key, scenario_hash|
+        @scenario_cache[key] = Scenario.new_from_hash(scenario_hash)
+      end
+    end
+
+    def confirm_scenario(scenario)
+      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 the modification part of the upgrade
+        MESSAGE
+        if [:no, :quit].include?(response)
+          ask_to_quit
+        end
+      end
+      response
+    ensure
+      @ask_to_confirm_upgrade = false
+    end
+
+    def skip?(next_phase)
+      # the next_phase was run before the current phase
+      PHASES.index(next_phase) < PHASES.index(phase)
+    end
+
+    def phase=(phase)
+      raise "Unknown phase #{phase}" unless PHASES.include?(phase)
+      @phase = phase
+    end
+  end
+end

data/lib/foreman_maintain/utils.rb

@@ -1,3 +1,4 @@
 require 'foreman_maintain/utils/command_runner'
 require 'foreman_maintain/utils/disk'
 require 'foreman_maintain/utils/hammer'
+require 'foreman_maintain/utils/curl_response'

data/lib/foreman_maintain/utils/curl_response.rb

@@ -0,0 +1,21 @@
+module ForemanMaintain
+  module Utils
+    class CurlResponse
+      attr_reader :result, :http_code, :error_msg
+
+      def initialize(response, http_code, http_error_msg)
+        @result = response || ''
+        @http_code = http_code
+        @error_msg = generate_error_msg(http_error_msg)
+      end
+
+      private
+
+      def generate_error_msg(msg_string)
+        <<-EOF
+        \n#{msg_string} #{http_code}. Response: #{result.inspect}
+        EOF
+      end
+    end
+  end
+end

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -110,18 +110,18 @@ files:
 - config/foreman_maintain.yml.example
 - config/foreman_maintain.yml.packaging
 - definitions/checks/disk_speed_minimal.rb
+- definitions/checks/foreman_proxy/verify_dhcp_config_syntax.rb
 - definitions/checks/foreman_tasks/invalid/check_old.rb
 - definitions/checks/foreman_tasks/invalid/check_pending_state.rb
 - definitions/checks/foreman_tasks/invalid/check_planning_state.rb
 - definitions/checks/foreman_tasks/not_paused.rb
 - definitions/checks/foreman_tasks/not_running.rb
-- definitions/checks/sync_plans/with_disabled_status.rb
-- definitions/checks/sync_plans/with_enabled_status.rb
 - definitions/checks/system_registration.rb
 - definitions/features/downstream.rb
 - definitions/features/foreman_1_11_x.rb
 - definitions/features/foreman_1_7_x.rb
 - definitions/features/foreman_database.rb
+- definitions/features/foreman_proxy.rb
 - definitions/features/foreman_tasks.rb
 - definitions/features/sync_plans.rb
 - definitions/features/upstream.rb
@@ -129,45 +129,55 @@ files:
 - definitions/procedures/foreman_tasks/resume.rb
 - definitions/procedures/foreman_tasks/ui_investigate.rb
 - definitions/procedures/hammer_setup.rb
-- definitions/procedures/install_package.rb
+- definitions/procedures/installer/upgrade.rb
+- definitions/procedures/maintenance_mode/disable.rb
+- definitions/procedures/maintenance_mode/enable.rb
+- definitions/procedures/packages/install.rb
+- definitions/procedures/packages/update.rb
+- definitions/procedures/repositories/setup.rb
 - definitions/procedures/sync_plans/disable.rb
 - definitions/procedures/sync_plans/enable.rb
-- definitions/scenarios/pre_upgrade_check_foreman_1_14.rb
-- definitions/scenarios/pre_upgrade_check_satellite_6_0_z.rb
-- definitions/scenarios/pre_upgrade_check_satellite_6_1.rb
-- definitions/scenarios/pre_upgrade_check_satellite_6_1_z.rb
-- definitions/scenarios/pre_upgrade_check_satellite_6_2.rb
-- definitions/scenarios/pre_upgrade_check_satellite_6_2_z.rb
-- definitions/scenarios/pre_upgrade_check_satellite_6_3.rb
+- definitions/scenarios/upgrade_to_satellite_6_2.rb
 - lib/foreman_maintain.rb
 - lib/foreman_maintain/check.rb
 - lib/foreman_maintain/cli.rb
+- lib/foreman_maintain/cli/advanced/procedure/abstract_by_tag_command.rb
+- lib/foreman_maintain/cli/advanced/procedure/abstract_procedure_command.rb
+- lib/foreman_maintain/cli/advanced/procedure/by_tag_command.rb
+- lib/foreman_maintain/cli/advanced/procedure/run_command.rb
+- lib/foreman_maintain/cli/advanced/procedure_command.rb
+- lib/foreman_maintain/cli/advanced_command.rb
 - lib/foreman_maintain/cli/base.rb
 - lib/foreman_maintain/cli/health_command.rb
+- lib/foreman_maintain/cli/transform_clamp_options.rb
 - lib/foreman_maintain/cli/upgrade_command.rb
 - lib/foreman_maintain/concerns/finders.rb
 - lib/foreman_maintain/concerns/hammer.rb
 - lib/foreman_maintain/concerns/logger.rb
 - lib/foreman_maintain/concerns/metadata.rb
+- lib/foreman_maintain/concerns/scenario_metadata.rb
 - lib/foreman_maintain/concerns/system_helpers.rb
 - lib/foreman_maintain/config.rb
 - lib/foreman_maintain/core_ext.rb
+- lib/foreman_maintain/csv_parser.rb
 - lib/foreman_maintain/dependency_graph.rb
 - lib/foreman_maintain/detector.rb
 - lib/foreman_maintain/error.rb
 - lib/foreman_maintain/executable.rb
 - lib/foreman_maintain/feature.rb
-- lib/foreman_maintain/object_cache.rb
 - lib/foreman_maintain/param.rb
 - lib/foreman_maintain/procedure.rb
 - lib/foreman_maintain/reporter.rb
 - lib/foreman_maintain/reporter/cli_reporter.rb
 - lib/foreman_maintain/runner.rb
 - lib/foreman_maintain/runner/execution.rb
+- lib/foreman_maintain/runner/stored_execution.rb
 - lib/foreman_maintain/scenario.rb
 - lib/foreman_maintain/top_level_modules.rb
+- lib/foreman_maintain/upgrade_runner.rb
 - lib/foreman_maintain/utils.rb
 - lib/foreman_maintain/utils/command_runner.rb
+- lib/foreman_maintain/utils/curl_response.rb
 - lib/foreman_maintain/utils/disk.rb
 - lib/foreman_maintain/utils/disk/device.rb
 - lib/foreman_maintain/utils/disk/io.rb
@@ -197,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Foreman maintenance tool belt

data/definitions/checks/sync_plans/with_disabled_status.rb

@@ -1,18 +0,0 @@
-module Checks::SyncPlans
-  class WithDisabledStatus < ForemanMaintain::Check
-    include ForemanMaintain::Concerns::Hammer
-
-    metadata do
-      for_feature :sync_plans
-      description 'check for disabled sync plans'
-      tags :post_upgrade
-    end
-
-    def run
-      disabled_plans_count = feature(:sync_plans).disabled_plans_count
-      assert(disabled_plans_count == 0,
-             "There are #{disabled_plans_count} disabled sync plans which needs to be enabled",
-             :next_steps => Procedures::SyncPlans::Enable.new)
-    end
-  end
-end

data/definitions/checks/sync_plans/with_enabled_status.rb

@@ -1,19 +0,0 @@
-module Checks::SyncPlans
-  class WithEnabledStatus < ForemanMaintain::Check
-    include ForemanMaintain::Concerns::Hammer
-
-    metadata do
-      for_feature :sync_plans
-      description 'check for enabled sync plans'
-      tags :pre_upgrade
-      before :disk_io
-    end
-
-    def run
-      active_sync_plans_count = feature(:sync_plans).active_sync_plans_count
-      assert(active_sync_plans_count == 0,
-             "There are total #{active_sync_plans_count} active sync plans in the system",
-             :next_steps => Procedures::SyncPlans::Disable.new)
-    end
-  end
-end

data/definitions/procedures/install_package.rb

@@ -1,17 +0,0 @@
-class Procedures::InstallPackage < ForemanMaintain::Procedure
-  metadata do
-    param :packages, 'List of packages to install', :array => true
-  end
-
-  def run
-    install_packages(@packages, :assumeyes => assumeyes?)
-  end
-
-  def necessary?
-    @packages.any? { |package| package_version(package).nil? }
-  end
-
-  def description
-    "Install package(s) #{@packages.join(', ')}"
-  end
-end

data/definitions/scenarios/pre_upgrade_check_foreman_1_14.rb

@@ -1,13 +0,0 @@
-class Scenarios::PreUpgradeCheckForeman_1_14 < ForemanMaintain::Scenario
-  metadata do
-    description 'checks before upgrading to Foreman 1.14'
-    tags :pre_upgrade_check
-    confine do
-      feature(:upstream)
-    end
-  end
-
-  def compose
-    add_steps(find_checks(:default))
-  end
-end

data/definitions/scenarios/pre_upgrade_check_satellite_6_0_z.rb

@@ -1,14 +0,0 @@
-class Scenarios::PreUpgradeCheckSatellite_6_0_z < ForemanMaintain::Scenario
-  metadata do
-    tags :pre_upgrade_check, :satellite_6_0_z
-    description 'checks before upgrading to Satellite 6.0'
-    confine do
-      feature(:downstream) && feature(:downstream).current_version.to_s.start_with?('6.0.')
-    end
-  end
-
-  def compose
-    add_steps(find_checks(:default))
-    add_steps(find_checks(:pre_upgrade))
-  end
-end

data/definitions/scenarios/pre_upgrade_check_satellite_6_1.rb

@@ -1,14 +0,0 @@
-class Scenarios::PreUpgradeCheckSatellite_6_1 < ForemanMaintain::Scenario
-  metadata do
-    description 'checks before upgrading to Satellite 6.1'
-    tags :pre_upgrade_check, :satellite_6_1
-    confine do
-      feature(:downstream) && feature(:downstream).current_version.to_s.start_with?('6.0.')
-    end
-  end
-
-  def compose
-    add_steps(find_checks(:default))
-    add_steps(find_checks(:pre_upgrade))
-  end
-end