Add and fix unit tests

Assisted by GitHub Copilot

Author: bocekm

convert2rhel/actions/pre_ponr_changes/yum_variables.py

@@ -22,7 +22,7 @@
 from convert2rhel import backup
 from convert2rhel.backup.files import InstalledFile, RestorableFile
 from convert2rhel.logger import root_logger
-from convert2rhel.pkghandler import get_files_owned_by_package, get_packages_to_remove
+from convert2rhel import pkghandler
 from convert2rhel.repo import DEFAULT_DNF_VARS_DIR, DEFAULT_YUM_VARS_DIR
 from convert2rhel.systeminfo import system_info
 from convert2rhel.toolopts.config import loggerinst
@@ -48,18 +48,24 @@ def run(self):
         super(BackUpYumVariables, self).run()
 
         logger.debug("Getting a list of files owned by packages affecting variables in .repo files.")
-        yum_var_affecting_pkgs = get_packages_to_remove(system_info.repofile_pkgs)
-        yum_var_files_to_back_up = self._get_yum_var_files_owned_by_pkgs(
-            [pkg_obj.nevra.name for pkg_obj in yum_var_affecting_pkgs]
-        )
+        yum_var_affecting_pkgs = []
+        for pkg in system_info.repofile_pkgs:
+            # We use get_installed_pkg_objects() to have yum find installed packages even when a glob (*) is useed
+            yum_var_affecting_pkgs.extend(pkghandler.get_installed_pkg_objects(pkg))
+
+        # Get just the names of the packages affecting yum variables
+        yum_var_affecting_pkg_names = [pkg.name for pkg in yum_var_affecting_pkgs]
+        logger.debug("Packages affecting yum variables: {0}".format(", ".join(yum_var_affecting_pkg_names)))
+
+        yum_var_files_to_back_up = self._get_yum_var_files_owned_by_pkgs(yum_var_affecting_pkg_names)
         self._back_up_var_files(yum_var_files_to_back_up)
 
     def _get_yum_var_files_owned_by_pkgs(self, pkg_names):
         """Get paths of yum var files owned by the packages passed to the method."""
         pkg_owned_files = set()
         for pkg in pkg_names:
             # using set() and union() to get unique paths
-            pkg_owned_files = pkg_owned_files.union(get_files_owned_by_package(pkg))
+            pkg_owned_files = pkg_owned_files.union(pkghandler.get_files_owned_by_package(pkg))
 
         # Out of all the files owned by the packages get just those in yum/dnf var dirs
         yum_var_filepaths = [
@@ -69,18 +75,19 @@ def _get_yum_var_files_owned_by_pkgs(self, pkg_names):
         return yum_var_filepaths
 
     def _back_up_var_files(self, paths):
-        """Back up yum variable files.
+        """Back up yum/dnf variable files.
 
         :param paths: Paths to the variable files to back up
         :type paths: list[str]
         """
         logger.info(
-            "Backing up variables files from {} owned by {} packages.".format(
+            "Backing up yum variable files from {} owned by {} packages.".format(
                 " and ".join(self.yum_var_dirs), system_info.name
             )
         )
         if not paths:
-            logger.info("No variables files backed up.")
+            logger.info("No variable files to back up detected.")
+            return
 
         for filepath in paths:
             restorable_file = RestorableFile(filepath)

convert2rhel/pkghandler.py

@@ -200,8 +200,8 @@ def get_rpm_header(pkg_obj):
 
 
 def get_installed_pkg_objects(name=None, version=None, release=None, arch=None):
-    """Return list with installed package objects. The packages can be
-    optionally filtered by name.
+    """Return list with installed package objects (yum.rpmsack.RPMInstalledPackage objects in case
+    of yum and hawkey.Package objects in case of dnf). The packages can be optionally filtered.
     """
     if pkgmanager.TYPE == "yum":
         return _get_installed_pkg_objects_yum(name, version, release, arch)

convert2rhel/unit_tests/actions/post_conversion/update_grub_test.py

@@ -247,3 +247,37 @@ def test_update_grub_error(update_grub_instance, monkeypatch, get_partition_erro
         description="The block device could not be identified, please look at the diagnosis " "for more information.",
         diagnosis=diagnosis,
     )
+
+
+# This function was generated by GitHub Copilot
+@pytest.mark.parametrize(
+    ("releasever_major", "file_content", "expected_log"),
+    [
+        (2, 'GRUB_TERMINAL="ec2-console"', "Successfully updated /etc/default/grub."),
+        (
+            2,
+            'GRUB_TERMINAL="console"',
+            'GRUB_TERMINAL="ec2-console" not found in /etc/default/grub. Nothing to do.',
+        ),
+        (3, 'GRUB_TERMINAL="ec2-console"', "Not running Amazon Linux 2, skipping."),
+    ],
+)
+def test_fix_grub_settings_on_al2(releasever_major, file_content, expected_log, monkeypatch, caplog):
+    monkeypatch.setattr(
+        "convert2rhel.systeminfo.system_info.version",
+        namedtuple("Version", ["major"])(releasever_major),
+    )
+    mock_open = mock.mock_open(read_data=file_content)
+    monkeypatch.setattr("builtins.open", mock_open)
+    monkeypatch.setattr("convert2rhel.utils.get_file_content", mock.Mock(return_value=file_content))
+
+    action = update_grub.FixGrubSettingsOnAL2()
+    action.run()
+
+    if releasever_major == 2 and "ec2-console" in file_content:
+        mock_open.assert_called_with("/etc/default/grub", "w")
+        mock_open().write.assert_called_once_with(file_content.replace("ec2-console", "console"))
+    else:
+        mock_open.assert_not_called()
+
+    assert expected_log in caplog.text

convert2rhel/unit_tests/actions/pre_ponr_changes/backup_system_test.py

@@ -23,11 +23,10 @@
 import six
 
 from convert2rhel import toolopts, unit_tests
-from convert2rhel.actions.pre_ponr_changes import backup_system, yum_variables
+from convert2rhel.actions.pre_ponr_changes import backup_system
 from convert2rhel.backup import files
 from convert2rhel.backup.files import RestorableFile
 from convert2rhel.unit_tests import CriticalErrorCallableObject
-from convert2rhel.unit_tests.conftest import all_systems, centos7, centos8
 from convert2rhel.utils.rpm import PRE_RPM_VA_LOG_FILENAME
 
 
@@ -45,11 +44,6 @@ def backup_repository_action():
     return backup_system.BackupRepository()
 
 
-@pytest.fixture
-def backup_variables_action():
-    return yum_variables.BackUpYumVariables()
-
-
 class RestorableFileBackupMocked(CriticalErrorCallableObject):
     method_spec = RestorableFile.enable
 
@@ -59,19 +53,6 @@ def backup_package_files_action():
     return backup_system.BackupPackageFiles()
 
 
-@pytest.fixture
-def generate_vars(tmpdir):
-    """Create yum and dnf vars folders with file for backup."""
-    tmpdir = tmpdir.mkdir("etc")
-
-    yum_vars = tmpdir.mkdir("yum").mkdir("vars").join("yum_test_var")
-    dnf_vars = tmpdir.mkdir("dnf").mkdir("vars").join("dnf_test_var")
-    yum_vars.write("yum_test_var")
-    dnf_vars.write("dnf_test_var")
-
-    return str(dnf_vars), str(yum_vars)
-
-
 def generate_repo(tmpdir, name):
     """Create .repo file for backup."""
     yum_repofile = tmpdir.mkdir("etc").mkdir("yum.repos.d").join(name)
@@ -469,76 +450,3 @@ def test_backup_repository_no_repofile_presence(self, tmpdir, monkeypatch, caplo
 
         backup_repository.run()
         assert ("Repository folder {} seems to be empty.".format(etc)) in caplog.text
-
-
-class TestBackupVariables:
-    @all_systems
-    def test_backup_variables_nonexisting_path(self, tmpdir, monkeypatch, caplog, backup_variables_action, pretend_os):
-        """Test empty paths, nothing for backup."""
-        etc = tmpdir.mkdir("etc")
-
-        monkeypatch.setattr(yum_variables, "DEFAULT_YUM_VARS_DIR", str(etc))
-        monkeypatch.setattr(yum_variables, "DEFAULT_DNF_VARS_DIR", str(etc))
-
-        backup_variables = backup_variables_action
-
-        backup_variables.run()
-
-        assert "No variables files backed up." in caplog.text
-
-    @centos7
-    def test_backup_variables_for_both_dnf_and_yum(
-        self, pretend_os, monkeypatch, tmpdir, generate_vars, backup_variables_action
-    ):
-        """All dnf and yum var files are to be backed up, not matter the system or package manager installed."""
-        dnf_vars, yum_vars = generate_vars
-
-        backup_dir = str(tmpdir.mkdir("backup"))
-
-        monkeypatch.setattr(files, "BACKUP_DIR", backup_dir)
-
-        backup_variables = backup_variables_action
-
-        backup_variables.run()
-
-        # Mapping if the file should be backed up or not
-        orig_path_dict = {dnf_vars: True, yum_vars: True}
-
-        # Get the target path of backed up file and check presence of the file
-        for path, value in orig_path_dict.items():
-            filename = os.path.basename(path)
-            dirname = os.path.dirname(path)
-            hashed_directory = os.path.join(backup_dir, hashlib.md5(dirname.encode()).hexdigest())
-            backed_up_path = os.path.join(hashed_directory, filename)
-
-            assert os.path.exists(backed_up_path) == value
-
-    @centos8
-    def test_backup_variables_complete(
-        self, monkeypatch, tmpdir, generate_vars, backup_variables_action, global_backup_control, pretend_os
-    ):
-        """Test backup, remove the originals and restore them from backup."""
-        dnf_vars, yum_vars = generate_vars
-
-        backup_dir = str(tmpdir.mkdir("backup"))
-
-        monkeypatch.setattr(files, "BACKUP_DIR", backup_dir)
-
-        backup_variables = backup_variables_action
-
-        backup_variables.run()
-
-        orig_path_list = [dnf_vars, yum_vars]
-
-        # Remove the original files
-        for path in orig_path_list:
-            os.remove(path)
-            assert not os.path.isfile(path)
-
-        global_backup_control.pop_all()
-
-        # Check presence of restored files
-        for path in orig_path_list:
-            assert os.path.isfile(path)
-            with open(path, mode="r") as f:
-                assert f.read() == os.path.basename(path)

convert2rhel/unit_tests/actions/pre_ponr_changes/test_yum_variables.py

@@ -0,0 +1,127 @@
+# Copyright(C) 2025 Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# GitHub Copilot assisted in writing this file.
+
+import pytest
+import six
+
+from convert2rhel import pkghandler
+from convert2rhel.actions.pre_ponr_changes import yum_variables
+from convert2rhel.backup.files import RestorableFile
+
+six.add_move(six.MovedModule("mock", "mock", "unittest.mock"))
+from six.moves import mock
+
+
+@pytest.mark.parametrize(
+    "pkg_names, owned_files, expected_files",
+    [
+        (["pkg1"], ["/etc/yum/vars/pkg1_var"], ["/etc/yum/vars/pkg1_var"]),
+        (["pkg1"], ["/etc/yum/vars/pkg1_var", "/other_file"], ["/etc/yum/vars/pkg1_var"]),
+        (
+            ["pkg1", "pkg2"],
+            ["/etc/yum/vars/pkg1_var", "/etc/yum/vars/pkg2_var"],
+            ["/etc/yum/vars/pkg1_var", "/etc/yum/vars/pkg2_var"],
+        ),
+        (["pkg1"], [], []),
+    ],
+)
+def test_get_yum_var_files_owned_by_pkgs(monkeypatch, pkg_names, owned_files, expected_files):
+    action = yum_variables.BackUpYumVariables()
+
+    def mock_get_files_owned_by_package(pkg):
+        return [file for file in owned_files if "/{}_".format(pkg) in file]
+
+    monkeypatch.setattr(
+        "convert2rhel.actions.pre_ponr_changes.yum_variables.get_files_owned_by_package",
+        mock_get_files_owned_by_package,
+    )
+
+    result = action._get_yum_var_files_owned_by_pkgs(pkg_names)
+
+    assert set(result) == set(expected_files)
+
+
+@pytest.mark.parametrize(
+    "paths, expected_push_calls, log_message",
+    [
+        ([], 0, "No variable files to back up detected."),
+        (
+            ["/etc/yum/vars/pkg1_var", "/etc/yum/vars/pkg2_var"],
+            2,
+            "Yum variables successfully backed up.",
+        ),
+    ],
+)
+def test_back_up_var_files(
+    monkeypatch, paths, expected_push_calls, log_message, global_system_info, global_backup_control, caplog
+):
+    action = yum_variables.BackUpYumVariables()
+    global_system_info.name = "centos"
+    monkeypatch.setattr(yum_variables, "system_info", global_system_info)
+    monkeypatch.setattr(global_backup_control, "push", mock.Mock())
+
+    action._back_up_var_files(paths)
+
+    assert caplog.records[0].levelname == "INFO"
+    assert caplog.records[0].message == (
+        "Backing up yum variable files from {} owned by {} packages.".format(
+            " and ".join(action.yum_var_dirs), "centos"
+        )
+    )
+
+    assert global_backup_control.push.call_count == expected_push_calls
+    for path in paths:
+        global_backup_control.push.assert_any_call(RestorableFile(path))
+
+    assert caplog.records[-1].levelname == "INFO"
+    assert caplog.records[-1].message == log_message
+
+
+@pytest.mark.parametrize(
+    "installed_pkgs, owned_files",
+    [
+        ([], []),
+        (
+            ["pkg1", "pkg2"],
+            ["/etc/yum/vars/pkg1_var", "/etc/yum/vars/pkg2_var"],
+        ),
+    ],
+)
+def test_run(monkeypatch, installed_pkgs, owned_files, global_system_info, caplog):
+    action = yum_variables.BackUpYumVariables()
+    action._back_up_var_files = mock.Mock()
+
+    global_system_info.repofile_pkgs = installed_pkgs
+    monkeypatch.setattr(yum_variables, "system_info", global_system_info)
+
+    class MockObj:
+        def __init__(self, name):
+            self.name = name
+
+    mock_get_installed_pkg_objects = mock.Mock()
+    mock_get_installed_pkg_objects.side_effect = lambda arg: [MockObj(pkg) for pkg in installed_pkgs if pkg == arg]
+    monkeypatch.setattr(pkghandler, "get_installed_pkg_objects", mock_get_installed_pkg_objects)
+    action._get_yum_var_files_owned_by_pkgs = mock.Mock()
+    action._get_yum_var_files_owned_by_pkgs.return_value = owned_files
+
+    action.run()
+
+    assert caplog.records[0].is_task
+    assert caplog.records[0].message == "Back up yum variables"
+    assert "Getting a list of files owned by packages affecting variables in .repo files." in caplog.text
+    assert "Packages affecting yum variables: {0}".format(", ".join(installed_pkgs)) in caplog.text
+    action._back_up_var_files.assert_called_once_with(owned_files)