foreman_maintain 1.0.12 → 1.1.3

data/lib/foreman_maintain/concerns/base_database.rb

@@ -4,13 +4,39 @@ module ForemanMaintain
       def data_dir
         if el7? && package_manager.installed?('rh-postgresql12-postgresql-server-syspaths')
           '/var/opt/rh/rh-postgresql12/lib/pgsql/data/'
+        elsif debian_or_ubuntu?
+          deb_postgresql_data_dir
         else
           '/var/lib/pgsql/data/'
         end
       end
 
+      def deb_postgresql_data_dir
+        deb_postgresql_versions.map do |ver|
+          "/var/lib/postgresql/#{ver}/main/"
+        end
+      end
+
+      def deb_postgresql_versions
+        installed_pkgs = package_manager.list_installed_packages('${binary:Package}\n')
+        @deb_postgresql_versions ||= installed_pkgs.grep(/^postgresql-\d+$/).map do |name|
+          name.split('-').last
+        end
+        @deb_postgresql_versions
+      end
+
       def postgresql_conf
-        "#{data_dir}/postgresql.conf"
+        return "#{data_dir}/postgresql.conf" if el?
+
+        deb_postgresql_config_dirs.map do |conf_dir|
+          "#{conf_dir}postgresql.conf"
+        end
+      end
+
+      def deb_postgresql_config_dirs
+        deb_postgresql_versions.map do |ver|
+          "/etc/postgresql/#{ver}/main/"
+        end
       end
 
       def restore_transform
@@ -89,11 +115,13 @@ module ForemanMaintain
 
       def backup_local(backup_file, extra_tar_options = {})
         dir = extra_tar_options.fetch(:data_dir, data_dir)
+        command = extra_tar_options.fetch(:command, 'create')
+
         FileUtils.cd(dir) do
           tar_options = {
             :archive => backup_file,
-            :command => 'create',
-            :transform => "s,^,#{data_dir[1..-1]},S",
+            :command => command,
+            :transform => "s,^,#{dir[1..-1]},S",
             :files => '*'
           }.merge(extra_tar_options)
           feature(:tar).run(tar_options)

data/lib/foreman_maintain/concerns/downstream.rb

@@ -66,7 +66,8 @@ module ForemanMaintain
         server_version_full = "#{server_version.major}.#{server_version.minor}"
         rh_repos.concat(product_specific_repos(server_version_full))
         if server_version > version('6.3')
-          rh_repos << ansible_repo(server_version)
+          ansible_repo = ansible_repo(server_version)
+          rh_repos << ansible_repo if ansible_repo
         end
 
         rh_repos
@@ -83,8 +84,6 @@ module ForemanMaintain
 
         if el7?
           "rhel-#{el_major_version}-server-ansible-#{ansible_version}-rpms"
-        else
-          "ansible-#{ansible_version}-for-rhel-#{el_major_version}-x86_64-rpms"
         end
       end
 

data/lib/foreman_maintain/concerns/firewall/maintenance_mode.rb

@@ -0,0 +1,31 @@
+module ForemanMaintain
+  module Concerns
+    module Firewall
+      module MaintenanceMode
+        def notify_and_ask_to_install_firewall_utility
+          puts 'Unable to find nftables or iptables!'
+          question, pkg = question_and_pkg_name
+          answer = ask_decision(question, actions_msg: 'y(yes), q(quit)')
+          if answer == :yes
+            packages_action(:install, pkg)
+            feature(:instance).firewall.enable_maintenance_mode
+          end
+        end
+
+        def can_install_nft?
+          # The nftables is default from EL8 and Debian 10(Buster)
+          (el? && el_major_version >= 8) ||
+            (debian? && deb_major_version >= 10) ||
+            (ubuntu? && ubuntu_major_version.to_i >= 22)
+        end
+
+        def question_and_pkg_name
+          pkg_to_install = can_install_nft? ? 'nftables' : 'iptables'
+          question = "Do you want to install missing netfilter utility #{pkg_to_install}?"\
+                     "\nand start maintenance mode?"
+          [question, [pkg_to_install]]
+        end
+      end
+    end
+  end
+end

data/lib/foreman_maintain/concerns/os_facts.rb

@@ -46,12 +46,20 @@ module ForemanMaintain
         facts.fetch('ID_LIKE', '').split
       end
 
+      def os_name
+        facts.fetch('NAME')
+      end
+
       def el?
         File.exist?('/etc/redhat-release')
       end
 
       def debian?
-        File.exist?('/etc/debian_version')
+        os_id == 'debian'
+      end
+
+      def ubuntu?
+        os_id == 'ubuntu'
       end
 
       def el7?
@@ -63,7 +71,23 @@ module ForemanMaintain
       end
 
       def el_major_version
-        return os_version_id.to_i if el?
+        os_version_id.to_i if el?
+      end
+
+      def deb_major_version
+        os_version_id.to_i if debian?
+      end
+
+      def ubuntu_major_version
+        os_version_id if ubuntu?
+      end
+
+      def debian_or_ubuntu?
+        debian? || ubuntu?
+      end
+
+      def os_version
+        facts.fetch('VERSION')
       end
     end
   end

data/lib/foreman_maintain/concerns/system_helpers.rb

@@ -100,12 +100,13 @@ module ForemanMaintain
       end
 
       def packages_action(action, packages, options = {})
-        options.validate_options!(:assumeyes)
+        options.validate_options!(:assumeyes, :yum_options)
         case action
         when :install
           package_manager.install(packages, :assumeyes => options[:assumeyes])
         when :update
-          package_manager.update(packages, :assumeyes => options[:assumeyes])
+          package_manager.update(packages, :assumeyes => options[:assumeyes],
+                                           :yum_options => options[:yum_options])
         when :remove
           package_manager.remove(packages, :assumeyes => options[:assumeyes])
         else
@@ -114,8 +115,13 @@ module ForemanMaintain
       end
 
       def package_version(name)
-        # space for extension to support non-rpm distributions
-        rpm_version(name)
+        ver = if el?
+                '%{VERSION}'
+              elsif debian_or_ubuntu?
+                '${VERSION}'
+              end
+        pkg = package_manager.find_installed_package(name, ver)
+        version(pkg) unless pkg.nil?
       end
 
       def parse_csv(data)
@@ -132,18 +138,14 @@ module ForemanMaintain
         nil
       end
 
-      def rpm_version(name)
-        rpm_version = execute(%(rpm -q '#{name}' --queryformat="%{VERSION}"))
-        if $CHILD_STATUS.success?
-          version(rpm_version)
-        end
-      end
-
       def shellescape(string)
         Shellwords.escape(string)
       end
 
       def version(value)
+        # packages versions, especially on Debian, sometimes include a + or a ~,
+        # but Gem::Version can't handle that.
+        value.gsub!(/[+~]/, '-')
         Version.new(value)
       end
 
@@ -190,7 +192,7 @@ module ForemanMaintain
       end
 
       def ruby_prefix(scl = true)
-        if debian?
+        if debian_or_ubuntu?
           'ruby-'
         elsif el7? && scl
           'tfm-rubygem-'
@@ -200,12 +202,12 @@ module ForemanMaintain
       end
 
       def foreman_plugin_name(plugin)
-        plugin = plugin.tr('_', '-') if debian?
+        plugin = plugin.tr('_', '-') if debian_or_ubuntu?
         ruby_prefix + plugin
       end
 
       def proxy_plugin_name(plugin)
-        if debian?
+        if debian_or_ubuntu?
           plugin = plugin.tr('_', '-')
           proxy_plugin_prefix = 'smart-proxy-'
         else
@@ -216,12 +218,12 @@ module ForemanMaintain
       end
 
       def hammer_plugin_name(plugin)
-        plugin = plugin.tr('_', '-') if debian?
-        [hammer_package, plugin].join(debian? ? '-' : '_')
+        plugin = plugin.tr('_', '-') if debian_or_ubuntu?
+        [hammer_package, plugin].join(debian_or_ubuntu? ? '-' : '_')
       end
 
       def hammer_package
-        hammer_prefix = if debian?
+        hammer_prefix = if debian_or_ubuntu?
                           'hammer-cli'
                         else
                           'hammer_cli'

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

@@ -36,8 +36,12 @@ module ForemanMaintain::PackageManager
       sys.execute?(%(rpm -q #{packages_list}))
     end
 
-    def find_installed_package(name)
-      status, result = sys.execute_with_status(%(rpm -q '#{name}'))
+    def find_installed_package(name, queryformat = '')
+      rpm_cmd = "rpm -q '#{name}'"
+      unless queryformat.empty?
+        rpm_cmd += " --qf '#{queryformat}'"
+      end
+      status, result = sys.execute_with_status(rpm_cmd)
       if status == 0
         result
       end
@@ -55,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)
@@ -78,12 +82,12 @@ module ForemanMaintain::PackageManager
       sys.execute(find_cmd).split("\n")
     end
 
-    def list_installed_packages(queryfm = '%{NAME}-%{VERSION}-%{RELEASE}.%{ARCH}\n')
-      # The queryfm should only include valid tag(s) as per `rpm --querytag` list.
+    def list_installed_packages(queryformat = '%{NAME}-%{VERSION}-%{RELEASE}.%{ARCH}\n')
+      # The queryformat should only include valid tag(s) as per `rpm --querytags` list.
       # If any special formatting is required with querytag then it should be provided with tag i.e,
-      # querytag = "--%{VENDOR}"
-      # The queryfm string must end with '\n'
-      sys.execute!("rpm -qa --qf '#{queryfm}'").split("\n")
+      # "--%{VENDOR}"
+      # The queryformat string must end with '\n'
+      sys.execute!("rpm -qa --qf '#{queryformat}'").split("\n")
     end
 
     private
@@ -116,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/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/utils/service/systemd.rb

@@ -8,21 +8,16 @@ module ForemanMaintain::Utils
         @instance_parent_unit = options.fetch(:instance_parent_unit, nil)
       end
 
-      def command(action, options = {})
-        do_wait = options.fetch(:wait, true) # wait for service to start
+      def command(action)
         all = @options.fetch(:all, false)
         skip_enablement = @options.fetch(:skip_enablement, false)
         if skip_enablement && %w[enable disable].include?(action)
           return skip_enablement_message(action, @name)
         end
 
-        if do_wait && File.exist?('/usr/sbin/service-wait')
-          "service-wait #{@name} #{action}"
-        else
-          cmd = "systemctl #{action} #{@name}"
-          cmd += ' --all' if all
-          cmd
-        end
+        cmd = "systemctl #{action} #{@name}"
+        cmd += ' --all' if all
+        cmd
       end
 
       def status
@@ -38,11 +33,11 @@ module ForemanMaintain::Utils
       end
 
       def enable
-        execute('enable', :wait => false)
+        execute('enable')
       end
 
       def disable
-        execute('disable', :wait => false)
+        execute('disable')
       end
 
       def running?
@@ -66,8 +61,8 @@ module ForemanMaintain::Utils
 
       private
 
-      def execute(action, options = {})
-        @sys.execute_with_status(command(action, options))
+      def execute(action)
+        @sys.execute_with_status(command(action))
       end
 
       def service_enabled_status

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '1.0.12'.freeze
+  VERSION = '1.1.3'.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.0.12
+  version: 1.1.3
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-07-01 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
@@ -281,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
@@ -365,7 +361,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
@@ -393,6 +388,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
@@ -414,6 +410,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