foreman_maintain 1.3.0 → 1.3.1

data/definitions/procedures/foreman_tasks/delete.rb

@@ -4,9 +4,9 @@ module Procedures::ForemanTasks
 
     metadata do
       param :state,
-            'In what state should the task be deleted.'\
-            " Possible values are #{ALLOWED_STATES_VALUES.join(', ')}",
-            :required => true, :allowed_values => ALLOWED_STATES_VALUES
+        'In what state should the task be deleted.'\
+        " Possible values are #{ALLOWED_STATES_VALUES.join(', ')}",
+        :required => true, :allowed_values => ALLOWED_STATES_VALUES
       description 'Delete tasks'
     end
 

data/definitions/procedures/hammer_setup.rb

@@ -5,7 +5,7 @@ class Procedures::HammerSetup < ForemanMaintain::Procedure
   end
 
   def run
-    if feature(:foreman_server) && feature(:foreman_server).services_running?
+    if feature(:foreman_server)&.services_running?
       puts 'Configuring Hammer CLI...'
       result = feature(:hammer).setup_admin_access
       logger.info 'Hammer was configured successfully.' if result

data/definitions/procedures/knowledge_base_article.rb

@@ -6,8 +6,8 @@ class Procedures::KnowledgeBaseArticle < ForemanMaintain::Procedure
       feature(:instance).downstream
     end
     param :doc,
-          'Document name required to select a correct article',
-          :required => true
+      'Document name required to select a correct article',
+      :required => true
     advanced_run false
   end
 
@@ -25,8 +25,7 @@ class Procedures::KnowledgeBaseArticle < ForemanMaintain::Procedure
     {
       'fix_cpdb_validate_failure' => 'https://access.redhat.com/solutions/3362821',
       'fix_db_migrate_failure_on_duplicate_roles' => 'https://access.redhat.com/solutions/3998941',
-      'upgrade_puppet_guide_for_sat63' => 'https://access.redhat.com/documentation/en-us/red_hat_satellite/6.3/html/upgrading_and_updating_red_hat_satellite/upgrading_puppet-1',
-      'many_fact_values' => 'https://access.redhat.com/solutions/4163891'
+      'many_fact_values' => 'https://access.redhat.com/solutions/4163891',
     }
   end
 end

data/definitions/procedures/packages/enable_modules.rb

@@ -3,7 +3,7 @@ module Procedures::Packages
     metadata do
       description 'Enable the given stream modules'
       confine do
-        package_manager.class.name == 'ForemanMaintain::PackageManager::Dnf'
+        package_manager.instance_of?(ForemanMaintain::PackageManager::Dnf)
       end
       param :module_names, 'Module names', :array => true, :required => true
       advanced_run false

data/definitions/procedures/packages/install.rb

@@ -6,7 +6,7 @@ module Procedures::Packages
       param :assumeyes, 'Do not ask for confirmation'
       param :force, 'Do not skip if package is installed', :flag => true, :default => false
       param :warn_on_errors, 'Do not interrupt scenario on failure',
-            :flag => true, :default => false
+        :flag => true, :default => false
     end
 
     def run

data/definitions/procedures/packages/uninstall.rb

@@ -5,7 +5,7 @@ module Procedures::Packages
       param :packages, 'List of packages to uninstall', :array => true
       param :assumeyes, 'Do not ask for confirmation'
       param :warn_on_errors, 'Do not interrupt scenario on failure',
-            :flag => true, :default => false
+        :flag => true, :default => false
     end
 
     def run

data/definitions/procedures/packages/update.rb

@@ -5,7 +5,7 @@ module Procedures::Packages
       param :assumeyes, 'Do not ask for confirmation'
       param :force, 'Do not skip if package is installed', :flag => true, :default => false
       param :warn_on_errors, 'Do not interrupt scenario on failure',
-            :flag => true, :default => false
+        :flag => true, :default => false
       param :yum_options, 'Extra yum options if any', :array => true, :default => []
     end
 

data/definitions/procedures/remote_execution/remove_existing_settingsd.rb

@@ -2,8 +2,8 @@ module Procedures::RemoteExecution
   class RemoveExistingSettingsd < ForemanMaintain::Procedure
     metadata do
       param :dirpath,
-            'Directory path for settings.d folder',
-            :required => true
+        '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

data/definitions/procedures/repositories/enable.rb

@@ -3,7 +3,7 @@ module Procedures::Repositories
     metadata do
       param :repos, 'Array of repositories to enable'
       param :use_rhsm, 'Use RHSM to enable repository',
-            :flag => true, :default => false
+        :flag => true, :default => false
       description 'Enable repositories'
     end
     def run

data/definitions/procedures/repositories/setup.rb

@@ -6,8 +6,8 @@ module Procedures::Repositories
         feature(:instance).downstream || feature(:upstream)
       end
       param :version,
-            'Version for which repositories needs to be setup',
-            :required => true
+        'Version for which repositories needs to be setup',
+        :required => true
       run_once
     end
 

data/definitions/procedures/restore/candlepin_dump.rb

@@ -3,8 +3,8 @@ module Procedures::Restore
     metadata do
       description 'Restore candlepin postgresql dump from backup'
       param :backup_dir,
-            'Path to backup directory',
-            :required => true
+        'Path to backup directory',
+        :required => true
       preparation_steps { Checks::Candlepin::DBUp.new }
       confine do
         feature(:candlepin_database)

data/definitions/procedures/restore/configs.rb

@@ -4,8 +4,8 @@ module Procedures::Restore
       description 'Restore configs from backup'
 
       param :backup_dir,
-            'Path to backup directory',
-            :required => true
+        'Path to backup directory',
+        :required => true
     end
 
     def run
@@ -15,11 +15,9 @@ module Procedures::Restore
         clean_conflicting_data
         restore_configs(backup)
         reset_qpid_jrnls
-        reload_configs
       end
     end
 
-    # rubocop:disable  Metrics/MethodLength
     def restore_configs(backup)
       exclude = ForemanMaintain.available_features.each_with_object([]) do |feat, cfgs|
         if backup.online_backup?
@@ -35,16 +33,11 @@ module Procedures::Restore
         :directory => '/',
         :archive => backup.file_map[:config_files][:path],
         :gzip => true,
-        :exclude => exclude
+        :exclude => exclude,
       }
 
       feature(:tar).run(tar_options)
     end
-    # rubocop:enable  Metrics/MethodLength
-
-    def reload_configs
-      feature(:mongo).reload_db_config if feature(:mongo)
-    end
 
     private
 

data/definitions/procedures/restore/drop_databases.rb

@@ -4,8 +4,8 @@ module Procedures::Restore
       description 'Drop postgresql databases'
 
       param :backup_dir,
-            'Path to backup directory',
-            :required => true
+        'Path to backup directory',
+        :required => true
 
       confine do
         feature(:foreman_database) || feature(:candlepin_database) || feature(:pulpcore_database)

data/definitions/procedures/restore/extract_files.rb

@@ -4,8 +4,8 @@ module Procedures::Restore
       description 'Extract any existing tar files in backup'
 
       param :backup_dir,
-            'Path to backup directory',
-            :required => true
+        'Path to backup directory',
+        :required => true
     end
 
     def run
@@ -15,10 +15,6 @@ module Procedures::Restore
           spinner.update('Extracting pulp data')
           extract_pulp_data(backup)
         end
-        if backup.file_map[:mongo_data][:present]
-          spinner.update('Extracting mongo data')
-          extract_mongo_data(backup)
-        end
         if backup.file_map[:pgsql_data][:present]
           spinner.update('Extracting pgsql data')
           extract_pgsql_data(backup)
@@ -32,7 +28,7 @@ module Procedures::Restore
         :absolute_names => true,
         :listed_incremental => '/dev/null',
         :command => 'extract',
-        :directory => '/'
+        :directory => '/',
       }
     end
 
@@ -52,14 +48,6 @@ module Procedures::Restore
       feature(:tar).run(pulp_data_tar)
     end
 
-    def extract_mongo_data(backup)
-      mongo_data_tar = base_tar.merge(
-        :archive => backup.file_map[:mongo_data][:path],
-        :gzip => true
-      )
-      feature(:tar).run(mongo_data_tar)
-    end
-
     def any_database
       feature(:foreman_database) || feature(:candlepin_database) || feature(:pulpcore_database)
     end
@@ -67,8 +55,7 @@ module Procedures::Restore
     def extract_pgsql_data(backup)
       pgsql_data_tar = base_tar.merge(
         :archive => backup.file_map[:pgsql_data][:path],
-        :gzip => true,
-        :transform => any_database.restore_transform
+        :gzip => true
       )
       feature(:tar).run(pgsql_data_tar)
       del_data_dir_param if el?

data/definitions/procedures/restore/foreman_dump.rb

@@ -3,8 +3,8 @@ module Procedures::Restore
     metadata do
       description 'Restore foreman postgresql dump from backup'
       param :backup_dir,
-            'Path to backup directory',
-            :required => true
+        'Path to backup directory',
+        :required => true
       preparation_steps { Checks::Foreman::DBUp.new }
       confine do
         feature(:foreman_database)

data/definitions/procedures/restore/installer_reset.rb

@@ -20,8 +20,7 @@ module Procedures::Restore
       # We always disable system checks to avoid unnecessary errors. The installer should have
       # already ran since this is to be run on an existing system, which means installer checks
       # has already been skipped
-      if feature(:foreman_proxy) &&
-         feature(:foreman_proxy).with_content? &&
+      if feature(:foreman_proxy)&.with_content? &&
          check_max_version('foreman-installer', '3.4')
         installer << '--disable-system-checks '
       end

data/definitions/procedures/restore/postgres_owner.rb

@@ -5,8 +5,8 @@ module Procedures::Restore
       description 'Make postgres owner of backup directory'
 
       param :backup_dir,
-            'Path to backup directory',
-            :required => true
+        'Path to backup directory',
+        :required => true
     end
 
     def run

data/definitions/procedures/restore/pulpcore_dump.rb

@@ -3,8 +3,8 @@ module Procedures::Restore
     metadata do
       description 'Restore pulpcore postgresql dump from backup'
       param :backup_dir,
-            'Path to backup directory',
-            :required => true
+        'Path to backup directory',
+        :required => true
       preparation_steps { Checks::Pulpcore::DBUp.new }
       confine do
         feature(:pulpcore_database)

data/definitions/procedures/selinux/set_file_security.rb

@@ -4,8 +4,8 @@ module Procedures::Selinux
       description 'Setting file security'
 
       param :incremental_backup,
-            'Is the backup incremental?',
-            :required => true
+        'Is the backup incremental?',
+        :required => true
       manual_detection
       confine do
         File.directory?('/sys/fs/selinux')

data/definitions/procedures/service/restart.rb

@@ -6,7 +6,7 @@ module Procedures::Service
       description 'Restart applicable services'
       Base.common_params(self)
       param :wait_for_server_response,
-            'Wait for server ping to return successfully before terminating'
+        'Wait for server ping to return successfully before terminating'
     end
 
     RETRIES_FOR_SERVICES_RESTART = 5

data/definitions/scenarios/backup.rb

@@ -6,7 +6,7 @@ module ForemanMaintain::Scenarios
       tags :backup
       run_strategy :fail_fast
       param :strategy, 'Backup strategy. One of [:online, :offline, :snapshot]',
-            :required => true
+        :required => true
       param :backup_dir, 'Directory where to backup to', :required => true
       param :mount_dir, 'Snapshot mount directory'
       param :include_db_dumps, 'Include dumps of local dbs as part of offline'
@@ -19,7 +19,6 @@ module ForemanMaintain::Scenarios
       param :tar_volume_size, 'Size of tar volume (indicates splitting)'
     end
 
-    # rubocop:disable Metrics/MethodLength
     def compose
       check_valid_startegy
       safety_confirmation
@@ -39,7 +38,6 @@ module ForemanMaintain::Scenarios
       end
       add_step_with_context(Procedures::Backup::CompressData)
     end
-    # rubocop:enable Metrics/MethodLength
 
     def deb_snapshot_msg
       if debian_or_ubuntu?
@@ -51,60 +49,54 @@ module ForemanMaintain::Scenarios
     # rubocop:disable  Metrics/MethodLength
     def set_context_mapping
       context.map(:backup_dir,
-                  Checks::Backup::DirectoryReady => :backup_dir,
-                  Procedures::Backup::PrepareDirectory => :backup_dir,
-                  Procedures::Backup::Metadata => :backup_dir,
-                  Procedures::Backup::ConfigFiles => :backup_dir,
-                  Procedures::Backup::CompressData => :backup_dir,
-                  Procedures::Backup::Pulp => :backup_dir,
-                  Procedures::Backup::Online::Mongo => :backup_dir,
-                  Procedures::Backup::Online::CandlepinDB => :backup_dir,
-                  Procedures::Backup::Online::ForemanDB => :backup_dir,
-                  Procedures::Backup::Online::PulpcoreDB => :backup_dir,
-                  Procedures::Backup::Offline::CandlepinDB => :backup_dir,
-                  Procedures::Backup::Offline::ForemanDB => :backup_dir,
-                  Procedures::Backup::Offline::PulpcoreDB => :backup_dir,
-                  Procedures::Backup::Offline::Mongo => :backup_dir,
-                  Procedures::Backup::Snapshot::LogicalVolumeConfirmation => :backup_dir,
-                  Procedures::Backup::Snapshot::MountCandlepinDB => :backup_dir,
-                  Procedures::Backup::Snapshot::MountForemanDB => :backup_dir,
-                  Procedures::Backup::Snapshot::MountPulpcoreDB => :backup_dir,
-                  Procedures::Backup::Snapshot::MountMongo => :backup_dir)
+        Checks::Backup::DirectoryReady => :backup_dir,
+        Procedures::Backup::PrepareDirectory => :backup_dir,
+        Procedures::Backup::Metadata => :backup_dir,
+        Procedures::Backup::ConfigFiles => :backup_dir,
+        Procedures::Backup::CompressData => :backup_dir,
+        Procedures::Backup::Pulp => :backup_dir,
+        Procedures::Backup::Online::CandlepinDB => :backup_dir,
+        Procedures::Backup::Online::ForemanDB => :backup_dir,
+        Procedures::Backup::Online::PulpcoreDB => :backup_dir,
+        Procedures::Backup::Offline::CandlepinDB => :backup_dir,
+        Procedures::Backup::Offline::ForemanDB => :backup_dir,
+        Procedures::Backup::Offline::PulpcoreDB => :backup_dir,
+        Procedures::Backup::Snapshot::LogicalVolumeConfirmation => :backup_dir,
+        Procedures::Backup::Snapshot::MountCandlepinDB => :backup_dir,
+        Procedures::Backup::Snapshot::MountForemanDB => :backup_dir,
+        Procedures::Backup::Snapshot::MountPulpcoreDB => :backup_dir)
       context.map(:preserve_dir,
-                  Checks::Backup::DirectoryReady => :preserve_dir,
-                  Procedures::Backup::PrepareDirectory => :preserve_dir)
+        Checks::Backup::DirectoryReady => :preserve_dir,
+        Procedures::Backup::PrepareDirectory => :preserve_dir)
       context.map(:incremental_dir,
-                  Procedures::Backup::PrepareDirectory => :incremental_dir,
-                  Procedures::Backup::Metadata => :incremental_dir)
+        Procedures::Backup::PrepareDirectory => :incremental_dir,
+        Procedures::Backup::Metadata => :incremental_dir)
       context.map(:proxy_features,
-                  Procedures::Backup::ConfigFiles => :proxy_features)
+        Procedures::Backup::ConfigFiles => :proxy_features)
       context.map(:snapshot_mount_dir,
-                  Procedures::Backup::Snapshot::PrepareMount => :mount_dir,
-                  Procedures::Backup::Snapshot::MountMongo => :mount_dir,
-                  Procedures::Backup::Snapshot::MountPulp => :mount_dir,
-                  Procedures::Backup::Snapshot::CleanMount => :mount_dir,
-                  Procedures::Backup::Snapshot::MountCandlepinDB => :mount_dir,
-                  Procedures::Backup::Snapshot::MountForemanDB => :mount_dir,
-                  Procedures::Backup::Snapshot::MountPulpcoreDB => :mount_dir,
-                  Procedures::Backup::Offline::Mongo => :mount_dir,
-                  Procedures::Backup::Pulp => :mount_dir,
-                  Procedures::Backup::Offline::CandlepinDB => :mount_dir,
-                  Procedures::Backup::Offline::ForemanDB => :mount_dir,
-                  Procedures::Backup::Offline::PulpcoreDB => :mount_dir)
+        Procedures::Backup::Snapshot::PrepareMount => :mount_dir,
+        Procedures::Backup::Snapshot::MountPulp => :mount_dir,
+        Procedures::Backup::Snapshot::CleanMount => :mount_dir,
+        Procedures::Backup::Snapshot::MountCandlepinDB => :mount_dir,
+        Procedures::Backup::Snapshot::MountForemanDB => :mount_dir,
+        Procedures::Backup::Snapshot::MountPulpcoreDB => :mount_dir,
+        Procedures::Backup::Pulp => :mount_dir,
+        Procedures::Backup::Offline::CandlepinDB => :mount_dir,
+        Procedures::Backup::Offline::ForemanDB => :mount_dir,
+        Procedures::Backup::Offline::PulpcoreDB => :mount_dir)
       context.map(:snapshot_block_size,
-                  Procedures::Backup::Snapshot::MountMongo => :block_size,
-                  Procedures::Backup::Snapshot::MountPulp => :block_size,
-                  Procedures::Backup::Snapshot::MountForemanDB => :block_size,
-                  Procedures::Backup::Snapshot::MountCandlepinDB => :block_size,
-                  Procedures::Backup::Snapshot::MountPulpcoreDB => :block_size)
+        Procedures::Backup::Snapshot::MountPulp => :block_size,
+        Procedures::Backup::Snapshot::MountForemanDB => :block_size,
+        Procedures::Backup::Snapshot::MountCandlepinDB => :block_size,
+        Procedures::Backup::Snapshot::MountPulpcoreDB => :block_size)
       context.map(:skip_pulp_content,
-                  Procedures::Backup::Pulp => :skip,
-                  Procedures::Backup::Snapshot::LogicalVolumeConfirmation => :skip_pulp,
-                  Procedures::Backup::Snapshot::MountPulp => :skip)
+        Procedures::Backup::Pulp => :skip,
+        Procedures::Backup::Snapshot::LogicalVolumeConfirmation => :skip_pulp,
+        Procedures::Backup::Snapshot::MountPulp => :skip)
       context.map(:tar_volume_size,
-                  Procedures::Backup::Pulp => :tar_volume_size)
+        Procedures::Backup::Pulp => :tar_volume_size)
       context.map(:include_db_dumps,
-                  Procedures::Backup::Online::SafetyConfirmation => :include_db_dumps)
+        Procedures::Backup::Online::SafetyConfirmation => :include_db_dumps)
     end
     # rubocop:enable  Metrics/MethodLength
 
@@ -149,7 +141,6 @@ module ForemanMaintain::Scenarios
         Procedures::Service::Stop,
         Procedures::Backup::ConfigFiles,
         Procedures::Backup::Pulp,
-        Procedures::Backup::Offline::Mongo,
         Procedures::Backup::Offline::CandlepinDB,
         Procedures::Backup::Offline::ForemanDB,
         Procedures::Backup::Offline::PulpcoreDB,
@@ -168,9 +159,6 @@ module ForemanMaintain::Scenarios
       if feature(:instance).database_local?(:pulpcore_database)
         add_step_with_context(Procedures::Backup::Online::PulpcoreDB)
       end
-      if feature(:instance).database_local?(:mongo)
-        add_step_with_context(Procedures::Backup::Online::Mongo)
-      end
     end
 
     # rubocop:disable  Metrics/MethodLength
@@ -182,7 +170,6 @@ module ForemanMaintain::Scenarios
         find_procedures(:maintenance_mode_on),
         Procedures::Service::Stop,
         Procedures::Backup::ConfigFiles,
-        Procedures::Backup::Snapshot::MountMongo,
         Procedures::Backup::Snapshot::MountPulp,
         Procedures::Backup::Snapshot::MountCandlepinDB,
         Procedures::Backup::Snapshot::MountForemanDB,
@@ -200,9 +187,6 @@ module ForemanMaintain::Scenarios
       if feature(:instance).database_local?(:pulpcore_database)
         add_step_with_context(Procedures::Backup::Offline::PulpcoreDB)
       end
-      if feature(:instance).database_local?(:mongo)
-        add_step_with_context(Procedures::Backup::Offline::Mongo)
-      end
       add_step_with_context(Procedures::Backup::Snapshot::CleanMount)
     end
     # rubocop:enable  Metrics/MethodLength
@@ -212,7 +196,6 @@ module ForemanMaintain::Scenarios
                                                              :online_backup => true)
       add_step_with_context(Procedures::Backup::Pulp, :ensure_unchanged => true)
       add_steps_with_context(
-        Procedures::Backup::Online::Mongo,
         Procedures::Backup::Online::CandlepinDB,
         Procedures::Backup::Online::ForemanDB,
         Procedures::Backup::Online::PulpcoreDB
@@ -253,11 +236,11 @@ module ForemanMaintain::Scenarios
 
     def set_context_mapping
       context.map(:snapshot_mount_dir,
-                  Procedures::Backup::Snapshot::CleanMount => :mount_dir)
+        Procedures::Backup::Snapshot::CleanMount => :mount_dir)
       context.map(:backup_dir,
-                  Procedures::Backup::Clean => :backup_dir)
+        Procedures::Backup::Clean => :backup_dir)
       context.map(:preserve_dir,
-                  Procedures::Backup::Clean => :preserve_dir)
+        Procedures::Backup::Clean => :preserve_dir)
     end
 
     private

data/definitions/scenarios/packages.rb

@@ -73,12 +73,12 @@ module ForemanMaintain::Scenarios
       def compose
         if Packages.skip_installer_run?(context.get(:packages))
           add_step_with_context(Procedures::Packages::Install,
-                                :force => true, :warn_on_errors => true)
+            :force => true, :warn_on_errors => true)
         else
           add_step_with_context(Procedures::Packages::InstallerConfirmation)
           add_step_with_context(Procedures::Packages::UnlockVersions)
           add_step_with_context(Procedures::Packages::Install,
-                                :force => true, :warn_on_errors => true)
+            :force => true, :warn_on_errors => true)
           add_step_with_context(Procedures::Installer::Upgrade)
           add_step(Procedures::Packages::LockingStatus)
         end
@@ -86,9 +86,9 @@ module ForemanMaintain::Scenarios
 
       def set_context_mapping
         context.map(:packages,
-                    Procedures::Packages::Install => :packages)
+          Procedures::Packages::Install => :packages)
         context.map(:assumeyes,
-                    Procedures::Packages::Install => :assumeyes)
+          Procedures::Packages::Install => :assumeyes)
       end
     end
 
@@ -103,7 +103,7 @@ module ForemanMaintain::Scenarios
       def compose
         if Packages.skip_installer_run?(context.get(:packages))
           add_step_with_context(Procedures::Packages::Update,
-                                :force => true, :warn_on_errors => true)
+            :force => true, :warn_on_errors => true)
         else
           add_steps_with_context(
             Procedures::Packages::UpdateAllConfirmation,
@@ -111,7 +111,7 @@ module ForemanMaintain::Scenarios
           )
           add_step_with_context(Procedures::Packages::UnlockVersions)
           add_step_with_context(Procedures::Packages::Update,
-                                :force => true, :warn_on_errors => true)
+            :force => true, :warn_on_errors => true)
           add_step_with_context(Procedures::Installer::Upgrade)
           add_step(Procedures::Packages::LockingStatus)
         end
@@ -119,10 +119,10 @@ module ForemanMaintain::Scenarios
 
       def set_context_mapping
         context.map(:packages,
-                    Procedures::Packages::Update => :packages,
-                    Procedures::Packages::UpdateAllConfirmation => :packages)
+          Procedures::Packages::Update => :packages,
+          Procedures::Packages::UpdateAllConfirmation => :packages)
         context.map(:assumeyes,
-                    Procedures::Packages::Update => :assumeyes)
+          Procedures::Packages::Update => :assumeyes)
       end
     end
   end