test: TT-352 entry_points and use_cases for activities complete testing

Author: JosueOb

V2/source/entry_points/flask_api/__init__.py

@@ -1,15 +1,27 @@
 from flask import Flask
-from flask_restplus import Resource, Api
+from flask_restplus import Namespace, Resource, Api
+from http import HTTPStatus
+
 from . import activities_endpoints
 
-app = Flask(__name__)
-api = Api(
-    app,
-    version='1.0',
-    title='Time Tracker API',
-    description='API for the TimeTracker project',
-)
-
-ns_activities = api.namespace('activities', description='Endpoint for activities')
-ns_activities.route('/')(activities_endpoints.Activities)
-ns_activities.route('/<string:activity_id>')(activities_endpoints.Activity)
+
+def create_app(test_config=None):
+    app = Flask(__name__, instance_relative_config=True)
+
+    api = Api(
+        app,
+        version='1.0',
+        title='Time Tracker API',
+        description='API for the TimeTracker project',
+    )
+
+    if test_config is not None:
+        app.config.from_mapping(test_config)
+
+    ns_activities = Namespace('activities', description='Endpoint for activities')
+    ns_activities.route('/')(activities_endpoints.Activities)
+    ns_activities.route('/<string:activity_id>')(activities_endpoints.Activity)
+
+    api.add_namespace(ns_activities)
+
+    return app

V2/source/use_cases/_get_activities_use_case.py

@@ -1,7 +1,9 @@
 from V2.source.services.activity_service import ActivityService
 from V2.source.daos.activities_json_dao import ActivitiesJsonDao
+from V2.source.dtos.activity import Activity
+import typing
 
-def get_list_activities():
+def get_list_activities() -> typing.List[Activity]:
     activity_json_dao = ActivitiesJsonDao('./V2/source/activities_data.json')
     activity_service = ActivityService(activity_json_dao)
     activities_dto = activity_service.get_all()

V2/source/use_cases/_get_activity_by_id_use_case.py

@@ -1,7 +1,8 @@
 from V2.source.services.activity_service import ActivityService
 from V2.source.daos.activities_json_dao import ActivitiesJsonDao
+from V2.source.dtos.activity import Activity
 
-def get_activity_by_id(id: str):
+def get_activity_by_id(id: str) -> Activity:
     activity_json_dao = ActivitiesJsonDao('./V2/source/activities_data.json')
     activity_service = ActivityService(activity_json_dao)
     activity_dto = activity_service.get_by_id(id)

V2/tests/entry_points/flask_api/activities_endpoints_test.py

@@ -0,0 +1,56 @@
+import json
+
+import pytest
+from http import HTTPStatus
+from pytest_mock import MockFixture
+from flask.testing import FlaskClient
+from faker import Faker
+from werkzeug.exceptions import NotFound
+
+from V2.source.entry_points.flask_api import create_app
+from V2.source import use_cases
+from V2.source.dtos.activity import Activity
+
+fake = Faker()
+
+valid_id = fake.uuid4()
+
+fake_activity = {
+    "name": fake.company(),
+    "description": fake.paragraph(),
+    "tenant_id": fake.uuid4(),
+    "id": valid_id,
+    "deleted": fake.date(),
+    "status": fake.boolean(),
+}
+fake_activity_dto = Activity(**fake_activity)
+
+
+@pytest.fixture
+def client():
+    app = create_app({'TESTING': True})
+    with app.test_client() as client:
+        yield client
+
+
+def test_get_all_activities_endpoint(client: FlaskClient, mocker: MockFixture):
+    use_cases.get_list_activities = mocker.Mock(return_value=[])
+    response = client.get("/activities/")
+    assert response.status_code == HTTPStatus.OK
+
+    json_data = json.loads(response.data)
+    assert [] == json_data
+
+
+def test_get_activity_by_id_using_a_valid_id(client: FlaskClient, mocker: MockFixture):
+    use_cases.get_activity_by_id = mocker.Mock(return_value=fake_activity_dto)
+    response = client.get("/activities/%s" % valid_id)
+    assert response.status_code == HTTPStatus.OK
+    assert fake_activity == json.loads(response.data)
+
+
+def test_get_activity_by_id_using_an_invalid_id(client: FlaskClient, mocker: MockFixture):
+    invalid_id = fake.uuid4()
+    use_cases.get_activity_by_id = mocker.Mock(side_effect=NotFound)
+    response = client.get("/activities/%s" % invalid_id)
+    assert response.status_code == HTTPStatus.NOT_FOUND

V2/tests/use_cases/activities_use_case_test.py

@@ -1,20 +1,42 @@
+import pytest
+from pytest_mock import MockFixture
+from faker import Faker
+
 from V2.source import use_cases
 from V2.source.daos.activities_json_dao import ActivitiesJsonDao
-import pytest
+
+fake = Faker()
+
 
 @pytest.fixture(scope='module')
 def activities_json_dao():
     activities_json_dao = ActivitiesJsonDao('./V2/source/activities_data.json')
     return activities_json_dao
 
-def test_get_activities_use_case(activities_json_dao):
+
+def test_get_activities_use_case(activities_json_dao, mocker: MockFixture):
     activities_dto = activities_json_dao.get_all()
     activities_expected = use_cases.get_list_activities()
 
     assert activities_dto == activities_expected
 
-def test_get_activity_by_id_use_case(activities_json_dao):
+    expected_activities = mocker.Mock()
+    use_cases.get_list_activities = mocker.Mock(return_value=expected_activities)
+    actual_activities = use_cases.get_list_activities()
+
+    assert use_cases.get_list_activities.called
+    assert expected_activities == actual_activities
+
+
+def test_get_activity_by_id_use_case(activities_json_dao, mocker: MockFixture):
     activity_dto = activities_json_dao.get_by_id('94ec92e2-a500-4700-a9f6-e41eb7b5507c')
     activity_expected = use_cases.get_activity_by_id('94ec92e2-a500-4700-a9f6-e41eb7b5507c')
 
-    assert activity_dto == activity_expected
+    assert activity_dto == activity_expected
+
+    expected_activity = mocker.Mock()
+    use_cases.get_activity_by_id = mocker.Mock(return_value=expected_activity)
+    actual_activity = use_cases.get_activity_by_id(fake.uuid4())
+
+    assert use_cases.get_activity_by_id.called
+    assert expected_activity == actual_activity