Improving unit tests for Aleph client commands

.gitignore

@@ -19,6 +19,7 @@ __pycache__/*
 .pydevproject
 .settings
 .idea
+*.iml
 tags
 
 # Package files

src/aleph_client/__init__.py

@@ -15,4 +15,6 @@
 
 def __getattr__(name):
     if name in moved_types:
-        raise ImportError(f"The 'aleph_client.{name}' type is deprecated and has been removed from aleph_client. Please use `aleph.sdk.{name}` instead.")
+        raise ImportError(
+            f"The 'aleph_client.{name}' type is deprecated and has been removed from aleph_client. Please use `aleph.sdk.{name}` instead."
+        )

src/aleph_client/__main__.py

@@ -2,20 +2,10 @@
 Aleph Client command-line interface.
 """
 
+from aleph_client.commands import (about, account, aggregate, domain, files,
+                                   instance, message, node, program)
 from aleph_client.utils import AsyncTyper
 
-from aleph_client.commands import (
-    about,
-    account,
-    aggregate,
-    domain,
-    files,
-    instance,
-    message,
-    node,
-    program,
-)
-
 app = AsyncTyper(no_args_is_help=True)
 
 app.add_typer(account.app, name="account", help="Manage account")

src/aleph_client/commands/about.py

@@ -14,7 +14,7 @@ def get_version(value: bool):
             __version__ = get_distribution(dist_name).version
         finally:
             typer.echo(f"Aleph CLI Version: {__version__}")
-            raise typer.Exit(1)
+            raise typer.Exit()
 
 
 @app.command()

src/aleph_client/commands/account.py

@@ -2,6 +2,7 @@
 import base64
 import json
 import logging
+import os
 import sys
 from pathlib import Path
 from typing import Optional
@@ -14,10 +15,10 @@
 from aleph.sdk.conf import settings as sdk_settings
 from aleph.sdk.types import AccountFromPrivateKey
 from aleph.sdk.utils import extended_json_encoder
-from typer.colors import RED
 
 from aleph_client.commands import help_strings
 from aleph_client.commands.utils import setup_logging
+from aleph_client.exit_codes import exit_with_error_message
 from aleph_client.utils import AsyncTyper
 
 logger = logging.getLogger(__name__)
@@ -45,9 +46,9 @@ def create(
         )
 
     if private_key_file.exists() and not replace:
-        typer.secho(f"Error: key already exists: '{private_key_file}'", fg=RED)
-
-        raise typer.Exit(1)
+        exit_with_error_message(
+            os.EX_CANTCREAT, f"key already exists: '{private_key_file}'"
+        )
 
     private_key_bytes: bytes
     if private_key is not None:
@@ -58,12 +59,11 @@ def create(
         private_key_bytes = generate_key()
 
     if not private_key_bytes:
-        typer.secho("An unexpected error occurred!", fg=RED)
-        raise typer.Exit(2)
+        exit_with_error_message(os.EX_DATAERR, "Failed to load private key")
 
     private_key_file.parent.mkdir(parents=True, exist_ok=True)
     private_key_file.write_bytes(private_key_bytes)
-    typer.secho(f"Private key stored in {private_key_file}", fg=RED)
+    typer.echo(f"Private key stored in {private_key_file}")
 
 
 @app.command()
@@ -82,8 +82,7 @@ def address(
     if private_key is not None:
         private_key_file = None
     elif private_key_file and not private_key_file.exists():
-        typer.secho("No private key available", fg=RED)
-        raise typer.Exit(code=1)
+        exit_with_error_message(os.EX_NOINPUT, "No private key provided")
 
     account: AccountFromPrivateKey = _load_account(private_key, private_key_file)
     typer.echo(account.get_address())
@@ -105,15 +104,16 @@ def export_private_key(
     if private_key is not None:
         private_key_file = None
     elif private_key_file and not private_key_file.exists():
-        typer.secho("No private key available", fg=RED)
-        raise typer.Exit(code=1)
+        exit_with_error_message(os.EX_NOINPUT, "No private key provided")
 
     account: AccountFromPrivateKey = _load_account(private_key, private_key_file)
     if hasattr(account, "private_key"):
         private_key_hex: str = base64.b16encode(account.private_key).decode().lower()
         typer.echo(f"0x{private_key_hex}")
     else:
-        typer.secho(f"Private key cannot be read for {account}", fg=RED)
+        exit_with_error_message(
+            os.EX_DATAERR, f"Private key cannot be read for {account}"
+        )
 
 
 @app.command()
@@ -170,7 +170,9 @@ async def balance(
             response = await session.get(uri)
             if response.status == 200:
                 balance_data = await response.json()
-                formatted_balance_data = json.dumps(balance_data, indent=4, default=extended_json_encoder)
+                formatted_balance_data = json.dumps(
+                    balance_data, indent=4, default=extended_json_encoder
+                )
                 typer.echo(formatted_balance_data)
             else:
                 typer.echo(

src/aleph_client/commands/aggregate.py

@@ -1,4 +1,5 @@
 import json
+import os
 from pathlib import Path
 from typing import Optional
 
@@ -13,6 +14,7 @@
 
 from aleph_client.commands import help_strings
 from aleph_client.commands.utils import setup_logging
+from aleph_client.exit_codes import exit_with_error_message
 from aleph_client.utils import AsyncTyper
 
 app = AsyncTyper(no_args_is_help=True)
@@ -45,13 +47,16 @@ async def forget(
         message_response = await client.get_messages(
             message_filter=MessageFilter(
                 addresses=[account.get_address()],
-                message_types=[MessageType.aggregate.value],
+                message_types=[MessageType.aggregate],
                 content_keys=[key],
             )
         )
-        hash_list = [message["item_hash"] for message in message_response.messages]
 
-        await client.forget(hashes=hash_list, reason=reason, channel=channel)
+        hash_list = [message.item_hash for message in message_response.messages]
+
+        typer.echo(
+            await client.forget(hashes=hash_list, reason=reason, channel=channel)
+        )
 
 
 @app.command()
@@ -81,8 +86,9 @@ async def post(
     try:
         content_dict = json.loads(content)
     except json.JSONDecodeError:
-        typer.echo("Invalid JSON for content. Please provide valid JSON.")
-        raise typer.Exit(1)
+        exit_with_error_message(
+            os.EX_DATAERR, "Invalid JSON for content. Please provide valid JSON."
+        )
 
     async with AuthenticatedAlephHttpClient(
         account=account, api_server=sdk_settings.API_HOST
@@ -95,7 +101,9 @@ async def post(
             inline=inline,
             address=address,
         )
-        log_message = json.dumps(message.dict(), indent=4, default=extended_json_encoder)
+        log_message = json.dumps(
+            message.dict(), indent=4, default=extended_json_encoder
+        )
         typer.echo(log_message)
 
 

src/aleph_client/commands/domain.py

@@ -6,13 +6,8 @@
 from aleph.sdk.account import _load_account
 from aleph.sdk.client import AlephHttpClient, AuthenticatedAlephHttpClient
 from aleph.sdk.conf import settings as sdk_settings
-from aleph.sdk.domain import (
-    DomainValidator,
-    Hostname,
-    TargetType,
-    get_target_type,
-    hostname_from_url,
-)
+from aleph.sdk.domain import (DomainValidator, Hostname, TargetType,
+                              get_target_type, hostname_from_url)
 from aleph.sdk.exceptions import DomainConfigurationError
 from aleph.sdk.query.filters import MessageFilter
 from aleph.sdk.types import AccountFromPrivateKey
@@ -74,7 +69,9 @@ async def attach_resource(
         item_hash = Prompt.ask("Enter Hash reference of the resource to attach")
 
     while not spa:
-        is_spa: str = Prompt.ask("It is an SPA application?", choices=["y", "n"], default="n")
+        is_spa: str = Prompt.ask(
+            "It is an SPA application?", choices=["y", "n"], default="n"
+        )
         spa = True if is_spa == "y" else False
 
     table = Table(title=f"Attach resource to: {fqdn}")
@@ -281,7 +278,11 @@ async def attach(
     account: AccountFromPrivateKey = _load_account(private_key, private_key_file)
 
     await attach_resource(
-        account, Hostname(fqdn), item_hash, interactive=False if (not ask) else None, spa=True if spa else None
+        account,
+        Hostname(fqdn),
+        item_hash,
+        interactive=False if (not ask) else None,
+        spa=True if spa else None,
     )
     raise typer.Exit()
 
@@ -339,14 +340,20 @@ async def info(
     is_spa = ""
     if resource_type == TargetType.IPFS:
         final_resource = ""
-        is_spa = "True" if "spa" in domain_info["info"] and domain_info["info"]["spa"] == "1" else "False"
+        is_spa = (
+            "True"
+            if "spa" in domain_info["info"] and domain_info["info"]["spa"] == "1"
+            else "False"
+        )
     elif resource_type == TargetType.PROGRAM:
         final_resource = domain_info["info"]["message_id"]
     if resource_type == TargetType.INSTANCE:
         ips = await domain_validator.get_ipv6_addresses(Hostname(fqdn))
         final_resource = ",".join([str(ip) for ip in ips])
 
-    table.add_row(resource_type, domain_info["info"]["message_id"], final_resource, is_spa)
+    table.add_row(
+        resource_type, domain_info["info"]["message_id"], final_resource, is_spa
+    )
 
     console.print(table)
     raise typer.Exit()

src/aleph_client/commands/files.py

@@ -1,5 +1,6 @@
 import json as json_lib
 import logging
+import os
 from datetime import datetime
 from pathlib import Path
 from typing import Optional
@@ -19,6 +20,7 @@
 
 from aleph_client.commands import help_strings
 from aleph_client.commands.utils import setup_logging
+from aleph_client.exit_codes import exit_with_error_message
 from aleph_client.utils import AsyncTyper
 
 logger = logging.getLogger(__name__)
@@ -82,8 +84,7 @@ async def upload(
         account=account, api_server=sdk_settings.API_HOST
     ) as client:
         if not path.is_file():
-            typer.echo(f"Error: File not found: '{path}'")
-            raise typer.Exit(code=1)
+            exit_with_error_message(os.EX_NOINPUT, f"No such file or directory: {path}")
 
         with open(path, "rb") as fd:
             logger.debug("Reading file")