Merge pull request lightspeed-core#1761 from tisnik/lcore-623-gss-encmode-config-type

LCORE-623: proper gss_encmode config type in PostgreSQL configuration

Author: tisnik

docs/openapi.json

@@ -16325,6 +16325,11 @@
                     },
                     "gss_encmode": {
                         "type": "string",
+                        "enum": [
+                            "disable",
+                            "prefer",
+                            "require"
+                        ],
                         "title": "GSS encmode",
                         "description": "This option determines whether or with what priority a secure GSS TCP/IP connection will be negotiated with the server.",
                         "default": "prefer"

src/constants.py

@@ -160,7 +160,7 @@
 # See: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-SSLMODE
 POSTGRES_DEFAULT_SSL_MODE: Final[Literal["prefer"]] = "prefer"
 # See: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-GSSENCMODE
-POSTGRES_DEFAULT_GSS_ENCMODE: Final[str] = "prefer"
+POSTGRES_DEFAULT_GSS_ENCMODE: Final[Literal["prefer"]] = "prefer"
 
 # cache constants
 CACHE_TYPE_MEMORY: Final[str] = "memory"

src/models/config.py

@@ -236,7 +236,7 @@ class PostgreSQLDatabaseConfiguration(ConfigurationBase):
         description="SSL mode",
     )
 
-    gss_encmode: str = Field(
+    gss_encmode: Literal["disable", "prefer", "require"] = Field(
         constants.POSTGRES_DEFAULT_GSS_ENCMODE,
         title="GSS encmode",
         description="This option determines whether or with what priority a secure GSS "

tests/unit/models/config/test_postgresql_database_configuration.py

@@ -264,3 +264,48 @@ def test_postgresql_database_configuration_improper_ssl_mode(
                     password="password",
                     ssl_mode=ssl_mode,
                 )  # pyright: ignore[reportCallIssue]
+
+
+def test_postgresql_database_configuration_gss_encmode(subtests: SubTests) -> None:
+    """Test the PostgreSQLDatabaseConfiguration model."""
+    gss_encmodes = ("disable", "prefer", "require")
+
+    for gss_encmode in gss_encmodes:
+        with subtests.test(msg=f"GSS encmode {gss_encmode}"):
+            # pylint: disable=no-member
+            c = PostgreSQLDatabaseConfiguration(
+                db="db",
+                user="user",
+                password="password",
+                gss_encmode=gss_encmode,
+            )  # pyright: ignore[reportCallIssue]
+
+            # most attributes are set to default values
+            assert c is not None
+            assert c.host == "localhost"
+            assert c.port == 5432
+            assert c.db == "db"
+            assert c.user == "user"
+            assert c.password.get_secret_value() == "password"
+            assert c.ssl_mode == POSTGRES_DEFAULT_SSL_MODE
+            assert c.gss_encmode == gss_encmode
+            assert c.namespace == "public"
+            assert c.ca_cert_path is None
+
+
+def test_postgresql_database_configuration_improper_gss_encmode(
+    subtests: SubTests,
+) -> None:
+    """Test the PostgreSQLDatabaseConfiguration model."""
+    gss_encmodes = ("foo", "bar", "baz", "")
+
+    for gss_encmode in gss_encmodes:
+        with subtests.test(msg=f"GSS encmode {gss_encmode}"):
+            with pytest.raises(ValueError, match="Input should be 'disable'"):
+                # pylint: disable=no-member
+                PostgreSQLDatabaseConfiguration(
+                    db="db",
+                    user="user",
+                    password="password",
+                    gss_encmode=gss_encmode,
+                )  # pyright: ignore[reportCallIssue]