Merge pull request 'clan: add dynamic completions to clan secrets {users,groups} and add completion functions' (#1556) from kenji/clan-core:add/completion/to-groups into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/1556

pkgs/clan-cli/clan_cli/completions.py

@@ -144,6 +144,49 @@ def complete_secrets(
     return secrets_dict
 
 
+def complete_users(
+    prefix: str, parsed_args: argparse.Namespace, **kwargs: Any
+) -> Iterable[str]:
+    """
+    Provides completion functionality for clan users
+    """
+    from pathlib import Path
+
+    from .secrets.users import list_users
+
+    if (clan_dir_result := clan_dir(None)) is not None:
+        flake = clan_dir_result
+    else:
+        flake = "."
+
+    users = list_users(Path(flake))
+
+    users_dict = {name: "user" for name in users}
+    return users_dict
+
+
+def complete_groups(
+    prefix: str, parsed_args: argparse.Namespace, **kwargs: Any
+) -> Iterable[str]:
+    """
+    Provides completion functionality for clan groups
+    """
+    from pathlib import Path
+
+    from .secrets.groups import list_groups
+
+    if (clan_dir_result := clan_dir(None)) is not None:
+        flake = clan_dir_result
+    else:
+        flake = "."
+
+    groups_list = list_groups(Path(flake))
+    groups = [group.name for group in groups_list]
+
+    groups_dict = {name: "group" for name in groups}
+    return groups_dict
+
+
 def add_dynamic_completer(
     action: argparse.Action,
     completer: Callable[..., Iterable[str]],

pkgs/clan-cli/clan_cli/secrets/groups.py

@@ -4,6 +4,13 @@ from pathlib import Path
 
 from clan_cli.git import commit_files
 
+from ..completions import (
+    add_dynamic_completer,
+    complete_groups,
+    complete_machines,
+    complete_secrets,
+    complete_users,
+)
 from ..errors import ClanError
 from ..machines.types import machine_name_type, validate_hostname
 from . import secrets
@@ -189,7 +196,10 @@ def remove_machine_command(args: argparse.Namespace) -> None:
 
 
 def add_group_argument(parser: argparse.ArgumentParser) -> None:
-    parser.add_argument("group", help="the name of the group", type=group_name_type)
+    group_action = parser.add_argument(
+        "group", help="the name of the secret", type=group_name_type
+    )
+    add_dynamic_completer(group_action, complete_groups)
 
 
 def add_secret(flake_dir: Path, group: str, name: str) -> None:
@@ -234,9 +244,10 @@ def register_groups_parser(parser: argparse.ArgumentParser) -> None:
         "add-machine", help="add a machine to group"
     )
     add_group_argument(add_machine_parser)
-    add_machine_parser.add_argument(
+    add_machine_action = add_machine_parser.add_argument(
         "machine", help="the name of the machines to add", type=machine_name_type
     )
+    add_dynamic_completer(add_machine_action, complete_machines)
     add_machine_parser.set_defaults(func=add_machine_command)
 
     # Remove machine
@@ -244,49 +255,50 @@ def register_groups_parser(parser: argparse.ArgumentParser) -> None:
         "remove-machine", help="remove a machine from group"
     )
     add_group_argument(remove_machine_parser)
-    remove_machine_parser.add_argument(
+    remove_machine_action = remove_machine_parser.add_argument(
         "machine", help="the name of the machines to remove", type=machine_name_type
     )
+    add_dynamic_completer(remove_machine_action, complete_machines)
     remove_machine_parser.set_defaults(func=remove_machine_command)
 
     # Add user
     add_user_parser = subparser.add_parser("add-user", help="add a user to group")
     add_group_argument(add_user_parser)
-    add_user_parser.add_argument(
+    add_user_action = add_user_parser.add_argument(
         "user", help="the name of the user to add", type=user_name_type
     )
+    add_dynamic_completer(add_user_action, complete_users)
     add_user_parser.set_defaults(func=add_user_command)
 
     # Remove user
     remove_user_parser = subparser.add_parser(
-        "remove-user", help="remove a user from group"
+        "remove-user", help="remove a user from a group"
     )
     add_group_argument(remove_user_parser)
-    remove_user_parser.add_argument(
+    remove_user_action = remove_user_parser.add_argument(
         "user", help="the name of the user to remove", type=user_name_type
     )
+    add_dynamic_completer(remove_user_action, complete_users)
     remove_user_parser.set_defaults(func=remove_user_command)
 
     # Add secret
     add_secret_parser = subparser.add_parser(
-        "add-secret", help="allow a user to access a secret"
+        "add-secret", help="allow a groups to access a secret"
     )
-    add_secret_parser.add_argument(
+    add_group_argument(add_secret_parser)
-        "group", help="the name of the user", type=group_name_type
+    add_secret_action = add_secret_parser.add_argument(
-    )
-    add_secret_parser.add_argument(
         "secret", help="the name of the secret", type=secret_name_type
     )
+    add_dynamic_completer(add_secret_action, complete_secrets)
     add_secret_parser.set_defaults(func=add_secret_command)
 
     # Remove secret
     remove_secret_parser = subparser.add_parser(
         "remove-secret", help="remove a group's access to a secret"
     )
-    remove_secret_parser.add_argument(
+    add_group_argument(remove_secret_parser)
-        "group", help="the name of the group", type=group_name_type
+    remove_secret_action = remove_secret_parser.add_argument(
-    )
-    remove_secret_parser.add_argument(
         "secret", help="the name of the secret", type=secret_name_type
     )
+    add_dynamic_completer(remove_secret_action, complete_secrets)
     remove_secret_parser.set_defaults(func=remove_secret_command)

pkgs/clan-cli/clan_cli/secrets/users.py

@@ -1,6 +1,11 @@
 import argparse
 from pathlib import Path
 
+from ..completions import (
+    add_dynamic_completer,
+    complete_secrets,
+    complete_users,
+)
 from ..errors import ClanError
 from ..git import commit_files
 from . import secrets
@@ -141,31 +146,41 @@ def register_users_parser(parser: argparse.ArgumentParser) -> None:
     add_parser.set_defaults(func=add_command)
 
     get_parser = subparser.add_parser("get", help="get a user public key")
-    get_parser.add_argument("user", help="the name of the user", type=user_name_type)
+    get_user_action = get_parser.add_argument(
+        "user", help="the name of the user", type=user_name_type
+    )
+    add_dynamic_completer(get_user_action, complete_users)
     get_parser.set_defaults(func=get_command)
 
     remove_parser = subparser.add_parser("remove", help="remove a user")
-    remove_parser.add_argument("user", help="the name of the user", type=user_name_type)
+    remove_user_action = remove_parser.add_argument(
+        "user", help="the name of the user", type=user_name_type
+    )
+    add_dynamic_completer(remove_user_action, complete_users)
     remove_parser.set_defaults(func=remove_command)
 
     add_secret_parser = subparser.add_parser(
         "add-secret", help="allow a user to access a secret"
     )
-    add_secret_parser.add_argument(
+    add_secret_user_action = add_secret_parser.add_argument(
-        "user", help="the name of the group", type=user_name_type
+        "user", help="the name of the user", type=user_name_type
     )
-    add_secret_parser.add_argument(
+    add_dynamic_completer(add_secret_user_action, complete_users)
+    add_secrets_action = add_secret_parser.add_argument(
         "secret", help="the name of the secret", type=secret_name_type
     )
+    add_dynamic_completer(add_secrets_action, complete_secrets)
     add_secret_parser.set_defaults(func=add_secret_command)
 
     remove_secret_parser = subparser.add_parser(
         "remove-secret", help="remove a user's access to a secret"
     )
-    remove_secret_parser.add_argument(
+    remove_secret_user_action = remove_secret_parser.add_argument(
         "user", help="the name of the group", type=user_name_type
     )
-    remove_secret_parser.add_argument(
+    add_dynamic_completer(remove_secret_user_action, complete_users)
+    remove_secrets_action = remove_secret_parser.add_argument(
         "secret", help="the name of the secret", type=secret_name_type
     )
+    add_dynamic_completer(remove_secrets_action, complete_secrets)
     remove_secret_parser.set_defaults(func=remove_secret_command)