Merge pull request #294 from bocekm/add_option_to_not_remove_rhsm

bocekm · web-flow · commit 50411648b660 · 2021-06-30T11:29:38.000+02:00
Allow conversions of offline systems
diff --git a/convert2rhel/main.py b/convert2rhel/main.py
@@ -170,6 +170,8 @@ def pre_ponr_conversion():
         subscription.download_rhsm_pkgs()
         loggerinst.task("Convert: Subscription Manager - Replace")
         subscription.replace_subscription_manager()
+        loggerinst.task("Convert: Subscription Manager - Verify installation")
+        subscription.verify_rhsm_installed()
         loggerinst.task("Convert: Install RHEL certificates for RHSM")
         system_cert = cert.SystemCert()
         system_cert.install()
diff --git a/convert2rhel/subscription.py b/convert2rhel/subscription.py
@@ -77,6 +77,10 @@ def subscribe_system():
 def unregister_system():
     """Unregister the system from RHSM."""
     loggerinst.info("Unregistering the system.")
+    if tool_opts.keep_rhsm:
+        loggerinst.info("Skipping due to the use of --keep-rhsm.")
+        return
+
     submgr_installed = pkghandler.get_installed_pkg_objects("subscription-manager")
     if not submgr_installed:
         loggerinst.info("The subscription-manager package is not installed.")
@@ -188,6 +192,10 @@ def replace_subscription_manager():
     Make sure the system is unregistered before removing the subscription-manager as not doing so would leave the
     system to be still registered on the server side, making it dificult for an admin to unregister it afterwards.
     """
+    if tool_opts.keep_rhsm:
+        loggerinst.info("Skipping due to the use of --keep-rhsm.")
+        return
+
     if not os.path.isdir(SUBMGR_RPMS_DIR) or not os.listdir(SUBMGR_RPMS_DIR):
         loggerinst.critical("The %s directory does not exist or is empty." % SUBMGR_RPMS_DIR)
 
@@ -347,11 +355,26 @@ def get_repo(repos_raw):
         yield repo_id
 
 
+def verify_rhsm_installed():
+    """Make sure that subscription-manager has been installed."""
+    if not pkghandler.get_installed_pkg_objects("subscription-manager"):
+        if tool_opts.keep_rhsm:
+            loggerinst.critical(
+                "When using the --keep-rhsm option, the subscription-manager needs to be installed before"
+                " executing convert2rhel."
+            )
+        else:
+            # Most probably this condition will not be hit. If the installation of subscription-manager fails, the
+            # conversion stops already at that point.
+            loggerinst.critical("The subscription-manager package is not installed correctly.")
+    else:
+        loggerinst.info("subscription-manager installed correctly.")
+
+
 def disable_repos():
     """Before enabling specific repositories, all repositories should be
     disabled. This can be overriden by the --disablerepo option.
     """
-
     disable_cmd = ""
     for repo in tool_opts.disablerepo:
         disable_cmd += " --disable=%s" % repo
@@ -423,6 +446,9 @@ def download_rhsm_pkgs():
     The packages are available in non-standard repositories, so additional repofiles need to be used. The downloaded
     RPMs are to be installed in a later stage of the conversion.
     """
+    if tool_opts.keep_rhsm:
+        loggerinst.info("Skipping due to the use of --keep-rhsm.")
+        return
     utils.mkdir_p(_RHSM_TMP_DIR)
     pkgs_to_download = ["subscription-manager", "subscription-manager-rhsm-certificates"]
 
diff --git a/convert2rhel/toolopts.py b/convert2rhel/toolopts.py
@@ -44,6 +44,7 @@ def __init__(self):
         self.arch = None
         self.no_rpm_va = False
         self.disable_colors = False
+        self.keep_rhsm = False
 
         # set True when credentials (username & password) are given through CLI
         self.credentials_thru_cli = False
@@ -61,16 +62,13 @@ def _get_argparser():
             "\n"
             "  convert2rhel [-h]\n"
             "  convert2rhel [--version]\n"
-            "  convert2rhel [-u username] [-p password | -f pswd_file]"
-            " [--pool pool_id | -a] [--disablerepo repoid] [--enablerepo"
-            " repoid] [--serverurl url] [--no-rpm-va]"
-            " [--debug] [--restart] [-y]\n"
+            "  convert2rhel [-u username] [-p password | -f pswd_file] [--pool pool_id | -a] [--disablerepo repoid]"
+            " [--enablerepo repoid] [--serverurl url] [--keep-rhsm] [--no-rpm-va] [--debug] [--restart]"
+            " [--disable-colors] [-y]\n"
             "  convert2rhel [--no-rhsm] [--disablerepo repoid]"
-            " [--enablerepo repoid] [--no-rpm-va] [--debug] [--restart] [-y]\n"
-            "  convert2rhel [-k key] [-o organization] [--pool pool_id |"
-            " -a] [--disablerepo repoid] [--enablerepo repoid]"
-            " [--serverurl url] [--no-rpm-va] [--debug]"
-            " [--restart] [--disable-colors] [-y]"
+            " [--enablerepo repoid] [--no-rpm-va] [--debug] [--restart] [--disable-colors] [-y]\n"
+            "  convert2rhel [-k key] [-o organization] [--pool pool_id | -a] [--disablerepo repoid] [--enablerepo"
+            " repoid] [--serverurl url] [--keep-rhsm] [--no-rpm-va] [--debug] [--restart] [--disable-colors] [-y]"
             "\n\n"
             "WARNING: The tool needs to be run under the root user"
         )
@@ -210,6 +208,15 @@ def _register_options(self):
             " The default is the Customer Portal Subscription Management service. It is not to be used to specify a"
             " Satellite server. For that, read the product documentation at https://access.redhat.com/.",
         )
+        group.add_option(
+            "--keep-rhsm",
+            action="store_true",
+            help="Keep the already installed Red Hat Subscription Management-related packages. By default,"
+            " during the conversion, these packages are removed, downloaded from verified sources and re-installed."
+            " This option is suitable for environments with no connection to the Internet, or for systems managed by"
+            " Red Hat Satellite. Warning: The system is being re-registered during the conversion and when the"
+            " re-registration fails, there's no automated rollback to the original registration.",
+        )
         self._parser.add_option_group(group)
 
         group = optparse.OptionGroup(
@@ -282,7 +289,7 @@ def _process_cli_options(self):
         if parsed_opts.no_rhsm or parsed_opts.disable_submgr:
             tool_opts.no_rhsm = True
             if not tool_opts.enablerepo:
-                loggerinst.critical("The --enablerepo option is required if --disable-submgr or --no-rhsm is passed.")
+                loggerinst.critical("The --enablerepo option is required when --disable-submgr or --no-rhsm is used.")
         if not tool_opts.disablerepo:
             # Default to disable every repo except:
             # - the ones passed through --enablerepo
@@ -293,13 +300,21 @@ def _process_cli_options(self):
             tool_opts.pool = parsed_opts.pool
 
         if parsed_opts.serverurl:
-            if parsed_opts.no_rhsm:
+            if tool_opts.no_rhsm:
                 loggerinst.warning(
                     "Ignoring the --serverurl option. It has no effect when --disable-submgr or --no-rhsm is used."
                 )
             else:
                 tool_opts.serverurl = parsed_opts.serverurl
 
+        if parsed_opts.keep_rhsm:
+            if tool_opts.no_rhsm:
+                loggerinst.warning(
+                    "Ignoring the --keep-rhsm option. It has no effect when --disable-submgr or --no-rhsm is used."
+                )
+            else:
+                tool_opts.keep_rhsm = parsed_opts.keep_rhsm
+
         tool_opts.autoaccept = parsed_opts.y
         tool_opts.auto_attach = parsed_opts.auto_attach
         tool_opts.restart = parsed_opts.restart
diff --git a/convert2rhel/unit_tests/main_test.py b/convert2rhel/unit_tests/main_test.py
@@ -154,6 +154,7 @@ def test_rollback_changes(self):
     @mock_calls(main.checks, "perform_pre_ponr_checks", CallOrderMocked)
     @mock_calls(pkghandler, "remove_excluded_pkgs", CallOrderMocked)
     @mock_calls(subscription, "replace_subscription_manager", CallOrderMocked)
+    @mock_calls(subscription, "verify_rhsm_installed", CallOrderMocked)
     @mock_calls(pkghandler, "remove_repofile_pkgs", CallOrderMocked)
     @mock_calls(cert.SystemCert, "install", CallOrderMocked)
     @mock_calls(redhatrelease.YumConf, "patch", CallOrderMocked)
@@ -175,6 +176,7 @@ def test_pre_ponr_conversion_order_with_rhsm(self):
         intended_call_order["check_and_resolve"] = 1
         intended_call_order["download_rhsm_pkgs"] = 1
         intended_call_order["replace_subscription_manager"] = 1
+        intended_call_order["verify_rhsm_installed"] = 1
         intended_call_order["install"] = 1
         intended_call_order["subscribe_system"] = 1
         intended_call_order["get_rhel_repoids"] = 1
@@ -200,6 +202,7 @@ def test_pre_ponr_conversion_order_with_rhsm(self):
     @mock_calls(main.checks, "perform_pre_ponr_checks", CallOrderMocked)
     @mock_calls(pkghandler, "remove_excluded_pkgs", CallOrderMocked)
     @mock_calls(subscription, "replace_subscription_manager", CallOrderMocked)
+    @mock_calls(subscription, "verify_rhsm_installed", CallOrderMocked)
     @mock_calls(pkghandler, "remove_repofile_pkgs", CallOrderMocked)
     @mock_calls(cert.SystemCert, "install", CallOrderMocked)
     @mock_calls(redhatrelease.YumConf, "patch", CallOrderMocked)
@@ -224,6 +227,7 @@ def test_pre_ponr_conversion_order_without_rhsm(self):
         # Do not expect this one to be called - related to RHSM
         intended_call_order["download_rhsm_pkgs"] = 0
         intended_call_order["replace_subscription_manager"] = 0
+        intended_call_order["verify_rhsm_installed"] = 0
         intended_call_order["install"] = 0
         intended_call_order["subscribe_system"] = 0
         intended_call_order["get_rhel_repoids"] = 0
diff --git a/convert2rhel/unit_tests/subscription_test.py b/convert2rhel/unit_tests/subscription_test.py
@@ -409,7 +409,7 @@ def __call__(self, pkg, dest, reposdir=None):
         (False, False),
     ),
 )
-def test_unregister_system_successfully(submgr_installed, unregistration_failure, monkeypatch, caplog):
+def test_unregister_system(submgr_installed, unregistration_failure, monkeypatch, caplog):
     if unregistration_failure:
         monkeypatch.setattr(utils, "run_subprocess", mock.Mock(return_value=("output", 1)))
     else:
@@ -426,11 +426,63 @@ def test_unregister_system_successfully(submgr_installed, unregistration_failure
 
     if submgr_installed:
         utils.run_subprocess.assert_called_once()
-
-    if submgr_installed:
         if unregistration_failure:
             assert "System unregistration failed" in caplog.text
         else:
             assert "System unregistered successfully." in caplog.text
     else:
         assert "The subscription-manager package is not installed." in caplog.text
+
+
+@mock.patch("convert2rhel.toolopts.tool_opts.keep_rhsm", True)
+def test_unregister_system_skipped(monkeypatch, caplog):
+    monkeypatch.setattr(pkghandler, "get_installed_pkg_objects", mock.Mock())
+    subscription.unregister_system()
+    assert "Skipping due to the use of --keep-rhsm." in caplog.text
+    pkghandler.get_installed_pkg_objects.assert_not_called()
+
+
+@mock.patch("convert2rhel.toolopts.tool_opts.keep_rhsm", True)
+def test_replace_subscription_manager_skipped(monkeypatch, caplog):
+    monkeypatch.setattr(subscription, "unregister_system", mock.Mock())
+    subscription.replace_subscription_manager()
+    assert "Skipping due to the use of --keep-rhsm." in caplog.text
+    subscription.unregister_system.assert_not_called()
+
+
+@mock.patch("convert2rhel.toolopts.tool_opts.keep_rhsm", True)
+def test_download_rhsm_pkgs_skipped(monkeypatch, caplog):
+    monkeypatch.setattr(subscription, "_download_rhsm_pkgs", mock.Mock())
+    subscription.download_rhsm_pkgs()
+    assert "Skipping due to the use of --keep-rhsm." in caplog.text
+    subscription._download_rhsm_pkgs.assert_not_called()
+
+
+@pytest.mark.parametrize(
+    ("submgr_installed", "keep_rhsm", "critical_string"),
+    (
+        (True, None, None),
+        (False, True, "the subscription-manager needs to be installed"),
+        (False, False, "The subscription-manager package is not installed correctly."),
+    ),
+)
+def test_verify_rhsm_installed(submgr_installed, keep_rhsm, critical_string, monkeypatch, caplog):
+    if keep_rhsm:
+        monkeypatch.setattr(tool_opts, "keep_rhsm", keep_rhsm)
+
+    if submgr_installed:
+        monkeypatch.setattr(
+            pkghandler, "get_installed_pkg_objects", lambda _: [namedtuple("Pkg", ["name"])("subscription-manager")]
+        )
+
+        subscription.verify_rhsm_installed()
+
+        assert "subscription-manager installed correctly." in caplog.text
+
+    else:
+        monkeypatch.setattr(pkghandler, "get_installed_pkg_objects", lambda _: None)
+
+        with pytest.raises(SystemExit):
+            subscription.verify_rhsm_installed()
+
+        assert critical_string in caplog.text
diff --git a/convert2rhel/unit_tests/toolopts_test.py b/convert2rhel/unit_tests/toolopts_test.py
@@ -80,6 +80,24 @@ def test_cmdline_disablerepo_defaults_to_asterisk(self):
         self.assertEqual(tool_opts.disablerepo, ["*"])
 
 
+@pytest.mark.parametrize(
+    ("argv", "warn", "keep_rhsm_value"),
+    (
+        (mock_cli_arguments(["--keep-rhsm"]), False, True),
+        (mock_cli_arguments(["--keep-rhsm", "--disable-submgr", "--enablerepo", "test_repo"]), True, False),
+    ),
+)
+@mock.patch("convert2rhel.toolopts.tool_opts.keep_rhsm", False)
+def test_keep_rhsm(argv, warn, keep_rhsm_value, monkeypatch, caplog):
+    monkeypatch.setattr(sys, "argv", argv)
+    convert2rhel.toolopts.CLI()
+    if warn:
+        assert "Ignoring the --keep-rhsm option" in caplog.text
+    else:
+        assert "Ignoring the --keep-rhsm option" not in caplog.text
+    assert convert2rhel.toolopts.tool_opts.keep_rhsm == keep_rhsm_value
+
+
 @pytest.mark.parametrize(
     ("argv", "warn", "ask_to_continue"),
     (
@@ -109,19 +127,20 @@ def test_cmdline_obsolete_variant_option(argv, warn, ask_to_continue, monkeypatc
     ("argv", "raise_exception", "no_rhsm_value"),
     (
         (mock_cli_arguments(["--disable-submgr"]), True, True),
+        (mock_cli_arguments(["--no-rhsm"]), True, True),
         (mock_cli_arguments(["--disable-submgr", "--enablerepo", "test_repo"]), False, True),
         (mock_cli_arguments(["--no-rhsm", "--disable-submgr", "--enablerepo", "test_repo"]), False, True),
-        (mock_cli_arguments(["--no-rhsm"]), False, True),
     ),
 )
 @mock.patch("convert2rhel.toolopts.tool_opts.no_rhsm", False)
+@mock.patch("convert2rhel.toolopts.tool_opts.enablerepo", [])
 def test_both_disable_submgr_and_no_rhsm_options_work(argv, raise_exception, no_rhsm_value, monkeypatch, caplog):
     monkeypatch.setattr(sys, "argv", argv)
 
     if raise_exception:
         with pytest.raises(SystemExit):
             convert2rhel.toolopts.CLI()
-            assert "The --enablerepo option is required if --disable-submgr or --no-rhsm is passed." in caplog.text
+            assert "The --enablerepo option is required when --disable-submgr or --no-rhsm is used." in caplog.text
     else:
         convert2rhel.toolopts.CLI()
 
