refactor: TT-352 improving use_cases, endpoitns and test to get activitivies from JSON file

Author: JosueOb

V2/source/daos/activities_json_dao.py

@@ -4,6 +4,7 @@
 import json
 import typing
 
+
 class ActivitiesJsonDao(ActivitiesDao):
     def __init__(self, json_data_file_path: str):
         self.json_data_file_path = json_data_file_path

V2/source/entry_points/flask_api/__init__.py

@@ -5,6 +5,8 @@
 from . import activities_endpoints
 
 csrf = CSRFProtect()
+
+
 def create_app(test_config=None):
     app = Flask(__name__)
     csrf.init_app(app)
@@ -19,11 +21,10 @@ def create_app(test_config=None):
     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)
+    activities_namespace = Namespace('activities', description='Endpoint for activities')
+    activities_namespace.route('/')(activities_endpoints.Activities)
+    activities_namespace.route('/<string:activity_id>')(activities_endpoints.Activity)
 
+    api.add_namespace(activities_namespace)
 
     return app

V2/source/entry_points/flask_api/activities_endpoints.py

@@ -5,16 +5,12 @@
 
 class Activities(Resource):
     def get(self):
-        activities_dto = use_cases.get_list_activities()
-        activities = [activity_dto.__dict__ for activity_dto in activities_dto]
-        return activities
+        return [activity.__dict__ for activity in use_cases.get_list_activities()]
 
 
 class Activity(Resource):
     def get(self, activity_id: str):
         try:
-            activities_dto = use_cases.get_activity_by_id(activity_id)
-            activity = activities_dto.__dict__
-            return activity
+            return use_cases.get_activity_by_id(activity_id).__dict__
         except AttributeError:
             return {'message': 'Activity not found'}, HTTPStatus.NOT_FOUND

V2/source/use_cases/__init__.py

@@ -1,2 +1,2 @@
 from ._get_activities_use_case import get_list_activities
-from ._get_activity_by_id_use_case import get_activity_by_id
+from ._get_activity_by_id_use_case import get_activity_by_id

V2/source/use_cases/_get_activities_use_case.py

@@ -3,9 +3,9 @@
 from V2.source.dtos.activity import Activity
 import typing
 
+
 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()
+    activity_json = ActivitiesJsonDao('./V2/source/activities_data.json')
+    activities = ActivityService(activity_json)
 
-    return activities_dto
+    return activities.get_all()

V2/source/use_cases/_get_activity_by_id_use_case.py

@@ -2,9 +2,9 @@
 from V2.source.daos.activities_json_dao import ActivitiesJsonDao
 from V2.source.dtos.activity import Activity
 
+
 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)
+    activity_json = ActivitiesJsonDao('./V2/source/activities_data.json')
+    activity = ActivityService(activity_json)
 
-    return activity_dto
+    return activity.get_by_id(id)

V2/tests/entry_points/flask_api/activities_endpoints_test.py

@@ -31,24 +31,31 @@ def client():
         yield client
 
 
-def test_get_all_activities_endpoint(client: FlaskClient, mocker: MockFixture):
+def test__activities_class__uses_the_get_activities_use_case__to_retrieve_activities(client: FlaskClient,
+                                                                                     mocker: MockFixture):
     use_cases.get_list_activities = mocker.Mock(return_value=[])
-    response = client.get("/activities/")
-    assert response.status_code == HTTPStatus.OK
 
+    response = client.get("/activities/")
     json_data = json.loads(response.data)
+
+    assert response.status_code == HTTPStatus.OK
     assert [] == json_data
 
 
-def test_get_activity_by_id_using_a_valid_id(client: FlaskClient, mocker: MockFixture):
+def test__activity_class__returns_an_activity__when_activity_matches_its_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):
+def test__activity_class__returns_an_activity__when_no_activity_matches_its_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

@@ -8,34 +8,20 @@
 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, mocker: MockFixture):
-    activities_dto = activities_json_dao.get_all()
-    activities_expected = use_cases.get_list_activities()
-
-    assert activities_dto == activities_expected
-
+def test__get_list_activities_function__uses_the_activities_service__to_retrieve_activities(mocker: MockFixture):
     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
-
+def test__get_activity_by_id_function__uses_the_activities_service__to_retrieve_activity(mocker: MockFixture):
     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