refactor: --headers is a top-level option

Author: azmeuk

scim2_cli/__init__.py

@@ -18,6 +18,8 @@
 from scim2_cli.test import test_cli
 from scim2_cli.utils import DOC_URL
 
+from .utils import split_headers
+
 
 # monkeypatching pydanclick until this patch is released
 # https://github.com/felix-martel/pydanclick/pull/25
@@ -39,12 +41,15 @@ def _is_pydantic_model(model: Any) -> TypeGuard[type[BaseModel]]:
 
 @click.group(cls=make_rst_to_ansi_formatter(DOC_URL, group=True))
 @click.option("--url", help="The SCIM server endpoint.")
+@click.option(
+    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
+)
 @click.pass_context
-def cli(ctx, url: str):
+def cli(ctx, url: str, headers: list[str]):
     """SCIM application development CLI."""
     ctx.ensure_object(dict)
     ctx.obj["URL"] = url
-    client = Client(base_url=ctx.obj["URL"])
+    client = Client(base_url=ctx.obj["URL"], headers=split_headers(headers))
     ctx.obj["client"] = SyncSCIMClient(client, resource_models=(User, Group))
     ctx.obj["client"].register_naive_resource_types()
     ctx.obj["resource_models"] = {

scim2_cli/create.py

@@ -10,15 +10,12 @@
 from .utils import DOC_URL
 from .utils import ModelCommand
 from .utils import formatted_payload
-from .utils import split_headers
 from .utils import unacceptable_fields
 
 
-def create_payload(client, payload, indent, headers):
+def create_payload(client, payload, indent):
     try:
-        response = client.create(
-            payload, headers=split_headers(headers), raise_scim_errors=False
-        )
+        response = client.create(payload, raise_scim_errors=False)
 
     except SCIMClientError as scim_exc:
         message = str(scim_exc)
@@ -46,12 +43,9 @@ def create_factory(model):
         default=True,
         help="Indent JSON response payloads.",
     )
-    @click.option(
-        "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
-    )
     @from_pydantic("obj", model, exclude=exclude)
     @click.pass_context
-    def create_command(ctx, indent, headers, obj: model, *args, **kwargs):
+    def create_command(ctx, indent, obj: model, *args, **kwargs):
         r"""Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request on resources endpoint.
 
         Input data can be passed through parameters like :code:`--external-id`.
@@ -83,7 +77,7 @@ def create_command(ctx, indent, headers, obj: model, *args, **kwargs):
             click.echo(ctx.get_help())
             ctx.exit(1)
 
-        create_payload(ctx.obj["client"], payload, indent, headers)
+        create_payload(ctx.obj["client"], payload, indent)
 
     return create_command
 
@@ -101,10 +95,7 @@ def create_command(ctx, indent, headers, obj: model, *args, **kwargs):
     default=True,
     help="Indent JSON response payloads.",
 )
-@click.option(
-    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
-)
-def create_cli(ctx, indent, headers):
+def create_cli(ctx, indent):
     """Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request on resources endpoint.
 
     There are subcommands for all the available models, with dynamic attributes.
@@ -129,4 +120,4 @@ def create_cli(ctx, indent, headers):
         click.echo(ctx.get_help())
         ctx.exit(1)
 
-    create_payload(ctx.obj["client"], payload, indent, headers)
+    create_payload(ctx.obj["client"], payload, indent)

scim2_cli/delete.py

@@ -9,23 +9,19 @@
 
 from .utils import DOC_URL
 from .utils import formatted_payload
-from .utils import split_headers
 
 
 @click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="delete")
 @click.argument("resource-type", required=True)
 @click.argument("id", required=True)
-@click.option(
-    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
-)
 @click.option(
     "--indent/--no-indent",
     is_flag=True,
     default=True,
     help="Indent JSON response payloads.",
 )
 @click.pass_context
-def delete_cli(ctx, resource_type, id, headers, indent):
+def delete_cli(ctx, resource_type, id, indent):
     """Perform a `SCIM DELETE query <https://www.rfc-editor.org/rfc/rfc7644#section-3.6>`_ request.
 
     .. code-block:: bash
@@ -41,9 +37,7 @@ def delete_cli(ctx, resource_type, id, headers, indent):
         ) from exc
 
     try:
-        response = ctx.obj["client"].delete(
-            resource_model, id, headers=split_headers(headers), raise_scim_errors=False
-        )
+        response = ctx.obj["client"].delete(resource_model, id, raise_scim_errors=False)
 
     except SCIMClientError as scim_exc:
         message = str(scim_exc)

scim2_cli/query.py

@@ -8,7 +8,6 @@
 
 from .utils import DOC_URL
 from .utils import formatted_payload
-from .utils import split_headers
 
 
 @click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="query")
@@ -46,9 +45,6 @@
     "--sort-order",
     help="A string indicating the order in which the “sortBy” parameter is applied.",
 )
-@click.option(
-    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
-)
 @click.option(
     "--indent/--no-indent",
     is_flag=True,
@@ -66,7 +62,6 @@ def query_cli(
     filter: str,
     sort_by: str,
     sort_order: str,
-    headers: list[str],
     indent: bool,
 ):
     """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request on the :code:`RESOURCE_TYPE` endpoint.
@@ -113,7 +108,6 @@ def query_cli(
             id,
             search_request=payload,
             check_request_payload=check_request_payload,
-            headers=split_headers(headers),
             raise_scim_errors=False,
         )
 

scim2_cli/replace.py

@@ -10,15 +10,12 @@
 from .utils import DOC_URL
 from .utils import ModelCommand
 from .utils import formatted_payload
-from .utils import split_headers
 from .utils import unacceptable_fields
 
 
-def replace_payload(client, payload, indent, headers):
+def replace_payload(client, payload, indent):
     try:
-        response = client.replace(
-            payload, headers=split_headers(headers), raise_scim_errors=False
-        )
+        response = client.replace(payload, raise_scim_errors=False)
 
     except SCIMClientError as scim_exc:
         message = str(scim_exc)
@@ -47,12 +44,9 @@ def replace_factory(model):
         default=True,
         help="Indent JSON response payloads.",
     )
-    @click.option(
-        "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
-    )
     @from_pydantic("obj", model, exclude=exclude)
     @click.pass_context
-    def replace_command(ctx, indent, headers, obj: model, *args, **kwargs):
+    def replace_command(ctx, indent, obj: model, *args, **kwargs):
         r"""Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request on resources endpoint.
 
         Input data can be passed through parameters like :code:`--external-id`.
@@ -85,7 +79,11 @@ def replace_command(ctx, indent, headers, obj: model, *args, **kwargs):
             click.echo(ctx.get_help())
             ctx.exit(1)
 
-        replace_payload(ctx.obj["client"], payload, indent, headers)
+        replace_payload(
+            ctx.obj["client"],
+            payload,
+            indent,
+        )
 
     return replace_command
 
@@ -97,16 +95,13 @@ def replace_command(ctx, indent, headers, obj: model, *args, **kwargs):
     invoke_without_command=True,
 )
 @click.pass_context
-@click.option(
-    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
-)
 @click.option(
     "--indent/--no-indent",
     is_flag=True,
     default=True,
     help="Indent JSON response payloads.",
 )
-def replace_cli(ctx, headers, indent):
+def replace_cli(ctx, indent):
     """Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.5.1>`_ request on the resources endpoint.
 
     There are subcommands for all the available models, with dynamic attributes.
@@ -131,4 +126,8 @@ def replace_cli(ctx, headers, indent):
         click.echo(ctx.get_help())
         ctx.exit(1)
 
-    replace_payload(ctx.obj["client"], payload, indent, headers)
+    replace_payload(
+        ctx.obj["client"],
+        payload,
+        indent,
+    )

scim2_cli/search.py

@@ -8,7 +8,6 @@
 
 from .utils import DOC_URL
 from .utils import formatted_payload
-from .utils import split_headers
 
 
 @click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="search")
@@ -44,9 +43,6 @@
     "--sort-order",
     help="A string indicating the order in which the “sortBy” parameter is applied.",
 )
-@click.option(
-    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
-)
 @click.option(
     "--indent/--no-indent",
     is_flag=True,
@@ -62,7 +58,6 @@ def search_cli(
     filter: str,
     sort_by: str,
     sort_order: str,
-    headers: list[str],
     indent: bool,
 ):
     """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request on the :code:`/.search` endpoint.
@@ -94,7 +89,6 @@ def search_cli(
         response = ctx.obj["client"].search(
             search_request=payload,
             check_request_payload=check_request_payload,
-            headers=split_headers(headers),
             raise_scim_errors=False,
         )
 

scim2_cli/test.py

@@ -5,24 +5,19 @@
 
 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):
+def test_cli(ctx, 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:

tests/test_cli.py

@@ -16,3 +16,40 @@ def test_stdin_bad_json(runner, httpserver):
     )
     assert result.exit_code == 1
     assert "Invalid JSON input." in result.stdout
+
+
+def test_auth_headers(runner, httpserver, simple_user_payload):
+    """Test passing auth bearer headers."""
+    httpserver.expect_request(
+        "/Users/foobar", method="GET", headers={"Authorization": "Bearer token"}
+    ).respond_with_json(
+        simple_user_payload("foobar"),
+        status=200,
+        content_type="application/scim+json",
+    )
+
+    result = runner.invoke(
+        cli,
+        [
+            "--url",
+            httpserver.url_for("/"),
+            "query",
+            "user",
+            "foobar",
+        ],
+    )
+    assert result.exit_code == 1
+
+    result = runner.invoke(
+        cli,
+        [
+            "--url",
+            httpserver.url_for("/"),
+            "--headers",
+            "Authorization: Bearer token",
+            "query",
+            "user",
+            "foobar",
+        ],
+    )
+    assert result.exit_code == 0