CLOS-3205: Rework the clearpackageconflicts actor with set definitoon to work for el8to9 upgrades

Seems like the InstalledRPM model was modified at some point, and the previous construction could not be utilized.

The logic was changed to process only package names (which is essentially already how the data was used) into the set, which is then used for package lookup.
This sidesteps the problem with the InstalledRPM type not being hashable.

Author: prilr

repos/system_upgrade/cloudlinux/actors/clearpackageconflicts/actor.py

@@ -1,102 +1,28 @@
-import os
-import errno
-import shutil
-
 from leapp.actors import Actor
 from leapp.models import InstalledRPM
 from leapp.tags import DownloadPhaseTag, IPUWorkflowTag
 from leapp.libraries.common.cllaunch import run_on_cloudlinux
+from leapp.libraries.actor import clearpackageconflicts
 
 
 class ClearPackageConflicts(Actor):
     """
-    Remove several python package files manually to resolve conflicts between versions of packages to be upgraded.
+    Remove several Python package files manually to resolve conflicts
+    between versions of packages to be upgraded.
+
+    When the corresponding packages are detected,
+    the conflicting files are removed to allow for an upgrade to the new package versions.
+
+    While most packages are handled automatically by the package manager,
+    some specific packages require direct intervention to resolve conflicts
+    between their own versions on different OS releases.
     """
 
     name = "clear_package_conflicts"
     consumes = (InstalledRPM,)
     produces = ()
     tags = (DownloadPhaseTag.Before, IPUWorkflowTag)
-    rpm_lookup = None
-
-    def has_package(self, name):
-        """
-        Check whether the package is installed.
-        Looks only for the package name, nothing else.
-        """
-        if self.rpm_lookup:
-            return name in self.rpm_lookup
-
-    def problem_packages_installed(self, problem_packages):
-        """
-        Check whether any of the problem packages are present in the system.
-        """
-        for pkg in problem_packages:
-            if self.has_package(pkg):
-                self.log.debug("Conflicting package {} detected".format(pkg))
-                return True
-        return False
-
-    def clear_problem_files(self, problem_files, problem_dirs):
-        """
-        Go over the list of problem files and directories and remove them if they exist.
-        They'll be replaced by the new packages.
-        """
-        for p_dir in problem_dirs:
-            try:
-                if os.path.isdir(p_dir):
-                    shutil.rmtree(p_dir)
-                    self.log.debug("Conflicting directory {} removed".format(p_dir))
-            except OSError as e:
-                if e.errno != errno.ENOENT:
-                    raise
-
-        for p_file in problem_files:
-            try:
-                if os.path.isfile(p_file):
-                    os.remove(p_file)
-                    self.log.debug("Conflicting file {} removed".format(p_file))
-            except OSError as e:
-                if e.errno != errno.ENOENT:
-                    raise
-
-    def alt_python37_handle(self):
-        """
-        These alt-python37 packages are conflicting with their own builds for EL8.
-        """
-        problem_packages = [
-            "alt-python37-six",
-            "alt-python37-pytz",
-        ]
-        problem_files = []
-        problem_dirs = [
-            "/opt/alt/python37/lib/python3.7/site-packages/six-1.15.0-py3.7.egg-info",
-            "/opt/alt/python37/lib/python3.7/site-packages/pytz-2017.2-py3.7.egg-info",
-        ]
-
-        if self.problem_packages_installed(problem_packages):
-            self.clear_problem_files(problem_files, problem_dirs)
-
-    def lua_cjson_handle(self):
-        """
-        lua-cjson package is conflicting with the incoming lua-cjson package for EL8.
-        """
-        problem_packages = [
-            "lua-cjson"
-        ]
-        problem_files = [
-            "/usr/lib64/lua/5.1/cjson.so",
-            "/usr/share/lua/5.1/cjson/tests/bench.lua",
-            "/usr/share/lua/5.1/cjson/tests/genutf8.pl",
-            "/usr/share/lua/5.1/cjson/tests/test.lua",
-        ]
-        problem_dirs = []
-
-        if self.problem_packages_installed(problem_packages):
-            self.clear_problem_files(problem_files, problem_dirs)
 
     @run_on_cloudlinux
     def process(self):
-        # todo: (CLOS-3205) investigate why set is needed here
-        self.rpm_lookup = [rpm for rpm in self.consume(InstalledRPM)]
-        self.alt_python37_handle()
+        clearpackageconflicts.process()

repos/system_upgrade/cloudlinux/actors/clearpackageconflicts/libraries/clearpackageconflicts.py

@@ -0,0 +1,84 @@
+import os
+import errno
+from re import L
+import shutil
+
+from leapp.libraries.stdlib import api
+from leapp.models import InstalledRPM
+
+
+def problem_packages_installed(problem_packages, lookup):
+    """
+    Check whether any of the problem packages are present in the system.
+    """
+    for pkg in problem_packages:
+        if pkg in lookup:
+            api.current_logger().debug("Conflicting package {} detected".format(pkg))
+            return True
+    return False
+
+
+def clear_problem_files(problem_files, problem_dirs):
+    """
+    Go over the list of problem files and directories and remove them if they exist.
+    They'll be replaced by the new packages.
+    """
+    for p_dir in problem_dirs:
+        try:
+            if os.path.isdir(p_dir):
+                shutil.rmtree(p_dir)
+                api.current_logger().debug("Conflicting directory {} removed".format(p_dir))
+        except OSError as e:
+            if e.errno != errno.ENOENT:
+                raise
+
+    for p_file in problem_files:
+        try:
+            if os.path.isfile(p_file):
+                os.remove(p_file)
+                api.current_logger().debug("Conflicting file {} removed".format(p_file))
+        except OSError as e:
+            if e.errno != errno.ENOENT:
+                raise
+
+
+def alt_python37_handle(package_lookup):
+    """
+    These alt-python37 packages are conflicting with their own builds for EL8.
+    """
+    problem_packages = [
+        "alt-python37-six",
+        "alt-python37-pytz",
+    ]
+    problem_files = []
+    problem_dirs = [
+        "/opt/alt/python37/lib/python3.7/site-packages/six-1.15.0-py3.7.egg-info",
+        "/opt/alt/python37/lib/python3.7/site-packages/pytz-2017.2-py3.7.egg-info",
+    ]
+
+    if problem_packages_installed(problem_packages, package_lookup):
+        clear_problem_files(problem_files, problem_dirs)
+
+
+def lua_cjson_handle(package_lookup):
+    """
+    lua-cjson package is conflicting with the incoming lua-cjson package for EL8.
+    """
+    problem_packages = [
+        "lua-cjson"
+    ]
+    problem_files = [
+        "/usr/lib64/lua/5.1/cjson.so",
+        "/usr/share/lua/5.1/cjson/tests/bench.lua",
+        "/usr/share/lua/5.1/cjson/tests/genutf8.pl",
+        "/usr/share/lua/5.1/cjson/tests/test.lua",
+    ]
+    problem_dirs = []
+
+    if problem_packages_installed(problem_packages, package_lookup):
+        clear_problem_files(problem_files, problem_dirs)
+
+
+def process():
+    rpm_lookup = {rpm.name for rpm in api.consume(InstalledRPM)}
+    alt_python37_handle(rpm_lookup)

repos/system_upgrade/cloudlinux/actors/clearpackageconflicts/tests/unit_test_clearpackageconflicts.py

@@ -0,0 +1,17 @@
+import pytest
+
+# from leapp import reporting
+from leapp.libraries.actor import clearpackageconflicts
+
+
+@pytest.mark.parametrize(
+    "problem_pkgs,lookup,expected_res",
+    (
+        (["cagefs"], {"cagefs", "dnf"}, True),
+        (["lve-utils"], {"lve-utils", "dnf"}, True),
+        (["nonexistent-pkg"], {"cagefs", "dnf"}, False),
+        (["cagefs"], {"lve-utils", "dnf"}, False),
+    ),
+)
+def test_problem_packages_installed(problem_pkgs, lookup, expected_res):
+    assert expected_res == clearpackageconflicts.problem_packages_installed(problem_pkgs, lookup)