ENH: Add endpoint to get sumo assets

Author: slangeveld

src/fmu_settings_api/interfaces/__init__.py

@@ -1,7 +1,9 @@
 """Interfaces for interacting with outside services."""
 
 from .smda_api import SmdaAPI
+from .sumo_api import SumoApi
 
 __all__ = [
     "SmdaAPI",
+    "SumoApi",
 ]

src/fmu_settings_api/interfaces/sumo_api.py

@@ -0,0 +1,40 @@
+"""Interface for querying Sumo's API."""
+
+import json
+from pathlib import Path
+from typing import Final, Self
+
+from pydantic import TypeAdapter
+
+from fmu_settings_api.models.project import SumoAsset
+
+
+class SumoApi:
+    """Class for interacting with Sumos API."""
+
+    def __init__(self: Self) -> None:
+        """Initializes the SumoApi interface."""
+        self._asset_filepath: Final[Path] = Path(__file__).parent / Path(
+            "sumo_assets.json"
+        )
+
+    def get_assets(self: Self) -> list[SumoAsset]:
+        """Gets the Sumo assets."""
+        return self._read_assets_from_file(self._asset_filepath)
+
+    @staticmethod
+    def _read_assets_from_file(filepath: Path) -> list[SumoAsset]:
+        """Reads the valid Sumo assets from file.
+
+        The file serves as a temporary alternative to the Sumo endpoint, until
+        we set up the intergration towards Sumo. The file is maintained and kept in
+        sync with the assets that are onboarded to Sumo.
+
+        Raises:
+            ValidationError: If Sumo assets read from file are not valid.
+            JSONDecodeError: If json file to read is not a valid json.
+            FileNotFoundError: If the file to read is not found.
+        """
+        with open(filepath, encoding="utf-8") as stream:
+            sumo_assets = json.load(stream)
+        return TypeAdapter(list[SumoAsset]).validate_python(sumo_assets)

src/fmu_settings_api/interfaces/sumo_assets.json

@@ -0,0 +1,117 @@
+[
+    {
+        "name": "Drogon",
+        "code": "001",
+        "roleprefix": "DROGON"
+    },
+    {
+        "name": "Johan Sverdrup",
+        "code": "002",
+        "roleprefix": "JOHAN-SVERDRUP"
+    },
+    {
+        "name": "Breidablikk",
+        "code": "003",
+        "roleprefix": "BREIDABLIKK"
+    },
+    {
+        "name": "Smørbukk",
+        "code": "004",
+        "roleprefix": "SMORBUKK"
+    },
+    {
+        "name": "Heidrun",
+        "code": "005",
+        "roleprefix": "HEIDRUN"
+    },
+    {
+        "name": "Johan Castberg",
+        "code": "006",
+        "roleprefix": "JOHAN-CASTBERG"
+    },
+    {
+        "name": "Snorre",
+        "code": "007",
+        "roleprefix": "SNORRE"
+    },
+    {
+        "name": "Grosbeak",
+        "code": "008",
+        "roleprefix": "GROSBEAK"
+    },
+    {
+        "name": "Troll",
+        "code": "009",
+        "roleprefix": "TROLL"
+    },
+    {
+        "name": "Rosebank",
+        "code": "010",
+        "roleprefix": "ROSEBANK"
+    },
+    {
+        "name": "Wisting",
+        "code": "011",
+        "roleprefix": "WISTING"
+    },
+    {
+        "name": "Oseberg",
+        "code": "012",
+        "roleprefix": "OSEBERG"
+    },
+    {
+        "name": "DIG_CCS_SUB",
+        "code": "013",
+        "roleprefix": "DIG_CCS_SUB"
+    },
+    {
+        "name": "Tordis",
+        "code": "014",
+        "roleprefix": "TORDIS"
+    },
+    {
+        "name": "Bauge",
+        "code": "015",
+        "roleprefix": "BAUGE"
+    },
+    {
+        "name": "Grane",
+        "code": "016",
+        "roleprefix": "GRANE"
+    },
+    {
+        "name": "Martin Linge",
+        "code": "017",
+        "roleprefix": "MARTIN-LINGE"
+    },
+    {
+        "name": "Njord",
+        "code": "018",
+        "roleprefix": "NJORD"
+    },
+    {
+        "name": "Raia",
+        "code": "019",
+        "roleprefix": "RAIA"
+    },
+    {
+        "name": "Aasta Hansteen",
+        "code": "020",
+        "roleprefix": "AASTA-HANSTEEN"
+    },
+    {
+        "name": "Tyrihans",
+        "code": "021",
+        "roleprefix": "TYRIHANS"
+    },
+    {
+        "name": "Fram",
+        "code": "022",
+        "roleprefix": "FRAM"
+    },
+    {
+        "name": "Smørbukk Midt",
+        "code": "023",
+        "roleprefix": "SMORBUKK-MIDT"
+    }
+]

src/fmu_settings_api/models/project.py

@@ -66,3 +66,16 @@ class LockStatus(BaseResponseModel):
 
     last_lock_refresh_error: str | None = Field(default=None)
     """Error message from the last attempt to refresh the lock."""
+
+
+class SumoAsset(BaseResponseModel):
+    """A valid asset in Sumo."""
+
+    name: str
+    """Name of the asset in Sumo."""
+
+    code: str
+    """Code of the asset in Sumo."""
+
+    roleprefix: str
+    """Roleprefix of the asset in Sumo."""

src/fmu_settings_api/services/project.py

@@ -13,8 +13,9 @@
     RmsWell,
 )
 
+from fmu_settings_api.interfaces import SumoApi
 from fmu_settings_api.models import FMUProject
-from fmu_settings_api.models.project import CacheRetention, GlobalConfigPath
+from fmu_settings_api.models.project import CacheRetention, GlobalConfigPath, SumoAsset
 
 from .rms import RmsService
 
@@ -156,3 +157,7 @@ def update_rms_wells(self, wells: list[RmsWell]) -> None:
         self._fmu_dir.set_config_value(
             "rms.wells", [well.model_dump() for well in wells]
         )
+
+    def get_sumo_assets(self) -> list[SumoAsset]:
+        """Get the Sumo assets."""
+        return SumoApi().get_assets()

src/fmu_settings_api/v1/routes/project.py

@@ -1,5 +1,6 @@
 """Routes to add an FMU project to an existing session."""
 
+import json
 from pathlib import Path
 from textwrap import dedent
 from typing import Final
@@ -42,6 +43,7 @@
     CacheRetention,
     GlobalConfigPath,
     LockStatus,
+    SumoAsset,
 )
 from fmu_settings_api.models.resource import CacheContent, CacheList
 from fmu_settings_api.models.rms import (
@@ -292,6 +294,22 @@
     ),
 }
 
+SumoAssetsResponses: Final[Responses] = {
+    **inline_add_response(
+        404,
+        "Sumo assets file not found",
+        [{"detail": "Sumo assets file not found: {error}"}],
+    ),
+    **inline_add_response(
+        422,
+        "Invalid file content in Sumo assets file",
+        [
+            {"detail": "Sumo assets file contains invalid assets: {errors}"},
+            {"detail": "Sumo assets file is not a valid JSON: {error}"},
+        ],
+    ),
+}
+
 
 @router.get(
     "/",
@@ -335,6 +353,38 @@ async def get_project(session_service: SessionServiceDep) -> FMUProject:
     return _create_opened_project_response(fmu_dir)
 
 
+@router.get(
+    "/sumo_assets",
+    response_model=list[SumoAsset],
+    summary="Returns a list of Sumo assets.",
+    description=dedent(
+        """
+        Returns a list of the assets that have been onboarded to
+        the Sumo platform.
+        """
+    ),
+    responses={**GetSessionResponses, **SumoAssetsResponses},
+)
+async def get_sumo_assets(project_service: ProjectServiceDep) -> list[SumoAsset]:
+    """Returns a list of the Sumo assets."""
+    try:
+        return project_service.get_sumo_assets()
+    except ValidationError as e:
+        errors = [error.get("msg", str(error)) for error in e.errors()]
+        raise HTTPException(
+            status_code=422,
+            detail=f"Sumo assets file contains invalid assets: {'; '.join(errors)}",
+        ) from e
+    except json.JSONDecodeError as e:
+        raise HTTPException(
+            status_code=422, detail=f"Sumo assets file is not a valid JSON: {str(e)}"
+        ) from e
+    except FileNotFoundError as e:
+        raise HTTPException(
+            status_code=404, detail=f"Sumo assets file not found: {str(e)}"
+        ) from e
+
+
 @router.get(
     "/global_config_status",
     response_model=Ok,