legacy fallbacks seem to just work (TM)?

2 files changed, 33 insertions, 5 deletions

diff --git a/synapse/config/oidc2.py b/synapse/config/oidc2.py
index 5224a255bd..062b8e111f 100644
--- a/synapse/config/oidc2.py
+++ b/synapse/config/oidc2.py
@@ -54,11 +54,9 @@ class OIDCProviderModel(BaseModel):
 
     # a unique identifier for this identity provider. Used in the 'user_external_ids'
     # table, as well as the query/path parameter used in the login protocol.
-    # TODO: this is optional in the old-style config, defaulting to "oidc".
     idp_id: IDP_ID_TYPE
 
     # user-facing name for this identity provider.
-    # TODO: this is optional in the old-style config, defaulting to "OIDC".
     idp_name: StrictStr
 
     # Optional MXC URI for icon for this IdP.
@@ -134,3 +132,8 @@ class OIDCProviderModel(BaseModel):
 
     # required attributes to require in userinfo to allow login/registration
     attribute_requirements: Tuple[Any, ...] = ()  # TODO SsoAttributeRequirement] = ()
+
+
+class LegacyOIDCProviderModel(OIDCProviderModel):
+    idp_id: IDP_ID_TYPE = "oidc"
+    idp_name: StrictStr = "OIDC"
diff --git a/tests/config/test_oidc2.py b/tests/config/test_oidc2.py
index e340a7d43b..63cb535308 100644
--- a/tests/config/test_oidc2.py
+++ b/tests/config/test_oidc2.py
@@ -1,12 +1,15 @@
 from copy import deepcopy
 from typing import Any, Dict
+from unittest import TestCase
 
 import yaml
 from pydantic import ValidationError
 
-from synapse.config.oidc2 import OIDCProviderModel, ClientAuthMethods
-
-from tests.unittest import TestCase
+from synapse.config.oidc2 import (
+    OIDCProviderModel,
+    ClientAuthMethods,
+    LegacyOIDCProviderModel,
+)
 
 SAMPLE_CONFIG = yaml.safe_load(
     """
@@ -80,6 +83,28 @@ class PydanticOIDCTestCase(TestCase):
             self.config["idp_id"] = "$" * 500
             OIDCProviderModel.parse_obj(self.config)
 
+    def test_legacy_model(self) -> None:
+        # Check that parsing the sample config doesn't raise an error.
+        LegacyOIDCProviderModel.parse_obj(self.config)
+
+        # Check we have default values for the attributes which have a legacy fallback
+        del self.config["idp_id"]
+        del self.config["idp_name"]
+        model = LegacyOIDCProviderModel.parse_obj(self.config)
+        self.assertEqual(model.idp_id, "oidc")
+        self.assertEqual(model.idp_name, "OIDC")
+
+        # Check we still reject bad types
+        for bad_value in 123, [], {}, None:
+            with self.assertRaises(ValidationError) as e:
+                self.config["idp_id"] = bad_value
+                self.config["idp_name"] = bad_value
+                LegacyOIDCProviderModel.parse_obj(self.config)
+            # And while we're at it, check that we spot errors in both fields
+            reported_bad_fields = {item["loc"] for item in e.exception.errors()}
+            expected_bad_fields = {("idp_id",), ("idp_name",)}
+            self.assertEqual(reported_bad_fields, expected_bad_fields, e.exception.errors())
+
     def test_issuer(self) -> None:
         """Example of a StrictStr field without a default."""