foreman_maintain 1.1.1 → 1.1.4

data/lib/foreman_maintain/package_manager/apt.rb

@@ -0,0 +1,71 @@
+module ForemanMaintain::PackageManager
+  class Apt < Base
+    def installed?(packages)
+      packages_list = [packages].flatten(1).map { |pkg| "'#{pkg}'" }.join(' ')
+      status, output = sys.execute_with_status(%(dpkg --status #{packages_list}))
+      return false if status != 0
+
+      status_of_pkg = output.split("\n").grep(/^Status:/).first
+      status_of_pkg.include?('installed')
+    end
+
+    def install(packages, assumeyes: false)
+      apt_action('install', packages, :assumeyes => assumeyes)
+    end
+
+    def remove(packages, assumeyes: false)
+      apt_action('remove', packages, :assumeyes => assumeyes)
+    end
+
+    def update(packages = [], assumeyes: false)
+      action = packages.any? ? '--only-upgrade install' : 'upgrade'
+      apt_action(action, packages, :assumeyes => assumeyes)
+    end
+
+    def clean_cache(assumeyes: false)
+      apt_action('clean', :assumeyes => assumeyes)
+    end
+
+    def find_installed_package(name, queryfm = '')
+      return unless installed?(name)
+
+      dpkg_cmd = "dpkg-query --show #{name}"
+      unless queryfm.empty?
+        dpkg_cmd = "dpkg-query --showformat='#{queryfm}' --show #{name}"
+      end
+      _, result = sys.execute_with_status(dpkg_cmd)
+      result
+    end
+
+    def check_update(packages: nil, with_status: false)
+      apt_action('upgrade --dry-run', packages, :with_status => with_status)
+    end
+
+    def list_installed_packages(queryfm = '${binary:Package}-${VERSION}\n')
+      # The queryfm should only include valid tag(s) as per `dpkg-query` man page.
+      # If any special formatting is required with querytag then it should be provided with tag i.e,
+      # querytag = "--%{VERSION}"
+      # The queryfm string must end with '\n'
+      sys.execute!("dpkg-query --showformat='#{queryfm}' -W").split("\n")
+    end
+
+    def version_locking_supported?
+      false
+    end
+
+    def apt_action(action, packages, with_status: false, assumeyes: false, valid_exit_statuses: [0])
+      apt_options = []
+      packages = [packages].flatten(1)
+      apt_options << '-y' if assumeyes
+      apt_options_s = apt_options.empty? ? '' : ' ' + apt_options.join(' ')
+      packages_s = packages.empty? ? '' : ' ' + packages.join(' ')
+      if with_status
+        sys.execute_with_status("apt-get#{apt_options_s} #{action}#{packages_s}",
+                                :interactive => !assumeyes)
+      else
+        sys.execute!("apt-get#{apt_options_s} #{action}#{packages_s}",
+                     :interactive => !assumeyes, :valid_exit_statuses => valid_exit_statuses)
+      end
+    end
+  end
+end

data/lib/foreman_maintain/package_manager/yum.rb

@@ -59,8 +59,8 @@ module ForemanMaintain::PackageManager
       yum_action('remove', packages, :assumeyes => assumeyes)
     end
 
-    def update(packages = [], assumeyes: false)
-      yum_action('update', packages, :assumeyes => assumeyes)
+    def update(packages = [], assumeyes: false, yum_options: [])
+      yum_action('update', packages, :assumeyes => assumeyes, :yum_options => yum_options)
     end
 
     def clean_cache(assumeyes: false)
@@ -120,8 +120,12 @@ module ForemanMaintain::PackageManager
       File.open(protector_config_file, 'w') { |file| file.puts config }
     end
 
-    def yum_action(action, packages, with_status: false, assumeyes: false, valid_exit_statuses: [0])
-      yum_options = []
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def yum_action(action, packages, options)
+      with_status = options.fetch(:with_status, false)
+      assumeyes = options.fetch(:assumeyes, false)
+      valid_exit_statuses = options.fetch(:valid_exit_statuses, [0])
+      yum_options = options.fetch(:yum_options, [])
       packages = [packages].flatten(1)
       yum_options << '-y' if assumeyes
       yum_options << '--disableplugin=foreman-protector'

data/lib/foreman_maintain/package_manager.rb

@@ -1,14 +1,16 @@
 require 'foreman_maintain/package_manager/base'
 require 'foreman_maintain/package_manager/yum'
 require 'foreman_maintain/package_manager/dnf'
+require 'foreman_maintain/package_manager/apt'
 
 module ForemanMaintain
   def self.package_manager
-    @package_manager ||= case (%w[dnf yum apt].find { |manager| !`command -v #{manager}`.empty? })
-                         when 'dnf'
-                           ForemanMaintain::PackageManager::Dnf.new
-                         when 'yum'
+    @package_manager ||= if el7?
                            ForemanMaintain::PackageManager::Yum.new
+                         elsif el?
+                           ForemanMaintain::PackageManager::Dnf.new
+                         elsif debian_or_ubuntu?
+                           ForemanMaintain::PackageManager::Apt.new
                          else
                            raise 'No supported package manager was found'
                          end

data/lib/foreman_maintain/reporter/cli_reporter.rb

@@ -317,7 +317,11 @@ module ForemanMaintain
 
         steps_with_error = scenario.steps_with_error(:whitelisted => false)
         steps_with_skipped = scenario.steps_with_skipped(:whitelisted => true)
-        steps_to_whitelist = steps_with_error + steps_with_skipped
+        not_skippable_steps = scenario.steps_with_error.select do |step|
+          step.metadata[:do_not_whitelist] == true
+        end
+
+        steps_to_whitelist = steps_with_error + steps_with_skipped - not_skippable_steps
         unless steps_with_error.empty?
           message << format(<<-MESSAGE.strip_heredoc, format_steps(steps_with_error, "\n", 2))
           The following steps ended up in failing state:
@@ -325,11 +329,25 @@ module ForemanMaintain
           %s
           MESSAGE
           whitelist_labels = steps_to_whitelist.map(&:label_dashed).join(',')
-          recommend << format(<<-MESSAGE.strip_heredoc, whitelist_labels)
-          Resolve the failed steps and rerun
-          the command. In case the failures are false positives,
-          use --whitelist="%s"
-          MESSAGE
+          unless whitelist_labels.empty?
+            recommend << if scenario.detector.feature(:instance).downstream
+                           format(<<-MESSAGE.strip_heredoc, whitelist_labels)
+              Resolve the failed steps and rerun the command.
+
+              If the situation persists and, you are unclear what to do next,
+              contact Red Hat Technical Support.
+
+              In case the failures are false positives, use
+              --whitelist="%s"
+              MESSAGE
+                         else
+                           format(<<-MESSAGE.strip_heredoc, whitelist_labels)
+              Resolve the failed steps and rerun the command.
+              In case the failures are false positives, use
+              --whitelist="%s"
+              MESSAGE
+                         end
+          end
         end
 
         steps_with_warning = scenario.steps_with_warning(:whitelisted => false)

data/lib/foreman_maintain/repository_manager/el.rb

@@ -76,10 +76,21 @@ module ForemanMaintain::RepositoryManager
     end
 
     def hash_of_repoids_urls(repos, regex)
-      Hash[*repos.split("\n").grep(regex).map do |entry|
-             entry.split(':', 2).last.strip
-           end
-      ]
+      ids_urls = Hash[*repos.split("\n").grep(regex).map do |entry|
+                        entry.split(':', 2).last.strip
+                      end]
+
+      # The EL7 yum repolist output includes extra info in the output,
+      # as example
+      # rhel-7-server-rpms/7Server/x86_64
+      # rhel-server-rhscl-7-rpms/7Server/x86_64
+      # This trims anything after first '/' to get correct repo label
+      trimmed_hash = {}
+      ids_urls.each do |id, url|
+        trimmed_id = id.split('/').first
+        trimmed_hash[trimmed_id] = url
+      end
+      trimmed_hash
     end
   end
 end

data/lib/foreman_maintain/repository_manager.rb

@@ -4,7 +4,7 @@ module ForemanMaintain
   def self.repository_manager
     @repository_manager ||= if el?
                               ForemanMaintain::RepositoryManager::El.new
-                            elsif debian?
+                            elsif debian_or_ubuntu?
                               raise 'Not implemented!'
                             else
                               raise 'No supported repository manager was found'

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.1.4'.freeze
 end

data/lib/foreman_maintain.rb

@@ -26,6 +26,7 @@ module ForemanMaintain
   require 'foreman_maintain/concerns/pulp_common'
   require 'foreman_maintain/concerns/firewall/iptables_maintenance_mode'
   require 'foreman_maintain/concerns/firewall/nftables_maintenance_mode'
+  require 'foreman_maintain/concerns/firewall/maintenance_mode'
   require 'foreman_maintain/top_level_modules'
   require 'foreman_maintain/yaml_storage'
   require 'foreman_maintain/config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.4
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-26 00:00:00.000000000 Z
+date: 2022-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -113,7 +113,6 @@ description: Provides various features that helps keeping the Foreman/Satellite
 email: inecas@redhat.com
 executables:
 - foreman-maintain
-- passenger-recycler
 - foreman-maintain-complete
 - foreman-maintain-rotate-tar
 extensions: []
@@ -126,12 +125,10 @@ files:
 - bin/foreman-maintain
 - bin/foreman-maintain-complete
 - bin/foreman-maintain-rotate-tar
-- bin/passenger-recycler
 - config/foreman-maintain.completion
 - config/foreman_maintain.yml.example
 - config/foreman_maintain.yml.packaging
 - config/hammer.yml.example
-- config/passenger-recycler.yaml
 - definitions/checks/backup/certs_tar_exist.rb
 - definitions/checks/backup/directory_ready.rb
 - definitions/checks/candlepin/db_up.rb
@@ -266,6 +263,7 @@ files:
 - definitions/procedures/foreman_tasks/ui_investigate.rb
 - definitions/procedures/hammer_setup.rb
 - definitions/procedures/installer/run.rb
+- definitions/procedures/installer/run_for_6_11.rb
 - definitions/procedures/installer/upgrade.rb
 - definitions/procedures/installer/upgrade_rake_task.rb
 - definitions/procedures/knowledge_base_article.rb
@@ -280,7 +278,6 @@ files:
 - definitions/procedures/packages/unlock_versions.rb
 - definitions/procedures/packages/update.rb
 - definitions/procedures/packages/update_all_confirmation.rb
-- definitions/procedures/passenger_recycler.rb
 - definitions/procedures/prep_6_10_upgrade.rb
 - definitions/procedures/pulp/cleanup_old_metadata_files.rb
 - definitions/procedures/pulp/migrate.rb
@@ -335,6 +332,8 @@ files:
 - definitions/scenarios/upgrade_to_capsule_6_10_z.rb
 - definitions/scenarios/upgrade_to_capsule_6_11.rb
 - definitions/scenarios/upgrade_to_capsule_6_11_z.rb
+- definitions/scenarios/upgrade_to_capsule_6_12.rb
+- definitions/scenarios/upgrade_to_capsule_6_12_z.rb
 - definitions/scenarios/upgrade_to_capsule_6_8.rb
 - definitions/scenarios/upgrade_to_capsule_6_8_z.rb
 - definitions/scenarios/upgrade_to_capsule_6_9.rb
@@ -343,6 +342,8 @@ files:
 - definitions/scenarios/upgrade_to_satellite_6_10_z.rb
 - definitions/scenarios/upgrade_to_satellite_6_11.rb
 - definitions/scenarios/upgrade_to_satellite_6_11_z.rb
+- definitions/scenarios/upgrade_to_satellite_6_12.rb
+- definitions/scenarios/upgrade_to_satellite_6_12_z.rb
 - definitions/scenarios/upgrade_to_satellite_6_2.rb
 - definitions/scenarios/upgrade_to_satellite_6_2_z.rb
 - definitions/scenarios/upgrade_to_satellite_6_3.rb
@@ -364,7 +365,6 @@ files:
 - extras/foreman_protector/foreman-protector.conf
 - extras/foreman_protector/foreman-protector.whitelist
 - extras/foreman_protector/yum/foreman-protector.py
-- extras/passenger-recycler.cron
 - lib/foreman_maintain.rb
 - lib/foreman_maintain/check.rb
 - lib/foreman_maintain/cli.rb
@@ -392,6 +392,7 @@ files:
 - lib/foreman_maintain/concerns/downstream.rb
 - lib/foreman_maintain/concerns/finders.rb
 - lib/foreman_maintain/concerns/firewall/iptables_maintenance_mode.rb
+- lib/foreman_maintain/concerns/firewall/maintenance_mode.rb
 - lib/foreman_maintain/concerns/firewall/nftables_maintenance_mode.rb
 - lib/foreman_maintain/concerns/hammer.rb
 - lib/foreman_maintain/concerns/logger.rb
@@ -413,6 +414,7 @@ files:
 - lib/foreman_maintain/executable.rb
 - lib/foreman_maintain/feature.rb
 - lib/foreman_maintain/package_manager.rb
+- lib/foreman_maintain/package_manager/apt.rb
 - lib/foreman_maintain/package_manager/base.rb
 - lib/foreman_maintain/package_manager/dnf.rb
 - lib/foreman_maintain/package_manager/yum.rb

data/bin/passenger-recycler

@@ -1,89 +0,0 @@
-#!/usr/bin/env ruby
-#
-# Trivial Passenger memory monitor and recycler. See the configuration file
-# /etc/passenger-recycler.yaml for options. Execute via SCL.
-#
-require 'yaml'
-
-CONFIG = {}.freeze
-CONFIG_FILE = '/etc/passenger-recycler.yaml'.freeze
-CONFIG = YAML.load_file(CONFIG_FILE) if File.readable?(CONFIG_FILE)
-exit 0 unless CONFIG[:ENABLED]
-
-def running?(pid)
-  Process.getpgid(pid) != -1
-rescue Errno::ESRCH
-  false
-end
-
-def debug(msg)
-  puts(msg) if CONFIG[:DEBUG]
-end
-
-def verbose(msg)
-  puts(msg) if CONFIG[:VERBOSE]
-end
-
-def kill(pid)
-  return unless running?(pid) && CONFIG[:KILL_BUSY]
-  verbose "Process #{pid} is still running, sending SIGKILL"
-  Process.kill 'KILL', pid
-  sleep 5
-end
-
-def process_status?(pid)
-  if running?(pid)
-    verbose "Process #{pid} still terminating, moving on..."
-  else
-    verbose "Process successfully #{pid} terminated"
-  end
-end
-
-def show_passenger_status(status_messages)
-  status_messages.each { |msg| verbose msg }
-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'
-stats = PhusionPassenger::AdminTools::MemoryStats.new
-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
-  started = get_process_start(pid)
-  get_pid_mem_kb, get_pid_mem_mb = get_rss_info(p)
-  debug "Checking #{pid} with RSS of #{get_pid_mem_kb}"
-  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 RSS size of #{get_pid_mem_mb} MB")
-  begin
-    Process.kill 'SIGUSR1', pid
-    sleep CONFIG[:GRACEFUL_SHUTDOWN_SLEEP]
-    kill(pid)
-    process_status?(pid)
-    show_passenger_status([status_ps, status_all, status_backtraces]) if CONFIG[:SEND_STATUS]
-    killed += 1
-    exit(1) if killed >= CONFIG[:MAX_TERMINATION]
-  rescue Errno::ESRCH
-    puts "#{Process.pid}: #{pid} is NOT running"
-  end
-end
-exit 0

data/config/passenger-recycler.yaml

@@ -1,38 +0,0 @@
----
-#
-# Trivial Passenger memory monitor. By default it is executed from cron every
-# five minutes and it kills processes exceeding the RSS memory threashold
-# configured with MAX_PRIV_RSS_MEMORY. Up to MAX_TERMINATION processes is
-# terminated during one execution.
-#
-
-# Set to 'false' to completely disable this script.
-:ENABLED: true
-
-# RSS memory threashold to recycle processes (in kB).
-:MAX_PRIV_RSS_MEMORY: 2_000_000
-
-# Controls amount of processes killed during one run. This number should be
-# smaller by one or two than maximum allowed amount of processes by passenger
-# (defaults to 6) so there is at least one process left.
-:MAX_TERMINATION: 1
-
-# Kill processes which do not terminate gracefully using SIGKILL after
-# GRACEFUL_SHUTDOWN_SLEEP period.
-:KILL_BUSY: true
-
-# Amount of seconds to wait for graceful shutdown (SIGTERM) until a process
-# kill (SIGKILL) is sent. Must be lower than 15 minutes (900 seconds). This
-# gives Passenger some extra time for respawning application before another
-# process is terminated.
-:GRACEFUL_SHUTDOWN_SLEEP: 90
-
-# Print 'passenger-status' and 'ps' output before termination to get some extra
-# information via email from cron. Only printed when a kill is performed.
-:SEND_STATUS: true
-
-# Print verbose information "Process terminating" or "Process killed".
-:VERBOSE: true
-
-# Print extra debugging information.
-:DEBUG: false

data/definitions/procedures/passenger_recycler.rb

@@ -1,14 +0,0 @@
-class Procedures::PassengerRecycler < ForemanMaintain::Procedure
-  metadata do
-    description 'Perform Passenger memory recycling'
-
-    confine do
-      execute?('which passenger-recycler')
-    end
-  end
-
-  def run
-    passenger_recycler_path = execute('which passenger-recycler')
-    execute!(passenger_recycler_path)
-  end
-end

data/extras/passenger-recycler.cron

@@ -1,3 +0,0 @@
-# Configuration file /etc/cron.d/passenger-recycler to run passenger-recycler
-# every 15 minutes.
-*/15 * * * * root /usr/bin/passenger-recycler