Merge pull request #681 from valory-xyz/fix/misleading-message

Fix misleading message on `generate-key`

aea/cli/generate_key.py

@@ -25,7 +25,7 @@
 import click
 
 from aea.cli.add_key import _add_private_key
-from aea.cli.utils.click_utils import password_option
+from aea.cli.utils.click_utils import LedgerChoice, password_option
 from aea.cli.utils.decorators import _check_aea_project
 from aea.configurations.constants import (
     ADDRESS,
@@ -41,7 +41,7 @@
 @click.argument(
     "type_",
     metavar="TYPE",
-    type=click.Choice([*list(crypto_registry.supported_ids), "all"]),
+    type=LedgerChoice(),
     required=True,
 )
 @click.argument(

aea/cli/utils/click_utils.py

@@ -18,7 +18,6 @@
 #
 # ------------------------------------------------------------------------------
 """Module with click utils of the aea cli."""
-
 import os
 from collections import OrderedDict
 from contextlib import contextmanager
@@ -46,6 +45,7 @@
     SKILL,
 )
 from aea.configurations.data_types import Dependency, PackageType, PublicId
+from aea.crypto.registries import crypto_registry
 from aea.helpers.io import open_file
 from aea.package_manager.base import PACKAGE_SOURCE_RE
 
@@ -259,6 +259,34 @@ def convert(self, value: str, param: Any, ctx: click.Context) -> Dependency:
             raise click.ClickException(str(e)) from e
 
 
+class LedgerChoice(click.ParamType):
+    """Ledger choice flag."""
+
+    ALL = "all"
+
+    def get_metavar(self, param: click.Parameter) -> str:
+        """Get metavar name."""
+        return "LEDGER_ID"
+
+    def convert(
+        self,
+        value: str,
+        param: Optional[click.Parameter] = None,
+        ctx: Optional[click.Context] = None,
+    ) -> str:
+        """Convert to ledger id."""
+        if len(crypto_registry.supported_ids) == 0:
+            raise click.ClickException("No ledger installation found")
+
+        if value not in crypto_registry.supported_ids and value != self.ALL:
+            raise click.ClickException(
+                f"Invalid identifier provided `{value}`; "
+                f"Available ledger identifiers {crypto_registry.supported_ids}"
+            )
+
+        return value
+
+
 def registry_flag(
     mark_default: bool = True,
     default_registry: Optional[str] = None,

tests/test_cli/test_generate_key.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # ------------------------------------------------------------------------------
 #
-#   Copyright 2022 Valory AG
+#   Copyright 2022-2023 Valory AG
 #   Copyright 2018-2021 Fetch.AI Limited
 #
 #   Licensed under the Apache License, Version 2.0 (the "License");
@@ -38,7 +38,7 @@
 from aea.cli import cli
 from aea.configurations.constants import MULTIKEY_FILENAME
 from aea.crypto.base import Crypto as BaseCrypto
-from aea.crypto.registries import make_crypto
+from aea.crypto.registries import crypto_registry, make_crypto
 from aea.helpers.io import open_file
 from aea.helpers.sym_link import cd
 from aea.test_tools.test_cases import AEATestCaseEmpty
@@ -105,6 +105,25 @@ def test_all(self):
         Path(FETCHAI_PRIVATE_KEY_FILE).unlink()
         Path(ETHEREUM_PRIVATE_KEY_FILE).unlink()
 
+    def test_invalid_ledger_id(self):
+        """Test that the fetch private key is created correctly."""
+        args = [*CLI_LOG_OPTION, "generate-key", "ledger"]
+        result = self.runner.invoke(cli, args)
+        assert result.exit_code == 1
+        assert "Invalid identifier provided `ledger`" in result.stdout
+
+    def test_no_ledger_installation_found(self):
+        """Test that the fetch private key is created correctly."""
+        args = [*CLI_LOG_OPTION, "generate-key", "ledger"]
+        specs = crypto_registry.specs.copy()
+        crypto_registry.specs = {}
+        try:
+            result = self.runner.invoke(cli, args)
+            assert result.exit_code == 1
+            assert "No ledger installation found" in result.stdout
+        finally:
+            crypto_registry.specs = specs
+
     @classmethod
     def teardown_class(cls):
         """Tear the test down."""