foreman_maintain 0.0.6 → 0.0.7

data/definitions/procedures/maintenance_mode/disable.rb

@@ -0,0 +1,13 @@
+module Procedures::MaintenanceMode
+  class Disable < ForemanMaintain::Procedure
+    metadata do
+      for_feature :foreman
+      description 'turn off maintenance mode'
+      tags :post_migrations
+    end
+
+    def run
+      feature(:foreman).maintenance_mode(:disable)
+    end
+  end
+end

data/definitions/procedures/maintenance_mode/enable.rb

@@ -0,0 +1,13 @@
+module Procedures::MaintenanceMode
+  class Enable < ForemanMaintain::Procedure
+    metadata do
+      for_feature :foreman
+      description 'turn on maintenance mode'
+      tags :pre_migrations
+    end
+
+    def run
+      feature(:foreman).maintenance_mode(:enable)
+    end
+  end
+end

data/definitions/procedures/packages/install.rb

@@ -0,0 +1,20 @@
+module Procedures::Packages
+  class Install < ForemanMaintain::Procedure
+    metadata do
+      param :packages, 'List of packages to install', :array => true
+      param :assumeyes, 'Do not ask for confirmation'
+    end
+
+    def run
+      packages_action(:install, @packages, :assumeyes => @assumeyes.nil? ? assumeyes? : @assumeyes)
+    end
+
+    def necessary?
+      @packages.any? { |package| package_version(package).nil? }
+    end
+
+    def runtime_message
+      "Install package(s) #{@packages.join(', ')}"
+    end
+  end
+end

data/definitions/procedures/packages/update.rb

@@ -0,0 +1,20 @@
+module Procedures::Packages
+  class Update < ForemanMaintain::Procedure
+    metadata do
+      param :packages, 'List of packages to update', :array => true
+      param :assumeyes, 'Do not ask for confirmation'
+    end
+
+    def run
+      packages_action(:update, @packages, :assumeyes => @assumeyes.nil? ? assumeyes? : @assumeyes)
+    end
+
+    def necessary?
+      @packages.any? { |package| package_version(package).nil? }
+    end
+
+    def description
+      "Update package(s) #{@packages.join(', ')}"
+    end
+  end
+end

data/definitions/procedures/repositories/setup.rb

@@ -0,0 +1,18 @@
+module Procedures::Repositories
+  class Setup < ForemanMaintain::Procedure
+    metadata do
+      description 'Setup repositories'
+      confine do
+        feature(:downstream) || feature(:upstream)
+      end
+      param :version, :required => true
+      run_once
+    end
+
+    def run
+      with_spinner("Configuring repositories for #{@version}") do
+        (feature(:downstream) || feature(:upstream)).setup_repositories(@version)
+      end
+    end
+  end
+end

data/definitions/procedures/sync_plans/disable.rb

@@ -3,6 +3,7 @@ module Procedures::SyncPlans
     metadata do
       for_feature :sync_plans
       description 'disable active sync plans'
+      tags :pre_migrations
     end
 
     def run
@@ -12,11 +13,14 @@ module Procedures::SyncPlans
     private
 
     def disable_all_enabled_sync_plans
+      feature(:sync_plans).load_from_storage(storage)
       with_spinner('disabling sync plans') do |spinner|
         ids = feature(:sync_plans).ids_by_status(true)
         feature(:sync_plans).make_disable(ids)
         spinner.update "Total #{ids.length} sync plans are now disabled."
       end
+    ensure
+      feature(:sync_plans).save_to_storage(storage)
     end
   end
 end

data/definitions/procedures/sync_plans/enable.rb

@@ -3,6 +3,8 @@ module Procedures::SyncPlans
     metadata do
       for_feature :sync_plans
       description 're-enable sync plans'
+      tags :post_migrations
+      before :disk_io
     end
 
     def run
@@ -12,10 +14,13 @@ module Procedures::SyncPlans
     private
 
     def enabled_sync_plans
+      feature(:sync_plans).load_from_storage(storage)
       with_spinner('re-enabling sync plans') do |spinner|
         record_ids = feature(:sync_plans).make_enable
         spinner.update "Total #{record_ids.length} sync plans are now enabled."
       end
+    ensure
+      feature(:sync_plans).save_to_storage(storage)
     end
   end
 end

data/definitions/scenarios/upgrade_to_satellite_6_2.rb

@@ -0,0 +1,77 @@
+module Scenarios::Satellite_6_2
+  class Abstract < ForemanMaintain::Scenario
+    def self.upgrade_metadata(&block)
+      metadata do
+        tags :upgrade_to_satellite_6_2
+        confine do
+          feature(:downstream) && feature(:downstream).current_minor_version == '6.1'
+        end
+        instance_eval(&block)
+      end
+    end
+  end
+
+  class PreUpgradeCheck < Abstract
+    upgrade_metadata do
+      description 'checks before upgrading to Satellite 6.2'
+      tags :pre_upgrade_checks
+      run_strategy :fail_slow
+    end
+
+    def compose
+      add_steps(find_checks(:default))
+      add_steps(find_checks(:pre_upgrade))
+    end
+  end
+
+  class PreMigrations < Abstract
+    upgrade_metadata do
+      description 'procedures before migrating to Satellite 6.2'
+      tags :pre_migrations
+    end
+
+    def compose
+      add_steps(find_procedures(:pre_migrations))
+    end
+  end
+
+  class Migrations < Abstract
+    upgrade_metadata do
+      description 'migration scripts to Satellite 6.2'
+      tags :migrations
+    end
+
+    def compose
+      add_step(Procedures::Repositories::Setup.new(:version => '6.2'))
+      add_step(Procedures::Packages::Update.new(:assumeyes => false))
+      add_step(Procedures::Installer::Upgrade.new)
+      add_steps(find_procedures(:label => :installer_upgrade))
+    end
+  end
+
+  class PostMigrations < Abstract
+    upgrade_metadata do
+      description 'procedures after migrating to Satellite 6.2'
+      tags :post_migrations
+    end
+
+    def compose
+      add_steps(find_procedures(:post_migrations))
+    end
+  end
+
+  class PostUpgradeChecks < Abstract
+    upgrade_metadata do
+      description 'checks after upgrading to Satellite 6.2'
+      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
+
+ForemanMaintain::UpgradeRunner.register_version('6.2', :upgrade_to_satellite_6_2)

data/lib/foreman_maintain.rb

@@ -12,6 +12,7 @@ module ForemanMaintain
   require 'foreman_maintain/concerns/logger'
   require 'foreman_maintain/concerns/finders'
   require 'foreman_maintain/concerns/metadata'
+  require 'foreman_maintain/concerns/scenario_metadata'
   require 'foreman_maintain/concerns/system_helpers'
   require 'foreman_maintain/concerns/hammer'
   require 'foreman_maintain/top_level_modules'
@@ -23,10 +24,10 @@ module ForemanMaintain
   require 'foreman_maintain/feature'
   require 'foreman_maintain/executable'
   require 'foreman_maintain/check'
-  require 'foreman_maintain/object_cache'
   require 'foreman_maintain/procedure'
   require 'foreman_maintain/scenario'
   require 'foreman_maintain/runner'
+  require 'foreman_maintain/upgrade_runner'
   require 'foreman_maintain/reporter'
   require 'foreman_maintain/utils'
   require 'foreman_maintain/error'
@@ -92,7 +93,9 @@ module ForemanMaintain
       # Note - If timestamp added to filename then number of log files i.e second
       # argument to Logger.new will not work as expected
       filename = File.expand_path("#{config.log_dir}/foreman-maintain.log")
-      @logger = Logger.new(filename, 10, 10_240_000).tap do |logger|
+      # convert size in KB to Bytes
+      log_fsize = config.log_file_size.to_i * 1024
+      @logger = Logger.new(filename, 10, log_fsize).tap do |logger|
         logger.level = LOGGER_LEVEL_MAPPING[config.log_level] || Logger::DEBUG
         logger.datetime_format = '%Y-%m-%d %H:%M:%S%z '
       end

data/lib/foreman_maintain/check.rb

@@ -14,12 +14,19 @@ module ForemanMaintain
     # * +:next_steps* - one or more procedures that can be followed to address
     #                   the failure, will be offered to the user when running
     #                   in interactive mode
+    #
+    # * +:warn* - issue warning instead of failure: this is less strict check,
+    #      that could be considered as non-critical for continuing with the scenario
     def assert(condition, error_message, options = {})
-      options = options.validate_options!(:next_steps)
+      options = options.validate_options!(:next_steps, :warn)
       unless condition
         next_steps = Array(options.fetch(:next_steps, []))
         self.next_steps.concat(next_steps)
-        raise Error::Fail, error_message
+        if options[:warn]
+          warn!(error_message)
+        else
+          fail!(error_message)
+        end
       end
     end
 
@@ -32,9 +39,9 @@ module ForemanMaintain
     def __run__(execution)
       super
     rescue Error::Fail => e
-      fail!(e.message)
+      set_fail(e.message)
     rescue Error::Warn => e
-      warn!(e.message)
+      set_warn(e.message)
     end
   end
 end

data/lib/foreman_maintain/cli.rb

@@ -1,14 +1,37 @@
 require 'clamp'
 require 'highline'
 require 'foreman_maintain/cli/base'
+require 'foreman_maintain/cli/transform_clamp_options'
 require 'foreman_maintain/cli/health_command'
 require 'foreman_maintain/cli/upgrade_command'
+require 'foreman_maintain/cli/advanced_command'
 
 module ForemanMaintain
   module Cli
     class MainCommand < Base
+      include Concerns::Logger
+
       subcommand 'health', 'Health related commands', HealthCommand
       subcommand 'upgrade', 'Upgrade related commands', UpgradeCommand
+      subcommand 'advanced', 'Advanced tools for server maintenance', AdvancedCommand
+
+      def run(*arguments)
+        logger.info("Running foreman-maintain command with arguments #{arguments.inspect}")
+        begin
+          super
+          exit_code = 0
+        rescue StandardError => e
+          if e.is_a?(Clamp::HelpWanted) || e.is_a?(ArgumentError) || e.is_a?(Clamp::UsageError)
+            raise e
+          end
+          puts e.message
+          logger.error(e)
+          exit_code = 1
+        end
+        return exit_code
+      ensure
+        logger.info("foreman-maintain command finished with #{exit_code}")
+      end
     end
   end
 end

data/lib/foreman_maintain/cli/advanced/procedure/abstract_by_tag_command.rb

@@ -0,0 +1,38 @@
+module ForemanMaintain
+  module Cli
+    module Procedure
+      class AbstractByTagCommand < AbstractProcedureCommand
+        def self.tag_params_to_options(tag)
+          params = params_for_tag(tag)
+          params.values.each do |param|
+            mapping = param[:procedures]
+            instance = param[:instance]
+            param_to_option(instance, :description => instance.description + " #{mapping}")
+          end
+        end
+
+        def self.params_for_tag(tag)
+          params = {}
+          ForemanMaintain.available_procedures(:tags => tag).each do |procedure|
+            procedure.params.values.each do |param|
+              unless params.key?(param.name)
+                params[param.name] = { :instance => param, :procedures => [] }
+              end
+              params[param.name][:procedures] += [procedure.label.to_s]
+            end
+          end
+          params
+        end
+
+        def execute
+          tag = underscorize(invocation_path.split.last).to_sym
+          scenario = ForemanMaintain::Scenario.new
+          ForemanMaintain.available_procedures(:tags => tag).sort_by(&:label).each do |procedure|
+            scenario.add_step(procedure.new(params_for_procedure(procedure)))
+          end
+          run_scenario(scenario)
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli/advanced/procedure/abstract_procedure_command.rb

@@ -0,0 +1,17 @@
+module ForemanMaintain
+  module Cli
+    module Procedure
+      class AbstractProcedureCommand < Base
+        include ForemanMaintain::Cli::TransformClampOptions
+
+        def execute
+          label = underscorize(invocation_path.split.last)
+          procedure = procedure(label.to_sym)
+          scenario = ForemanMaintain::Scenario.new
+          scenario.add_step(procedure.new(get_params_for(procedure)))
+          run_scenario(scenario)
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli/advanced/procedure/by_tag_command.rb

@@ -0,0 +1,32 @@
+require 'foreman_maintain/cli/advanced/procedure/abstract_by_tag_command'
+
+module ForemanMaintain
+  module Cli
+    module Procedure
+      class ByTagCommand < Base
+        available_tags(ForemanMaintain.available_procedures(nil)).each do |tag|
+          klass = Class.new(AbstractByTagCommand) do
+            tag_params_to_options(tag)
+            interactive_option
+          end
+          procedures = ForemanMaintain.available_procedures(:tags => tag).map do |procedure|
+            procedure.label.to_s
+          end
+
+          subcommand(dashize(tag), "Run procedures tagged ##{tag} #{procedures}", klass)
+        end
+
+        def execute
+          puts help
+        end
+
+        def help
+          if self.class.recognised_subcommands.empty?
+            warn 'WARNING: There were no tags found in procedures'
+          end
+          super
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli/advanced/procedure/run_command.rb

@@ -0,0 +1,17 @@
+require 'foreman_maintain/cli/advanced/procedure/abstract_procedure_command'
+
+module ForemanMaintain
+  module Cli
+    module Procedure
+      class RunCommand < Base
+        ForemanMaintain.available_procedures(nil).each do |procedure|
+          klass = Class.new(AbstractProcedureCommand) do
+            params_to_options(procedure.params)
+            interactive_option
+          end
+          subcommand(dashize(procedure.label), procedure.description, klass)
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/cli/advanced/procedure_command.rb

@@ -0,0 +1,11 @@
+require 'foreman_maintain/cli/advanced/procedure/run_command'
+require 'foreman_maintain/cli/advanced/procedure/by_tag_command'
+
+module ForemanMaintain
+  module Cli
+    class ProcedureCommand < Base
+      subcommand 'run', 'Run maintain procedures manually', Procedure::RunCommand
+      subcommand 'by-tag', 'Run maintain procedures in bulks', Procedure::ByTagCommand
+    end
+  end
+end