foreman_maintain 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1db04c176ed0a5d5293dd9980db6c05e7f2c29c43f7da63d622e917c692d49ce
-  data.tar.gz: 2d41a5d195c217f7c7764b2543ed43ec3bacfac1339aad2162431052286775ca
+  metadata.gz: cbe5e2f041a482d1800b74195b3d0cbaeb504d14345c86402d4ee9402f052999
+  data.tar.gz: 96420eefe94c8632ec43a52d105af613aaf7b30107e59f6a69abc9549a02200b
 SHA512:
-  metadata.gz: d321a63d2e313db2694dbd70c138c498c829843b5ac891d33e91969a682494f94971b1411dbe81228f1e049bfb35b3a3ba2dc9c59d08629aa4297baff20210ad
-  data.tar.gz: a53ce7c727dbbf92d7257e7024587ba33a1e7db9b27c17fccf5e3ecc9ede63173bdcbcef2cd7f51173a3d88df661b6dd2e0f68fab05ea0983b8f657e9f02beae
+  metadata.gz: 2207cfef121cf8a15ce12c0c961b249b31ac3fb92b2275c15df58b245fc987261c634d53bd0fad5cfe8de3c71106fd30016f76fa7ffac67da2b5ab593fb02347
+  data.tar.gz: a121716d79737dbe7e480bca7aa767dd17090226d8ef51f19c9f49e8ce82b7b8620416bc5cecc2a654068f7a7e0d0ed8ba93dbf2eedac71ccbbb36517f7bbd0b

data/definitions/procedures/packages/enable_version_locking.rb

@@ -6,7 +6,11 @@ module Procedures::Packages
     end
 
     def run
-      package_manager.install_version_locking(:assumeyes => @assumeyes)
+      installed_fm_packages = []
+      ['satellite-maintain', 'rubygem-foreman_maintain'].each do |pkg|
+        installed_fm_packages << find_package(pkg)
+      end
+      package_manager.reinstall(installed_fm_packages, :assumeyes => @assumeyes)
     end
   end
 end

data/definitions/procedures/packages/lock_versions.rb

@@ -2,7 +2,9 @@ module Procedures::Packages
   class LockVersions < ForemanMaintain::Procedure
     metadata do
       description 'Lock packages'
-      preparation_steps { [Checks::VersionLockingEnabled.new] }
+      confine do
+        package_manager.version_locking_supported?
+      end
     end
 
     def run

data/definitions/procedures/packages/locking_status.rb

@@ -2,7 +2,9 @@ module Procedures::Packages
   class LockingStatus < ForemanMaintain::Procedure
     metadata do
       description 'Check status of version locking of packages'
-      preparation_steps { [Checks::VersionLockingEnabled.new] }
+      confine do
+        package_manager.version_locking_supported?
+      end
     end
 
     def run

data/definitions/procedures/packages/unlock_versions.rb

@@ -2,7 +2,9 @@ module Procedures::Packages
   class UnlockVersions < ForemanMaintain::Procedure
     metadata do
       description 'Unlock packages'
-      preparation_steps { [Checks::VersionLockingEnabled.new] }
+      confine do
+        package_manager.version_locking_supported?
+      end
     end
 
     def run

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

@@ -0,0 +1,77 @@
+import dnf
+import dnf.exceptions
+from dnfpluginscore import _, logger
+
+import configparser
+
+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)
+        except Exception as e:
+            raise dnf.exceptions.Error(_("Parsing file failed: {}").format(str(e)))
+
+        if parser.has_section('main'):
+            fileurl = parser.get('main', 'whitelist')
+        else:
+            raise dnf.exceptions.Error(_('Incorrect plugin configuration!'))
+        return fileurl
+
+    def _load_whitelist(self):
+        fileurl = self._get_whitelist_file_url()
+        package_whitelist = set()
+        try:
+            if fileurl:
+                llfile = open(fileurl, 'r')
+                for line in llfile.readlines():
+                    if line.startswith('#') or line.strip() == '':
+                        continue
+
+                    package_whitelist.add(line.rstrip())
+                llfile.close()
+        except IOError as e:
+            raise dnf.exceptions.Error('Unable to read Foreman protector"s configuration: %s' % e)
+        return package_whitelist
+
+    def _add_obsoletes(self):
+        package_whitelist = self._load_whitelist()
+        final_query = self.base.sack.query()
+        if package_whitelist:
+        #  If anything obsoletes something that we have whitelisted ... then
+        # whitelist that too.
+            whitelist_query = self.base.sack.query().filterm(name=package_whitelist)
+            obsoletes_query = self.base.sack.query().filterm(obsoletes=list(whitelist_query))
+
+            final_query = whitelist_query.union(obsoletes_query)
+        return final_query
+
+    def sack(self):
+        whitelist_and_obsoletes = self._add_obsoletes()
+        all_available_packages = self.base.sack.query().available()
+        excluded_pkgs_query = all_available_packages.difference(whitelist_and_obsoletes)
+        total = len(excluded_pkgs_query)
+        logger.info(_('Reading Foreman protector configuration'))
+        self.base.sack.add_excludes(excluded_pkgs_query)
+
+        logger.info(_('*** Excluded total: %s' % total))
+        if total:
+            if total > 1:
+                suffix = 's'
+            else:
+                suffix = ''
+            logger.info(_('\n'
+                            'WARNING: Excluding %d package%s due to foreman-protector. \n'
+                            'Use foreman-maintain packages install/update <package> \n'
+                            'to safely install packages without restrictions.\n'
+                            'Use foreman-maintain upgrade run for full upgrade.\n'
+                            % (total, suffix)))
+        else:
+            logger.info(_('\n'
+                            'Nothing excluded by foreman-protector!\n'))

data/extras/foreman_protector/foreman-protector.whitelist

@@ -17,5 +17,8 @@ boost-random
 boost-iostreams
 boost-thread
 yum-utils
+# el8 yum-utils dependencies
+dnf-plugins-core
+python3-dnf-plugins-core
 # foreman-maintain
 rubygem-foreman_maintain

data/lib/foreman_maintain/package_manager/base.rb

@@ -1,13 +1,8 @@
 module ForemanMaintain::PackageManager
   # rubocop:disable Lint/UnusedMethodArgument
   class Base
-    # check tools are installed and enabled
-    def version_locking_enabled?
-      raise NotImplementedError
-    end
-
-    # make sure the version locking tools are configured
-    def install_version_locking(assumeyes: false)
+    # confirms that Package Manager supports the locking mechanism
+    def version_locking_supported?
       raise NotImplementedError
     end
 

data/lib/foreman_maintain/package_manager/dnf.rb

@@ -5,6 +5,10 @@ module ForemanMaintain::PackageManager
       super
     end
 
+    def version_locking_supported?
+      true
+    end
+
     private
 
     def dnf_action(action, packages, with_status: false, assumeyes: false)

data/lib/foreman_maintain/package_manager/yum.rb

@@ -2,7 +2,6 @@ module ForemanMaintain::PackageManager
   class Yum < Base
     PROTECTOR_CONFIG_FILE = '/etc/yum/pluginconf.d/foreman-protector.conf'.freeze
     PROTECTOR_WHITELIST_FILE = '/etc/yum/pluginconf.d/foreman-protector.whitelist'.freeze
-    PROTECTOR_PLUGIN_FILE = '/usr/lib/yum-plugins/foreman-protector.py'.freeze
 
     def self.parse_envra(envra)
       # envra format: 0:foreman-1.20.1.10-1.el7sat.noarch
@@ -19,18 +18,17 @@ module ForemanMaintain::PackageManager
     end
 
     def versions_locked?
-      !!(protector_config =~ /^\s*enabled\s*=\s*1/)
+      !!(protector_config =~ /^\s*enabled\s*=\s*1/) &&
+        protector_whitelist_file_nonzero?
     end
 
-    def version_locking_enabled?
-      File.exist?(PROTECTOR_PLUGIN_FILE) && File.exist?(PROTECTOR_CONFIG_FILE) &&
-        File.exist?(PROTECTOR_WHITELIST_FILE)
+    def protector_whitelist_file_nonzero?
+      File.exist?(PROTECTOR_WHITELIST_FILE) &&
+        !File.zero?(PROTECTOR_WHITELIST_FILE)
     end
 
-    def install_version_locking(*)
-      install_extras('foreman_protector/foreman-protector.py', PROTECTOR_PLUGIN_FILE)
-      install_extras('foreman_protector/foreman-protector.conf', PROTECTOR_CONFIG_FILE)
-      install_extras('foreman_protector/foreman-protector.whitelist', PROTECTOR_WHITELIST_FILE)
+    def version_locking_supported?
+      true
     end
 
     def installed?(packages)
@@ -49,6 +47,10 @@ module ForemanMaintain::PackageManager
       yum_action('install', packages, :assumeyes => assumeyes)
     end
 
+    def reinstall(packages, assumeyes: false)
+      yum_action('reinstall', packages, :assumeyes => assumeyes)
+    end
+
     def remove(packages, assumeyes: false)
       yum_action('remove', packages, :assumeyes => assumeyes)
     end
@@ -129,14 +131,5 @@ module ForemanMaintain::PackageManager
                      :interactive => !assumeyes, :valid_exit_statuses => valid_exit_statuses)
       end
     end
-
-    def install_extras(src, dest, override: false)
-      extras_src = File.expand_path('../../../../extras', __FILE__)
-      if override ||
-         (File.directory?(dest) && !File.exist?(File.join(dest, src))) ||
-         !File.exist?(dest)
-        FileUtils.cp(File.join(extras_src, src), dest)
-      end
-    end
   end
 end

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '1.0.7'.freeze
+  VERSION = '1.0.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -184,7 +184,6 @@ files:
 - definitions/checks/server_ping.rb
 - definitions/checks/services_up.rb
 - definitions/checks/system_registration.rb
-- definitions/checks/version_locking_enabled.rb
 - definitions/features/apache.rb
 - definitions/features/candlepin.rb
 - definitions/features/candlepin_database.rb
@@ -361,9 +360,10 @@ files:
 - definitions/scenarios/upgrade_to_satellite_6_9.rb
 - definitions/scenarios/upgrade_to_satellite_6_9_z.rb
 - extras/foreman-maintain.sh
+- extras/foreman_protector/dnf/foreman-protector.py
 - extras/foreman_protector/foreman-protector.conf
-- extras/foreman_protector/foreman-protector.py
 - 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

data/definitions/checks/version_locking_enabled.rb

@@ -1,14 +0,0 @@
-module Checks
-  class VersionLockingEnabled < ForemanMaintain::Check
-    metadata do
-      description 'Check if tooling for package locking is installed'
-    end
-
-    def run
-      enabled = package_manager.version_locking_enabled?
-      enable_locking = Procedures::Packages::EnableVersionLocking.new(:assumeyes => assumeyes?)
-      assert(enabled, 'Tools for package version locking are not available on this system',
-             :next_steps => enable_locking)
-    end
-  end
-end