refactor: TT-181 create method to find all projects with list of customers id (#267)

Author: eduardisrael

tests/conftest.py

@@ -17,6 +17,9 @@
 from time_tracker_api.activities.activities_model import (
     ActivityCosmosDBRepository,
 )
+from time_tracker_api.projects.projects_model import (
+    ProjectCosmosDBRepository,
+)
 
 fake = Faker()
 Faker.seed()
@@ -193,6 +196,17 @@ def time_entry_repository(app: Flask) -> TimeEntryCosmosDBRepository:
     return TimeEntryCosmosDBRepository()
 
 
+@pytest.fixture(scope="module")
+def project_repository(app: Flask) -> ProjectCosmosDBRepository:
+    with app.app_context():
+        from commons.data_access_layer.cosmos_db import init_app, cosmos_helper
+
+        if cosmos_helper is None:
+            init_app(app)
+
+    return ProjectCosmosDBRepository()
+
+
 @pytest.fixture
 def time_entries_dao():
     from time_tracker_api.time_entries.time_entries_namespace import (

tests/time_tracker_api/projects/projects_model_test.py

@@ -0,0 +1,66 @@
+from unittest.mock import Mock, patch
+import pytest
+
+from commons.data_access_layer.database import EventContext
+from time_tracker_api.projects.projects_model import (
+    ProjectCosmosDBRepository,
+    ProjectCosmosDBModel,
+)
+
+
+@pytest.mark.parametrize(
+    "customer_ids_list,expected_result",
+    [
+        (["id1"], "c.customer_id IN ('id1')"),
+        (["id1", "id2"], "c.customer_id IN ('id1', 'id2')"),
+        (["id1", "id2", "id3", "id4"], "c.customer_id IN ('id1', 'id2', 'id3', 'id4')"),
+    ],
+)
+def test_create_sql_in_condition(
+    project_repository: ProjectCosmosDBRepository, 
+    customer_ids_list, 
+    expected_result,
+):
+    result = project_repository.create_sql_customer_id_in_condition(customer_ids_list)
+    assert expected_result == result
+    
+
+@patch(
+    'time_tracker_api.projects.projects_model.ProjectCosmosDBRepository.create_sql_condition_for_visibility'
+)
+@patch(
+    'time_tracker_api.projects.projects_model.ProjectCosmosDBRepository.create_sql_customer_id_in_condition'
+)
+@patch(
+    'time_tracker_api.projects.projects_model.ProjectCosmosDBRepository.find_partition_key_value'
+)
+def test_find_all_with_customer_id_in_list(
+    find_partition_key_value_mock,
+    create_sql_customer_id_in_condition_mock,
+    create_sql_condition_for_visibility_mock,
+    event_context: EventContext,
+    project_repository: ProjectCosmosDBRepository,
+):
+    expected_item = {
+        'customer_id': 'id1',
+        'name': 'testing',
+        'description': 'do some testing',
+        'project_type_id': "id2",
+        'tenant_id': 'tenantid1',
+    }
+
+    query_items_mock = Mock(return_value=[expected_item])
+    project_repository.container = Mock()
+    project_repository.container.query_items = query_items_mock
+
+    result = project_repository.find_all_with_customer_id_in_list(event_context, [])
+
+    create_sql_condition_for_visibility_mock.assert_called_once()
+    create_sql_customer_id_in_condition_mock.assert_called_once()
+    find_partition_key_value_mock.assert_called_once()
+    query_items_mock.assert_called_once()
+
+    assert len(result) == 1
+    project = result[0]
+    assert isinstance(project, ProjectCosmosDBModel)
+    assert project.__dict__ == expected_item

time_tracker_api/projects/projects_model.py

@@ -6,6 +6,9 @@
     CosmosDBRepository,
 )
 from time_tracker_api.database import CRUDDao, APICosmosDBDao
+from typing import List, Callable
+from commons.data_access_layer.database import EventContext
+from utils.repository import convert_list_to_tuple_string
 from time_tracker_api.customers.customers_model import (
     create_dao as customers_create_dao,
 )
@@ -63,6 +66,36 @@ def __init__(self):
             mapper=ProjectCosmosDBModel,
         )
 
+    def create_sql_customer_id_in_condition(self, customer_ids_list):
+        id_values = convert_list_to_tuple_string(customer_ids_list)
+
+        return "c.customer_id IN {value_condition}".format(value_condition=id_values)
+    
+    def find_all_with_customer_id_in_list(
+        self,
+        event_context: EventContext,
+        customer_ids_list: List[str],
+        visible_only=True,
+        mapper: Callable = None,
+    ):  
+        visibility = self.create_sql_condition_for_visibility(visible_only)
+        query_str = """
+            SELECT * FROM c
+            WHERE {condition}
+            {visibility_condition}
+            """.format(
+            condition=self.create_sql_customer_id_in_condition(customer_ids_list),
+            visibility_condition=visibility,
+        )
+        
+        tenant_id_value = self.find_partition_key_value(event_context)
+        result = self.container.query_items(
+            query=query_str,
+            partition_key=tenant_id_value,
+        )
+        function_mapper = self.get_mapper_or_dict(mapper)
+        return list(map(function_mapper, result))
+
 
 class ProjectCosmosDBDao(APICosmosDBDao, ProjectDao):
     def __init__(self, repository):