renames

Author: pcrespov

packages/postgres-database/src/simcore_postgres_database/utils_products.py

@@ -10,6 +10,9 @@
 _GroupID = int
 
 
+class EmptyProductsError(ValueError): ...
+
+
 async def get_default_product_name(conn: AsyncConnection) -> str:
     """The first row in the table is considered as the default product
 
@@ -19,14 +22,14 @@ async def get_default_product_name(conn: AsyncConnection) -> str:
         sa.select(products.c.name).order_by(products.c.priority)
     )
     if not product_name:
-        msg = "No product defined in database"
-        raise ValueError(msg)
+        msg = "No product was defined in database. Upon construction, at least one product is added but there are none."
+        raise EmptyProductsError(msg)
 
     assert isinstance(product_name, str)  # nosec
     return product_name
 
 
-async def get_product_group_id(
+async def get_product_group_id_or_none(
     connection: AsyncConnection, product_name: str
 ) -> _GroupID | None:
     group_id = await connection.scalar(
@@ -35,7 +38,9 @@ async def get_product_group_id(
     return None if group_id is None else _GroupID(group_id)
 
 
-async def get_or_create_product_group(conn: AsyncConnection, product_name: str) -> int:
+async def get_or_create_product_group(
+    conn: AsyncConnection, product_name: str
+) -> _GroupID:
     #
     # NOTE: Separated so it can be used in asyncpg and aiopg environs while both
     #       coexist

packages/postgres-database/tests/products/test_utils_products.py

@@ -10,9 +10,10 @@
 from simcore_postgres_database.models.groups import GroupType, groups
 from simcore_postgres_database.models.products import products
 from simcore_postgres_database.utils_products import (
+    EmptyProductsError,
     get_default_product_name,
     get_or_create_product_group,
-    get_product_group_id,
+    get_product_group_id_or_none,
 )
 from sqlalchemy.ext.asyncio import AsyncEngine
 
@@ -29,7 +30,7 @@ async def test_default_product(
 @pytest.mark.parametrize("pg_sa_engine", ["sqlModels"], indirect=True)
 async def test_default_product_undefined(asyncpg_engine: AsyncEngine):
     async with asyncpg_engine.connect() as conn:
-        with pytest.raises(ValueError, match="No product"):
+        with pytest.raises(EmptyProductsError):
             await get_default_product_name(conn)
 
 
@@ -79,22 +80,22 @@ async def test_get_or_create_group_product(
             )
             assert result.one()
 
-            assert product_group_id == await get_product_group_id(
+            assert product_group_id == await get_product_group_id_or_none(
                 conn, product_name=product_row.name
             )
 
             # group-id is UPDATED -> product.group_id is updated to the new value
             await conn.execute(
                 groups.update().where(groups.c.gid == product_group_id).values(gid=1000)
             )
-            product_group_id = await get_product_group_id(
+            product_group_id = await get_product_group_id_or_none(
                 conn, product_name=product_row.name
             )
             assert product_group_id == 1000
 
             # if group is DELETED -> product.group_id=null
             await conn.execute(groups.delete().where(groups.c.gid == product_group_id))
-            product_group_id = await get_product_group_id(
+            product_group_id = await get_product_group_id_or_none(
                 conn, product_name=product_row.name
             )
             assert product_group_id is None