From 97ce710ceb87e4a1fc62454b6e1828567245870b Mon Sep 17 00:00:00 2001 From: zhiren Date: Tue, 9 Apr 2024 11:22:27 -0400 Subject: [PATCH 1/4] use keyword and prefix to config the path under project folder or name folder --- app/models/item.py | 2 +- .../file_metadata/file_metadata_client.py | 13 +++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/app/models/item.py b/app/models/item.py index 569bc066..c670e293 100644 --- a/app/models/item.py +++ b/app/models/item.py @@ -32,7 +32,7 @@ def get_prefix_by_type(self) -> str: """Get the prefix for the folder type.""" prefix = { - self.NAMEFOLDER: 'users/', + self.NAMEFOLDER: '', self.SHAREDFOLDER: 'shared/', } diff --git a/app/services/file_manager/file_metadata/file_metadata_client.py b/app/services/file_manager/file_metadata/file_metadata_client.py index ad3833a3..3f64feb7 100644 --- a/app/services/file_manager/file_metadata/file_metadata_client.py +++ b/app/services/file_manager/file_metadata/file_metadata_client.py @@ -19,6 +19,7 @@ import app.services.logger_services.log_functions as logger import app.services.output_manager.message_handler as message_handler +from app.models.item import ItemType from app.services.output_manager.error_handler import ECustomizedError from app.services.output_manager.error_handler import customized_error_msg from app.utils.aggregated import get_attribute_template_by_id @@ -109,14 +110,14 @@ def download_file_metadata(self) -> List[Dict[str, Any]]: """ project_code, object_path = self.file_path.split('/', 1) - item_res = search_item(project_code, self.zone, object_path) + root_folder, object_path = object_path.split('/', 1) + # double check if the file is in shared folder - if item_res.get('code') == 404: - item_res = search_item(project_code, self.zone, f'shared/{object_path}') - if item_res.get('code') == 404: - logger.error(f'Cannot find item {self.file_path} at {self.zone}.') - exit(1) + root_type = ItemType.get_type_from_keyword(root_folder) + object_path = join(root_type.get_prefix_by_type(), object_path) + item_res = search_item(project_code, self.zone, object_path) + # filter out item metadata item_res = item_res.get('result', {}) extra_info = item_res.pop('extended', {}).get('extra') tags = extra_info.get('tags', []) From 5bf2418b3e53ab9f30f93fb8a67113ec6d7b7ea1 Mon Sep 17 00:00:00 2001 From: zhiren Date: Tue, 9 Apr 2024 11:44:27 -0400 Subject: [PATCH 2/4] fixup test cases --- app/models/item.py | 2 +- .../file_metadata/file_metadata_client.py | 3 + .../test_file_metadata_client.py | 109 ++++++++---------- 3 files changed, 49 insertions(+), 65 deletions(-) diff --git a/app/models/item.py b/app/models/item.py index c670e293..569bc066 100644 --- a/app/models/item.py +++ b/app/models/item.py @@ -32,7 +32,7 @@ def get_prefix_by_type(self) -> str: """Get the prefix for the folder type.""" prefix = { - self.NAMEFOLDER: '', + self.NAMEFOLDER: 'users/', self.SHAREDFOLDER: 'shared/', } diff --git a/app/services/file_manager/file_metadata/file_metadata_client.py b/app/services/file_manager/file_metadata/file_metadata_client.py index 3f64feb7..b53ce27d 100644 --- a/app/services/file_manager/file_metadata/file_metadata_client.py +++ b/app/services/file_manager/file_metadata/file_metadata_client.py @@ -116,6 +116,9 @@ def download_file_metadata(self) -> List[Dict[str, Any]]: root_type = ItemType.get_type_from_keyword(root_folder) object_path = join(root_type.get_prefix_by_type(), object_path) item_res = search_item(project_code, self.zone, object_path) + if item_res.get('code') == 404: + logger.error(f'Cannot find item {self.file_path} at {self.zone}.') + exit(1) # filter out item metadata item_res = item_res.get('result', {}) diff --git a/tests/app/services/file_manager/file_metadata/test_file_metadata_client.py b/tests/app/services/file_manager/file_metadata/test_file_metadata_client.py index dafeeaac..05b72110 100644 --- a/tests/app/services/file_manager/file_metadata/test_file_metadata_client.py +++ b/tests/app/services/file_manager/file_metadata/test_file_metadata_client.py @@ -2,19 +2,30 @@ # # Contact Indoc Systems for any questions regarding the use of this source code. +import pytest + from app.configs.app_config import AppConfig +from app.models.item import ItemType from app.services.file_manager.file_metadata.file_metadata_client import FileMetaClient from tests.conftest import decoded_token -def test_file_metadata_client_get_detail_success(mocker, httpx_mock): +@pytest.mark.parametrize( + 'root_folder', + [ItemType.NAMEFOLDER, ItemType.SHAREDFOLDER], +) +def test_file_metadata_client_get_detail_success(mocker, httpx_mock, root_folder: ItemType): + file_name = 'test_file.txt' + project_code = 'project_code' item_info = { 'id': 'test', 'parent_id': 'test_parent', - 'parent_path': '', - 'name': 'admin', + 'parent_path': root_folder.get_prefix_by_type(), + 'name': file_name, 'zone': 0, 'status': 'ACTIVE', + 'container_code': project_code, + 'container_type': 'project', } tags = ['test'] attri_template_uid = 'template_uid' @@ -41,9 +52,11 @@ def test_file_metadata_client_get_detail_success(mocker, httpx_mock): return_value=None, ) - file_meta_client = FileMetaClient('zone', 'project_code/object_path', 'general', 'attr', 'tag') - assert file_meta_client.project_code == 'project_code' - assert file_meta_client.object_path == 'object_path' + file_meta_client = FileMetaClient( + 'zone', f'{project_code}/{root_folder.get_prefix_by_type()}/{file_name}', 'general', 'attr', 'tag' + ) + assert file_meta_client.project_code == project_code + assert file_meta_client.object_path == f'{root_folder.get_prefix_by_type()}/{file_name}' item_info, res_attributes, tags = file_meta_client.download_file_metadata() assert item_info == item_info @@ -51,14 +64,22 @@ def test_file_metadata_client_get_detail_success(mocker, httpx_mock): assert tags == tags -def test_file_metadata_client_get_detail_success_with_no_tag_attributes(mocker, httpx_mock): +@pytest.mark.parametrize( + 'root_folder', + [ItemType.NAMEFOLDER, ItemType.SHAREDFOLDER], +) +def test_file_metadata_client_get_detail_success_with_no_tag_attributes(mocker, root_folder: ItemType): + file_name = 'test_file.txt' + project_code = 'project_code' item_info = { 'id': 'test', 'parent_id': 'test_parent', - 'parent_path': '', - 'name': 'admin', + 'parent_path': root_folder.get_prefix_by_type(), + 'name': file_name, 'zone': 0, 'status': 'ACTIVE', + 'container_code': project_code, + 'container_type': 'project', } mocker.patch( @@ -76,9 +97,11 @@ def test_file_metadata_client_get_detail_success_with_no_tag_attributes(mocker, return_value=None, ) - file_meta_client = FileMetaClient('zone', 'project_code/object_path', 'general', 'attr', 'tag') - assert file_meta_client.project_code == 'project_code' - assert file_meta_client.object_path == 'object_path' + file_meta_client = FileMetaClient( + 'zone', f'{project_code}/{root_folder.get_prefix_by_type()}/{file_name}', 'general', 'attr', 'tag' + ) + assert file_meta_client.project_code == project_code + assert file_meta_client.object_path == f'{root_folder.get_prefix_by_type()}/{file_name}' item_info, res_attributes, tags = file_meta_client.download_file_metadata() assert item_info == item_info @@ -86,20 +109,11 @@ def test_file_metadata_client_get_detail_success_with_no_tag_attributes(mocker, assert tags == tags -def test_metadata_download_from_project_folder(mocker, httpx_mock): - item_info = { - 'id': 'test', - 'parent_id': 'test_parent', - 'parent_path': 'shared/path', - 'name': 'admin', - 'zone': 0, - 'status': 'ACTIVE', - } - tags = ['test'] - attri_template_uid = 'template_uid' - attri_template_name = 'template_name' - attributes = {attri_template_uid: {'attr_1': 'value'}} - +@pytest.mark.parametrize( + 'root_folder', + [ItemType.NAMEFOLDER, ItemType.SHAREDFOLDER], +) +def test_metadata_download_fail_when_file_doesnot_exist(mocker, capfd, root_folder: ItemType): mocker.patch( 'app.services.user_authentication.token_manager.SrvTokenManager.decode_access_token', return_value=decoded_token(), @@ -107,53 +121,20 @@ def test_metadata_download_from_project_folder(mocker, httpx_mock): search_mock = mocker.patch( 'app.services.file_manager.file_metadata.file_metadata_client.search_item', - ) - search_mock.side_effect = [ - {'result': {}, 'code': 404}, - {'result': {**item_info, 'extended': {'extra': {'tags': tags, 'attributes': attributes}}}}, - ] - httpx_mock.add_response( - url=AppConfig.Connections.url_portal + f'/v1/data/manifest/{attri_template_uid}', - method='GET', - json={'result': {'id': attri_template_uid, 'name': attri_template_name}}, + return_value={'result': {}, 'code': 404}, ) - mocker.patch( - 'app.services.file_manager.file_metadata.file_metadata_client.FileMetaClient.save_file_metadata', - return_value=None, + file_meta_client = FileMetaClient( + 'zone', f'project_code/{root_folder.get_prefix_by_type()}/file_name', 'general', 'attr', 'tag' ) - file_meta_client = FileMetaClient('zone', 'project_code/object_path', 'general', 'attr', 'tag') - assert file_meta_client.project_code == 'project_code' - assert file_meta_client.object_path == 'object_path' - - item_info, res_attributes, tags = file_meta_client.download_file_metadata() - assert item_info == item_info - assert res_attributes == {attri_template_name: attributes.get(attri_template_uid)} - assert tags == tags - assert search_mock.call_count == 2 - - -def test_metadata_download_fail_when_file_doesnot_exist(mocker, capfd): - mocker.patch( - 'app.services.user_authentication.token_manager.SrvTokenManager.decode_access_token', - return_value=decoded_token(), - ) - - search_mock = mocker.patch( - 'app.services.file_manager.file_metadata.file_metadata_client.search_item', - ) - search_mock.side_effect = [{'result': {}, 'code': 404}, {'result': {}, 'code': 404}] - - file_meta_client = FileMetaClient('zone', 'project_code/object_path', 'general', 'attr', 'tag') - try: file_meta_client.download_file_metadata() except SystemExit: - assert search_mock.call_count == 2 + assert search_mock.call_count == 1 out, _ = capfd.readouterr() - expect = 'Cannot find item project_code/object_path at zone.\n' + expect = f'Cannot find item project_code/{root_folder.get_prefix_by_type()}/file_name at zone.\n' assert out == expect else: AssertionError('SystemExit not raised') From 98b73bc437dfe02a362323d46c66b7455126f132 Mon Sep 17 00:00:00 2001 From: zhiren Date: Thu, 25 Apr 2024 15:57:32 -0400 Subject: [PATCH 3/4] remove old comments --- app/services/file_manager/file_metadata/file_metadata_client.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/app/services/file_manager/file_metadata/file_metadata_client.py b/app/services/file_manager/file_metadata/file_metadata_client.py index b53ce27d..fad9cc02 100644 --- a/app/services/file_manager/file_metadata/file_metadata_client.py +++ b/app/services/file_manager/file_metadata/file_metadata_client.py @@ -111,8 +111,6 @@ def download_file_metadata(self) -> List[Dict[str, Any]]: project_code, object_path = self.file_path.split('/', 1) root_folder, object_path = object_path.split('/', 1) - - # double check if the file is in shared folder root_type = ItemType.get_type_from_keyword(root_folder) object_path = join(root_type.get_prefix_by_type(), object_path) item_res = search_item(project_code, self.zone, object_path) From 9b74824ca7b6a5403f18ca6bbf0063adeae7d6f1 Mon Sep 17 00:00:00 2001 From: zhiren Date: Thu, 25 Apr 2024 15:59:02 -0400 Subject: [PATCH 4/4] remove response is used before assignment --- app/services/project_manager/project.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/services/project_manager/project.py b/app/services/project_manager/project.py index ec98c503..ef832bc0 100644 --- a/app/services/project_manager/project.py +++ b/app/services/project_manager/project.py @@ -48,4 +48,4 @@ def list_projects(self, page, page_size, order, order_by): else: SrvErrorHandler.default_handle(response.content, True) except Exception: - SrvErrorHandler.default_handle(response.content, True) + SrvErrorHandler.default_handle('Error when listing projects', True)