feat: add official field in the operational API update endpoint (#1097)

* feat: add official field in the operational API update endpoint

* updated unit test & linter fix

* added official field to Operations API schema

Author: AlfredNwolisa

docs/OperationsAPI.yaml

@@ -319,6 +319,9 @@ components:
             - no_change
             - wip
             - published
+        official:
+          type: boolean
+          description: Whether this is an official feed.
       required:
         - id
         - status
@@ -364,6 +367,9 @@ components:
             - no_change
             - wip
             - published
+        official:
+          type: boolean
+          description: Whether this is an official feed.
       required:
         - id
         - status

functions-python/operations_api/src/feeds_operations/impl/models/update_request_gtfs_feed_impl.py

@@ -14,11 +14,11 @@
 #  limitations under the License.
 #
 
-from shared.database_gen.sqlacodegen_models import Gtfsfeed
 from feeds_operations.impl.models.external_id_impl import ExternalIdImpl
 from feeds_operations.impl.models.redirect_impl import RedirectImpl
 from feeds_operations_gen.models.source_info import SourceInfo
 from feeds_operations_gen.models.update_request_gtfs_feed import UpdateRequestGtfsFeed
+from shared.database_gen.sqlacodegen_models import Gtfsfeed
 
 
 class UpdateRequestGtfsFeedImpl(UpdateRequestGtfsFeed):
@@ -64,6 +64,7 @@ def from_orm(cls, obj: Gtfsfeed | None) -> UpdateRequestGtfsFeed | None:
                 [ExternalIdImpl.from_orm(item) for item in obj.externalids],
                 key=lambda x: x.external_id,
             ),
+            official=obj.official,
         )
 
     @classmethod
@@ -78,6 +79,7 @@ def to_orm(
         entity.feed_name = update_request.feed_name
         entity.note = update_request.note
         entity.feed_contact_email = update_request.feed_contact_email
+        entity.official = update_request.official
         entity.producer_url = (
             None
             if (

functions-python/operations_api/src/feeds_operations/impl/models/update_request_gtfs_rt_feed_impl.py

@@ -14,14 +14,14 @@
 #  limitations under the License.
 #
 
-from shared.database_gen.sqlacodegen_models import Gtfsfeed, Gtfsrealtimefeed
 from feeds_operations.impl.models.entity_type_impl import EntityTypeImpl
 from feeds_operations.impl.models.external_id_impl import ExternalIdImpl
 from feeds_operations.impl.models.redirect_impl import RedirectImpl
 from feeds_operations_gen.models.source_info import SourceInfo
 from feeds_operations_gen.models.update_request_gtfs_rt_feed import (
     UpdateRequestGtfsRtFeed,
 )
+from shared.database_gen.sqlacodegen_models import Gtfsfeed, Gtfsrealtimefeed
 
 
 class UpdateRequestGtfsRtFeedImpl(UpdateRequestGtfsRtFeed):
@@ -71,6 +71,7 @@ def from_orm(cls, obj: Gtfsrealtimefeed | None) -> UpdateRequestGtfsRtFeed | Non
                 [EntityTypeImpl.from_orm(item) for item in obj.entitytypes]
             ),
             feed_references=sorted([item.stable_id for item in obj.gtfs_feeds]),
+            official=obj.official,
         )
 
     @classmethod
@@ -85,6 +86,7 @@ def to_orm(
         entity.feed_name = update_request.feed_name
         entity.note = update_request.note
         entity.feed_contact_email = update_request.feed_contact_email
+        entity.official = update_request.official
         entity.producer_url = (
             None
             if (

functions-python/operations_api/tests/feeds_operations/impl/test_feeds_operations_impl_gtfs.py

@@ -38,6 +38,7 @@ def update_request_gtfs_feed():
         ),
         redirects=[],
         operational_status_action="no_change",
+        official=True,
     )
 
 
@@ -52,7 +53,7 @@ def update_request_gtfs_feed():
 async def test_update_gtfs_feed_no_changes(_, update_request_gtfs_feed):
     api = OperationsApiImpl()
     response: Response = await api.update_gtfs_feed(update_request_gtfs_feed)
-    assert response.status_code == 204
+    assert response.status_code == 200
 
 
 @patch("shared.helpers.logger.Logger")
@@ -168,3 +169,27 @@ async def test_update_gtfs_feed_invalid_feed(_, update_request_gtfs_feed):
         await api.update_gtfs_feed(update_request_gtfs_feed)
     assert exc_info.value.status_code == 400
     assert exc_info.value.detail == "Feed ID not found: invalid"
+
+
+@patch("shared.helpers.logger.Logger")
+@mock.patch.dict(
+    os.environ,
+    {
+        "FEEDS_DATABASE_URL": default_db_url,
+    },
+)
+@pytest.mark.asyncio
+async def test_update_gtfs_feed_official_field(_, update_request_gtfs_feed):
+    """Test updating the official field of a GTFS feed."""
+    update_request_gtfs_feed.official = True
+    with get_testing_session() as session:
+        api = OperationsApiImpl()
+        response: Response = await api.update_gtfs_feed(update_request_gtfs_feed)
+        assert response.status_code == 204
+
+        db_feed = (
+            session.query(Gtfsfeed)
+            .filter(Gtfsfeed.stable_id == feed_mdb_40.stable_id)
+            .one()
+        )
+        assert db_feed.official is True

functions-python/operations_api/tests/feeds_operations/impl/test_feeds_operations_impl_gtfs_rt.py

@@ -40,6 +40,7 @@ def update_request_gtfs_rt_feed():
         redirects=[],
         operational_status_action="no_change",
         entity_types=[EntityType.VP],
+        official=True,
     )
 
 
@@ -137,3 +138,27 @@ async def test_update_gtfs_rt_feed_set_published(_, update_request_gtfs_rt_feed)
             .one()
         )
         assert db_feed.operational_status == "published"
+
+
+@patch("shared.helpers.logger.Logger")
+@mock.patch.dict(
+    os.environ,
+    {
+        "FEEDS_DATABASE_URL": default_db_url,
+    },
+)
+@pytest.mark.asyncio
+async def test_update_gtfs_rt_feed_official_field(_, update_request_gtfs_rt_feed):
+    """Test updating the official field of a GTFS-RT feed."""
+    update_request_gtfs_rt_feed.official = True
+    with get_testing_session() as session:
+        api = OperationsApiImpl()
+        response: Response = await api.update_gtfs_rt_feed(update_request_gtfs_rt_feed)
+        assert response.status_code == 200
+
+        db_feed = (
+            session.query(Gtfsrealtimefeed)
+            .filter(Gtfsrealtimefeed.stable_id == feed_mdb_41.stable_id)
+            .one()
+        )
+        assert db_feed.official is True