Test docstrings in quota limiters unit tests

Author: tisnik

tests/unit/quota/test_cluster_quota_limiter.py

@@ -16,7 +16,22 @@
 def create_quota_limiter(
     name: str, initial_quota: int, quota_limit: int
 ) -> ClusterQuotaLimiter:
-    """Create new quota limiter instance."""
+    """Create new quota limiter instance.
+
+    Builds and returns a ClusterQuotaLimiter using an in-memory
+    SQLite configuration for testing.
+
+    Parameters:
+        - name (str): Name assigned to the configured quota limiter.
+        - initial_quota (int): Initial quota value passed to the
+          ClusterQuotaLimiter instance.
+        - quota_limit (int): Initial quota value placed into the limiter
+          configuration (mapped to the configuration's `initial_quota`).
+
+    Returns:
+        ClusterQuotaLimiter: A configured ClusterQuotaLimiter backed by an
+        in-memory SQLite database.
+    """
     configuration = QuotaHandlersConfiguration()  # pyright: ignore[reportCallIssue]
     configuration.sqlite = SQLiteDatabaseConfiguration(
         db_path=":memory:",
@@ -138,7 +153,14 @@ def test_ensure_available_quota() -> None:
 
 
 def test_ensure_available_quota_no_quota() -> None:
-    """Test the ensure_available_quota operation."""
+    """Test the ensure_available_quota operation.
+
+    Verify ensure_available_quota raises QuotaExceedError when the cluster has zero tokens.
+
+    Sets up a limiter with initial quota 0, initializes quota for cluster
+    "foo", and asserts that calling ensure_available_quota("foo") raises
+    QuotaExceedError with a message matching "Cluster has no available tokens".
+    """
     initial_quota = 0
     quota_limit = 100
 

tests/unit/quota/test_connect_pg.py

@@ -11,7 +11,14 @@
 
 
 def test_connect_pg_when_connection_established(mocker: MockerFixture) -> None:
-    """Test the connection to PostgreSQL database."""
+    """Test the connection to PostgreSQL database.
+
+    Verify that connect_pg returns a non-None connection object when the
+    underlying psycopg2 connection succeeds.
+
+    Patches psycopg2.connect to avoid a real network call and asserts the
+    returned connection is not None.
+    """
     # any correct PostgreSQL configuration can be used
     configuration = PostgreSQLDatabaseConfiguration(
         db="db",
@@ -34,7 +41,15 @@ def test_connect_pg_when_connection_established(mocker: MockerFixture) -> None:
 
 
 def test_connect_pg_when_connection_error(mocker: MockerFixture) -> None:
-    """Test the connection to PostgreSQL database."""
+    """Test the connection to PostgreSQL database.
+
+    Verifies that connect_pg propagates psycopg2.OperationalError when the
+    underlying connection attempt fails.
+
+    Asserts that calling connect_pg with a valid configuration raises an
+    OperationalError with the original error message when psycopg2.connect
+    raises OperationalError.
+    """
     # any correct PostgreSQL configuration can be used
     configuration = PostgreSQLDatabaseConfiguration(
         host="foo",

tests/unit/quota/test_quota_limiter_factory.py

@@ -57,7 +57,14 @@ def test_quota_limiters_no_limiters_sqlite_storage() -> None:
 
 
 def test_quota_limiters_empty_limiters_pg_storage() -> None:
-    """Test the quota limiters creating when no limiters are specified."""
+    """Test the quota limiters creating when no limiters are specified.
+
+    Verify no quota limiters are created when PostgreSQL storage is configured
+    but the limiter list is empty.
+
+    Asserts that QuotaLimiterFactory.quota_limiters(configuration) returns an
+    empty collection.
+    """
     configuration = QuotaHandlersConfiguration()  # pyright: ignore[reportCallIssue]
     configuration.postgres = PostgreSQLDatabaseConfiguration(
         db="test",
@@ -89,7 +96,16 @@ def test_quota_limiters_empty_limiters_sqlite_storage() -> None:
 def test_quota_limiters_user_quota_limiter_postgres_storage(
     mocker: MockerFixture,
 ) -> None:
-    """Test the quota limiters creating when one limiter is specified."""
+    """Test the quota limiters creating when one limiter is specified.
+
+    Verify that configuring PostgreSQL storage with a single limiter of type
+    "user_limiter" produces exactly one UserQuotaLimiter.
+
+    Sets up a QuotaHandlersConfiguration with PostgreSQL connection settings
+    and one QuotaLimiterConfiguration(type="user_limiter"), patches
+    psycopg2.connect to avoid real DB connections, and asserts the factory
+    returns a single UserQuotaLimiter instance.
+    """
     configuration = QuotaHandlersConfiguration()  # pyright: ignore[reportCallIssue]
     configuration.postgres = PostgreSQLDatabaseConfiguration(
         db="test",
@@ -119,7 +135,14 @@ def test_quota_limiters_user_quota_limiter_postgres_storage(
 
 
 def test_quota_limiters_user_quota_limiter_sqlite_storage() -> None:
-    """Test the quota limiters creating when one limiter is specified."""
+    """Test the quota limiters creating when one limiter is specified.
+
+    Verify that providing a single `user_limiter` configuration with in-memory
+    SQLite storage produces one UserQuotaLimiter instance.
+
+    Asserts that exactly one limiter is returned and that it is an instance of
+    `UserQuotaLimiter`.
+    """
     configuration = QuotaHandlersConfiguration()  # pyright: ignore[reportCallIssue]
     configuration.sqlite = SQLiteDatabaseConfiguration(
         db_path=":memory:",

tests/unit/quota/test_user_quota_limiter.py

@@ -64,7 +64,7 @@ def test_available_quota() -> None:
 
     quota_limiter = create_quota_limiter("foo", initial_quota, quota_limit)
 
-    # init quota for given cluster
+    # init quota for given user
     quota_limiter._init_quota()
 
     available_quota = quota_limiter.available_quota("foo")
@@ -78,7 +78,7 @@ def test_consume_tokens() -> None:
 
     quota_limiter = create_quota_limiter("foo", initial_quota, quota_limit)
 
-    # init quota for given cluster
+    # init quota for given user
     quota_limiter._init_quota()
 
     available_quota = quota_limiter.available_quota("foo")
@@ -107,7 +107,7 @@ def test_increase_quota() -> None:
 
     quota_limiter = create_quota_limiter("foo", initial_quota, quota_limit)
 
-    # init quota for given cluster
+    # init quota for given user
     quota_limiter._init_quota()
 
     available_quota = quota_limiter.available_quota("foo")
@@ -129,20 +129,29 @@ def test_ensure_available_quota() -> None:
 
     quota_limiter = create_quota_limiter("foo", initial_quota, quota_limit)
 
-    # init quota for given cluster
+    # init quota for given user
     quota_limiter._init_quota()
 
     quota_limiter.ensure_available_quota("foo")
 
 
 def test_ensure_available_quota_no_quota() -> None:
-    """Test the ensure_available_quota operation."""
+    """Test the ensure_available_quota operation.
+
+    Verify that ensure_available_quota raises QuotaExceedError when the user's
+    available quota is zero.
+
+    Initializes a limiter with initial_quota set to 0, calls the limiter
+    initialization routine, and asserts that calling
+    ensure_available_quota("foo") raises QuotaExceedError with the message
+    "User foo has no available tokens".
+    """
     initial_quota = 0
     quota_limit = 100
 
     quota_limiter = create_quota_limiter("foo", initial_quota, quota_limit)
 
-    # init quota for given cluster
+    # init quota for given user
     quota_limiter._init_quota()
 
     with pytest.raises(QuotaExceedError, match="User foo has no available tokens"):
@@ -156,7 +165,7 @@ def test_revoke_quota() -> None:
 
     quota_limiter = create_quota_limiter("foo", initial_quota, quota_limit)
 
-    # init quota for given cluster
+    # init quota for given user
     quota_limiter._init_quota()
 
     available_quota = quota_limiter.available_quota("foo")