Merge pull request #138 from code42/INTEG-2751/user-agent

update user-agent

Author: ceciliastevens

CHANGELOG.md

@@ -9,6 +9,13 @@
  how a consumer would use the library or CLI tool (e.g. adding unit tests, updating documentation, etc) are not captured
  here.
 
+## Unreleased
+
+### Updated
+
+- The CLI and SDK now have user-agent headers consistent with Code42 current standards.
+
+
 ## 2.2.0 - 2024-11-18
 
 ### Updated

src/_incydr_cli/main.py

@@ -52,6 +52,9 @@
 )
 @logging_options
 def incydr(version, python, script_dir):
+    # Configure SDK settings
+    os.environ["INCYDR_USER_AGENT_PREFIX"] = "incydrCLI (Code42; code42.com) "
+
     if version:
         console.print(__version__, highlight=False)
     if python:

src/_incydr_sdk/core/client.py

@@ -28,7 +28,7 @@
 from _incydr_sdk.users.client import UsersClient
 from _incydr_sdk.watchlists.client import WatchlistsClient
 
-_base_user_agent = user_agent("incydr", __version__)
+_base_user_agent = user_agent("incydrSDK", __version__)
 
 
 class Client:
@@ -75,8 +75,8 @@ def __init__(
 
         self._session = BaseUrlSession(base_url=self._settings.url)
         self._session.headers["User-Agent"] = (
-            self._settings.user_agent_prefix or "" + _base_user_agent
-        )
+            self._settings.user_agent_prefix or ""
+        ) + _base_user_agent
         self._session.auth = APIClientAuth(
             session=self._session,
             api_client_id=self._settings.api_client_id,

tests/test_cli_core.py

@@ -1,3 +1,7 @@
+from typing import Optional
+
+import pytest
+
 from _incydr_cli.main import incydr
 
 
@@ -9,3 +13,27 @@ def test_cli_auth_missing_error_prints_missing_vars(runner, monkeypatch):
     assert "INCYDR_API_CLIENT_SECRET" in result.output
     assert "INCYDR_URL" not in result.output
     assert "INCYDR_API_CLIENT_ID" not in result.output
+
+
+@pytest.mark.disable_autouse
+def test_cli_user_agent(runner, httpserver_auth):
+    def starts_with_matcher(
+        header_name: str, actual: Optional[str], expected: str
+    ) -> bool:
+        if actual is None:
+            return False
+
+        return actual.startswith(expected)
+
+    httpserver_auth.expect_ordered_request(
+        "/v1/users",
+        method="GET",
+        headers={"User-Agent": "incydrCLI"},
+        header_value_matcher=starts_with_matcher,
+    ).respond_with_json({"users": [], "totalCount": 0})
+    result = runner.invoke(
+        incydr, ["users", "list", "--log-stderr", "--log-level", "DEBUG"]
+    )
+    httpserver_auth.check()
+    assert result.exit_code == 0
+    assert "No results found" in result.output

tests/test_core.py

@@ -117,3 +117,8 @@ class Test(Model):
         err.value
     )
     assert "value is not a valid integer" in str(err.value)
+
+
+def test_user_agent(httpserver_auth: HTTPServer):
+    c = Client()
+    assert c._session.headers["User-Agent"].startswith("incydrSDK")