feat(api): adds unit tests to open_auth_url

Author: Matt-Carre

src/python_interface_to_workflows/auth/keycloak_checker.py

@@ -1,8 +1,6 @@
 import os
 
 from keycloak import KeycloakOpenID
-
-# from keycloak.exceptions import KeycloakPostError
 from keycloak.pkce_utils import generate_code_challenge, generate_code_verifier
 
 from python_interface_to_workflows.auth.open_auth_url import open_auth_url
@@ -26,19 +24,6 @@ def return_key(dev: bool) -> str:
                 client_secret_key="",
                 pool_maxsize=1,
             )
-    # btw, as you review this, I don't think this try-except is
-    # necessary - pretty certain this functionality is already in keycloak
-    # as the tokens i've seen are suspiciously similar and also don't require a login
-    # which i believe is due to it figuring out we already have a refresh token
-    # ergo, not confident that this hashed out stuff is needed.
-    # try:
-    #     newtoken: dict[str, str] = (  # pyright: ignore[reportUnknownVariableType]
-    #         keycloak_openid.refresh_token(  # pyright: ignore[reportUnknownMemberType]
-    #             os.environ.get("REFRESH")  # pyright: ignore[reportArgumentType]
-    #         )
-    #     )
-    #     return newtoken["access_token"]
-    # except KeycloakPostError:
     code_verifier = generate_code_verifier()
     code_challenge, code_challenge_method = generate_code_challenge(code_verifier)
     auth_url = keycloak_openid.auth_url(

src/python_interface_to_workflows/auth/open_auth_url.py

@@ -6,28 +6,27 @@
 from typing import cast
 
 
-def open_auth_url(auth_url: str):
+class _ReusingHTTPServer(HTTPServer):
+    allow_reuse_address = True
+    auth_code: str
+
 
-    class _ReusingHTTPServer(HTTPServer):
-        allow_reuse_address = True
-        auth_code: str
+class CallbackHandler(BaseHTTPRequestHandler):
+    def do_GET(self):
+        query = urllib.parse.urlparse(self.path).query
+        params = urllib.parse.parse_qs(query)
+        if "code" in params:
+            cast(_ReusingHTTPServer, self.server).auth_code = params["code"][0]
+            self.send_response(200)
+            self.end_headers()
+            self.wfile.write(b"Authorization successful. You can close this window.")
+        else:
+            self.send_response(400)
+            self.end_headers()
+            self.wfile.write(b"Missing authorization code.")
 
-    class CallbackHandler(BaseHTTPRequestHandler):
-        def do_GET(self):
-            query = urllib.parse.urlparse(self.path).query
-            params = urllib.parse.parse_qs(query)
-            if "code" in params:
-                cast(_ReusingHTTPServer, self.server).auth_code = params["code"][0]
-                self.send_response(200)
-                self.end_headers()
-                self.wfile.write(
-                    b"Authorization successful. You can close this window."
-                )
-            else:
-                self.send_response(400)
-                self.end_headers()
-                self.wfile.write(b"Missing authorization code.")
 
+def open_auth_url(auth_url: str):
     httpd = _ReusingHTTPServer(("localhost", 5173), CallbackHandler)
     webbrowser.open(auth_url)
     try:

tests/test_open_auth_url.py

@@ -0,0 +1,80 @@
+import os
+from unittest.mock import MagicMock, patch
+
+from python_interface_to_workflows.auth.open_auth_url import (
+    CallbackHandler,
+    open_auth_url,
+)
+
+
+@patch("python_interface_to_workflows.auth.open_auth_url.webbrowser.open")
+@patch("python_interface_to_workflows.auth.open_auth_url._ReusingHTTPServer")
+def test_open_auth_url_normal_function(
+    mock_http_server: MagicMock,
+    mock_open_browser: MagicMock,
+):
+    server = mock_http_server.return_value
+    server.auth_code = "this_is_your_code"
+    open_auth_url("url")
+    server.handle_request.assert_called_once()
+    mock_open_browser.assert_called_once_with("url")
+    server.socket.shutdown.assert_called_once()
+    server.server_close.assert_called_once()
+    assert os.environ["AUTH"] == "this_is_your_code"
+
+
+@patch("python_interface_to_workflows.auth.open_auth_url.exit")
+@patch("python_interface_to_workflows.auth.open_auth_url.webbrowser.open")
+@patch("python_interface_to_workflows.auth.open_auth_url._ReusingHTTPServer")
+def test_open_auth_url_raises_error(
+    mock_http_server: MagicMock,
+    mock_open_browser: MagicMock,
+    mock_exit: MagicMock,
+):
+    server = mock_http_server.return_value
+    server.auth_code = "this_is_your_code"
+    server.handle_request.side_effect = OSError
+    open_auth_url("url")
+    mock_open_browser.assert_called_once_with("url")
+    assert os.environ["AUTH"] == ""
+    mock_exit.assert_called_once_with(1)
+    server.socket.shutdown.assert_called_once()
+    server.server_close.assert_called_once()
+
+
+def test_handler_normal_function():
+    handler = CallbackHandler.__new__(CallbackHandler)
+    handler.path = "/?code=this_is_your_code"
+
+    handler.server = MagicMock()
+
+    handler.send_response = MagicMock()
+    handler.end_headers = MagicMock()
+    handler.wfile = MagicMock()
+    handler.wfile.write = MagicMock()
+
+    handler.do_GET()
+
+    assert handler.server.auth_code == "this_is_your_code"
+    handler.send_response.assert_called_once_with(200)
+    handler.wfile.write.assert_called_once_with(
+        b"Authorization successful. You can close this window."
+    )
+
+
+def test_handler_error_response():
+    handler = CallbackHandler.__new__(CallbackHandler)
+    handler.path = "/"
+
+    handler.server = MagicMock()
+
+    handler.send_response = MagicMock()
+    handler.end_headers = MagicMock()
+    handler.wfile = MagicMock()
+    handler.wfile.write = MagicMock()
+
+    handler.do_GET()
+
+    handler.send_response.assert_called_once_with(400)
+    handler.end_headers.assert_called_once()
+    handler.wfile.write.assert_called_once_with(b"Missing authorization code.")