feat: TT-367 V2 - Delete Activity (#330)

* feat: TT-356 Read activities with an azure endpoint

* refactor: TT-356 Solving code smells from Sonarcloud

* refactor: TT-356 change directory from files in source to azure_time_tracker

* test: TT-356 Adding azure endpoint api test

* feat: TT-358 Use serverless to create Azure endpoint

* refactor: TT-358 Changing time tracker backend app skeleton

* refactor: TT-358 Change name to the domain partitioning

* refactor: TT-358 Change route of activities data json file for azure functions

* refactor: TT-358 Change folder structure according to new app skeleton

* feat: TT-358 Add Makefile to install time tracker backend

* refactor: TT-358 Change api test to use create temp activities fixture

* feat: TT-367 creation of the functionality to change the status of an activity

* test: TT-367 unit test for activity service

* test: TT-367 unit test for delete activity use case

* test: TT-367 integration test for activities json dao

* test: TT-367 api test for endpoint to delete an activity

Co-authored-by: Andrés Soto <[email protected]>

Author: JosueOb

V2/serverless.yml

@@ -46,3 +46,13 @@ functions:
             - GET
           route: activities/{id:?}
           authLevel: anonymous
+
+  delete_activity:
+    handler: time_entries/interface.delete_activity
+    events:
+      - http: true
+        x-azure-settings:
+          methods:
+            - DELETE
+          route: activities/{id}
+          authLevel: anonymous

V2/tests/api/azure/activity_azure_endpoints_test.py

@@ -1,4 +1,7 @@
-from time_entries._application._activities import _get_activities as activities
+from time_entries._application._activities import (
+    _get_activities,
+    _delete_activity,
+)
 import azure.functions as func
 import json
 import typing
@@ -8,10 +11,10 @@ def test__activity_azure_endpoint__returns_all_activities(
     create_temp_activities,
 ):
     activities_json, tmp_directory = create_temp_activities
-    activities.JSON_PATH = tmp_directory
+    _get_activities.JSON_PATH = tmp_directory
     req = func.HttpRequest(method='GET', body=None, url='/api/activities')
 
-    response = activities.get_activities(req)
+    response = _get_activities.get_activities(req)
     activities_json_data = response.get_body().decode("utf-8")
 
     assert response.status_code == 200
@@ -22,16 +25,35 @@ def test__activity_azure_endpoint__returns_an_activity__when_activity_matches_it
     create_temp_activities,
 ):
     activities_json, tmp_directory = create_temp_activities
-    activities.JSON_PATH = tmp_directory
+    _get_activities.JSON_PATH = tmp_directory
     req = func.HttpRequest(
         method='GET',
         body=None,
         url='/api/activities/',
         route_params={"id": activities_json[0]['id']},
     )
 
-    response = activities.get_activities(req)
+    response = _get_activities.get_activities(req)
     activitiy_json_data = response.get_body().decode("utf-8")
 
     assert response.status_code == 200
     assert activitiy_json_data == json.dumps(activities_json[0])
+
+
+def test__activity_azure_endpoint__returns_an_activity_with_inactive_status__when_an_activity_matching_its_id_is_found(
+    create_temp_activities,
+):
+    activities_json, tmp_directory = create_temp_activities
+    _delete_activity.JSON_PATH = tmp_directory
+    req = func.HttpRequest(
+        method='DELETE',
+        body=None,
+        url='/api/activities/',
+        route_params={"id": activities_json[0]['id']},
+    )
+
+    response = _delete_activity.delete_activity(req)
+    activity_json_data = json.loads(response.get_body().decode("utf-8"))
+
+    assert response.status_code == 200
+    assert activity_json_data['status'] == 'inactive'

V2/tests/integration/daos/activities_json_dao_test.py

@@ -47,7 +47,7 @@ def test__get_by_id__returns_none__when_no_activity_matches_its_id(
 
     result = activities_json_dao.get_by_id(Faker().uuid4())
 
-    assert result == None
+    assert result is None
 
 
 def test__get_all__returns_a_list_of_activity_dto_objects__when_one_or_more_activities_are_found(
@@ -83,3 +83,37 @@ def test_get_all__returns_an_empty_list__when_doesnt_found_any_activities(
     result = activities_json_dao.get_all()
 
     assert result == activities
+
+
+def test_delete__returns_an_activity_with_inactive_status__when_an_activity_matching_its_id_is_found(
+    create_fake_activities,
+):
+    activities_json_dao = ActivitiesJsonDao(Faker().file_path())
+    activities = create_fake_activities(
+        [
+            {
+                "name": "test_name",
+                "description": "test_description",
+                "tenant_id": "test_tenant_id",
+                "id": "test_id",
+                "deleted": "test_deleted",
+                "status": "test_status",
+            }
+        ]
+    )
+
+    activity_dto = activities.pop()
+    result = activities_json_dao.delete(activity_dto.id)
+
+    assert result.status == 'inactive'
+
+
+def test_delete__returns_none__when_no_activity_matching_its_id_is_found(
+    create_fake_activities,
+):
+    activities_json_dao = ActivitiesJsonDao(Faker().file_path())
+    create_fake_activities([])
+
+    result = activities_json_dao.delete(Faker().uuid4())
+
+    assert result is None

V2/tests/unit/services/activity_service_test.py

@@ -26,3 +26,18 @@ def test__get_by_id__uses_the_activity_dao__to_retrieve_one_activity(mocker):
 
     assert activity_dao.get_by_id.called
     assert expected_activity == actual_activity
+
+
+def test__delete_activity__uses_the_activity_dao__to_change_activity_status(
+    mocker,
+):
+    expected_activity = mocker.Mock()
+    activity_dao = mocker.Mock(
+        delete=mocker.Mock(return_value=expected_activity)
+    )
+
+    activity_service = ActivityService(activity_dao)
+    deleted_activity = activity_service.delete(Faker().uuid4())
+
+    assert activity_dao.delete.called
+    assert expected_activity == deleted_activity

V2/tests/unit/use_cases/activities_use_case_test.py

@@ -6,7 +6,7 @@
 fake = Faker()
 
 
-def test__get_list_activities_function__uses_the_activities_service__to_retrieve_activities(
+def test__get_list_activities_function__uses_the_activity_service__to_retrieve_activities(
     mocker: MockFixture,
 ):
     expected_activities = mocker.Mock()
@@ -21,7 +21,7 @@ def test__get_list_activities_function__uses_the_activities_service__to_retrieve
     assert expected_activities == actual_activities
 
 
-def test__get_activity_by_id_function__uses_the_activities_service__to_retrieve_activity(
+def test__get_activity_by_id_function__uses_the_activity_service__to_retrieve_activity(
     mocker: MockFixture,
 ):
     expected_activity = mocker.Mock()
@@ -34,3 +34,18 @@ def test__get_activity_by_id_function__uses_the_activities_service__to_retrieve_
 
     assert activity_service.get_by_id.called
     assert expected_activity == actual_activity
+
+
+def test__delete_activity_function__uses_the_activity_service__to_change_activity_status(
+    mocker: MockFixture,
+):
+    expected_activity = mocker.Mock()
+    activity_service = mocker.Mock(
+        delete=mocker.Mock(return_value=expected_activity)
+    )
+
+    activity_use_case = _use_cases.DeleteActivityUseCase(activity_service)
+    deleted_activity = activity_use_case.delete_activity(fake.uuid4())
+
+    assert activity_service.delete.called
+    assert expected_activity == deleted_activity

V2/time_entries/_application/__init__.py

@@ -1 +1,2 @@
 from ._activities import get_activities
+from ._activities import delete_activity

V2/time_entries/_application/_activities/__init__.py

@@ -1 +1,2 @@
 from ._get_activities import get_activities
+from ._delete_activity import delete_activity

V2/time_entries/_application/_activities/_delete_activity.py

@@ -0,0 +1,36 @@
+from time_entries._infrastructure import ActivitiesJsonDao
+from time_entries._domain import ActivityService, _use_cases
+
+import azure.functions as func
+import json
+import logging
+
+JSON_PATH = (
+    'time_entries/_infrastructure/_data_persistence/activities_data.json'
+)
+
+
+def delete_activity(req: func.HttpRequest) -> func.HttpResponse:
+    logging.info(
+        'Python HTTP trigger function processed a request to delete an activity.'
+    )
+    activity_id = req.route_params.get('id')
+    response = _delete(activity_id)
+    status_code = 200 if response != b'Not found' else 404
+
+    return func.HttpResponse(
+        body=response, status_code=status_code, mimetype="application/json"
+    )
+
+
+def _delete(activity_id: str) -> str:
+    activity_use_case = _use_cases.DeleteActivityUseCase(
+        _create_activity_service(JSON_PATH)
+    )
+    activity = activity_use_case.delete_activity(activity_id)
+    return json.dumps(activity.__dict__) if activity else b'Not found'
+
+
+def _create_activity_service(path: str):
+    activity_json = ActivitiesJsonDao(path)
+    return ActivityService(activity_json)

V2/time_entries/_domain/_persistence_contracts/_activities_dao.py

@@ -11,3 +11,7 @@ def get_by_id(self, id: str) -> Activity:
     @abc.abstractmethod
     def get_all(self) -> typing.List[Activity]:
         pass
+
+    @abc.abstractmethod
+    def delete(self, id: str) -> Activity:
+        pass

V2/time_entries/_domain/_services/_activity.py

@@ -11,3 +11,6 @@ def get_by_id(self, activity_id: str) -> Activity:
 
     def get_all(self) -> typing.List[Activity]:
         return self.activities_dao.get_all()
+
+    def delete(self, activity_id: str) -> Activity:
+        return self.activities_dao.delete(activity_id)