foreman_maintain 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e9f70b0ee10a6f3d86da947c29b44f28425fe3d
-  data.tar.gz: 25c1ffb8b8b12ff26a2ee7cad07f407b7586f276
+  metadata.gz: 65b1daa7e3ed6b36c77a34061c0cde3badf9cc0d
+  data.tar.gz: '08aedcc2e9c4242dc17b8d50b5bf356bd3349d28'
 SHA512:
-  metadata.gz: ab4457e9ea8319b82ac952b5d389bd2156d384076d2d36db0150b51a04127b62393617327118d715ebb468bcf104ceaefda96cb86d641a0da8724d4ae29cb632
-  data.tar.gz: 4d59d274a7f28c85f4c315766e276890fb9c5285225fd02dcf5aef62e495b08343e8becfcdd7cbb39ddf916b6be38180692dba4ffc83ff9f83fddc9570c12e80
+  metadata.gz: 8a7548a663107ef22475acefbe0b0a5dc5aeff92e816c6eaf0096b2ce344c43536af033d9d67fbbc5c36f976c4d6f7e0dbb6e6d8f0343e69ad678feaa907cdc6
+  data.tar.gz: 6e0a423955cd009992767a126168609ac9ec0d1687465089bfa1861798402157f8225f335ad452fa64ba04a751468d5804cac000faafe9a450d07d75109db6bf

data/bin/passenger-recycler

@@ -41,31 +41,39 @@ def process_status?(pid)
 end
 
 require 'phusion_passenger'
+PhusionPassenger.locate_directories
 require 'phusion_passenger/platform_info'
 require 'phusion_passenger/platform_info/ruby'
 require 'phusion_passenger/admin_tools/memory_stats'
-PhusionPassenger.locate_directories
 stats = PhusionPassenger::AdminTools::MemoryStats.new
-unless stats.platform_provides_private_dirty_rss_information?
-  puts 'Please run as root or platform unsupported'
-  exit 1
-end
 killed = 0
+
+def get_process_start(pid)
+  `ps -p#{pid} -o start=`.strip
+rescue StandardError => e
+  verbose "Error: #{e.message} \nReturning '?'"
+  '?'
+end
+
+def get_rss_info(process)
+  get_pid_mem_kb = process.private_dirty_rss || process.rss
+  get_pid_mem_mb = format('%.0f', get_pid_mem_kb / 1024)
+  [get_pid_mem_kb, get_pid_mem_mb]
+end
+
 stats.passenger_processes.each do |p|
   pid = p.pid.to_i
-  debug "Checking #{pid} with RSS of #{p.private_dirty_rss}"
-  next unless p.private_dirty_rss > CONFIG[:MAX_PRIV_RSS_MEMORY]
-  started = begin
-              `ps -p#{pid} -o start=`.strip
-            rescue StandardError => e
-              verbose "Error: #{e.message} \nReturning '?'"
-              '?'
-            end
+  started = get_process_start(pid)
+  get_pid_mem_kb, get_pid_mem_mb = get_rss_info(p)
+  debug_message = "Checking #{pid} with RSS of #{get_pid_mem_kb}"
+  verbose_message = "Terminating #{pid} (started #{started}) with private" \
+                    " RSS size of #{get_pid_mem_mb} MB"
+  debug debug_message
+  next unless get_pid_mem_kb > CONFIG[:MAX_PRIV_RSS_MEMORY]
   status_ps = `ps -p#{pid} -u`
   status_all = `passenger-status 2> /dev/null`
   status_backtraces = `passenger-status --show=backtraces 2>/dev/null`
-  verbose "Terminating #{pid} (started #{started}) with private dirty RSS" \
-          " size of #{p.private_dirty_rss} MB"
+  verbose verbose_message
   Process.kill 'SIGUSR1', pid
   sleep CONFIG[:GRACEFUL_SHUTDOWN_SLEEP]
   kill(pid)

data/config/foreman_maintain.yml.example

@@ -19,3 +19,7 @@
 
 # Mention path where foreman-proxy certificates stored on filesystem
 # :foreman_proxy_cert_path: '/etc/foreman'
+
+# Mention directory path to store candlepin db backups
+# :db_backup_dir: '/var/lib/foreman-maintain/db-backups'
+

data/config/foreman_maintain.yml.packaging

@@ -20,3 +20,5 @@
 # Mention path where foreman-proxy certificates stored on filesystem
 # :foreman_proxy_cert_path: '/etc/foreman'
 
+# Mention directory path to store candlepin db backups
+# :db_backup_dir: '/var/lib/foreman-maintain/db-backups'

data/definitions/checks/candlepin/validate_db.rb

@@ -10,7 +10,15 @@ module Checks::Candlepin
     end
 
     def run
-      feature(:candlepin_database).execute_cpdb_validate_cmd
+      result, result_msg = feature(:candlepin_database).execute_cpdb_validate_cmd
+      next_steps = []
+      if feature(:downstream) && feature(:downstream).current_minor_version == '6.2'
+        next_steps.concat(
+          [Procedures::Candlepin::DeleteOrphanedRecordsFromEnvContent.new,
+           Procedures::KnowledgeBaseArticle.new(:doc => 'fix_cpdb_validate_failure')]
+        )
+      end
+      assert(result == 0, result_msg, :next_steps => next_steps)
     end
   end
 end

data/definitions/checks/remote_execution/verify_settings_file_already_exists.rb

@@ -0,0 +1,42 @@
+module Checks::RemoteExecution
+  class VerifySettingsFileAlreadyExists < ForemanMaintain::Check
+    metadata do
+      description 'Check to verify remote_execution_ssh settings already exist'
+
+      confine do
+        feature(:downstream) &&
+          feature(:downstream).current_minor_version == '6.2' &&
+          find_package('tfm-rubygem-smart_proxy_dynflow_core') &&
+          file_exists?('/etc/smart_proxy_dynflow_core')
+      end
+    end
+
+    def run
+      if file_exists?(settingd_dir_path)
+        symlinks = find_symlinks(settingd_dir_path)
+        assert(
+          symlinks.empty?,
+          failure_msg(settingd_dir_path, symlinks),
+          :next_steps => [
+            Procedures::RemoteExecution::RemoveExistingSettingsd.new(
+              :dirpath => settingd_dir_path
+            )
+          ]
+        )
+      end
+    end
+
+    private
+
+    def failure_msg(dir_path, symlinks)
+      'Settings related to remote_execution_ssh are already present'\
+      " under #{dir_path} and " \
+      "\nit would conflict with the installer from the next version." \
+      "\nsymlinks available - #{symlinks.join(', ')}"
+    end
+
+    def settingd_dir_path
+      '/etc/smart_proxy_dynflow_core/settings.d'
+    end
+  end
+end

data/definitions/checks/repositories/validate.rb

@@ -0,0 +1,33 @@
+module Checks::Repositories
+  class Validate < ForemanMaintain::Check
+    metadata do
+      description 'Validate availability of repositories'
+
+      confine do
+        feature(:downstream)
+      end
+
+      param :version,
+            'Version for which repositories needs to be validated',
+            :required => true
+
+      manual_detection
+    end
+
+    def run
+      with_spinner("Validating availability of repositories for #{@version}") do |spinner|
+        absent_repos = feature(:downstream).absent_repos(@version)
+        unless absent_repos.empty?
+          spinner.update('Some repositories missing, calling `subscription-manager refresh`')
+          feature(:downstream).rhsm_refresh
+          absent_repos = feature(:downstream).absent_repos(@version)
+        end
+        unless absent_repos.empty?
+          fail!(
+            "Following repositories are not available on your system: #{absent_repos.join(', ')}"
+          )
+        end
+      end
+    end
+  end
+end

data/definitions/features/candlepin_database.rb

@@ -27,12 +27,20 @@ class Features::CandlepinDatabase < ForemanMaintain::Feature
 
   def execute_cpdb_validate_cmd
     main_cmd = cpdb_validate_cmd
-    unless main_cmd.empty?
-      main_cmd += format_shell_args(
-        '-u' => configuration['username'], '-p' => configuration[%(password)]
-      )
-      execute!(main_cmd, :hidden_patterns => [configuration['password']])
-    end
+    return [true, nil] if main_cmd.empty?
+    main_cmd += format_shell_args(
+      '-u' => configuration['username'], '-p' => configuration[%(password)]
+    )
+    execute_with_status(main_cmd, :hidden_patterns => [configuration['password']])
+  end
+
+  def env_content_ids_with_null_content
+    sql = <<-SQL
+      SELECT ec.id
+      FROM cp_env_content ec
+      LEFT JOIN cp_content c ON ec.contentid = c.id WHERE c.id IS NULL
+    SQL
+    query(sql).map { |r| r['id'] }
   end
 
   private
@@ -40,15 +48,15 @@ class Features::CandlepinDatabase < ForemanMaintain::Feature
   def load_configuration
     raw_config = File.read(CANDLEPIN_DB_CONFIG)
     full_config = Hash[raw_config.scan(/(^[^#\n][^=]*)=(.*)/)]
-    uri = %r{://(([^/:]*):?([^/]*))/(.*)}.match(full_config['org.quartz.dataSource.myDS.URL'])
+    uri = %r{://(([^/:]*):?([^/]*))/(.*)}.match(full_config['jpa.config.hibernate.connection.url'])
     @configuration = {
-      'username' => full_config['org.quartz.dataSource.myDS.user'],
-      'password' => full_config['org.quartz.dataSource.myDS.password'],
+      'username' => full_config['jpa.config.hibernate.connection.username'],
+      'password' => full_config['jpa.config.hibernate.connection.password'],
       'database' => uri[4],
       'host' => uri[2],
       'port' => uri[3] || '5432',
-      'driver' => full_config['org.quartz.dataSource.myDS.driver'],
-      'url' => full_config['org.quartz.dataSource.myDS.URL']
+      'driver_class' => full_config['jpa.config.hibernate.connection.driver_class'],
+      'url' => full_config['jpa.config.hibernate.connection.url']
     }
   end
 

data/definitions/features/downstream.rb

@@ -29,6 +29,19 @@ class Features::Downstream < ForemanMaintain::Feature
     end
   end
 
+  def absent_repos(version)
+    all_repo_lines = execute(%(LANG=en_US.utf-8 subscription-manager repos --list | ) +
+                              %(grep '^Repo ID:')).split("\n")
+    all_repos = all_repo_lines.map { |line| line.split(/\s+/).last }
+    repos_required = rh_repos(version)
+    repos_found = repos_required & all_repos
+    repos_required - repos_found
+  end
+
+  def rhsm_refresh
+    execute!(%(subscription-manager refresh))
+  end
+
   private
 
   def rh_repos(sat_version)

data/definitions/features/foreman_1_7_x.rb

@@ -35,7 +35,9 @@ class Features::Foreman_1_7_x < ForemanMaintain::Feature
 
   def del_custom_iptables_chain(name)
     return unless execute?("iptables -L #{name}") # the chain is already gone
-    execute!("iptables -D INPUT -j #{name}")
+    if execute?("iptables -L INPUT | tail -n +3 | grep '^#{name} '")
+      execute!("iptables -D INPUT -j #{name}")
+    end
     execute!("iptables -F #{name}")
     execute!("iptables -X #{name}")
   end

data/definitions/features/foreman_proxy.rb

@@ -34,16 +34,17 @@ class Features::ForemanProxy < ForemanMaintain::Feature
         next unless str.include?('HTTP')
         http_line = str
       end
+      return http_line if http_line.empty?
       http_line.split(curl_http_status.to_s).last.strip
     end
   end
 
   def run_dhcp_curl
     curl_resp = execute(dhcp_curl_cmd)
-    array_output = curl_resp.split(/\r\n/)
-    result_array = array_output.last.split(/\n/)
-    curl_http_status = result_array.delete_at(result_array.length - 1).strip.to_i
-    curl_http_resp = parse_json(result_array.join(''))
+    array_output = curl_resp.split(/\r?\n/)
+    status_str = array_output.last
+    curl_http_status = (status_str ? status_str.strip : status_str).to_i
+    curl_http_resp = parse_json(array_output[0])
     ForemanMaintain::Utils::CurlResponse.new(
       curl_http_resp,
       curl_http_status,
@@ -55,7 +56,7 @@ class Features::ForemanProxy < ForemanMaintain::Feature
     dhcp_curl_resp = run_dhcp_curl
     success = true
     if dhcp_curl_resp.http_code.eql?(200)
-      if dhcp_curl_resp.result.empty?
+      if dhcp_curl_resp.result.to_s.empty?
         success = false
         puts "Verify DHCP Settings. Response: #{dhcp_curl_resp.result.inspect}"
       end

data/definitions/procedures/candlepin/delete_orphaned_records_from_env_content.rb

@@ -0,0 +1,34 @@
+module Procedures::Candlepin
+  class DeleteOrphanedRecordsFromEnvContent < ForemanMaintain::Procedure
+    metadata do
+      description 'Delete orphaned record(s) from cp_env_content with unresolvable content'
+      label :candlepin_delete_orphaned_records_from_env_content
+
+      confine do
+        feature(:candlepin_database) &&
+          feature(:downstream) &&
+          feature(:downstream).current_minor_version == '6.2' &&
+          feature(:candlepin_database).table_exist?('cp_env_content')
+      end
+    end
+
+    def run
+      with_spinner('Deleting cp_env_content record(s) with unresolvable content') do |spinner|
+        spinner.update 'Finding cp_env_content records with unresolvable content'
+        env_content_ids = feature(:candlepin_database).env_content_ids_with_null_content
+        if env_content_ids.empty?
+          spinner.update 'No orphaned records found'
+        else
+          spinner.update 'Taking a backup of the candlepin database'
+          feature(:candlepin_database).perform_backup
+
+          puts "Total #{env_content_ids.length} records with unresolvable content"
+          spinner.update 'Deleting record(s) from cp_env_content table'
+          feature(:candlepin_database).delete_records_by_ids(
+            'cp_env_content', env_content_ids
+          )
+        end
+      end
+    end
+  end
+end

data/definitions/procedures/knowledge_base_article.rb

@@ -0,0 +1,29 @@
+class Procedures::KnowledgeBaseArticle < ForemanMaintain::Procedure
+  metadata do
+    description 'Show knowledge base article for troubleshooting'
+
+    confine do
+      feature(:downstream)
+    end
+    param :doc,
+          'Document name required to select a correct article',
+          :required => true
+    advanced_run false
+  end
+
+  def run
+    ask(<<-MESSAGE.strip_heredoc)
+      Go to #{kcs_documents[@doc]}
+      please follow steps from above article to resolve this issue
+      press ENTER once done.
+    MESSAGE
+  end
+
+  private
+
+  def kcs_documents
+    {
+      'fix_cpdb_validate_failure' => 'https://access.redhat.com/solutions/3362821'
+    }
+  end
+end

data/definitions/procedures/remote_execution/remove_existing_settingsd.rb

@@ -0,0 +1,18 @@
+module Procedures::RemoteExecution
+  class RemoveExistingSettingsd < ForemanMaintain::Procedure
+    metadata do
+      param :dirpath,
+            'Directory path for settings.d folder',
+            :required => true
+      description 'Remove existing settings.d directory before installer run.' \
+        "\n The next run of the installer will re-create the directory properly."
+      advanced_run false
+    end
+
+    def run
+      with_spinner("Removing existing #{@dirpath} directory") do |_spinner|
+        execute!("rm -rf #{@dirpath}")
+      end
+    end
+  end
+end

data/definitions/procedures/sync_plans/disable.rb

@@ -17,14 +17,16 @@ module Procedures::SyncPlans
     private
 
     def disable_all_enabled_sync_plans
-      feature(:sync_plans).load_from_storage(storage)
+      default_storage = ForemanMaintain.storage(:default)
+      feature(:sync_plans).load_from_storage(default_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)
+      feature(:sync_plans).save_to_storage(default_storage)
+      default_storage.save
     end
   end
 end

data/definitions/procedures/sync_plans/enable.rb

@@ -18,13 +18,15 @@ module Procedures::SyncPlans
     private
 
     def enabled_sync_plans
-      feature(:sync_plans).load_from_storage(storage)
+      default_storage = ForemanMaintain.storage(:default)
+      feature(:sync_plans).load_from_storage(default_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)
+      feature(:sync_plans).save_to_storage(default_storage)
+      default_storage.save
     end
   end
 end

data/definitions/scenarios/upgrade_to_satellite_6_2.rb

@@ -21,6 +21,7 @@ module Scenarios::Satellite_6_2
     def compose
       add_steps(find_checks(:default))
       add_steps(find_checks(:pre_upgrade))
+      add_step(Checks::Repositories::Validate.new(:version => '6.2'))
     end
   end
 

data/definitions/scenarios/upgrade_to_satellite_6_2_z.rb

@@ -21,6 +21,7 @@ module Scenarios::Satellite_6_2_z
     def compose
       add_steps(find_checks(:default))
       add_steps(find_checks(:pre_upgrade))
+      add_step(Checks::Repositories::Validate.new(:version => '6.2'))
     end
   end
 

data/definitions/scenarios/upgrade_to_satellite_6_3.rb

@@ -21,6 +21,8 @@ module Scenarios::Satellite_6_3
     def compose
       add_steps(find_checks(:default))
       add_steps(find_checks(:pre_upgrade))
+      add_step(Checks::RemoteExecution::VerifySettingsFileAlreadyExists.new)
+      add_step(Checks::Repositories::Validate.new(:version => '6.3'))
     end
   end
 

data/definitions/scenarios/upgrade_to_satellite_6_3_z.rb

@@ -21,6 +21,7 @@ module Scenarios::Satellite_6_3_z
     def compose
       add_steps(find_checks(:default))
       add_steps(find_checks(:pre_upgrade))
+      add_step(Checks::Repositories::Validate.new(:version => '6.3'))
     end
   end
 

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

@@ -13,7 +13,7 @@ module ForemanMaintain
 
         def self.params_for_tag(tag)
           params = {}
-          ForemanMaintain.available_procedures(:tags => tag).each do |procedure|
+          ForemanMaintain.allowed_available_procedures(:tags => tag).each do |procedure|
             procedure.params.each_value do |param|
               unless params.key?(param.name)
                 params[param.name] = { :instance => param, :procedures => [] }
@@ -35,7 +35,9 @@ module ForemanMaintain
           tag = underscorize(invocation_path.split.last).to_sym
           scenario = ForemanMaintain::Scenario.new
 
-          ForemanMaintain.available_procedures(:tags => tag).sort_by(&:label).each do |procedure|
+          ForemanMaintain.allowed_available_procedures(
+            :tags => tag
+          ).sort_by(&:label).each do |procedure|
             scenario.add_step(procedure.new(get_params_for(procedure)))
           end
 

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

@@ -4,12 +4,14 @@ module ForemanMaintain
   module Cli
     module Procedure
       class ByTagCommand < Base
-        available_tags(ForemanMaintain.available_procedures(nil)).each do |tag|
+        available_tags(ForemanMaintain.allowed_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|
+          procedures = ForemanMaintain.allowed_available_procedures(
+            :tags => tag
+          ).map do |procedure|
             procedure.label.to_s
           end
 

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

@@ -4,7 +4,7 @@ module ForemanMaintain
   module Cli
     module Procedure
       class RunCommand < Base
-        ForemanMaintain.available_procedures(nil).each do |procedure|
+        ForemanMaintain.allowed_available_procedures(nil).each do |procedure|
           klass = Class.new(AbstractProcedureCommand) do
             params_to_options(procedure.params)
             interactive_option

data/lib/foreman_maintain/cli/base.rb

@@ -103,8 +103,8 @@ module ForemanMaintain
         option ['-y', '--assumeyes'], :flag,
                'Automatically answer yes for all questions'
 
-        option ['-w', '--whitelist'], 'whitelist',
-               'Comma-separated list of labels of steps to be ignored' do |whitelist|
+        option(['-w', '--whitelist'], 'whitelist',
+               'Comma-separated list of labels of steps to be skipped') do |whitelist|
           raise ArgumentError, 'value not specified' if whitelist.nil? || whitelist.empty?
           whitelist.split(',').map(&:strip)
         end

data/lib/foreman_maintain/concerns/base_database.rb

@@ -22,6 +22,49 @@ module ForemanMaintain
         psql('SELECT 1 as ping', config)
       end
 
+      def backup_file_path(config = configuration)
+        dump_file_name = "#{config['database']}_#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}.dump"
+        "#{backup_dir}/#{dump_file_name}.bz2"
+      end
+
+      def backup_db_command(file_path, config = configuration)
+        pg_dump_cmd = "pg_dump -Fc #{config['database']}"
+        "runuser - postgres -c '#{pg_dump_cmd}' | bzip2 -9 > #{file_path}"
+      end
+
+      def backup_dir
+        @backup_dir ||= File.expand_path(ForemanMaintain.config.db_backup_dir)
+      end
+
+      def perform_backup(config = configuration)
+        file_path = backup_file_path(config)
+        backup_cmd = backup_db_command(file_path, config)
+        execute!(backup_cmd)
+        puts "\n Note: Database backup file path - #{file_path}"
+        puts "\n In case of any exception, use above dump file to restore DB."
+      end
+
+      def table_exist?(table_name)
+        sql = <<-SQL
+          SELECT EXISTS ( SELECT *
+          FROM information_schema.tables WHERE table_name =  '#{table_name}' )
+        SQL
+        result = query(sql)
+        return false if result.nil? || (result && result.empty?)
+        result.first['exists'].eql?('t')
+      end
+
+      def delete_records_by_ids(tbl_name, rec_ids)
+        quotize_rec_ids = rec_ids.map { |el| "'#{el}'" }.join(',')
+        unless quotize_rec_ids.empty?
+          psql(<<-SQL)
+            BEGIN;
+             DELETE FROM #{tbl_name} WHERE id IN (#{quotize_rec_ids});
+            COMMIT;
+          SQL
+        end
+      end
+
       private
 
       def psql_db_connection_str(config)

data/lib/foreman_maintain/concerns/metadata.rb

@@ -96,6 +96,10 @@ module ForemanMaintain
           @data[:run_once] = true
         end
 
+        def advanced_run(advanced_run)
+          @data[:advanced_run] = advanced_run
+        end
+
         def self.eval_dsl(metadata, &block)
           new(metadata).tap do |dsl|
             dsl.instance_eval(&block)
@@ -174,13 +178,18 @@ module ForemanMaintain
           metadata[:run_once]
         end
 
+        def advanced_run?
+          metadata[:advanced_run]
+        end
+
         def initialize_metadata
           { :tags => [],
             :confine_blocks => [],
             :params => {},
             :preparation_steps_blocks => [],
             :before => [],
-            :after => [] }.tap do |metadata|
+            :after => [],
+            :advanced_run => true }.tap do |metadata|
             if superclass.respond_to?(:metadata)
               metadata[:label] = superclass.metadata[:label]
             end
@@ -271,6 +280,10 @@ module ForemanMaintain
       def preparation_steps(*args)
         self.class.preparation_steps(*args)
       end
+
+      def advanced_run?
+        self.class.advanced_run?
+      end
     end
   end
 end

data/lib/foreman_maintain/concerns/system_helpers.rb

@@ -61,6 +61,11 @@ module ForemanMaintain
         command_runner.output
       end
 
+      def execute_with_status(command, options = {})
+        result_msg = execute(command, options)
+        [$CHILD_STATUS.to_i, result_msg]
+      end
+
       def file_exists?(filename)
         File.exist?(filename)
       end
@@ -142,6 +147,12 @@ module ForemanMaintain
       def format_shell_args(options = {})
         options.map { |shell_optn, val| " #{shell_optn} '#{shellescape(val)}'" }.join
       end
+
+      def find_symlinks(dir_path)
+        cmd = "find '#{dir_path}' -maxdepth 1 -type l"
+        result = execute(cmd).strip
+        result.split(/\n/)
+      end
     end
   end
 end

data/lib/foreman_maintain/config.rb

@@ -3,7 +3,8 @@ module ForemanMaintain
   class Config
     attr_accessor :pre_setup_log_messages,
                   :config_file, :definitions_dirs, :log_level, :log_dir, :log_file_size,
-                  :storage_file, :backup_dir, :foreman_proxy_cert_path
+                  :storage_file, :backup_dir, :foreman_proxy_cert_path,
+                  :db_backup_dir
 
     def initialize(options)
       @pre_setup_log_messages = []
@@ -12,10 +13,7 @@ module ForemanMaintain
       @definitions_dirs = @options.fetch(:definitions_dirs,
                                          [File.join(source_path, 'definitions')])
       load_log_configs
-      @storage_file = @options.fetch(:storage_file, 'data.yml')
-      @backup_dir = find_dir_path(
-        @options.fetch(:backup_dir, '/var/lib/foreman-maintain')
-      )
+      load_backup_dir_paths
       @foreman_proxy_cert_path = @options.fetch(:foreman_proxy_cert_path, '/etc/foreman')
     end
 
@@ -27,6 +25,16 @@ module ForemanMaintain
       @log_file_size = @options.fetch(:log_file_size, 10_000)
     end
 
+    def load_backup_dir_paths
+      @storage_file = @options.fetch(:storage_file, 'data.yml')
+      @backup_dir = find_dir_path(
+        @options.fetch(:backup_dir, '/var/lib/foreman-maintain')
+      )
+      @db_backup_dir = find_dir_path(
+        @options.fetch(:db_backup_dir, '/var/lib/foreman-maintain/db-backups')
+      )
+    end
+
     def load_config
       if File.exist?(config_file)
         YAML.load(File.open(config_file)) || {}

data/lib/foreman_maintain/context.rb

@@ -0,0 +1,34 @@
+module ForemanMaintain
+  class Context
+    def initialize(data = {})
+      @data = data
+      @mapping = {}
+    end
+
+    def set(key, value, mapping = {})
+      @data[key] = value
+      map(key, mapping)
+    end
+
+    def get(key, default = nil)
+      @data.fetch(key, default)
+    end
+
+    def to_hash
+      @data
+    end
+
+    def map(key, mapping = {})
+      @mapping[key] ||= {}
+      @mapping[key].merge!(mapping)
+    end
+
+    def params_for(definition)
+      @mapping.inject({}) do |params, (key, mapping)|
+        target = mapping[definition]
+        params[target] = @data[key] unless target.nil?
+        params
+      end
+    end
+  end
+end

data/lib/foreman_maintain/detector.rb

@@ -50,7 +50,7 @@ module ForemanMaintain
 
     def find_present_classes(object_base_class)
       object_base_class.all_sub_classes.reduce([]) do |array, object_class|
-        array << object_class if object_class.present?
+        array << object_class if object_class.autodetect? && object_class.present?
         array
       end
     end

data/lib/foreman_maintain/executable.rb

@@ -116,7 +116,9 @@ module ForemanMaintain
     # internal method called by executor
     def __run__(execution)
       setup_execution_state(execution)
-      run
+      unless skipped?
+        run
+      end
     end
 
     # method defined both on object and class to ensure we work always with object

data/lib/foreman_maintain/runner/execution.rb

@@ -66,16 +66,20 @@ module ForemanMaintain
 
       def run
         @reporter.before_execution_starts(self)
+
         if skip?
           @status = :already_run
           return
         end
-        @status = :running
+
+        @status = whitelisted? ? :skipped : :running
+
         with_metadata_calculation do
           capture_errors do
             step.__run__(self)
           end
         end
+
         # change the state only when not modified
         @status = :success if @status == :running
       ensure

data/lib/foreman_maintain/scenario.rb

@@ -6,7 +6,7 @@ module ForemanMaintain
     include Concerns::Finders
     extend Concerns::Finders
 
-    attr_reader :steps
+    attr_reader :steps, :context
 
     class FilteredScenario < Scenario
       metadata do
@@ -79,14 +79,19 @@ module ForemanMaintain
       end
     end
 
-    def initialize
+    def initialize(context_data = {})
       @steps = []
+      @context = Context.new(context_data)
+      set_context_mapping
       compose
     end
 
     # Override to compose steps for the scenario
     def compose; end
 
+    # Override to map context for the scenario
+    def set_context_mapping; end
+
     def preparation_steps
       # we first take the preparation steps defined for the scenario + collect
       # preparation steps for the steps inside the scenario
@@ -141,7 +146,15 @@ module ForemanMaintain
     end
 
     def add_step(step)
-      add_steps([step])
+      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?
+    end
+
+    def add_steps_with_context(*definitions)
+      definitions.flatten.each { |definition| add_step_with_context(definition) }
     end
 
     def self.inspect

data/lib/foreman_maintain/upgrade_runner.rb

@@ -175,7 +175,7 @@ module ForemanMaintain
         The upgrade failed and system was restored to pre-upgrade state.
       MESSAGE
     end
-    # rubocop:enable Metrics/AbcSize, Lint/NonLocalExitFromIterator
+    # rubocop:enable Metrics/AbcSize
 
     def with_non_empty_scenario(phase)
       next_scenario = scenario(phase)

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/lib/foreman_maintain.rb

@@ -20,6 +20,7 @@ module ForemanMaintain
   require 'foreman_maintain/top_level_modules'
   require 'foreman_maintain/yaml_storage'
   require 'foreman_maintain/config'
+  require 'foreman_maintain/context'
   require 'foreman_maintain/detector'
   require 'foreman_maintain/dependency_graph'
   require 'foreman_maintain/param'
@@ -91,6 +92,11 @@ module ForemanMaintain
       detector.available_procedures(*args)
     end
 
+    def allowed_available_procedures(*args)
+      procedures = detector.available_procedures(*args)
+      procedures.select(&:advanced_run?)
+    end
+
     def init_logger
       # Note - If timestamp added to filename then number of log files i.e second
       # argument to Logger.new will not work as expected

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -120,6 +120,8 @@ files:
 - definitions/checks/foreman_tasks/not_paused.rb
 - definitions/checks/foreman_tasks/not_running.rb
 - definitions/checks/hammer_ping.rb
+- definitions/checks/remote_execution/verify_settings_file_already_exists.rb
+- definitions/checks/repositories/validate.rb
 - definitions/checks/system_registration.rb
 - definitions/features/candlepin_database.rb
 - definitions/features/downstream.rb
@@ -135,6 +137,7 @@ files:
 - definitions/features/pulp.rb
 - definitions/features/sync_plans.rb
 - definitions/features/upstream.rb
+- definitions/procedures/candlepin/delete_orphaned_records_from_env_content.rb
 - definitions/procedures/foreman_tasks/delete.rb
 - definitions/procedures/foreman_tasks/fetch_tasks_status.rb
 - definitions/procedures/foreman_tasks/resume.rb
@@ -144,11 +147,13 @@ files:
 - definitions/procedures/katello_service/restart.rb
 - definitions/procedures/katello_service/start.rb
 - definitions/procedures/katello_service/stop.rb
+- definitions/procedures/knowledge_base_article.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/passenger_recycler.rb
+- definitions/procedures/remote_execution/remove_existing_settingsd.rb
 - definitions/procedures/repositories/setup.rb
 - definitions/procedures/sync_plans/disable.rb
 - definitions/procedures/sync_plans/enable.rb
@@ -177,6 +182,7 @@ files:
 - lib/foreman_maintain/concerns/scenario_metadata.rb
 - lib/foreman_maintain/concerns/system_helpers.rb
 - lib/foreman_maintain/config.rb
+- lib/foreman_maintain/context.rb
 - lib/foreman_maintain/core_ext.rb
 - lib/foreman_maintain/csv_parser.rb
 - lib/foreman_maintain/dependency_graph.rb