Merge pull request #160 from maykinmedia/feature/157-Relocate-shared-test-utilities

✨ [#157] Relocate shared test utilities

Author: stevenbal

mozilla_django_oidc_db/tests/utils.py

@@ -0,0 +1,57 @@
+"""
+Keycloak helpers taken from mozilla-django-oidc-db::tests/utils.py & pytest fixtures.
+
+These help dealing with/stubbing out OpenID Provider configuration.
+
+The Keycloak client ID/secret and URLs are set up for the config in
+docker/docker-compose.keycloak.yml. See the README.md in docker/keycloak/ for more
+information.
+"""
+
+from contextlib import nullcontext
+
+from pyquery import PyQuery as pq
+from requests import Session
+
+
+def keycloak_login(
+    login_url: str,
+    username: str = "testuser",
+    password: str = "testuser",
+    host: str = "http://testserver/",
+    session: Session | None = None,
+) -> str:
+    """
+    Test helper to perform a keycloak login.
+
+    :param login_url: A login URL for keycloak with all query string parameters. E.g.
+        `client.get(reverse("login"))["Location"]`.
+    :returns: The redirect URI to consume in the django application, with the ``code``
+        ``state`` query parameters. Consume this with ``response = client.get(url)``.
+    """
+    cm = Session() if session is None else nullcontext(session)
+    with cm as session:
+        login_page = session.get(login_url)
+        assert login_page.status_code == 200
+
+        # process keycloak's login form and submit the username + password to
+        # authenticate
+        document = pq(login_page.text)
+        login_form = document("form#kc-form-login")
+        submit_url = login_form.attr("action")
+        assert isinstance(submit_url, str)
+        login_response = session.post(
+            submit_url,
+            data={
+                "username": username,
+                "password": password,
+                "credentialId": "",
+                "login": "Sign In",
+            },
+            allow_redirects=False,
+        )
+
+        assert login_response.status_code == 302
+        assert (redirect_uri := login_response.headers["Location"]).startswith(host)
+
+        return redirect_uri

tests/test_integration_multiple_configs.py

@@ -5,9 +5,9 @@
 from requests import Session
 
 from mozilla_django_oidc_db.models import OIDCClient
+from mozilla_django_oidc_db.tests.utils import keycloak_login
 
 from .conftest import oidcconfig
-from .utils import keycloak_login
 
 
 @pytest.mark.vcr

tests/test_integration_oidc_flow_variants.py

@@ -7,9 +7,9 @@
     OIDCClient,
     UserInformationClaimsSources,
 )
+from mozilla_django_oidc_db.tests.utils import keycloak_login
 
 from .conftest import oidcconfig
-from .utils import keycloak_login
 
 KEYCLOAK_BASE_URL = "http://localhost:8080/realms/test/"
 

tests/test_logout.py

@@ -5,10 +5,10 @@
 from requests import Session
 
 from mozilla_django_oidc_db.models import OIDCClient
+from mozilla_django_oidc_db.tests.utils import keycloak_login
 from mozilla_django_oidc_db.utils import do_op_logout
 
 from .conftest import oidcconfig
-from .utils import keycloak_login
 
 
 @pytest.fixture

tests/utils.py

@@ -1,10 +1,7 @@
 from collections.abc import Sequence
-from contextlib import nullcontext
 from typing import TypedDict
 
 from glom import assign
-from pyquery import PyQuery as pq
-from requests import Session
 
 from mozilla_django_oidc_db.models import (
     OIDCClient,
@@ -14,50 +11,6 @@
 from mozilla_django_oidc_db.typing import JSONObject
 
 
-def keycloak_login(
-    login_url: str,
-    username: str = "testuser",
-    password: str = "testuser",
-    session: Session | None = None,
-) -> str:
-    """
-    Test helper to perform a keycloak login.
-
-    :param login_url: A login URL for keycloak with all query string parameters. E.g.
-        `client.get(reverse("login"))["Location"]`.
-    :returns: The redirect URI to consume in the django application, with the ``code``
-        ``state`` query parameters. Consume this with ``response = client.get(url)``.
-    """
-    cm = Session() if session is None else nullcontext(session)
-    with cm as session:
-        login_page = session.get(login_url)
-        assert login_page.status_code == 200
-
-        # process keycloak's login form and submit the username + password to
-        # authenticate
-        document = pq(login_page.text)
-        login_form = document("form#kc-form-login")
-        submit_url = login_form.attr("action")
-        assert isinstance(submit_url, str)
-        login_response = session.post(
-            submit_url,
-            data={
-                "username": username,
-                "password": password,
-                "credentialId": "",
-                "login": "Sign In",
-            },
-            allow_redirects=False,
-        )
-
-        assert login_response.status_code == 302
-        assert (redirect_uri := login_response.headers["Location"]).startswith(
-            "http://testserver/"
-        )
-
-        return redirect_uri
-
-
 class OIDCConfigOptions(TypedDict, total=False):
     """
     Provider and/or client configuration options, which map to model fields.