cli: refactor detach to the new approach

Signed-off-by: Renan Rodrigo <[email protected]>

features/help.feature

@@ -111,6 +111,19 @@ Feature: Pro Client help text
       (optional arguments|options):
         -h, --help  show this help message and exit
       """
+    When I run `pro detach --help` as non-root
+    Then stdout matches regexp:
+      """
+      usage: pro detach \[flags\]
+
+      Detach this machine from an Ubuntu Pro subscription.
+
+      (optional arguments|options):
+        -h, --help           show this help message and exit
+        --assume-yes         do not prompt for confirmation before performing the
+                             detach
+        --format \{cli,json\}  output in the specified format \(default: cli\)
+      """
 
     Examples: ubuntu release
       | release | machine_type  |

uaclient/cli/__init__.py

@@ -13,7 +13,6 @@
     apt_news,
     config,
     contract,
-    daemon,
     defaults,
     entitlements,
     event_logger,
@@ -24,7 +23,6 @@
     messages,
     security_status,
     status,
-    timer,
     util,
     version,
 )
@@ -38,11 +36,11 @@
 from uaclient.cli.auto_attach import auto_attach_command
 from uaclient.cli.collect_logs import collect_logs_command
 from uaclient.cli.constants import NAME, USAGE_TMPL
-from uaclient.cli.disable import disable_command, perform_disable
+from uaclient.cli.detach import detach_command
+from uaclient.cli.disable import disable_command
 from uaclient.cli.enable import enable_command
-from uaclient.entitlements import entitlements_disable_order
 from uaclient.entitlements.entitlement_status import ApplicationStatus
-from uaclient.files import machine_token, state_files
+from uaclient.files import state_files
 from uaclient.log import get_user_or_root_log_file_path
 from uaclient.timer.update_messaging import refresh_motd, update_motd_messages
 from uaclient.yaml import safe_dump
@@ -59,6 +57,7 @@
     attach_command,
     auto_attach_command,
     collect_logs_command,
+    detach_command,
     disable_command,
     enable_command,
 ]
@@ -256,28 +255,6 @@ def action_security_status(args, *, cfg, **kwargs):
     return 0
 
 
-def detach_parser(parser):
-    """Build or extend an arg parser for detach subcommand."""
-    usage = USAGE_TMPL.format(name=NAME, command="detach")
-    parser.usage = usage
-    parser.prog = "detach"
-    parser.description = messages.CLI_DETACH_DESC
-    parser._optionals.title = "Flags"
-    parser.add_argument(
-        "--assume-yes",
-        action="store_true",
-        help=messages.CLI_ASSUME_YES.format(command="detach"),
-    )
-    parser.add_argument(
-        "--format",
-        action="store",
-        choices=["cli", "json"],
-        default="cli",
-        help=messages.CLI_FORMAT_DESC.format(default="cli"),
-    )
-    return parser
-
-
 def help_parser(parser, cfg: config.UAConfig):
     """Build or extend an arg parser for help subcommand."""
     usage = USAGE_TMPL.format(name=NAME, command="help [service]")
@@ -598,76 +575,6 @@ def action_config_unset(args, *, cfg, **kwargs):
     return 0
 
 
-@cli_util.verify_json_format_args
-@cli_util.assert_root
-@cli_util.assert_attached()
-@cli_util.assert_lock_file("pro detach")
-def action_detach(args, *, cfg, **kwargs) -> int:
-    """Perform the detach action for this machine.
-
-    @return: 0 on success, 1 otherwise
-    """
-    ret = _detach(
-        cfg, assume_yes=args.assume_yes, json_output=(args.format == "json")
-    )
-    if ret == 0:
-        daemon.start()
-        timer.stop()
-    event.process_events()
-    return ret
-
-
-def _detach(cfg: config.UAConfig, assume_yes: bool, json_output: bool) -> int:
-    """Detach the machine from the active Ubuntu Pro subscription,
-
-    :param cfg: a ``config.UAConfig`` instance
-    :param assume_yes: Assume a yes answer to any prompts requested.
-         In this case, it means automatically disable any service during
-         detach.
-    :param json_output: output should be json only
-
-    @return: 0 on success, 1 otherwise
-    """
-    to_disable = []
-    for ent_name in entitlements_disable_order(cfg):
-        try:
-            ent = entitlements.entitlement_factory(
-                cfg=cfg,
-                name=ent_name,
-            )
-        except exceptions.EntitlementNotFoundError:
-            continue
-
-        # For detach, we should not consider that a service
-        # cannot be disabled because of dependent services,
-        # since we are going to disable all of them anyway
-        ret, _ = ent.can_disable(ignore_dependent_services=True)
-        if ret:
-            to_disable.append(ent)
-
-    if to_disable:
-        event.info(messages.DETACH_WILL_DISABLE.pluralize(len(to_disable)))
-        for ent in to_disable:
-            event.info("    {}".format(ent.name))
-    if not util.prompt_for_confirmation(assume_yes=assume_yes):
-        return 1
-    for ent in to_disable:
-        perform_disable(
-            ent,
-            cfg,
-            json_output=json_output,
-            assume_yes=assume_yes,
-            update_status=False,
-        )
-
-    machine_token_file = machine_token.get_machine_token_file(cfg)
-    machine_token_file.delete()
-    state_files.delete_state_files()
-    update_motd_messages(cfg)
-    event.info(messages.DETACH_SUCCESS)
-    return 0
-
-
 def get_parser(cfg: config.UAConfig):
     parser = UAArgumentParser(
         prog=NAME,
@@ -700,12 +607,6 @@ def get_parser(cfg: config.UAConfig):
     config_parser(parser_config)
     parser_config.set_defaults(action=action_config)
 
-    parser_detach = subparsers.add_parser(
-        "detach", help=messages.CLI_ROOT_DETACH
-    )
-    detach_parser(parser_detach)
-    parser_detach.set_defaults(action=action_detach)
-
     fix.add_parser(subparsers)
 
     parser_security_status = subparsers.add_parser(

uaclient/cli/detach.py

@@ -0,0 +1,109 @@
+from uaclient import (
+    config,
+    daemon,
+    entitlements,
+    event_logger,
+    exceptions,
+    messages,
+    timer,
+    util,
+)
+from uaclient.cli import cli_util
+from uaclient.cli.commands import ProArgument, ProCommand
+from uaclient.cli.disable import perform_disable
+from uaclient.files import machine_token, state_files
+from uaclient.timer.update_messaging import update_motd_messages
+
+event = event_logger.get_event_logger()
+
+
+@cli_util.verify_json_format_args
+@cli_util.assert_root
+@cli_util.assert_attached()
+@cli_util.assert_lock_file("pro detach")
+def action_detach(args, *, cfg, **kwargs) -> int:
+    """Perform the detach action for this machine.
+
+    @return: 0 on success, 1 otherwise
+    """
+    ret = _detach(
+        cfg, assume_yes=args.assume_yes, json_output=(args.format == "json")
+    )
+    if ret == 0:
+        daemon.start()
+        timer.stop()
+    event.process_events()
+    return ret
+
+
+def _detach(cfg: config.UAConfig, assume_yes: bool, json_output: bool) -> int:
+    """Detach the machine from the active Ubuntu Pro subscription,
+
+    :param cfg: a ``config.UAConfig`` instance
+    :param assume_yes: Assume a yes answer to any prompts requested.
+         In this case, it means automatically disable any service during
+         detach.
+    :param json_output: output should be json only
+
+    @return: 0 on success, 1 otherwise
+    """
+    to_disable = []
+    for ent_name in entitlements.entitlements_disable_order(cfg):
+        try:
+            ent = entitlements.entitlement_factory(
+                cfg=cfg,
+                name=ent_name,
+            )
+        except exceptions.EntitlementNotFoundError:
+            continue
+
+        # For detach, we should not consider that a service
+        # cannot be disabled because of dependent services,
+        # since we are going to disable all of them anyway
+        ret, _ = ent.can_disable(ignore_dependent_services=True)
+        if ret:
+            to_disable.append(ent)
+
+    if to_disable:
+        event.info(messages.DETACH_WILL_DISABLE.pluralize(len(to_disable)))
+        for ent in to_disable:
+            event.info("    {}".format(ent.name))
+    if not util.prompt_for_confirmation(assume_yes=assume_yes):
+        return 1
+    for ent in to_disable:
+        perform_disable(
+            ent,
+            cfg,
+            json_output=json_output,
+            assume_yes=assume_yes,
+            update_status=False,
+        )
+
+    machine_token_file = machine_token.get_machine_token_file(cfg)
+    machine_token_file.delete()
+    state_files.delete_state_files()
+    update_motd_messages(cfg)
+    event.info(messages.DETACH_SUCCESS)
+    return 0
+
+
+detach_command = ProCommand(
+    "detach",
+    help=messages.CLI_ROOT_DETACH,
+    description=messages.CLI_DETACH_DESC,
+    action=action_detach,
+    arguments=[
+        ProArgument(
+            "--assume-yes",
+            help=messages.CLI_ASSUME_YES.format(command="detach"),
+            action="store_true",
+        ),
+        ProArgument(
+            "--format",
+            help=messages.CLI_FORMAT_DESC.format(default="cli"),
+            action="store",
+            choices=["cli", "json"],
+            default="cli",
+        ),
+    ],
+)

uaclient/cli/fix.py

@@ -58,6 +58,7 @@
     _is_attached,
 )
 from uaclient.cli.constants import NAME, USAGE_TMPL
+from uaclient.cli.detach import action_detach
 from uaclient.clouds.identity import (
     CLOUD_TYPE_TO_TITLE,
     PRO_CLOUD_URLS,
@@ -472,8 +473,6 @@ def _prompt_for_new_token(cfg: UAConfig) -> bool:
     """
     import argparse
 
-    from uaclient import cli
-
     _inform_ubuntu_pro_existence_if_applicable()
     print(messages.SECURITY_UPDATE_NOT_INSTALLED_EXPIRED)
     choice = util.prompt_choices(
@@ -484,9 +483,7 @@ def _prompt_for_new_token(cfg: UAConfig) -> bool:
         print(messages.PROMPT_EXPIRED_ENTER_TOKEN)
         token = input("> ")
         print(colorize_commands([["pro", "detach"]]))
-        cli.action_detach(
-            argparse.Namespace(assume_yes=True, format="cli"), cfg
-        )
+        action_detach(argparse.Namespace(assume_yes=True, format="cli"), cfg)
         return _run_ua_attach(cfg, token)
 
     return False