GH-257: Get status for authority's schemes from the API

Author: markhobson

schemes/infrastructure/api/schemes/schemes.py

@@ -1,6 +1,6 @@
 from typing import Any
 
-from schemes.domain.schemes.schemes import Scheme, SchemeRepository, Status
+from schemes.domain.schemes.schemes import Scheme, SchemeRepository
 from schemes.infrastructure.api.authorities import AuthorityModel
 from schemes.infrastructure.api.base import BaseModel
 from schemes.infrastructure.api.collections import CollectionModel
@@ -46,13 +46,13 @@ def to_domain(
 class CapitalSchemeItemModel(BaseModel):
     reference: str
     overview: CapitalSchemeOverviewModel
+    status: CapitalSchemeStatusModel
     authority_review: CapitalSchemeAuthorityReviewModel | None = None
 
     def to_domain(
         self, authority_models: list[AuthorityModel], funding_programme_item_models: list[FundingProgrammeItemModel]
     ) -> Scheme:
-        # status is always active to match filters in get capital schemes by bid submitting authority
-        scheme = Scheme(reference=self.reference, status=Status.ACTIVE)
+        scheme = Scheme(reference=self.reference, status=self.status.status.to_domain())
         scheme.overview.update_overview(self.overview.to_domain(authority_models, funding_programme_item_models))
         # TODO: financials, milestones, outputs
 

tests/e2e/api_server/authorities.py

@@ -10,6 +10,7 @@
     CapitalSchemeAuthorityReviewModel,
     CapitalSchemeModel,
     CapitalSchemeOverviewModel,
+    CapitalSchemeStatusModel,
     capital_schemes,
 )
 from tests.e2e.api_server.collections import CollectionModel
@@ -26,6 +27,7 @@ class CapitalSchemeItemModel(BaseModel):
     id: Annotated[AnyUrl, Field(alias="@id")]
     reference: str
     overview: CapitalSchemeOverviewModel
+    status: CapitalSchemeStatusModel
     authority_review: CapitalSchemeAuthorityReviewModel | None
 
 
@@ -106,5 +108,6 @@ def _to_capital_scheme_item(capital_scheme: CapitalSchemeModel) -> CapitalScheme
         id=AnyUrl(url_for("capital_schemes.get_capital_scheme", reference=capital_scheme.reference, _external=True)),
         reference=capital_scheme.reference,
         overview=capital_scheme.overview,
+        status=capital_scheme.status,
         authority_review=capital_scheme.authority_review,
     )

tests/unit/infrastructure/api/builders.py

@@ -140,10 +140,12 @@ def build_capital_scheme_json(
 def build_capital_scheme_item_json(
     reference: str = "dummy",
     overview: dict[str, Any] | None = None,
+    status: dict[str, Any] | None = None,
     authority_review: dict[str, Any] | None = None,
 ) -> dict[str, Any]:
     return {
         "reference": reference,
         "overview": overview or build_overview_json(),
+        "status": status or build_status_json(),
         "authorityReview": authority_review if authority_review else None,
     }

tests/unit/infrastructure/api/schemes/test_schemes.py

@@ -259,7 +259,9 @@ def test_to_domain_sets_authority_review(self) -> None:
 
 class TestCapitalSchemeItemModel:
     def test_to_domain(self) -> None:
-        capital_scheme_item_model = CapitalSchemeItemModel(reference="ATE00001", overview=build_overview_model())
+        capital_scheme_item_model = CapitalSchemeItemModel(
+            reference="ATE00001", overview=build_overview_model(), status=build_status_model()
+        )
 
         scheme = capital_scheme_item_model.to_domain([build_authority_model()], [build_funding_programme_item_model()])
 
@@ -283,6 +285,7 @@ def test_to_domain_sets_overview_revision(self) -> None:
                 funding_programme=AnyUrl("https://api.example/funding-programmes/ATF4"),
                 type=CapitalSchemeTypeModel.CONSTRUCTION,
             ),
+            status=build_status_model(),
         )
 
         scheme = capital_scheme_item_model.to_domain([authority_model], [funding_programme_item_model])
@@ -296,7 +299,11 @@ def test_to_domain_sets_overview_revision(self) -> None:
         )
 
     def test_to_domain_sets_status(self) -> None:
-        capital_scheme_item_model = CapitalSchemeItemModel(reference="ATE00001", overview=build_overview_model())
+        capital_scheme_item_model = CapitalSchemeItemModel(
+            reference="ATE00001",
+            overview=build_overview_model(),
+            status=CapitalSchemeStatusModel(status=StatusModel.ACTIVE),
+        )
 
         scheme = capital_scheme_item_model.to_domain([build_authority_model()], [build_funding_programme_item_model()])
 
@@ -306,6 +313,7 @@ def test_to_domain_sets_authority_review(self) -> None:
         capital_scheme_item_model = CapitalSchemeItemModel(
             reference="ATE00001",
             overview=build_overview_model(),
+            status=build_status_model(),
             authority_review=CapitalSchemeAuthorityReviewModel(
                 review_date=datetime(2020, 1, 2, tzinfo=UTC), source=DataSourceModel.AUTHORITY_UPDATE
             ),
@@ -639,6 +647,7 @@ async def test_get_schemes_by_authority_sets_status(
                     build_capital_scheme_item_json(
                         reference="ATE00001",
                         overview=build_overview_json(bid_submitting_authority=f"{api_base_url}/authorities/LIV"),
+                        status=build_status_json(status="active"),
                     )
                 ]
             },