Register close with exit handler (#94)

Author: djperrefort

keystone_client/http.py

@@ -7,6 +7,7 @@
 """
 
 import abc
+import atexit
 import logging
 import re
 import uuid
@@ -73,9 +74,7 @@ def __init__(
             transport=transport,
         )
 
-    @abc.abstractmethod
-    def _client_factory(self, **kwargs) -> Union[httpx.Client, httpx.AsyncClient]:
-        """Create a new HTTP client instance with the provided settings."""
+        atexit.register(self.close)
 
     @property
     def base_url(self) -> str:
@@ -116,6 +115,75 @@ def get_application_headers(self, overrides: Union[dict, None] = None) -> dict[s
 
         return headers
 
+    @abc.abstractmethod
+    def _client_factory(self, **kwargs) -> Union[httpx.Client, httpx.AsyncClient]:
+        """Create a new HTTP client instance with the provided settings."""
+
+    @abc.abstractmethod
+    def close(self) -> None:
+        """Close any open server connections."""
+
+    @abc.abstractmethod
+    def send_request(
+        self,
+        method: HttpMethod,
+        endpoint: str,
+        *,
+        headers: Optional[dict] = None,
+        json: Optional[RequestContent] = None,
+        files: Optional[RequestFiles] = None,
+        params: Optional[QueryParamTypes] = None,
+        timeout: int = httpx.USE_CLIENT_DEFAULT,
+    ) -> httpx.Response:
+        """Send an HTTP request (sync or async depending on the implementation)."""
+
+    @abc.abstractmethod
+    def http_get(
+        self,
+        endpoint: str,
+        params: Optional[QueryParamTypes] = None,
+        timeout: int = httpx.USE_CLIENT_DEFAULT,
+    ) -> httpx.Response:
+        """Send a GET request."""
+
+    @abc.abstractmethod
+    def http_post(
+        self,
+        endpoint: str,
+        json: Optional[RequestData] = None,
+        files: Optional[RequestFiles] = None,
+        timeout: int = httpx.USE_CLIENT_DEFAULT,
+    ) -> httpx.Response:
+        """Send a POST request."""
+
+    @abc.abstractmethod
+    def http_patch(
+        self,
+        endpoint: str,
+        json: Optional[RequestData] = None,
+        files: Optional[RequestFiles] = None,
+        timeout: int = httpx.USE_CLIENT_DEFAULT,
+    ) -> httpx.Response:
+        """Send a PATCH request."""
+
+    @abc.abstractmethod
+    def http_put(
+        self,
+        endpoint: str,
+        json: Optional[RequestData] = None,
+        files: Optional[RequestFiles] = None,
+        timeout: int = httpx.USE_CLIENT_DEFAULT,
+    ) -> httpx.Response:
+        """Send a PUT request."""
+
+    @abc.abstractmethod
+    def http_delete(
+        self,
+        endpoint: str,
+        timeout: int = httpx.USE_CLIENT_DEFAULT,
+    ) -> httpx.Response:
+        """Send a DELETE request."""
+
 
 class HTTPClient(HTTPBase):
     """Synchronous HTTP Client."""

tests/unit_tests/test_http/test_HTTPBase.py

@@ -2,14 +2,35 @@
 
 import uuid
 from unittest import TestCase
-from unittest.mock import MagicMock
+from unittest.mock import MagicMock, patch
 
 from keystone_client.http import HTTPBase
 
 
 class DummyHTTPBase(HTTPBase):
     """Concrete subclass of HTTPBase for testing."""
 
+    def send_request(self, *args, **kwargs) -> None:
+        """Method required by abstract parent for sending HTTP requests."""
+
+    def http_get(self, *args, **kwargs) -> None:
+        """Method required by abstract parent for sending GET requests."""
+
+    def http_post(self, *args, **kwargs) -> None:
+        """Method required by abstract parent for sending POST requests."""
+
+    def http_patch(self, *args, **kwargs) -> None:
+        """Method required by abstract parent for sending PATCH requests."""
+
+    def http_put(self, *args, **kwargs) -> None:
+        """Method required by abstract parent for sending PUT requests."""
+
+    def http_delete(self, *args, **kwargs) -> None:
+        """Method required by abstract parent for sending DELETE requests."""
+
+    def close(self) -> None:
+        """Method required by abstract parent for cleaning up open resources."""
+
     def _client_factory(self, **kwargs) -> MagicMock:
         """Create a mock object as a stand in for an HTTP client."""
 
@@ -117,3 +138,14 @@ def test_header_overrides_replace_existing_header(self) -> None:
         headers = self.http_base.get_application_headers(overrides)
 
         self.assertEqual(custom_cid, headers[HTTPBase.CID_HEADER])
+
+
+class CloseAtExit(TestCase):
+    """Test resource cleanup at application exit."""
+
+    @patch('atexit.register')
+    def test_close_registered_with_atexit(self, mock_atexit_register: MagicMock) -> None:
+        """Verify the `close` method is registered with `atexit` on initialization."""
+
+        client = DummyHTTPBase('https://example.com/')
+        mock_atexit_register.assert_called_once_with(client.close)