feat: correctly display discovery network connections

Author: azmeuk

doc/changelog.rst

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+[0.2.1] - Unreleased
+--------------------
+
+Added
+^^^^^
+- Display server discovery step network connections.
+
 [0.2.0] - 2024-12-03
 --------------------
 

scim2_cli/__init__.py

@@ -6,6 +6,7 @@
 import click
 from httpx import Client
 from pydantic import BaseModel
+from scim2_client import SCIMClientError
 from scim2_client.engines.httpx import SyncSCIMClient
 from scim2_models import Group
 from scim2_models import Resource
@@ -23,6 +24,7 @@
 from scim2_cli.test import test_cli
 from scim2_cli.utils import DOC_URL
 from scim2_cli.utils import HeaderType
+from scim2_cli.utils import exception_to_click_error
 from scim2_cli.utils import split_headers
 
 
@@ -128,11 +130,14 @@ def cli(
         resource_types=resource_types_obj,
         service_provider_config=spc_obj,
     )
-    scim_client.discover(
-        schemas=not bool(schemas),
-        resource_types=not bool(resource_types),
-        service_provider_config=not bool(service_provider_config),
-    )
+    try:
+        scim_client.discover(
+            schemas=not bool(schemas),
+            resource_types=not bool(resource_types),
+            service_provider_config=not bool(service_provider_config),
+        )
+    except SCIMClientError as exc:
+        raise exception_to_click_error(exc) from exc
 
     ctx.obj["client"] = scim_client
     ctx.obj["resource_models"] = {

scim2_cli/create.py

@@ -1,30 +1,23 @@
-import sys
-
 import click
 from click import ClickException
 from pydanclick import from_pydantic
 from scim2_client import SCIMClientError
 from scim2_models import Context
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
-from .utils import DOC_URL
-from .utils import ModelCommand
-from .utils import formatted_payload
-from .utils import unacceptable_fields
+from scim2_cli.utils import DOC_URL
+from scim2_cli.utils import ModelCommand
+from scim2_cli.utils import exception_to_click_error
+from scim2_cli.utils import formatted_payload
+from scim2_cli.utils import unacceptable_fields
 
 
 def create_payload(client, payload, indent):
     try:
         response = client.create(payload, raise_scim_errors=False)
 
     except SCIMClientError as scim_exc:
-        message = str(scim_exc)
-        if sys.version_info >= (3, 11) and hasattr(
-            scim_exc, "__notes__"
-        ):  # pragma: no cover
-            for note in scim_exc.__notes__:
-                message = f"{message}\n{note}"
-        raise ClickException(message) from scim_exc
+        raise exception_to_click_error(scim_exc) from scim_exc
 
     payload = formatted_payload(response.model_dump(), indent)
     click.echo(payload)

scim2_cli/delete.py

@@ -1,12 +1,12 @@
-import sys
-
 import click
 from click import ClickException
 from scim2_client import SCIMClientError
 from scim2_models import Message
 from scim2_models import Resource
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
+from scim2_cli.utils import exception_to_click_error
+
 from .utils import DOC_URL
 from .utils import formatted_payload
 
@@ -40,13 +40,7 @@ def delete_cli(ctx, resource_type, id, indent):
         response = ctx.obj["client"].delete(resource_model, id, raise_scim_errors=False)
 
     except SCIMClientError as scim_exc:
-        message = str(scim_exc)
-        if sys.version_info >= (3, 11) and hasattr(
-            scim_exc, "__notes__"
-        ):  # pragma: no cover
-            for note in scim_exc.__notes__:
-                message = f"{message}\n{note}"
-        raise ClickException(message) from scim_exc
+        raise exception_to_click_error(scim_exc) from scim_exc
 
     if response:
         payload = (

scim2_cli/query.py

@@ -1,5 +1,3 @@
-import sys
-
 import click
 from click import ClickException
 from scim2_client import SCIMClientError
@@ -9,6 +7,8 @@
 from scim2_models import ServiceProviderConfig
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
+from scim2_cli.utils import exception_to_click_error
+
 from .utils import DOC_URL
 from .utils import formatted_payload
 
@@ -118,13 +118,7 @@ def query_cli(
         )
 
     except SCIMClientError as scim_exc:
-        message = str(scim_exc)
-        if sys.version_info >= (3, 11) and hasattr(
-            scim_exc, "__notes__"
-        ):  # pragma: no cover
-            for note in scim_exc.__notes__:
-                message = f"{message}\n{note}"
-        raise ClickException(message) from scim_exc
+        raise exception_to_click_error(scim_exc) from scim_exc
 
     payload = formatted_payload(response.model_dump(), indent)
     click.echo(payload)

scim2_cli/replace.py

@@ -1,12 +1,12 @@
-import sys
-
 import click
 from click import ClickException
 from pydanclick import from_pydantic
 from scim2_client import SCIMClientError
 from scim2_models import Context
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
+from scim2_cli.utils import exception_to_click_error
+
 from .utils import DOC_URL
 from .utils import ModelCommand
 from .utils import formatted_payload
@@ -18,13 +18,7 @@ def replace_payload(client, payload, indent):
         response = client.replace(payload, raise_scim_errors=False)
 
     except SCIMClientError as scim_exc:
-        message = str(scim_exc)
-        if sys.version_info >= (3, 11) and hasattr(
-            scim_exc, "__notes__"
-        ):  # pragma: no cover
-            for note in scim_exc.__notes__:
-                message = f"{message}\n{note}"
-        raise ClickException(message) from scim_exc
+        raise exception_to_click_error(scim_exc) from scim_exc
 
     payload = formatted_payload(response.model_dump(), indent)
     click.echo(payload)

scim2_cli/search.py

@@ -1,11 +1,10 @@
-import sys
-
 import click
-from click import ClickException
 from scim2_client import SCIMClientError
 from scim2_models import SearchRequest
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
+from scim2_cli.utils import exception_to_click_error
+
 from .utils import DOC_URL
 from .utils import formatted_payload
 
@@ -93,13 +92,7 @@ def search_cli(
         )
 
     except SCIMClientError as scim_exc:
-        message = str(scim_exc)
-        if sys.version_info >= (3, 11) and hasattr(
-            scim_exc, "__notes__"
-        ):  # pragma: no cover
-            for note in scim_exc.__notes__:
-                message = f"{message}\n{note}"
-        raise ClickException(message) from scim_exc
+        raise exception_to_click_error(scim_exc) from scim_exc
 
     payload = formatted_payload(response.model_dump(), indent)
     click.echo(payload)

scim2_cli/utils.py

@@ -1,4 +1,5 @@
 import json
+import sys
 from enum import Enum
 
 import click
@@ -104,3 +105,12 @@ def unacceptable_fields(context, model):
         for field_name in model.model_fields
         if not is_field_acceptable(context, model, field_name)
     ]
+
+
+def exception_to_click_error(exception):
+    message = str(exception)
+    if sys.version_info >= (3, 11) and hasattr(
+        exception, "__notes__"
+    ):  # pragma: no cover
+        message += "\n" + "\n".join(exception.__notes__)
+    return click.ClickException(message)

tests/test_cli.py

@@ -27,6 +27,13 @@ def test_help(runner):
     assert "SCIM application development CLI.\n" in result.output
 
 
+def test_bad_server(runner):
+    """Test that the discovery step display a readable error when a bad server has been passed."""
+    result = runner.invoke(cli, ["--url", "http://scim.invalid", "query"])
+    assert result.exit_code == 1
+    assert "Error: Network error happened during request\n" in result.output
+
+
 def test_stdin_bad_json(runner, httpserver):
     """Test that invalid JSON stdin raise an error."""
     result = runner.invoke(