feat: server compliance test

Author: azmeuk

README.md

@@ -1,6 +1,6 @@
 # scim2-cli
 
-An utility command line to help you perform requests against a SCIM server, while validating input and response payloads.
+An utility command line to help you perform requests against a SCIM server, while validating input and response payloads. It also uses [scim2-tester](https://scim2-tester.readthedocs.io) to perform a [SCIM server compliance test](https://scim2-cli.readthedocs.io/en/latest/reference.html#scim-url-test).
 
 ## What's SCIM anyway?
 

doc/changelog.rst

@@ -4,6 +4,7 @@ Changelog
 Added
 ^^^^^
 - Add support for passing custom headers to requests.
+- Server compliance test.
 
 [0.1.1] - 2024-06-02
 --------------------

doc/conf.py

@@ -40,6 +40,7 @@
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
+    "scim2_tester": ("https://scim2-tester.readthedocs.io/en/latest/", None),
 }
 
 # -- Options for HTML output ----------------------------------------------

poetry.lock

@@ -28,6 +28,7 @@ classifiers = [
 python = "^3.10"
 click = "^8.1.7"
 scim2-client = "^0.1.6"
+scim2-tester = "^0.1.2"
 sphinx-click-rst-to-ansi-formatter = "^0.1.0"
 
 [tool.poetry.group.doc]

pyproject.toml

@@ -12,6 +12,7 @@
 from .query import query_cli
 from .replace import replace_cli
 from .search import search_cli
+from .test import test_cli
 from .utils import DOC_URL
 
 
@@ -44,3 +45,4 @@ def cli(ctx, url):
 cli.add_command(replace_cli)
 cli.add_command(delete_cli)
 cli.add_command(search_cli)
+cli.add_command(test_cli)

scim2_cli/__init__.py

@@ -0,0 +1,40 @@
+import click
+from scim2_tester import Status
+from scim2_tester import check_server
+from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
+
+from .utils import DOC_URL
+from .utils import Color
+from .utils import split_headers
+
+
+@click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="test")
+@click.pass_context
+@click.option(
+    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
+)
+@click.option("-v", "--verbose", is_flag=True, help="Enables verbose mode")
+def test_cli(ctx, headers, verbose):
+    """Perform a server SCIM compliance check using
+    :doc:scim2-tester:`scim2-tester <index>`.
+
+    .. code-block:: bash
+
+        scim https://scim.example test
+    """
+
+    client = ctx.obj["client"]
+    client.client.headers.update(split_headers(headers))
+    results = check_server(client)
+    click.echo(f"Performing a SCIM compliance check on {client.client.base_url} ...")
+    for result in results:
+        if result.status == Status.SUCCESS:
+            status = click.style(result.status.name, fg=Color.green)
+        else:
+            status = click.style(result.status.name, fg=Color.red)
+        click.echo(f"{status} {result.title}")
+
+        if result.reason:
+            click.echo(f"  {result.reason}")
+            if verbose and result.data:
+                click.echo(f"  {result.data}")

scim2_cli/test.py

@@ -1,9 +1,29 @@
 import json
+from enum import Enum
 
 DOC_URL = "https://scim2-cli.readthedocs.io/"
 INDENTATION_SIZE = 4
 
 
+class Color(str, Enum):
+    black = "black"
+    red = "red"
+    green = "green"
+    yellow = "yellow"
+    blue = "blue"
+    magenta = "magenta"
+    cyan = "cyan"
+    white = "white"
+    bright_black = "bright_black"
+    bright_red = "bright_red"
+    bright_green = "bright_green"
+    bright_yellow = "bright_yellow"
+    bright_blue = "bright_blue"
+    bright_magenta = "bright_magenta"
+    bright_cyan = "bright_cyan"
+    bright_white = "bright_white"
+
+
 def formatted_payload(obj, indent):
     indent = INDENTATION_SIZE if indent else False
     return json.dumps(obj, indent=indent)

scim2_cli/utils.py

@@ -0,0 +1,78 @@
+from unittest.mock import patch
+
+from scim2_tester import CheckResult
+from scim2_tester import Status
+
+from scim2_cli import cli
+
+
+def test_nominal(runner, httpserver):
+    """Test SCIM compliance test."""
+
+    results = [
+        CheckResult(
+            status=Status.SUCCESS,
+            title="test1",
+            description="description1",
+            reason="reason1",
+            data="data1",
+        ),
+        CheckResult(
+            status=Status.ERROR,
+            title="test2",
+            description="description2",
+            data="data2",
+        ),
+    ]
+    with patch("scim2_cli.test.check_server", side_effect=[results]):
+        result = runner.invoke(
+            cli,
+            [httpserver.url_for("/"), "test"],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.stdout
+
+        expected_output = f"""Performing a SCIM compliance check on http://localhost:{httpserver.port}/ ...
+SUCCESS test1
+  reason1
+ERROR test2
+"""
+        assert result.output == expected_output
+
+
+def test_verbose(runner, httpserver):
+    """Test SCIM compliance test."""
+
+    results = [
+        CheckResult(
+            status=Status.SUCCESS,
+            title="test1",
+            description="description1",
+            reason="reason1",
+            data="data1",
+        ),
+        CheckResult(
+            status=Status.ERROR,
+            title="test2",
+            description="description2",
+            reason="reason2",
+            data="data2",
+        ),
+    ]
+    with patch("scim2_cli.test.check_server", side_effect=[results]):
+        result = runner.invoke(
+            cli,
+            [httpserver.url_for("/"), "test", "--verbose"],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.stdout
+
+        expected_output = f"""Performing a SCIM compliance check on http://localhost:{httpserver.port}/ ...
+SUCCESS test1
+  reason1
+  data1
+ERROR test2
+  reason2
+  data2
+"""
+        assert result.output == expected_output