Merge pull request #329 from raballew/001-noun-aliases

feat: accept both singular and plural noun forms in CLI commands

Author: raballew

python/packages/jumpstarter-cli-admin/jumpstarter_cli_admin/alias_test.py

@@ -0,0 +1,49 @@
+from click.testing import CliRunner
+
+from jumpstarter_cli_admin import admin
+
+
+class TestAdminGetNounAliases:
+    def test_get_clients_resolves_to_get_client(self):
+        runner = CliRunner()
+        result_singular = runner.invoke(admin, ["get", "client", "--help"])
+        result_plural = runner.invoke(admin, ["get", "clients", "--help"])
+        assert result_singular.exit_code == 0
+        assert result_plural.exit_code == 0
+        assert result_singular.output == result_plural.output
+
+    def test_get_exporters_resolves_to_get_exporter(self):
+        runner = CliRunner()
+        result_singular = runner.invoke(admin, ["get", "exporter", "--help"])
+        result_plural = runner.invoke(admin, ["get", "exporters", "--help"])
+        assert result_singular.exit_code == 0
+        assert result_plural.exit_code == 0
+        assert result_singular.output == result_plural.output
+
+    def test_get_cluster_and_clusters_remain_distinct(self):
+        runner = CliRunner()
+        result_singular = runner.invoke(admin, ["get", "cluster", "--help"])
+        result_plural = runner.invoke(admin, ["get", "clusters", "--help"])
+        assert result_singular.exit_code == 0
+        assert result_plural.exit_code == 0
+        assert result_singular.output != result_plural.output
+
+
+class TestAdminCreateNounAliases:
+    def test_create_clusters_resolves_to_create_cluster(self):
+        runner = CliRunner()
+        result_singular = runner.invoke(admin, ["create", "cluster", "--help"])
+        result_plural = runner.invoke(admin, ["create", "clusters", "--help"])
+        assert result_singular.exit_code == 0
+        assert result_plural.exit_code == 0
+        assert result_singular.output == result_plural.output
+
+
+class TestAdminDeleteNounAliases:
+    def test_delete_clusters_resolves_to_delete_cluster(self):
+        runner = CliRunner()
+        result_singular = runner.invoke(admin, ["delete", "cluster", "--help"])
+        result_plural = runner.invoke(admin, ["delete", "clusters", "--help"])
+        assert result_singular.exit_code == 0
+        assert result_plural.exit_code == 0
+        assert result_singular.output == result_plural.output

python/packages/jumpstarter-cli-common/jumpstarter_cli_common/alias.py

@@ -21,8 +21,13 @@ class AliasedGroup(click.Group):
         "delete": ["del", "d"],
         "shell": ["sh", "s"],
         "exporter": ["exporters", "e"],
+        "exporters": ["exporter"],
         "client": ["clients", "c"],
+        "clients": ["client"],
         "lease": ["leases", "l"],
+        "leases": ["lease"],
+        "cluster": ["clusters"],
+        "clusters": ["cluster"],
         "version": ["ver", "v"],
     }
 

python/packages/jumpstarter-cli/jumpstarter_cli/alias_test.py

@@ -0,0 +1,45 @@
+from click.testing import CliRunner
+
+from .jmp import jmp
+
+
+class TestUserCliNounAliases:
+    def test_get_exporter_resolves_to_get_exporters(self):
+        runner = CliRunner()
+        result_plural = runner.invoke(jmp, ["get", "exporters", "--help"])
+        result_singular = runner.invoke(jmp, ["get", "exporter", "--help"])
+        assert result_singular.exit_code == 0
+        assert result_plural.exit_code == 0
+        assert result_singular.output == result_plural.output
+
+    def test_get_lease_resolves_to_get_leases(self):
+        runner = CliRunner()
+        result_plural = runner.invoke(jmp, ["get", "leases", "--help"])
+        result_singular = runner.invoke(jmp, ["get", "lease", "--help"])
+        assert result_singular.exit_code == 0
+        assert result_plural.exit_code == 0
+        assert result_singular.output == result_plural.output
+
+    def test_delete_lease_resolves_to_delete_leases(self):
+        runner = CliRunner()
+        result_plural = runner.invoke(jmp, ["delete", "leases", "--help"])
+        result_singular = runner.invoke(jmp, ["delete", "lease", "--help"])
+        assert result_singular.exit_code == 0
+        assert result_plural.exit_code == 0
+        assert result_singular.output == result_plural.output
+
+    def test_create_leases_resolves_to_create_lease(self):
+        runner = CliRunner()
+        result_singular = runner.invoke(jmp, ["create", "lease", "--help"])
+        result_plural = runner.invoke(jmp, ["create", "leases", "--help"])
+        assert result_plural.exit_code == 0
+        assert result_singular.exit_code == 0
+        assert result_singular.output == result_plural.output
+
+    def test_update_leases_resolves_to_update_lease(self):
+        runner = CliRunner()
+        result_singular = runner.invoke(jmp, ["update", "lease", "--help"])
+        result_plural = runner.invoke(jmp, ["update", "leases", "--help"])
+        assert result_plural.exit_code == 0
+        assert result_singular.exit_code == 0
+        assert result_singular.output == result_plural.output

python/packages/jumpstarter-cli/jumpstarter_cli/create.py

@@ -1,6 +1,7 @@
 from datetime import datetime, timedelta
 
 import click
+from jumpstarter_cli_common.alias import AliasedGroup
 from jumpstarter_cli_common.config import opt_config
 from jumpstarter_cli_common.exceptions import handle_exceptions_with_reauthentication
 from jumpstarter_cli_common.opt import OutputType, opt_output_all
@@ -10,7 +11,7 @@
 from .login import relogin_client
 
 
-@click.group()
+@click.group(cls=AliasedGroup)
 def create():
     """
     Create a resource

python/packages/jumpstarter-cli/jumpstarter_cli/create_test.py

@@ -1,3 +1,4 @@
+import inspect
 from datetime import timedelta
 from unittest.mock import Mock, patch
 
@@ -14,7 +15,7 @@ def test_create_lease_passes_exporter_name_to_config():
 
     with patch("jumpstarter_cli.create.model_print") as model_print:
         # Skip Click config loading wrapper and call the command body directly.
-        create_lease.callback.__wrapped__.__wrapped__(
+        inspect.unwrap(create_lease.callback)(
             config=config,
             selector=None,
             exporter_name="laptop-test-exporter",
@@ -36,7 +37,7 @@ def test_create_lease_passes_exporter_name_to_config():
 
 def test_create_lease_requires_selector_or_name():
     with pytest.raises(click.UsageError, match="one of --selector/-l or --name/-n is required"):
-        create_lease.callback.__wrapped__.__wrapped__(
+        inspect.unwrap(create_lease.callback)(
             config=Mock(),
             selector=None,
             exporter_name=None,

python/packages/jumpstarter-cli/jumpstarter_cli/delete.py

@@ -1,4 +1,5 @@
 import click
+from jumpstarter_cli_common.alias import AliasedGroup
 from jumpstarter_cli_common.config import opt_config
 from jumpstarter_cli_common.exceptions import handle_exceptions_with_reauthentication
 from jumpstarter_cli_common.opt import OutputMode, OutputType, opt_output_name_only
@@ -7,7 +8,7 @@
 from .login import relogin_client
 
 
-@click.group()
+@click.group(cls=AliasedGroup)
 def delete():
     """
     Delete resources
@@ -16,36 +17,35 @@ def delete():
 
 @delete.command(name="leases")
 @opt_config(exporter=False)
-@click.argument("name", required=False)
+@click.argument("names", nargs=-1)
 @opt_selector
 @click.option("--all", "all", is_flag=True)
 @opt_output_name_only
 @handle_exceptions_with_reauthentication(relogin_client)
-def delete_leases(config, name: str, selector: str | None, all: bool, output: OutputType):
+def delete_leases(config, names: tuple[str, ...], selector: str | None, all: bool, output: OutputType):
     """
     Delete leases
     """
 
-    names = []
+    resolved_names = list(names)
 
-    if name is not None:
-        names.append(name)
+    if resolved_names:
+        pass
     elif selector:
         leases = config.list_leases(filter=selector)
-        # Client-side filtering for matchExpressions (server only filters matchLabels)
         leases = leases.filter_by_selector(selector)
         for lease in leases.leases:
             if lease.client == config.metadata.name:
-                names.append(lease.name)
+                resolved_names.append(lease.name)
     elif all:
         leases = config.list_leases(filter=None)
         for lease in leases.leases:
             if lease.client == config.metadata.name:
-                names.append(lease.name)
+                resolved_names.append(lease.name)
     else:
-        raise click.ClickException("One of NAME, --selector or --all must be specified")
+        raise click.ClickException("One of NAME(S), --selector or --all must be specified")
 
-    for name in names:
+    for name in resolved_names:
         config.delete_lease(name=name)
         match output:
             case OutputMode.NAME:

python/packages/jumpstarter-cli/jumpstarter_cli/delete_batch_test.py

@@ -0,0 +1,46 @@
+from unittest.mock import Mock
+
+import click
+import pytest
+
+from jumpstarter_cli.delete import delete_leases
+
+
+class TestBatchDeleteLeases:
+    def test_delete_multiple_leases(self):
+        config = Mock()
+        delete_leases.callback.__wrapped__.__wrapped__(
+            config=config,
+            names=("lease1", "lease2", "lease3"),
+            selector=None,
+            all=False,
+            output=None,
+        )
+        assert config.delete_lease.call_count == 3
+        config.delete_lease.assert_any_call(name="lease1")
+        config.delete_lease.assert_any_call(name="lease2")
+        config.delete_lease.assert_any_call(name="lease3")
+
+    def test_delete_zero_names_no_flags_raises_error(self):
+        config = Mock()
+        with pytest.raises(click.ClickException, match="must be specified"):
+            delete_leases.callback.__wrapped__.__wrapped__(
+                config=config,
+                names=(),
+                selector=None,
+                all=False,
+                output=None,
+            )
+
+    def test_delete_with_output_name(self):
+        from jumpstarter_cli_common.opt import OutputMode
+
+        config = Mock()
+        delete_leases.callback.__wrapped__.__wrapped__(
+            config=config,
+            names=("lease1", "lease2"),
+            selector=None,
+            all=False,
+            output=OutputMode.NAME,
+        )
+        assert config.delete_lease.call_count == 2

python/packages/jumpstarter-cli/jumpstarter_cli/get.py

@@ -1,4 +1,5 @@
 import click
+from jumpstarter_cli_common.alias import AliasedGroup
 from jumpstarter_cli_common.config import opt_config
 from jumpstarter_cli_common.exceptions import handle_exceptions_with_reauthentication
 from jumpstarter_cli_common.opt import OutputType, opt_comma_separated, opt_output_all
@@ -8,7 +9,7 @@
 from .login import relogin_client
 
 
-@click.group()
+@click.group(cls=AliasedGroup)
 def get():
     """
     Display one or many resources

python/packages/jumpstarter-cli/jumpstarter_cli/shell_test.py

@@ -1,3 +1,4 @@
+import inspect
 from contextlib import asynccontextmanager
 from datetime import timedelta
 from unittest.mock import AsyncMock, Mock, patch
@@ -49,7 +50,7 @@ def test_shell_passes_exporter_name_to_lease_async():
 
 def test_shell_requires_selector_or_name():
     with pytest.raises(click.UsageError, match="one of --selector/-l or --name/-n is required"):
-        shell.callback.__wrapped__.__wrapped__(
+        inspect.unwrap(shell.callback)(
             config=Mock(spec=ClientConfigV1Alpha1),
             command=(),
             lease_name=None,
@@ -66,7 +67,7 @@ def test_shell_allows_existing_lease_name_without_selector_or_name():
         patch("jumpstarter_cli.shell.anyio.run", return_value=0),
         patch("jumpstarter_cli.shell.sys.exit") as mock_exit,
     ):
-        shell.callback.__wrapped__.__wrapped__(
+        inspect.unwrap(shell.callback)(
             config=Mock(spec=ClientConfigV1Alpha1),
             command=(),
             lease_name="existing-lease",
@@ -86,7 +87,7 @@ def test_shell_allows_env_lease_without_selector_or_name():
         patch("jumpstarter_cli.shell.sys.exit") as mock_exit,
         patch.dict("os.environ", {JMP_LEASE: "existing-lease"}, clear=False),
     ):
-        shell.callback.__wrapped__.__wrapped__(
+        inspect.unwrap(shell.callback)(
             config=Mock(spec=ClientConfigV1Alpha1),
             command=(),
             lease_name=None,

python/packages/jumpstarter-cli/jumpstarter_cli/update.py

@@ -1,6 +1,7 @@
 from datetime import datetime, timedelta
 
 import click
+from jumpstarter_cli_common.alias import AliasedGroup
 from jumpstarter_cli_common.config import opt_config
 from jumpstarter_cli_common.exceptions import handle_exceptions_with_reauthentication
 from jumpstarter_cli_common.opt import OutputType, opt_output_all
@@ -10,7 +11,7 @@
 from .login import relogin_client
 
 
-@click.group()
+@click.group(cls=AliasedGroup)
 def update():
     """
     Update a resource