Add HTTP proxy support via environment variables (#29)

supports HTTP_PROXY & HTTPS_PROXY env vars

Author: finn-huynh-armis

armis_sdk/core/armis_client.py

@@ -44,6 +44,7 @@ class ArmisClient:  # pylint: disable=too-few-public-methods
     1. Authenticating requests.
     2. Retrying of failed requests (when applicable).
     3. Pagination of requests (when applicable).
+    4. Proxy configuration via HTTPS_PROXY and HTTP_PROXY environment variables.
     """
 
     def __init__(
@@ -91,14 +92,22 @@ def client(self, retries: Optional[int] = None, backoff: Optional[float] = None)
         retries = retries if retries is not None else self._default_retries
         backoff = backoff if backoff is not None else self._default_backoff
         retry = Retry(total=retries, backoff_factor=backoff)
+
+        if proxy := self._get_proxy_config():
+            http_transport = httpx.AsyncHTTPTransport(proxy=proxy)
+            transport = RetryTransport(retry=retry, transport=http_transport)
+        else:
+            transport = RetryTransport(retry=retry)
+
         return httpx.AsyncClient(
             auth=self._auth,
             base_url=self._base_url,
             headers={
                 "User-Agent": self._user_agent,
                 "Armis-API-Client-Id": self._client_id,
             },
-            transport=RetryTransport(retry=retry),
+            transport=transport,
+            trust_env=True,
         )
 
     async def list(self, url: str, key: str) -> AsyncIterator[dict]:
@@ -142,3 +151,7 @@ async def main():
                 for item in items:
                     yield item
                 from_ = data.get("next")
+
+    def _get_proxy_config(self):
+        """Get proxy configuration from environment variables."""
+        return os.getenv("HTTPS_PROXY") or os.getenv("HTTP_PROXY")

tests/armis_sdk/core/armis_client_test.py

@@ -2,6 +2,7 @@
 import platform
 
 import httpx
+import pytest
 import pytest_httpx
 
 from armis_sdk.core.armis_client import ArmisClient
@@ -149,3 +150,34 @@ async def test_list_with_multiple_pages(
         {"id": "4", "name": "mock_site_4"},
         {"id": "5", "name": "mock_site_5"},
     ]
+
+
+@pytest.mark.parametrize(
+    ["env_var", "proxy_url", "expected_proxy"],
+    [
+        (
+            "HTTP_PROXY",
+            "http://test-proxy:8080?b=1&a=2",
+            "http://test-proxy:8080/?a=2&b=1",
+        ),
+        (
+            "HTTPS_PROXY",
+            "https://user:[email protected]:8080?b=1&a=2&c=3",
+            "https://user:[email protected]:8080/?c=3&b=1&a=2",
+        ),
+    ],
+)
+async def test_proxy(monkeypatch, httpx_mock, env_var, proxy_url, expected_proxy):
+    monkeypatch.setenv(env_var, proxy_url)
+
+    # proxy_url must match,
+    # Order of parameters in the query string does not matter
+    httpx_mock.add_response(
+        url="https://mock_tenant.armis.com/mock/endpoint",
+        proxy_url=expected_proxy,
+        json={"ok": True},
+    )
+
+    async with ArmisClient().client() as client:
+        resp = await client.get("/mock/endpoint")
+        assert resp.json() == {"ok": True}