foreman_maintain 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f9e8ef6df753833b37ddddb8923706bfe5f53671e3cf21dd3706227f759d292
-  data.tar.gz: 43d73546fe50ec575de65b7c27b4b05df136ee1ed8076921a3b6548b310dca39
+  metadata.gz: 6fabde56ed1a12feb739b6776178693bc779dae8ae3d71ba11b5612c09cd3837
+  data.tar.gz: 24c1ea2e3a56c4a72e444808853d61e0abf56134e071b4d89c4ee501bb6fbedf
 SHA512:
-  metadata.gz: 2f4d2397cd58b6223f823c599c33695f1d814e24d782f0ee60ef97db953b741e7ad1502ec01f5cf8e24beb472360c16b0434e98461e444a42d3121f49e997a50
-  data.tar.gz: b09a486b783897e76cc6c70de5ce569bc5889c26a798beb01ab861a9d8baae8884e5160517875a91ad0c71e13fb773e66c97dd05c4c00be2a70fe1753aebe62f
+  metadata.gz: 13fa993d11f4b56cc24d538fd7b9d1b86e39baaad5971266ab8de8a07151d875c6066481b91edadfc5beabd041f4e09b07b298b42ebdc45a1c7c5852d7ac0268
+  data.tar.gz: 00b68e16dca36bf7c71634a98aa7e4d78846aa5ca5b4cfcbc183dd3b492522c53c02793a215da18048f480a002487e95fe6d9965e5b6c1d382a889fb4dd46598

data/definitions/checks/backup/directory_ready.rb

@@ -6,11 +6,13 @@ module Checks::Backup
       manual_detection
       param :backup_dir, 'Directory where to backup to', :required => true
       param :preserve_dir, 'Directory where to backup to', :flag => true, :default => false
+      param :postgres_access, 'Whether the postgres user needs access', :flag => true,
+        :default => false
     end
 
     def run
       assert(File.directory?(@backup_dir), "Backup directory (#{@backup_dir}) does not exist.")
-      if feature(:instance).postgresql_local?
+      if feature(:instance).postgresql_local? && @postgres_access
         result = system("runuser - postgres -c 'test -w #{@backup_dir}'")
         assert(result, "Postgres user needs write access to the backup directory \n" \
           "Please allow the postgres user write access to #{@backup_dir}" \

data/definitions/features/foreman_server.rb

@@ -10,11 +10,7 @@ module ForemanMaintain
       end
 
       def services
-        if execute?('systemctl is-enabled foreman')
-          [system_service('foreman', 30, :socket => 'foreman')]
-        else
-          [system_service('httpd', 30)]
-        end
+        [system_service('foreman', 30, :socket => 'foreman')]
       end
 
       def plugins

data/definitions/features/pulpcore.rb

@@ -5,17 +5,13 @@ class Features::Pulpcore < ForemanMaintain::Feature
 
   metadata do
     label :pulpcore
-
-    confine do
-      ForemanMaintain::Utils::Service::Systemd.new('pulpcore-api', 0).enabled?
-    end
   end
 
   def services
     redis_services = feature(:redis) ? feature(:redis).services : []
 
     self.class.pulpcore_common_services + configured_workers +
-      redis_services + feature(:apache).services
+      redis_services
   end
 
   def configured_workers
@@ -27,15 +23,6 @@ class Features::Pulpcore < ForemanMaintain::Feature
     end
   end
 
-  def self.pulpcore_migration_services
-    pulpcore_common_services + [
-      ForemanMaintain::Utils.system_service('pulpcore-worker@1', 20),
-      ForemanMaintain::Utils.system_service('pulpcore-worker@2', 20),
-      ForemanMaintain::Utils.system_service('pulpcore-worker@3', 20),
-      ForemanMaintain::Utils.system_service('pulpcore-worker@4', 20),
-    ]
-  end
-
   def config_files
     [
       '/etc/pulp/settings.py',
@@ -44,22 +31,9 @@ class Features::Pulpcore < ForemanMaintain::Feature
   end
 
   def self.pulpcore_common_services
-    common_services = [
+    [
       ForemanMaintain::Utils.system_service('pulpcore-api', 10, :socket => 'pulpcore-api'),
       ForemanMaintain::Utils.system_service('pulpcore-content', 10, :socket => 'pulpcore-content'),
     ]
-    common_services + pulpcore_resource_manager_service
-  end
-
-  def self.pulpcore_resource_manager_service
-    # The pulpcore_resource_manager is only required on 3.14+
-    # if the old tasking system is being used
-    # The foreman-installer does not create unit file for this service,
-    # if the new tasking system is being used
-    if feature(:service).unit_file_available?('pulpcore-resource-manager.service')
-      return [ForemanMaintain::Utils.system_service('pulpcore-resource-manager', 10)]
-    end
-
-    []
   end
 end

data/definitions/procedures/packages/update.rb

@@ -27,7 +27,11 @@ module Procedures::Packages
     end
 
     def description
-      "Update package(s) #{@packages.join(', ')}"
+      if @yum_options.include?('--downloadonly')
+        "Download package(s) #{@packages.join(', ')}"
+      else
+        "Update package(s) #{@packages.join(', ')}"
+      end
     end
   end
 end

data/definitions/procedures/pulpcore/migrate.rb

@@ -1,6 +1,7 @@
 module Procedures::Pulpcore
   class Migrate < ForemanMaintain::Procedure
     include ForemanMaintain::Concerns::SystemService
+    include ForemanMaintain::Concerns::PulpCommon
 
     metadata do
       description 'Migrate pulpcore db'
@@ -16,9 +17,7 @@ module Procedures::Pulpcore
         feature(:service).handle_services(spinner, 'stop', :only => pulp_services)
 
         spinner.update('Migrating pulpcore database')
-        execute!('sudo PULP_SETTINGS=/etc/pulp/settings.py '\
-          'DJANGO_SETTINGS_MODULE=pulpcore.app.settings '\
-          'pulpcore-manager migrate --noinput')
+        execute!(pulpcore_manager('migrate --noinput'))
       end
     end
   end

data/definitions/procedures/pulpcore/trim_rpm_changelogs.rb

@@ -1,6 +1,7 @@
 module Procedures::Pulpcore
   class TrimRpmChangelogs < ForemanMaintain::Procedure
     include ForemanMaintain::Concerns::SystemService
+    include ForemanMaintain::Concerns::PulpCommon
 
     metadata do
       description 'Trim RPM changelogs in the pulpcore db'
@@ -14,9 +15,7 @@ module Procedures::Pulpcore
         feature(:service).handle_services(spinner, 'start', :only => necessary_services)
 
         spinner.update('Trimming RPM changelogs')
-        execute!('sudo PULP_SETTINGS=/etc/pulp/settings.py '\
-          'DJANGO_SETTINGS_MODULE=pulpcore.app.settings '\
-          'pulpcore-manager rpm-trim-changelogs')
+        execute!(pulpcore_manager('rpm-trim-changelogs'))
       end
     end
   end

data/definitions/procedures/restore/required_packages.rb

@@ -0,0 +1,23 @@
+module Procedures::Restore
+  class RequiredPackages < ForemanMaintain::Procedure
+    metadata do
+      description 'Ensure required packages are installed before restore'
+
+      param :backup_dir,
+        'Path to backup directory',
+        :required => true
+    end
+
+    def run
+      backup = ForemanMaintain::Utils::Backup.new(@backup_dir)
+      required_packages = []
+      required_packages << 'puppetserver' if backup.with_puppetserver?
+      required_packages << 'qpid-cpp-server' if backup.with_qpidd?
+      if required_packages.any?
+        with_spinner('Installing required packages') do
+          ForemanMaintain.package_manager.install(required_packages, assumeyes: true)
+        end
+      end
+    end
+  end
+end

data/definitions/procedures/service/restart.rb

@@ -13,8 +13,7 @@ module Procedures::Service
     PING_RETRY_INTERVAL = 30
 
     def run
-      run_service_action('stop', common_options)
-      run_service_action('start', common_options)
+      run_service_action('restart', common_options)
       server_ping_retry if @wait_for_server_response
     end
 

data/definitions/scenarios/backup.rb

@@ -103,10 +103,9 @@ module ForemanMaintain::Scenarios
     private
 
     def prepare_directory
-      add_steps_with_context(
-        Procedures::Backup::PrepareDirectory,
-        Checks::Backup::DirectoryReady
-      )
+      add_step_with_context(Procedures::Backup::PrepareDirectory)
+      add_step_with_context(Checks::Backup::DirectoryReady,
+        :postgres_access => online_backup? || include_db_dumps?)
     end
 
     def logical_volume_confirmation

data/definitions/scenarios/restore.rb

@@ -28,6 +28,7 @@ module ForemanMaintain::Scenarios
 
       add_steps_with_context(Procedures::Restore::Confirmation,
         Procedures::Selinux::SetFileSecurity,
+        Procedures::Restore::RequiredPackages,
         Procedures::Restore::Configs)
       add_step_with_context(Procedures::Crond::Stop) if feature(:cron)
       unless backup.incremental?
@@ -88,6 +89,7 @@ module ForemanMaintain::Scenarios
         Checks::Restore::ValidateHostname => :backup_dir,
         Checks::Restore::ValidateInterfaces => :backup_dir,
         Checks::Restore::ValidatePostgresqlDumpPermissions => :backup_dir,
+        Procedures::Restore::RequiredPackages => :backup_dir,
         Procedures::Restore::Configs => :backup_dir,
         Procedures::Restore::DropDatabases => :backup_dir,
         Procedures::Restore::CandlepinDump => :backup_dir,

data/definitions/scenarios/upgrade_to_capsule_6_14.rb

@@ -40,7 +40,6 @@ module Scenarios::Capsule_6_14
 
     def compose
       add_steps(find_procedures(:pre_migrations))
-      add_step(Procedures::Service::Stop.new)
     end
   end
 
@@ -58,7 +57,9 @@ module Scenarios::Capsule_6_14
       add_step(Procedures::Repositories::Setup.new(:version => '6.14'))
       modules_to_enable = ["satellite-capsule:#{el_short_name}"]
       add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
-      add_step(Procedures::Packages::UnlockVersions.new)
+      add_step(Procedures::Packages::Update.new(:assumeyes => true,
+        :yum_options => ['--downloadonly']))
+      add_step(Procedures::Service::Stop.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step_with_context(Procedures::Installer::Upgrade)
     end

data/definitions/scenarios/upgrade_to_capsule_6_14_z.rb

@@ -40,7 +40,6 @@ module Scenarios::Capsule_6_14_z
 
     def compose
       add_steps(find_procedures(:pre_migrations))
-      add_step(Procedures::Service::Stop.new)
     end
   end
 
@@ -58,7 +57,9 @@ module Scenarios::Capsule_6_14_z
       add_step(Procedures::Repositories::Setup.new(:version => '6.14'))
       modules_to_enable = ["satellite-capsule:#{el_short_name}"]
       add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
-      add_step(Procedures::Packages::UnlockVersions.new)
+      add_step(Procedures::Packages::Update.new(:assumeyes => true,
+        :yum_options => ['--downloadonly']))
+      add_step(Procedures::Service::Stop.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step_with_context(Procedures::Installer::Upgrade)
     end

data/definitions/scenarios/upgrade_to_katello_nightly.rb

@@ -54,6 +54,9 @@ module Scenarios::Katello_Nightly
       add_step(Procedures::Repositories::Setup.new(:version => 'nightly'))
       modules_to_enable = ["katello:#{el_short_name}", "pulpcore:#{el_short_name}"]
       add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
+      add_step(Procedures::Packages::Update.new(:assumeyes => true,
+        :yum_options => ['--downloadonly']))
+      add_step(Procedures::Service::Stop.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step_with_context(Procedures::Installer::Upgrade)
     end

data/definitions/scenarios/upgrade_to_satellite_6_14.rb

@@ -40,7 +40,6 @@ module Scenarios::Satellite_6_14
 
     def compose
       add_steps(find_procedures(:pre_migrations))
-      add_step(Procedures::Service::Stop.new)
     end
   end
 
@@ -59,7 +58,9 @@ module Scenarios::Satellite_6_14
       add_step(Procedures::Repositories::Setup.new(:version => '6.14'))
       modules_to_enable = ["satellite:#{el_short_name}"]
       add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
-      add_step(Procedures::Packages::UnlockVersions.new)
+      add_step(Procedures::Packages::Update.new(:assumeyes => true,
+        :yum_options => ['--downloadonly']))
+      add_step(Procedures::Service::Stop.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step_with_context(Procedures::Installer::Upgrade)
       add_step(Procedures::Installer::UpgradeRakeTask)

data/definitions/scenarios/upgrade_to_satellite_6_14_z.rb

@@ -40,7 +40,6 @@ module Scenarios::Satellite_6_14_z
 
     def compose
       add_steps(find_procedures(:pre_migrations))
-      add_step(Procedures::Service::Stop.new)
     end
   end
 
@@ -58,7 +57,9 @@ module Scenarios::Satellite_6_14_z
       add_step(Procedures::Repositories::Setup.new(:version => '6.14'))
       modules_to_enable = ["satellite:#{el_short_name}"]
       add_step(Procedures::Packages::EnableModules.new(:module_names => modules_to_enable))
-      add_step(Procedures::Packages::UnlockVersions.new)
+      add_step(Procedures::Packages::Update.new(:assumeyes => true,
+        :yum_options => ['--downloadonly']))
+      add_step(Procedures::Service::Stop.new)
       add_step(Procedures::Packages::Update.new(:assumeyes => true))
       add_step_with_context(Procedures::Installer::Upgrade)
       add_step(Procedures::Installer::UpgradeRakeTask)

data/extras/foreman_protector/dnf/foreman-protector.py

@@ -4,14 +4,12 @@ from dnfpluginscore import _, logger
 
 import configparser
 
+PROTECT_COMMANDS = ('install', 'downgrade', 'reinstall', 'distro-sync', 'swap', 'upgrade', 'upgrade-minimal')
+
 class ForemanProtector(dnf.Plugin):
     name = 'foreman-protector'
     config_name = 'foreman-protector'
 
-    def __init__(self,base,cli):
-        self.base = base
-        self.cli = cli
-
     def _get_whitelist_file_url(self):
         try:
              parser = self.read_config(self.base.conf)
@@ -53,6 +51,8 @@ class ForemanProtector(dnf.Plugin):
         return final_query
 
     def sack(self):
+        if self.cli is not None and self.cli.command._basecmd not in PROTECT_COMMANDS:
+            return
         whitelist_and_obsoletes = self._add_obsoletes()
         all_available_packages = self.base.sack.query().available()
         excluded_pkgs_query = all_available_packages.difference(whitelist_and_obsoletes)

data/lib/foreman_maintain/concerns/pulp_common.rb

@@ -10,6 +10,10 @@ module ForemanMaintain
         # All below directories and their contents are regenerated on installer run
         %w[assets exports imports sync_imports tmp]
       end
+
+      def pulpcore_manager(command)
+        "PULP_SETTINGS=/etc/pulp/settings.py runuser -u pulp -- pulpcore-manager #{command}"
+      end
     end
   end
 end

data/lib/foreman_maintain/config.rb

@@ -28,7 +28,7 @@ module ForemanMaintain
     private
 
     def load_log_configs
-      @log_level = @options.fetch(:log_level, ::Logger::DEBUG)
+      @log_level = @options.fetch(:log_level, ::Logger::INFO)
       @log_dir = find_dir_path(@options.fetch(:log_dir, 'log'))
       @log_file_size = @options.fetch(:log_file_size, 10_000)
       # Note - If timestamp added to filename then number of log files i.e second

data/lib/foreman_maintain/package_manager/yum.rb

@@ -68,7 +68,7 @@ module ForemanMaintain::PackageManager
     end
 
     def check_update(packages: nil, with_status: false)
-      yum_action('check-update', packages, :assumeyes => true, :valid_exit_statuses => [100],
+      yum_action('check-update', packages, :assumeyes => true, :valid_exit_statuses => [0, 100],
                                            :with_status => with_status)
     end
 

data/lib/foreman_maintain/package_manager.rb

@@ -5,12 +5,12 @@ require 'foreman_maintain/package_manager/apt'
 
 module ForemanMaintain
   def self.package_manager
-    @package_manager ||= if el?
-                           ForemanMaintain::PackageManager::Dnf.new
-                         elsif debian_or_ubuntu?
-                           ForemanMaintain::PackageManager::Apt.new
-                         else
-                           raise 'No supported package manager was found'
-                         end
+    if el?
+      ForemanMaintain::PackageManager::Dnf.new
+    elsif debian_or_ubuntu?
+      ForemanMaintain::PackageManager::Apt.new
+    else
+      raise 'No supported package manager was found'
+    end
   end
 end

data/lib/foreman_maintain/utils/backup.rb

@@ -253,6 +253,18 @@ module ForemanMaintain
       def online_backup?
         !!metadata.fetch('online', false)
       end
+
+      def installed_rpms
+        metadata.fetch('rpms', metadata.fetch(:rpms, []))
+      end
+
+      def with_puppetserver?
+        installed_rpms.any? { |rpm| rpm.start_with?('puppetserver-') }
+      end
+
+      def with_qpidd?
+        installed_rpms.any? { |rpm| rpm.start_with?('qpid-cpp-server-') }
+      end
     end
   end
 end

data/lib/foreman_maintain/utils/service/systemd.rb

@@ -33,6 +33,10 @@ module ForemanMaintain::Utils
         execute('stop')
       end
 
+      def restart
+        execute('restart')
+      end
+
       def enable
         execute('enable')
       end

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '1.3.1'.freeze
+  VERSION = '1.3.3'.freeze
 end

data/lib/foreman_maintain.rb

@@ -143,7 +143,7 @@ module ForemanMaintain
       # convert size in KB to Bytes
       log_fsize = config.log_file_size.to_i * 1024
       @logger = Logger.new(config.log_filename, 10, log_fsize).tap do |logger|
-        logger.level = LOGGER_LEVEL_MAPPING[config.log_level] || Logger::DEBUG
+        logger.level = LOGGER_LEVEL_MAPPING[config.log_level] || Logger::INFO
         logger.datetime_format = '%Y-%m-%d %H:%M:%S%z '
       end
       pickup_log_messages
@@ -180,10 +180,11 @@ module ForemanMaintain
       puts "Checking for new version of #{package_name}..."
 
       enable_maintenance_module
+      package_manager = ForemanMaintain.package_manager
 
-      if ForemanMaintain.package_manager.update_available?(main_package_name)
+      if package_manager.update_available?(main_package_name)
         puts "\nUpdating #{package_name} package."
-        ForemanMaintain.package_manager.update(main_package_name, :assumeyes => true)
+        package_manager.update(main_package_name, :assumeyes => true)
         puts "\nThe #{package_name} package successfully updated."\
              "\nRe-run #{command} with required options!"
         exit 75

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -313,6 +313,7 @@ files:
 - definitions/procedures/restore/postgres_owner.rb
 - definitions/procedures/restore/pulpcore_dump.rb
 - definitions/procedures/restore/reindex_databases.rb
+- definitions/procedures/restore/required_packages.rb
 - definitions/procedures/selinux/set_file_security.rb
 - definitions/procedures/service/base.rb
 - definitions/procedures/service/daemon_reload.rb
@@ -451,7 +452,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Foreman maintenance tool belt