feat: implement POST endpoints for asset

Author: jacob-a-brown

api/asset.py

@@ -17,7 +17,8 @@
 from fastapi import APIRouter, Depends, UploadFile, File
 from fastapi_pagination.ext.sqlalchemy import paginate
 from sqlalchemy import select
-from starlette.status import HTTP_201_CREATED
+from sqlalchemy.exc import ProgrammingError
+from starlette.status import HTTP_201_CREATED, HTTP_409_CONFLICT
 
 from api.pagination import CustomPage
 from core.dependencies import (
@@ -39,12 +40,42 @@
     check_asset_exists,
     add_signed_url,
 )
+from services.exceptions_helper import PydanticStyleException
 
 router = APIRouter(
     prefix="/asset", tags=["asset"], dependencies=[Depends(viewer_function)]
 )
 
 
+def database_error_handler(payload: CreateAsset, error: ProgrammingError) -> None:
+    """
+    Handle errors raised by the database when adding or updating a sample.
+    """
+
+    error_message = error.orig.args[0]["M"]
+    print(error_message)
+
+    if (
+        error_message
+        == 'null value in column "thing_id" of relation "asset_thing_association" violates not-null constraint'
+    ):
+        """
+        Developer's notes
+
+        this error occurs because the thing_id is set by the Thing record that
+        is retrieved, so if there is no Thing with thing_id it tries to set
+        thing_id to None in the AssetThingAssociation table
+        """
+        detail = {
+            "loc": ["body", "thing_id"],
+            "msg": f"Thing with ID {payload.thing_id} not found.",
+            "type": "value_error",
+            "input": {"thing_id": payload.thing_id},
+        }
+
+    raise PydanticStyleException(status_code=HTTP_409_CONFLICT, detail=[detail])
+
+
 # ======= Create =========
 @router.post(
     "/upload", status_code=HTTP_201_CREATED, dependencies=[Depends(admin_function)]
@@ -64,33 +95,38 @@ async def add_asset(
     user: admin_dependency, session: session_dependency, asset_data: CreateAsset
 ) -> AssetResponse:
 
-    data = asset_data.model_dump()
-    thing_id = data.pop("thing_id", None)
-    storage_path = data["storage_path"]
-
-    # check to see if an asset entry already exists for
-    # this storage path and thing_id
-    existing_asset = check_asset_exists(session, storage_path, thing_id=thing_id)
-    if existing_asset:
-        # If an asset already exists, return it
-        return existing_asset
-
-    data["storage_service"] = "gcs"
-    asset = Asset(**data)
-    audit_add(user, asset)
-
-    if thing_id:
-        assoc = AssetThingAssociation()
-        audit_add(user, assoc)
-        thing = session.get(Thing, thing_id)
-        assoc.thing = thing
-        assoc.asset = asset
-        session.add(assoc)
-
-    session.add(asset)
-    session.commit()
-    session.refresh(asset)
-    return asset
+    try:
+        data = asset_data.model_dump()
+        print(data)
+        thing_id = data.pop("thing_id", None)
+        print(thing_id)
+        storage_path = data["storage_path"]
+
+        # check to see if an asset entry already exists for
+        # this storage path and thing_id
+        existing_asset = check_asset_exists(session, storage_path, thing_id=thing_id)
+        if existing_asset:
+            # If an asset already exists, return it
+            return existing_asset
+
+        data["storage_service"] = "gcs"
+        asset = Asset(**data)
+        audit_add(user, asset)
+
+        if thing_id:
+            assoc = AssetThingAssociation()
+            audit_add(user, assoc)
+            thing = session.get(Thing, thing_id)
+            assoc.thing = thing
+            assoc.asset = asset
+            session.add(assoc)
+
+        session.add(asset)
+        session.commit()
+        session.refresh(asset)
+        return asset
+    except ProgrammingError as e:
+        database_error_handler(asset_data, e)
 
 
 # ======= Read =========

schemas/asset.py

@@ -13,7 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ===============================================================================
-from pydantic import BaseModel, AwareDatetime
+from pydantic import BaseModel
+
+from schemas import ORMBaseModel
 
 
 class BaseAsset(BaseModel):
@@ -23,26 +25,17 @@ class BaseAsset(BaseModel):
     mime_type: str
     size: int
     uri: str
-    thing_id: int | None = None
 
 
 # -------- CREATE ----------
 class CreateAsset(BaseAsset):
-    pass
+    thing_id: int | None = None
 
 
 # -------- RESPONSE --------
-class AssetResponse(BaseAsset):
-    id: int
-    # name: str
-    # label: str
-    # storage_service: str
-    # storage_path: str
-    # mime_type: str
-    # size: int
-    created_at: AwareDatetime
+class AssetResponse(ORMBaseModel, BaseAsset):
+    storage_service: str
     storage_service: str
-    uri: str
     signed_url: str | None = None
 
 

tests/test_asset.py

@@ -21,6 +21,8 @@
 
 import pytest
 
+# CLASSES, FIXTURES, AND FUNCTIONS =============================================
+
 
 class MockBlob:
     def upload_from_file(self, *args, **kwargs):
@@ -63,6 +65,9 @@ def override_dependency_fixture():
     app.dependency_overrides = {}
 
 
+# POST & UPLOAD tests ==========================================================
+
+
 def test_upload_asset():
     path = "tests/data/riochama.png"
 
@@ -78,46 +83,51 @@ def test_upload_asset():
 
 
 def test_add_asset(thing):
-    resp = client.post(
-        "/asset",
-        json={
-            "thing_id": thing.id,
-            "name": "riochama.png",
-            "storage_service": "mock_service",
-            "storage_path": "mock/path/to/asset",
-            "uri": "https://storage.googleapis.com/mock-bucket/mock-asset",
-            "mime_type": "image/png",
-            "size": 12345,
-        },
-    )
-
+    payload = {
+        "thing_id": thing.id,
+        "name": "test_asset.png",
+        "label": "Test Asset",
+        "uri": "https://storage.googleapis.com/mock-bucket/mock-asset",
+        "storage_service": "mock_service",
+        "storage_path": "mock/path/to/asset/test_asset.png",
+        "mime_type": "image/png",
+        "size": 12345,
+    }
+    resp = client.post("/asset", json=payload)
     assert resp.status_code == 201
     data = resp.json()
-    assert data["name"] == "riochama.png"
+    assert "id" in data
+    assert "created_at" in data
+    assert data["name"] == payload["name"]
+    assert data["label"] == payload["label"]
+    assert data["uri"] == payload["uri"]
+    assert data["storage_service"] == "gcs"
+    assert data["storage_path"] == payload["storage_path"]
+    assert data["mime_type"] == payload["mime_type"]
+    assert data["size"] == payload["size"]
 
     cleanup_post_test(Asset, data["id"])
 
 
-def test_add_asset_with_label(thing):
-    resp = client.post(
-        "/asset",
-        json={
-            "thing_id": thing.id,
-            "name": "test_asset.png",
-            "label": "Test Asset",
-            "uri": "https://storage.googleapis.com/mock-bucket/mock-asset",
-            "storage_service": "mock_service",
-            "storage_path": "mock/path/to/asset/test_asset.png",
-            "mime_type": "image/png",
-            "size": 12345,
-        },
-    )
-    assert resp.status_code == 201
+def test_add_asset_409_bad_thing_id(thing):
+    bad_thing_id = 99999
+    payload = {
+        "thing_id": bad_thing_id,
+        "name": "test_asset.png",
+        "label": "Test Asset",
+        "uri": "https://storage.googleapis.com/mock-bucket/mock-asset",
+        "storage_service": "mock_service",
+        "storage_path": "mock/path/to/asset/test_asset.png",
+        "mime_type": "image/png",
+        "size": 12345,
+    }
+    resp = client.post("/asset", json=payload)
+    assert resp.status_code == 409
     data = resp.json()
-    assert data["name"] == "test_asset.png"
-    assert data["label"] == "Test Asset"
-
-    cleanup_post_test(Asset, data["id"])
+    assert data["detail"][0]["loc"] == ["body", "thing_id"]
+    assert data["detail"][0]["msg"] == f"Thing with ID {bad_thing_id} not found."
+    assert data["detail"][0]["type"] == "value_error"
+    assert data["detail"][0]["input"] == {"thing_id": bad_thing_id}
 
 
 def test_get_asset(asset):