feat: allow setting host and headers with environment vars

Author: azmeuk

pyproject.toml

@@ -49,15 +49,13 @@ dev = [
     "pytest-httpserver>=1.0.10",
     "tox-uv>=1.16.0",
 ]
-
 doc = [
     "shibuya>=2024.5.15",
     "sphinx>=7.3.7",
     "sphinx-click>=6.0.0",
     "sphinx-issues >= 5.0.0",
     "myst-parser>=3.0.1",
 ]
-
 bundle = [
     "pyinstaller>=6.10.0",
 ]

scim2_cli/__init__.py

@@ -17,6 +17,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 .utils import split_headers
 
@@ -40,16 +41,22 @@ 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("--url", help="The SCIM server endpoint.", envvar="SCIM_CLI_URL")
 @click.option(
-    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
+    "-h",
+    "--headers",
+    multiple=True,
+    type=HeaderType(),
+    help="Header to pass in the HTTP requests.",
+    envvar="SCIM_CLI_HEADERS",
 )
 @click.pass_context
 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"], headers=split_headers(headers))
+    headers_dict = split_headers(headers)
+    client = Client(base_url=ctx.obj["URL"], headers=headers_dict)
     ctx.obj["client"] = SyncSCIMClient(client, resource_models=(User, Group))
     ctx.obj["client"].register_naive_resource_types()
     ctx.obj["resource_models"] = {

scim2_cli/utils.py

@@ -8,6 +8,11 @@
 INDENTATION_SIZE = 4
 
 
+class HeaderType(click.ParamType):
+    envvar_list_splitter = ";"
+    name = "HEADER"
+
+
 class Color(str, Enum):
     black = "black"
     red = "red"

tests/test_cli.py

@@ -1,3 +1,5 @@
+import os
+
 from scim2_cli import cli
 
 
@@ -53,3 +55,26 @@ def test_auth_headers(runner, httpserver, simple_user_payload):
         ],
     )
     assert result.exit_code == 0
+
+
+def test_env_vars(runner, httpserver, simple_user_payload):
+    """Test passing host and headers with environment vars."""
+    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, ["query", "user"])
+    assert result.exit_code == 1
+
+    os.environ["SCIM_CLI_URL"] = httpserver.url_for("/")
+    os.environ["SCIM_CLI_HEADERS"] = "Authorization: Bearer token;foo: bar"
+    try:
+        result = runner.invoke(cli, ["query", "user", "foobar"], catch_exceptions=False)
+        assert result.exit_code == 0
+    finally:
+        del os.environ["SCIM_CLI_URL"]
+        del os.environ["SCIM_CLI_HEADERS"]