TT-201 validate the current entry and last entry (#273)

* refactor: TT-201 add fucntion to add update last entry flag in model

* refactor: TT-201 add update_last_entry and get_last_entry in repository, update CosmosDBQueryBuilder with order by condition

* test: TT-201 add test method for get_last_entry

* fix: TT-201 fix import errors and function calls in time_entry_repository

* fix: TT-201 fix return None in orderBy condition

* fix: TT-201 missed and bad arguments and order by params not supported by cosmosdb

* refactor: TT-201 delete unnecessary parameters in query_builder and its tests

* refactor: TT-201 Add tests for update last entry and update TimeEntriesDao

* refactor: TT-201 apply changes

* refactor: TT-201 add type hinting and rename start_date_tmp

Co-authored-by: kelly <[email protected]>

Author: VanessaIniguez

tests/time_tracker_api/api_test.py

@@ -30,16 +30,57 @@ def test_remove_required_constraint():
     from flask_restplus import Namespace
 
     ns = Namespace('todos', description='Namespace for testing')
-    sample_model = ns.model('Todo', {
-        'id': fields.Integer(readonly=True, description='The task unique identifier'),
-        'task': fields.String(required=True, description='The task details'),
-        'done': fields.Boolean(required=False, description='Has it being done or not')
-    })
+    sample_model = ns.model(
+        'Todo',
+        {
+            'id': fields.Integer(
+                readonly=True, description='The task unique identifier'
+            ),
+            'task': fields.String(
+                required=True, description='The task details'
+            ),
+            'done': fields.Boolean(
+                required=False, description='Has it being done or not'
+            ),
+        },
+    )
 
     new_model = remove_required_constraint(sample_model)
 
     assert new_model is not sample_model
 
     for attrib in sample_model:
-        assert new_model[attrib].required is False, "No attribute should be required"
-        assert new_model[attrib] is not sample_model[attrib], "No attribute should be required"
+        assert (
+            new_model[attrib].required is False
+        ), "No attribute should be required"
+        assert (
+            new_model[attrib] is not sample_model[attrib]
+        ), "No attribute should be required"
+
+
+def test_add_update_last_entry_if_overlap():
+    from time_tracker_api.api import add_update_last_entry_if_overlap
+    from flask_restplus import fields
+    from flask_restplus import Namespace
+
+    ns = Namespace('todos', description='Namespace for testing')
+    sample_model = ns.model(
+        'Todo',
+        {
+            'id': fields.Integer(
+                readonly=True, description='The task unique identifier'
+            ),
+            'task': fields.String(
+                required=True, description='The task details'
+            ),
+        },
+    )
+
+    new_model = add_update_last_entry_if_overlap(sample_model)
+
+    assert new_model is not sample_model
+
+    update_last_entry_if_overlap = new_model.get(
+        'update_last_entry_if_overlap'
+    )
+    assert update_last_entry_if_overlap is not None

tests/time_tracker_api/time_entries/time_entries_model_test.py

@@ -310,3 +310,98 @@ def test_find_all_v2(
     time_entry = result[0]
     assert isinstance(time_entry, TimeEntryCosmosDBModel)
     assert time_entry.__dict__ == expected_item
+
+
+@patch(
+    'time_tracker_api.time_entries.time_entries_repository.TimeEntryCosmosDBRepository.find_partition_key_value'
+)
+def test_get_last_entry(
+    find_partition_key_value_mock,
+    event_context: EventContext,
+    time_entry_repository: TimeEntryCosmosDBRepository,
+):
+    expected_item = {
+        'id': 'id',
+        'start_date': '2021-03-22T10:00:00.000Z',
+        'end_date': "2021-03-22T11:00:00.000Z",
+        'description': 'do some testing',
+        'tenant_id': 'tenant_id',
+        'project_id': 'project_id',
+        'activity_id': 'activity_id',
+        'technologies': ['python'],
+    }
+    query_items_mock = Mock(return_value=iter([expected_item]))
+    time_entry_repository.container = Mock()
+    time_entry_repository.container.query_items = query_items_mock
+
+    time_entry = time_entry_repository.get_last_entry('id1', event_context)
+
+    find_partition_key_value_mock.assert_called_once()
+    assert isinstance(time_entry, TimeEntryCosmosDBModel)
+    assert time_entry.__dict__ == expected_item
+
+
+expected_item = {
+    'id': 'id',
+    'owner_id': '1',
+    'start_date': '2021-03-22T10:00:00.000Z',
+    'end_date': "2021-03-22T11:00:00.000Z",
+    'description': 'do some testing',
+    'tenant_id': 'tenant_id',
+    'project_id': 'project_id',
+    'activity_id': 'activity_id',
+    'technologies': ['python'],
+}
+
+running_item = {
+    'id': 'id',
+    'owner_id': '1',
+    'update_last_entry_if_overlap': True,
+    'start_date': '2021-03-22T10:30:00.000Z',
+    'end_date': '2021-03-22T11:30:00.000Z',
+    'description': 'do some testing',
+    'tenant_id': 'tenant_id',
+    'project_id': 'project_id',
+    'activity_id': 'activity_id',
+    'technologies': ['python'],
+}
+
+last_item_update = {
+    'id': 'id',
+    'owner_id': '1',
+    'start_date': '2021-03-22T10:00:00.000Z',
+    'end_date': "2021-03-22T10:30:00.000Z",
+    'description': 'do some testing',
+    'tenant_id': 'tenant_id',
+    'project_id': 'project_id',
+    'activity_id': 'activity_id',
+    'technologies': ['python'],
+}
+
+
+@pytest.mark.parametrize(
+    "expected_item, running_item, last_item_update",
+    [(expected_item, running_item, last_item_update)],
+)
+def test_update_last_entry(
+    event_context: EventContext,
+    time_entry_repository: TimeEntryCosmosDBRepository,
+    expected_item,
+    running_item,
+    last_item_update,
+):
+    query_items_mock = Mock(return_value=iter([expected_item]))
+    time_entry_repository.container = Mock()
+    time_entry_repository.container.query_items = query_items_mock
+
+    partial_update_mock = Mock(return_value=[last_item_update])
+    time_entry_repository.partial_update = partial_update_mock
+
+    time_entry_repository.update_last_entry(
+        running_item.get('owner_id'),
+        running_item.get('start_date'),
+        event_context,
+    )
+
+    partial_update_mock.assert_called_once()
+    query_items_mock.assert_called_once()

tests/time_tracker_api/time_entries/time_entries_namespace_test.py

@@ -881,3 +881,32 @@ def test_paginated_sends_max_count_and_offset_on_call_to_repository(
     _, kwargs = time_entries_dao.repository.find_all.call_args
     assert 'max_count' in kwargs and kwargs['max_count'] is not None
     assert 'offset' in kwargs and kwargs['offset'] is not None
+
+
+def test_update_time_entry_calls_update_last_entry(
+    client: FlaskClient,
+    mocker: MockFixture,
+    valid_header: dict,
+    valid_id: str,
+    time_entries_dao,
+):
+    time_entries_dao.repository.partial_update = Mock(return_value={})
+    time_entries_dao.repository.find = Mock(return_value={})
+    time_entries_dao.check_whether_current_user_owns_item = Mock()
+    time_entries_dao.repository.update_last_entry = Mock(return_value={})
+
+    update_time_entry = valid_time_entry_input.copy()
+    update_time_entry['update_last_entry_if_overlap'] = True
+
+    response = client.put(
+        f'/time-entries/{valid_id}',
+        headers=valid_header,
+        json=update_time_entry,
+        follow_redirects=True,
+    )
+
+    assert HTTPStatus.OK == response.status_code
+    time_entries_dao.repository.partial_update.assert_called_once()
+    time_entries_dao.repository.find.assert_called_once()
+    time_entries_dao.check_whether_current_user_owns_item.assert_called_once()
+    time_entries_dao.repository.update_last_entry.assert_called_once()

tests/utils/query_builder_test.py

@@ -1,5 +1,5 @@
 from unittest.mock import patch
-from utils.query_builder import CosmosDBQueryBuilder
+from utils.query_builder import CosmosDBQueryBuilder, Order
 from utils.repository import remove_white_spaces
 import pytest
 
@@ -41,7 +41,9 @@ def test_add_select_conditions_should_update_select_list(
     ],
 )
 def test_add_sql_in_condition_should_update_where_list(
-    attribute, ids_list, expected_where_condition_list,
+    attribute,
+    ids_list,
+    expected_where_condition_list,
 ):
     query_builder = CosmosDBQueryBuilder().add_sql_in_condition(
         attribute, ids_list
@@ -66,7 +68,9 @@ def test_add_sql_in_condition_should_update_where_list(
     ],
 )
 def test_add_sql_where_equal_condition_should_update_where_params_list(
-    data, expected_where_list, expected_params,
+    data,
+    expected_where_list,
+    expected_params,
 ):
     query_builder = CosmosDBQueryBuilder().add_sql_where_equal_condition(data)
 
@@ -91,7 +95,8 @@ def test_add_sql_where_equal_condition_with_None_should_not_update_lists():
     [(True, ['NOT IS_DEFINED(c.deleted)']), (False, [])],
 )
 def test_add_sql_visibility_condition(
-    visibility_bool, expected_where_list,
+    visibility_bool,
+    expected_where_list,
 ):
     query_builder = CosmosDBQueryBuilder().add_sql_visibility_condition(
         visibility_bool
@@ -102,7 +107,12 @@ def test_add_sql_visibility_condition(
 
 
 @pytest.mark.parametrize(
-    "limit_value,expected_limit", [(1, 1), (10, 10), (None, None),],
+    "limit_value,expected_limit",
+    [
+        (1, 1),
+        (10, 10),
+        (None, None),
+    ],
 )
 def test_add_sql_limit_condition(limit_value, expected_limit):
     query_builder = CosmosDBQueryBuilder().add_sql_limit_condition(limit_value)
@@ -111,10 +121,16 @@ def test_add_sql_limit_condition(limit_value, expected_limit):
 
 
 @pytest.mark.parametrize(
-    "offset_value,expected_offset", [(1, 1), (10, 10), (None, None),],
+    "offset_value,expected_offset",
+    [
+        (1, 1),
+        (10, 10),
+        (None, None),
+    ],
 )
 def test_add_sql_offset_condition(
-    offset_value, expected_offset,
+    offset_value,
+    expected_offset,
 ):
     query_builder = CosmosDBQueryBuilder().add_sql_offset_condition(
         offset_value
@@ -125,10 +141,15 @@ def test_add_sql_offset_condition(
 
 @pytest.mark.parametrize(
     "select_conditions,expected_condition",
-    [([], "*"), (["c.id"], "c.id"), (["c.id", "c.name"], "c.id,c.name"),],
+    [
+        ([], "*"),
+        (["c.id"], "c.id"),
+        (["c.id", "c.name"], "c.id,c.name"),
+    ],
 )
 def test__build_select_return_fields_in_select_list(
-    select_conditions, expected_condition,
+    select_conditions,
+    expected_condition,
 ):
     query_builder = CosmosDBQueryBuilder().add_select_conditions(
         select_conditions
@@ -148,7 +169,8 @@ def test__build_select_return_fields_in_select_list(
     ],
 )
 def test__build_where_should_return_concatenated_conditions(
-    fields, expected_condition,
+    fields,
+    expected_condition,
 ):
     query_builder = CosmosDBQueryBuilder().add_sql_where_equal_condition(
         fields
@@ -164,7 +186,9 @@ def test__build_where_should_return_concatenated_conditions(
     [(1, "OFFSET @offset", [{'name': '@offset', 'value': 1}]), (None, "", [])],
 )
 def test__build_offset(
-    offset, expected_condition, expected_params,
+    offset,
+    expected_condition,
+    expected_params,
 ):
     query_builder = CosmosDBQueryBuilder().add_sql_offset_condition(offset)
 
@@ -179,7 +203,9 @@ def test__build_offset(
     [(1, "LIMIT @limit", [{'name': '@limit', 'value': 1}]), (None, "", [])],
 )
 def test__build_limit(
-    limit, expected_condition, expected_params,
+    limit,
+    expected_condition,
+    expected_params,
 ):
     query_builder = CosmosDBQueryBuilder().add_sql_limit_condition(limit)
 
@@ -235,3 +261,44 @@ def test_build_with_empty_and_None_attributes_return_query_select_all():
     assert query == expected_query
     assert len(query_builder.get_parameters()) == 0
     assert len(query_builder.where_conditions) == 0
+
+
+@pytest.mark.parametrize(
+    "attribute,order,expected_order_by",
+    [
+        ('start_date', Order.DESC, ('start_date', 'DESC')),
+        ('start_date', Order.ASC, ('start_date', 'ASC')),
+    ],
+)
+def test_add_sql_order_by_condition(
+    attribute,
+    order,
+    expected_order_by,
+):
+    query_builder = CosmosDBQueryBuilder().add_sql_order_by_condition(
+        attribute, order
+    )
+
+    assert len(query_builder.order_by) == 2
+    assert query_builder.order_by == expected_order_by
+
+
+@pytest.mark.parametrize(
+    "attribute,order,expected_order_by_condition",
+    [
+        ('start_date', Order.DESC, "ORDER BY c.start_date DESC"),
+        ('start_date', Order.ASC, "ORDER BY c.start_date ASC"),
+    ],
+)
+def test__build_order_by(
+    attribute,
+    order,
+    expected_order_by_condition,
+):
+    query_builder = CosmosDBQueryBuilder().add_sql_order_by_condition(
+        attribute, order
+    )
+
+    orderBy_condition = query_builder._CosmosDBQueryBuilder__build_order_by()
+
+    assert orderBy_condition == expected_order_by_condition

time_tracker_api/api.py

@@ -34,6 +34,19 @@ def remove_required_constraint(model: Model):
     return result
 
 
+def add_update_last_entry_if_overlap(time_entry_model: Model):
+    time_entry_flag = {
+        'update_last_entry_if_overlap': fields.Boolean(
+            title='Update last entry if overlap',
+            required=False,
+            description='Flag that indicates if the last time entry is updated',
+            example=True,
+        )
+    }
+    new_model = time_entry_model.clone('TimeEntryInput', time_entry_flag)
+    return new_model
+
+
 def create_attributes_filter(
     ns: namespace, model: Model, filter_attrib_names: list
 ) -> RequestParser:

time_tracker_api/time_entries/time_entries_dao.py

@@ -225,10 +225,14 @@ def create(self, data: dict):
 
     def update(self, id, data: dict, description=None):
         event_ctx = self.create_event_context("update", description)
-
         time_entry = self.repository.find(id, event_ctx)
         self.check_whether_current_user_owns_item(time_entry)
 
+        if data.get('update_last_entry_if_overlap', None):
+            self.repository.update_last_entry(
+                data.get('owner_id'), data.get('start_date'), event_ctx
+            )
+
         return self.repository.partial_update(
             id,
             data,