add feed api endpoint unit tests

Author: davidgamez

functions-python/operations_api/src/feeds_operations/impl/feeds_operations_impl.py

@@ -53,6 +53,10 @@ def detect_changes(
         """
         # Normalize the feed and the update request and compare them
         copy_feed = UpdateRequestGtfsFeedImpl.from_orm(feed)
+        # Temporary solution to update the operational status
+        copy_feed.operational_status_action = (
+            update_request_gtfs_feed.operational_status_action
+        )
         diff = DeepDiff(
             copy_feed.model_dump(),
             update_request_gtfs_feed.model_dump(),
@@ -89,7 +93,10 @@ async def update_gtfs_feed(
                 session, update_request_gtfs_feed.id, DataType.GTFS.name
             )
             if feed is None:
-                raise HTTPException(status_code=400, detail=f"Feed ID not found: {id}")
+                raise HTTPException(
+                    status_code=400,
+                    detail=f"Feed ID not found: {update_request_gtfs_feed.id}",
+                )
 
             logging.info(
                 f"Feed ID: {id} attempting to update with the following request: {update_request_gtfs_feed}"
@@ -104,9 +111,9 @@ async def update_gtfs_feed(
                 )
                 # This is a temporary solution as the operational_status is not visible in the diff
                 feed.operational_status = (
-                    "wip"
-                    if update_request_gtfs_feed.operational_status_action == "wip"
-                    else ""
+                    feed.operational_status
+                    if update_request_gtfs_feed.operational_status_action == "no_change"
+                    else update_request_gtfs_feed.operational_status_action
                 )
                 session.add(feed)
                 session.commit()
@@ -119,6 +126,8 @@ async def update_gtfs_feed(
                 return Response(status_code=204)
         except Exception as e:
             logging.error(f"Failed to update feed ID: {id}. Error: {e}")
+            if isinstance(e, HTTPException):
+                raise e
             raise HTTPException(status_code=500, detail=f"Internal server error: {e}")
         finally:
             if session:

functions-python/operations_api/tests/__init__.py

@@ -0,0 +1,7 @@
+import sys
+
+sys.path.append("..")
+
+import os
+
+print(os.getcwd())

functions-python/operations_api/tests/conftest.py

@@ -0,0 +1,81 @@
+#
+#   MobilityData 2023
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+from database_gen.sqlacodegen_models import Gtfsfeed
+from test_utils.database_utils import clean_testing_db, get_testing_session
+
+feed_mdb_40 = Gtfsfeed(
+    id="mdb-40",
+    data_type="gtfs",
+    feed_name="London Transit Commission",
+    note="note",
+    producer_url="producer_url",
+    authentication_type="1",
+    authentication_info_url="authentication_info_url",
+    api_key_parameter_name="api_key_parameter_name",
+    license_url="license_url",
+    stable_id="mdb-40",
+    status="active",
+    feed_contact_email="feed_contact_email",
+    provider="provider",
+)
+
+
+def populate_database():
+    """
+    Populates the database with fake data with the following distribution:
+    - 1 GTFS feeds
+        - 5 active
+        - 5 inactive
+    - 5 GTFS Realtime feeds
+    - 9 GTFS datasets
+        - 3 active in active feeds
+        - 6 active in inactive feeds
+    """
+    session = get_testing_session()
+
+    session.add(feed_mdb_40)
+    session.commit()
+
+
+def pytest_configure(config):
+    """
+    Allows plugins and conftest files to perform initial configuration.
+    This hook is called for every plugin and initial conftest
+    file after command line options have been parsed.
+    """
+
+
+def pytest_sessionstart(session):
+    """
+    Called after the Session object has been created and
+    before performing collection and entering the run test loop.
+    """
+    clean_testing_db()
+    populate_database()
+
+
+def pytest_sessionfinish(session, exitstatus):
+    """
+    Called after whole test run finished, right before
+    returning the exit status to the system.
+    """
+    clean_testing_db()
+
+
+def pytest_unconfigure(config):
+    """
+    called before test process is exited.
+    """

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

@@ -0,0 +1,112 @@
+import os
+from unittest import mock
+
+import pytest
+from fastapi import HTTPException
+from starlette.responses import Response
+
+from database_gen.sqlacodegen_models import Gtfsfeed
+from feeds_operations.impl.feeds_operations_impl import OperationsApiImpl
+from feeds_operations_gen.models.authentication_type import AuthenticationType
+from feeds_operations_gen.models.feed_status import FeedStatus
+from feeds_operations_gen.models.source_info import SourceInfo
+from feeds_operations_gen.models.update_request_gtfs_feed import UpdateRequestGtfsFeed
+from operations_api.tests.conftest import feed_mdb_40
+from test_utils.database_utils import get_testing_session, default_db_url
+
+
+@pytest.fixture
+def update_request_gtfs_feed():
+    return UpdateRequestGtfsFeed(
+        id=feed_mdb_40.id,
+        status=FeedStatus(feed_mdb_40.status.lower()),
+        external_ids=[],
+        provider=feed_mdb_40.provider,
+        feed_name=feed_mdb_40.feed_name,
+        note=feed_mdb_40.note,
+        feed_contact_email=feed_mdb_40.feed_contact_email,
+        source_info=SourceInfo(
+            producer_url=feed_mdb_40.producer_url,
+            authentication_type=AuthenticationType(
+                int(feed_mdb_40.authentication_type)
+            ),
+            authentication_info_url=feed_mdb_40.authentication_info_url,
+            api_key_parameter_name=feed_mdb_40.api_key_parameter_name,
+            license_url=feed_mdb_40.license_url,
+        ),
+        redirects=[],
+        operational_status_action="no_change",
+    )
+
+
+@mock.patch.dict(
+    os.environ,
+    {
+        "FEEDS_DATABASE_URL": default_db_url,
+    },
+)
+@pytest.mark.asyncio
+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
+
+
+@mock.patch.dict(
+    os.environ,
+    {
+        "FEEDS_DATABASE_URL": default_db_url,
+    },
+)
+@pytest.mark.asyncio
+async def test_update_gtfs_feed_field_change(update_request_gtfs_feed):
+    update_request_gtfs_feed.feed_name = "New feed name"
+    with get_testing_session() as session:
+        api = OperationsApiImpl()
+        response: Response = await api.update_gtfs_feed(update_request_gtfs_feed)
+        assert response.status_code == 200
+
+        db_feed = (
+            session.query(Gtfsfeed)
+            .filter(Gtfsfeed.stable_id == feed_mdb_40.stable_id)
+            .one()
+        )
+        assert db_feed.feed_name == "New feed name"
+
+
+@mock.patch.dict(
+    os.environ,
+    {
+        "FEEDS_DATABASE_URL": default_db_url,
+    },
+)
+@pytest.mark.asyncio
+async def test_update_gtfs_feed_set_wip(update_request_gtfs_feed):
+    update_request_gtfs_feed.operational_status_action = "wip"
+    with get_testing_session() as session:
+        api = OperationsApiImpl()
+        response: Response = await api.update_gtfs_feed(update_request_gtfs_feed)
+        assert response.status_code == 200
+
+        db_feed = (
+            session.query(Gtfsfeed)
+            .filter(Gtfsfeed.stable_id == feed_mdb_40.stable_id)
+            .one()
+        )
+        assert db_feed.operational_status == "wip"
+
+
+@mock.patch.dict(
+    os.environ,
+    {
+        "FEEDS_DATABASE_URL": default_db_url,
+    },
+)
+@pytest.mark.asyncio
+async def test_update_gtfs_feed_invalid_feed(update_request_gtfs_feed):
+    update_request_gtfs_feed.id = "invalid"
+    api = OperationsApiImpl()
+    with pytest.raises(HTTPException) as exc_info:
+        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"