scim2-cli 0.2.0__tar.gz → 0.2.1__tar.gz

{scim2_cli-0.2.0 → scim2_cli-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-cli
-Version: 0.2.0
+Version: 0.2.1
 Summary: SCIM application development CLI
 Project-URL: documentation, https://scim2-cli.readthedocs.io
 Project-URL: repository, https://github.com/python-scim/scim2-cli

{scim2_cli-0.2.0 → scim2_cli-0.2.1}/doc/changelog.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+[0.2.1] - 2024-12-04
+--------------------
+
+Added
+^^^^^
+- Display server discovery step network connections.
+- Support loading server configuration objects in :class:`~scim2_models.ListResponses`.
+
 [0.2.0] - 2024-12-03
 --------------------
 

{scim2_cli-0.2.0 → scim2_cli-0.2.1}/doc/tutorial.rst

@@ -6,8 +6,8 @@ The :ref:`cli` command allows you to interact with a SCIM server.
 Basic parameters
 ----------------
 
-In order to connect to a SCIM server you will need to pass the :option:`scim --url` parameter.
-You can also pass additional headers, such as authentication ones, with :option:`scim --url`.
+In order to connect to a SCIM server you will need to pass the :option:`--url <scim --url>` parameter.
+You can also pass additional headers, such as authentication ones, with :option:`--header <scim --header>`.
 
 .. code-block:: shell
 
@@ -45,3 +45,31 @@ To make commands shorter, you can set those parameters once for all by using the
             "location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
         },
     }
+
+
+Server configuration
+--------------------
+
+The CLI needs to reach the server configuration to find out which features are available,
+which resource schemas are available, and where they are located.
+
+By default the CLI will automatically discover those resources on the server, before each command is run.
+
+However you might find too time consuming to achieve all those network requests.
+You can store those data locally and reuse them for future command runs thanks to the
+:option:`--schemas <scim --schemas>`, :option:`--resource-types <scim --resource-types>` and :option:`--service-provider-config <scim --service-provider-config>` (and their corresponding environment vars :ref:`SCIM_CLI_SCHEMAS <scim-schemas-scim_cli_schemas>`, :ref:`SCIM_CLI_RESOURCE_TYPES <scim-resource_types-scim_cli_resource_types>` and :ref:`SCIM_CLI_SERVICE_PROVIDER_CONFIG <scim-service_provider_config-scim_cli_service_provider_config>`)
+
+.. code-block:: shell
+    :caption: Save the configuration resources
+
+    $ scim query schema > /tmp/schemas.json
+    $ scim query resourcetype > /tmp/resource-types.json
+    $ scim query serviceproviderconfig > /tmp/service-provider-config.json
+
+.. code-block:: shell
+    :caption: Load the cached resources
+
+    $ export SCIM_SCHEMAS=/tmp/schemas.json
+    $ export SCIM_RESOURCE_TYPES=/tmp/resource-types.json
+    $ export SCIM_SERVICE_PROVIDER_CONFIG=/tmp/service-provider-config.json
+    $ scim2 query ...

{scim2_cli-0.2.0 → scim2_cli-0.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "scim2-cli"
-version = "0.2.0"
+version = "0.2.1"
 description = "SCIM application development CLI"
 authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
 license = {file = "LICENSE.md"}

{scim2_cli-0.2.0 → scim2_cli-0.2.1}/scim2_cli/__init__.py

@@ -6,8 +6,10 @@ from typing import TypeGuard
 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 ListResponse
 from scim2_models import Resource
 from scim2_models import ResourceType
 from scim2_models import Schema
@@ -23,6 +25,7 @@ from scim2_cli.search import search_cli
 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
 
 
@@ -51,7 +54,10 @@ def load_config_files(
 ]:
     if schemas_fd:
         schemas_payload = json.load(schemas_fd)
-        schemas_obj = [Schema.model_validate(schema) for schema in schemas_payload]
+        if isinstance(schemas_payload, dict):
+            schemas_obj = ListResponse[Schema].model_validate(schemas_payload).resources
+        else:
+            schemas_obj = [Schema.model_validate(schema) for schema in schemas_payload]
         resource_models = [Resource.from_schema(schema) for schema in schemas_obj]
 
     else:
@@ -59,9 +65,16 @@ def load_config_files(
 
     if resource_types_fd:
         resource_types_payload = json.load(resource_types_fd)
-        resource_types = [
-            ResourceType.model_validate(item) for item in resource_types_payload
-        ]
+        if isinstance(schemas_payload, dict):
+            resource_types = (
+                ListResponse[ResourceType]
+                .model_validate(resource_types_payload)
+                .resources
+            )
+        else:
+            resource_types = [
+                ResourceType.model_validate(item) for item in resource_types_payload
+            ]
     else:
         resource_types = None
 
@@ -128,11 +141,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-0.2.0 → scim2_cli-0.2.1}/scim2_cli/create.py

@@ -1,5 +1,3 @@
-import sys
-
 import click
 from click import ClickException
 from pydanclick import from_pydantic
@@ -7,10 +5,11 @@ 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):
@@ -18,13 +17,7 @@ def create_payload(client, payload, indent):
         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-0.2.0 → scim2_cli-0.2.1}/scim2_cli/delete.py

@@ -1,5 +1,3 @@
-import sys
-
 import click
 from click import ClickException
 from scim2_client import SCIMClientError
@@ -7,6 +5,8 @@ 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-0.2.0 → scim2_cli-0.2.1}/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 SearchRequest
 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-0.2.0 → scim2_cli-0.2.1}/scim2_cli/replace.py

@@ -1,5 +1,3 @@
-import sys
-
 import click
 from click import ClickException
 from pydanclick import from_pydantic
@@ -7,6 +5,8 @@ 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-0.2.0 → scim2_cli-0.2.1}/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-0.2.0 → scim2_cli-0.2.1}/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)

{scim2_cli-0.2.0 → scim2_cli-0.2.1}/tests/test_cli.py

@@ -1,13 +1,16 @@
 import json
 import os
 
+import pytest
 from scim2_models import AuthenticationScheme
 from scim2_models import Bulk
 from scim2_models import ChangePassword
 from scim2_models import ETag
 from scim2_models import Filter
+from scim2_models import ListResponse
 from scim2_models import Patch
 from scim2_models import ResourceType
+from scim2_models import Schema
 from scim2_models import ServiceProviderConfig
 from scim2_models import Sort
 from scim2_models import User
@@ -27,6 +30,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(
@@ -105,9 +115,9 @@ def test_env_vars(runner, httpserver, simple_user_payload):
         del os.environ["SCIM_CLI_HEADERS"]
 
 
-def test_custom_configuration(runner, httpserver, simple_user_payload, tmp_path):
-    """Test passing custom .JSON configuration files to the command."""
-    spc = ServiceProviderConfig(
+@pytest.fixture
+def service_provider_configuration():
+    return ServiceProviderConfig(
         documentation_uri="https://scim.test",
         patch=Patch(supported=False),
         bulk=Bulk(supported=False, max_operations=0, max_payload_size=0),
@@ -125,29 +135,48 @@ def test_custom_configuration(runner, httpserver, simple_user_payload, tmp_path)
                 primary=True,
             ),
         ],
-    ).model_dump()
+    )
 
-    spc_path = tmp_path / "service_provider_configuration.json"
-    with open(spc_path, "w") as fd:
-        json.dump(spc, fd)
 
-    schemas = [User.to_schema().model_dump()]
-    schemas_path = tmp_path / "schemas.json"
-    with open(schemas_path, "w") as fd:
-        json.dump(schemas, fd)
+@pytest.fixture
+def schemas():
+    return [User.to_schema()]
 
-    resource_types = [
+
+@pytest.fixture
+def resource_types():
+    return [
         ResourceType(
             id="User",
             name="User",
             endpoint="/somewhere-different",
             description="User accounts",
             schema_="urn:ietf:params:scim:schemas:core:2.0:User",
-        ).model_dump()
+        )
     ]
+
+
+def test_custom_configuration_by_parameter(
+    runner,
+    httpserver,
+    simple_user_payload,
+    tmp_path,
+    service_provider_configuration,
+    schemas,
+    resource_types,
+):
+    """Test passing custom .JSON configuration files to the command."""
+    spc_path = tmp_path / "service_provider_configuration.json"
+    with open(spc_path, "w") as fd:
+        json.dump(service_provider_configuration.model_dump(), fd)
+
+    schemas_path = tmp_path / "schemas.json"
+    with open(schemas_path, "w") as fd:
+        json.dump([schema.model_dump() for schema in schemas], fd)
+
     resource_types_path = tmp_path / "resource_types.json"
     with open(resource_types_path, "w") as fd:
-        json.dump(resource_types, fd)
+        json.dump([resource_type.model_dump() for resource_type in resource_types], fd)
 
     httpserver.expect_request(
         "/somewhere-different/foobar",
@@ -176,3 +205,123 @@ def test_custom_configuration(runner, httpserver, simple_user_payload, tmp_path)
         catch_exceptions=False,
     )
     assert result.exit_code == 0
+
+
+def test_custom_configuration_in_list_response(
+    runner,
+    httpserver,
+    simple_user_payload,
+    tmp_path,
+    service_provider_configuration,
+    schemas,
+    resource_types,
+):
+    """Test that ListResponse format is supported."""
+    spc_path = tmp_path / "service_provider_configuration.json"
+    with open(spc_path, "w") as fd:
+        json.dump(service_provider_configuration.model_dump(), fd)
+
+    schemas_path = tmp_path / "schemas.json"
+    with open(schemas_path, "w") as fd:
+        json.dump(
+            ListResponse[Schema](
+                total_results=len(schemas),
+                start_index=1,
+                items_per_page=len(schemas),
+                resources=schemas,
+            ).model_dump(),
+            fd,
+        )
+
+    resource_types_path = tmp_path / "resource_types.json"
+    with open(resource_types_path, "w") as fd:
+        json.dump(
+            ListResponse[ResourceType](
+                total_results=len(resource_types),
+                start_index=1,
+                items_per_page=len(resource_types),
+                resources=resource_types,
+            ).model_dump(),
+            fd,
+        )
+
+    httpserver.expect_request(
+        "/somewhere-different/foobar",
+        method="GET",
+    ).respond_with_json(
+        simple_user_payload("foobar"),
+        status=200,
+        content_type="application/scim+json",
+    )
+
+    result = runner.invoke(
+        cli,
+        [
+            "--url",
+            httpserver.url_for("/"),
+            "--service-provider-config",
+            spc_path,
+            "--schemas",
+            schemas_path,
+            "--resource-types",
+            resource_types_path,
+            "query",
+            "user",
+            "foobar",
+        ],
+        catch_exceptions=False,
+    )
+    assert result.exit_code == 0
+
+
+def test_custom_configuration_by_env(
+    runner,
+    httpserver,
+    simple_user_payload,
+    tmp_path,
+    service_provider_configuration,
+    schemas,
+    resource_types,
+):
+    """Test passing custom .JSON configuration files to the command."""
+    spc_path = tmp_path / "service_provider_configuration.json"
+    with open(spc_path, "w") as fd:
+        json.dump(service_provider_configuration.model_dump(), fd)
+
+    schemas_path = tmp_path / "schemas.json"
+    with open(schemas_path, "w") as fd:
+        json.dump([schema.model_dump() for schema in schemas], fd)
+
+    resource_types_path = tmp_path / "resource_types.json"
+    with open(resource_types_path, "w") as fd:
+        json.dump([resource_type.model_dump() for resource_type in resource_types], fd)
+
+    httpserver.expect_request(
+        "/somewhere-different/foobar",
+        method="GET",
+    ).respond_with_json(
+        simple_user_payload("foobar"),
+        status=200,
+        content_type="application/scim+json",
+    )
+
+    os.environ["SCIM_CLI_SERVICE_PROVIDER_CONFIG"] = str(spc_path)
+    os.environ["SCIM_CLI_SCHEMAS"] = str(schemas_path)
+    os.environ["SCIM_CLI_RESOURCE_TYPES"] = str(resource_types_path)
+    try:
+        result = runner.invoke(
+            cli,
+            [
+                "--url",
+                httpserver.url_for("/"),
+                "query",
+                "user",
+                "foobar",
+            ],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0
+    finally:
+        del os.environ["SCIM_CLI_SERVICE_PROVIDER_CONFIG"]
+        del os.environ["SCIM_CLI_SCHEMAS"]
+        del os.environ["SCIM_CLI_RESOURCE_TYPES"]