add test

Author: giancarloromeo

packages/models-library/src/models_library/api_schemas_webserver/auth.py

@@ -58,6 +58,7 @@ class ApiKeyListQueryParams(RequestParameters):
     include_autogenerated: Annotated[
         bool,
         Field(
+            alias="includeAutogenerated",
             description="If True, then the list includes autogenerated API keys. "
             "Otherwise, only user-created API keys are returned.",
         ),

services/web/server/tests/unit/with_dbs/01/test_api_keys.py

@@ -13,6 +13,7 @@
 import tenacity
 from aiohttp.test_utils import TestClient
 from faker import Faker
+from models_library.auth import API_KEY_AUTOGENERATED_PREFIX
 from models_library.products import ProductName
 from pytest_mock import MockerFixture, MockType
 from pytest_simcore.helpers.assert_checks import assert_status
@@ -67,6 +68,39 @@ async def fake_user_api_keys(
         )
 
 
+@pytest.fixture
+async def fake_auto_api_keys(
+    client: TestClient,
+    logged_user: UserInfoDict,
+    osparc_product_name: ProductName,
+    faker: Faker,
+) -> AsyncIterable[list[ApiKey]]:
+    assert client.app
+
+    api_keys: list[ApiKey] = [
+        await _repository.create_api_key(
+            client.app,
+            user_id=logged_user["id"],
+            product_name=osparc_product_name,
+            display_name=API_KEY_AUTOGENERATED_PREFIX + faker.pystr(),
+            expiration=None,
+            api_key=faker.pystr(),
+            api_secret=faker.pystr(),
+        )
+        for _ in range(5)
+    ]
+
+    yield api_keys
+
+    for api_key in api_keys:
+        await _repository.delete_api_key(
+            client.app,
+            api_key_id=api_key.id,
+            user_id=logged_user["id"],
+            product_name=osparc_product_name,
+        )
+
+
 def _get_user_access_parametrizations(expected_authed_status_code):
     return [
         pytest.param(UserRole.ANONYMOUS, status.HTTP_401_UNAUTHORIZED),
@@ -86,13 +120,43 @@ def _get_user_access_parametrizations(expected_authed_status_code):
 async def test_list_api_keys(
     disabled_setup_garbage_collector: MockType,
     client: TestClient,
+    fake_user_api_keys: list[ApiKey],
     logged_user: UserInfoDict,
     user_role: UserRole,
     expected: HTTPStatus,
 ):
     resp = await client.get("/v0/auth/api-keys")
     data, errors = await assert_status(resp, expected)
 
+    if not errors:
+        assert len(data) == len(fake_user_api_keys)
+
+
+@pytest.mark.parametrize(
+    "user_role,expected",
+    _get_user_access_parametrizations(status.HTTP_200_OK),
+)
+async def test_list_auto_api_keys(
+    disabled_setup_garbage_collector: MockType,
+    client: TestClient,
+    fake_auto_api_keys: list[ApiKey],
+    logged_user: UserInfoDict,
+    user_role: UserRole,
+    expected: HTTPStatus,
+):
+    resp = await client.get(
+        "/v0/auth/api-keys", params={"includeAutogenerated": "true"}
+    )
+    data, errors = await assert_status(resp, expected)
+
+    if not errors:
+        assert len(data) == len(fake_auto_api_keys)
+
+    resp = await client.get(
+        "/v0/auth/api-keys", params={"includeAutogenerated": "false"}
+    )
+    data, errors = await assert_status(resp, expected)
+
     if not errors:
         assert not data