🚨 Address errors raised by ruff

Author: stevenbal

mozilla_django_oidc_db/constants.py

@@ -1,10 +1,9 @@
-from collections.abc import Mapping
 
 from .typing import EndpointFieldNames
 
 # Mapping the configuration model fieldnames for endpoints to their
 # corresponding names in the OIDC spec
-OIDC_MAPPING: Mapping[EndpointFieldNames, str] = {
+OIDC_MAPPING: dict[EndpointFieldNames, str] = {
     "oidc_op_authorization_endpoint": "authorization_endpoint",
     "oidc_op_token_endpoint": "token_endpoint",
     "oidc_op_user_endpoint": "userinfo_endpoint",

mozilla_django_oidc_db/forms.py

@@ -1,5 +1,6 @@
 import json
-from collections.abc import Mapping
+from collections.abc import Mapping, Sequence
+from typing import ClassVar
 from urllib.parse import urljoin
 
 from django import forms
@@ -15,7 +16,7 @@
 
 
 class OIDCProviderForm(forms.ModelForm):
-    required_endpoints = [
+    required_endpoints: ClassVar[Sequence[str]] = [
         "oidc_op_authorization_endpoint",
         "oidc_op_token_endpoint",
         "oidc_op_user_endpoint",

mozilla_django_oidc_db/setup_configuration/models.py

@@ -1,5 +1,7 @@
-from typing import Annotated, Literal
+from collections.abc import Sequence
+from typing import Annotated, ClassVar, Literal
 
+from django.db.models import Model
 from django.utils.translation import gettext_lazy as _
 
 from django_setup_configuration.fields import DjangoModelRef
@@ -76,7 +78,7 @@ class OIDCConfigProviderModel(ConfigurationModel):
     endpoint_config: OIDCProviderConfigUnion
 
     class Meta:
-        django_model_refs = {
+        django_model_refs: ClassVar[dict[type[Model], Sequence[str]]] = {
             OIDCProvider: [
                 "oidc_token_use_basic_auth",
                 "oidc_use_nonce",
@@ -217,7 +219,7 @@ class AdminOIDCConfigurationModelItem(ConfigurationModel):
     )
 
     class Meta:
-        django_model_refs = {
+        django_model_refs: ClassVar[dict[type[Model], Sequence[str]]] = {
             OIDCClient: [
                 "oidc_rp_client_id",
                 "oidc_rp_client_secret",
@@ -227,7 +229,7 @@ class Meta:
                 "userinfo_claims_source",
             ]
         }
-        extra_kwargs = {
+        extra_kwargs: ClassVar[dict[str, dict[str, object]]] = {
             "oidc_rp_client_id": {"examples": ["modify-this"]},
             "oidc_rp_client_secret": {"examples": ["modify-this"]},
             "oidc_rp_idp_sign_key": {"examples": ["modify-this"]},

mozilla_django_oidc_db/tests/utils.py

@@ -30,8 +30,8 @@ def keycloak_login(
         ``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)
+    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
@@ -40,7 +40,7 @@ def keycloak_login(
         login_form = document("form#kc-form-login")
         submit_url = login_form.attr("action")
         assert isinstance(submit_url, str)
-        login_response = session.post(
+        login_response = _session.post(
             submit_url,
             data={
                 "username": username,
@@ -52,6 +52,9 @@ def keycloak_login(
         )
 
         assert login_response.status_code == 302
-        assert (redirect_uri := login_response.headers["Location"]).startswith(host)
+
+        redirect_uri = login_response.headers["Location"]
+
+        assert redirect_uri.startswith(host)
 
         return redirect_uri

pyproject.toml

@@ -160,3 +160,6 @@ section-order = [
 
 [tool.ruff.lint.isort.sections]
 "django" = ["django"]
+
+[tool.ruff.lint.per-file-ignores]
+"*/migrations/*.py" = ["RUF012"]

testapp/settings.py

@@ -18,7 +18,7 @@
         "USER": os.getenv("PGUSER", "mozilla_django_oidc_db"),
         "PASSWORD": os.getenv("PGPASSWORD", "mozilla_django_oidc_db"),
         "HOST": os.getenv("DB_HOST", "localhost"),
-        "PORT": os.getenv("DB_PORT", 5432),
+        "PORT": int(os.getenv("DB_PORT", "5432")),
     }
 }
 

tests/test_admin_form.py

@@ -9,7 +9,8 @@
 import requests_mock
 from requests.exceptions import RequestException
 
-from mozilla_django_oidc_db.forms import OIDCProviderForm
+from mozilla_django_oidc_db.constants import EndpointFieldNames
+from mozilla_django_oidc_db.forms import OIDC_MAPPING, OIDCProviderForm
 from mozilla_django_oidc_db.models import OIDCClient
 from tests.factories import UserFactory
 
@@ -65,10 +66,8 @@ def test_derive_endpoints_extra_field():
     class ExtendedOIDCProviderForm(OIDCProviderForm):
         required_endpoints = OIDCProviderForm.required_endpoints
         # Define an extra field to derive from the configuration
-        oidc_mapping = dict(
-            **OIDCProviderForm.oidc_mapping,
-            **{"logout_endpoint": "end_session_endpoint"},
-        )
+        oidc_mapping: dict[EndpointFieldNames, str] = OIDC_MAPPING
+        oidc_mapping["oidc_op_logout_endpoint"] = "end_session_endpoint"
 
     form = ExtendedOIDCProviderForm(data=form_data)
 
@@ -89,7 +88,7 @@ class ExtendedOIDCProviderForm(OIDCProviderForm):
     # The endpoint that was added to the mapping on the extended form
     # should be present in the cleaned data
     assert (
-        form.cleaned_data["logout_endpoint"]
+        form.cleaned_data["oidc_op_logout_endpoint"]
         == "http://provider.com/auth/realms/master/protocol/openid-connect/logout"
     )
 

tests/test_callback_flow.py

@@ -224,10 +224,10 @@ def test_wrong_config_model_used(
     init_view = OIDCAuthenticationRequestInitView.as_view(identifier="test-oidc")
     init_view(auth_request)
     # there is only one state expected
-    state_key = list(auth_request.session["oidc_states"].keys())[0]
+    state_key = next(iter(auth_request.session["oidc_states"].keys()))
     callback_url = reverse("oidc_authentication_callback")
     session = client.session
-    for key in auth_request.session.keys():
+    for key in auth_request.session.keys():  # ruff: ignore[SIM118]
         session[key] = auth_request.session[key]
     session.save()
 

tests/test_logout.py

@@ -97,7 +97,4 @@ def test_logout_response_has_redirect(dummy_config: OIDCClient, requests_mock):
         headers={"Location": "http://testserver/endpoint-that-does-not-exist"},
     )
 
-    try:
-        do_op_logout(dummy_config, id_token="dummy-id-token")
-    except Exception:
-        pytest.fail("Logout should not crash")
+    do_op_logout(dummy_config, id_token="dummy-id-token")