integration test

[michelkluger]

I am trying, both with patching the limiter and using freeze_gun,
to test that my global limits are in place and working as expected,

from datetime import datetime, timedelta
from typing import Any
from unittest.mock import MagicMock

import pytest
from freezegun import freeze_time
from starlette.testclient import TestClient

from mymodule.api import rate_limits


def reach_the_limit(
    client: TestClient, search_query: dict[str, Any], limit: int
) -> None:
    for i in range(limit):
        response = client.post("/search/", json=search_query)
        assert response.status_code == 200


def one_more_request(client: TestClient, search_query: dict[str, Any]) -> None:
    response = client.post("/search/", json=search_query)
    assert response.status_code == 429


def one_more_request_after_limit_interval(
    client: TestClient,
    search_query: dict[str, Any],
) -> None:
    response = client.post("/search/", json=search_query)
    assert response.status_code == 200


@pytest.mark.parametrize("auth_state", ["authorized"])
# @patch("mymodule.api.limiter.Limiter.default_limits")
def test_global_rate_limiter_per_limit_interval(
    client: TestClient,
    # mock_default_limits: MagicMock,
    auth_state: str,
) -> None:
    """
    Test that the global rate limiter works as expected
    after the limit is reached, it should return 429
    after the limit period of time has passed, it should return 200 again
    """
    # mock_default_limits.return_value = ["10/hour", "20/day"]

    # rate_limits = {"hour": 10, "day": 20}
    initial_time = datetime(2024, 1, 1, 0, 0, 0)
    for limit_interval, limit in rate_limits.items():
        if limit_interval == "hour":
            delta = timedelta(hours=1)
        elif limit_interval == "day":
            delta = timedelta(days=1)

        with freeze_time(initial_time):
            query = "a"
            search_query = {
                "query": query,
                "filters": {},
            }

            reach_the_limit(client, search_query, limit)

            one_more_request(client, search_query)

        with freeze_time(initial_time + delta):
            one_more_request_after_limit_interval(client, search_query)

this is what I tried so far, any idea of why is it not working and how to fix it?
I get assertion error that the response is 200 instead of 429 in the one_more_request function

[laurentS]

Hi @michelkluger thanks for reporting this. Can you share your endpoint and Limiter definitions?