From ab724101c8405517e23d227efbeeb175285d4d6c Mon Sep 17 00:00:00 2001 From: zhiren Date: Thu, 21 Mar 2024 17:01:50 -0400 Subject: [PATCH 01/15] add [p] prefix for project folder when listing items under project --- app/models/folder.py | 22 -------- app/models/item.py | 55 +++++++++++++++++++ app/services/file_manager/file_list.py | 12 +++- .../file_manager/file_upload/file_upload.py | 4 +- app/utils/aggregated.py | 12 ++-- tests/app/commands/test_file.py | 2 +- .../file_upload/test_file_upload.py | 10 ++-- tests/app/utils/test_aggregated.py | 10 ++-- 8 files changed, 84 insertions(+), 43 deletions(-) delete mode 100644 app/models/folder.py create mode 100644 app/models/item.py diff --git a/app/models/folder.py b/app/models/folder.py deleted file mode 100644 index 180c337c..00000000 --- a/app/models/folder.py +++ /dev/null @@ -1,22 +0,0 @@ -# Copyright (C) 2023-2024 Indoc Systems -# -# Contact Indoc Systems for any questions regarding the use of this source code. - -from enum import Enum - - -class FolderType(str, Enum): - """Available folder types.""" - - NAMEFOLDER = 'namefolder' - PROJECTFOLDER = 'projectfolder' - - def get_prefix(self) -> str: - """Get the prefix for the folder type.""" - - prefix = { - 'namefolder': '', - 'projectfolder': 'shared/', - } - - return prefix.get(self.value) diff --git a/app/models/item.py b/app/models/item.py new file mode 100644 index 00000000..233bca73 --- /dev/null +++ b/app/models/item.py @@ -0,0 +1,55 @@ +# Copyright (C) 2023-2024 Indoc Systems +# +# Contact Indoc Systems for any questions regarding the use of this source code. + +from enum import Enum + + +class FolderPrefix(str, Enum): + """In database, name folders and project folders will prefix with different path. and user will need to key in the + keyword to get the correct path. eg. + + - project folder: + - key in: /projectfolder/ + - path: /shared/ + - name folder: + - key in: // + - path: // + """ + + NAMEFOLDER = 'namefolder' + PROJECTFOLDER = 'projectfolder' + + def get_prefix(self) -> str: + """Get the prefix for the folder type.""" + + prefix = { + 'namefolder': '', + 'projectfolder': 'shared/', + } + + return prefix.get(self.value) + + +class ItemType(str, Enum): + """The class to reflect the type of item in database.""" + + FILE = 'file' + Folder = 'folder' + NAMEFOLDER = 'name_folder' + PROJECTFOLDER = 'project_folder' + + @classmethod + def get_item_type(cls, value): + # Define a mapping for alternative values + alternative_mapping = { + 'namefolder': cls.NAMEFOLDER, + } + # Check if the value is in the alternative mapping + if value in alternative_mapping: + return alternative_mapping[value] + # Fall back to normal lookup by value + for item in cls: + if item.value == value: + return item + return None diff --git a/app/services/file_manager/file_list.py b/app/services/file_manager/file_list.py index 39982cd9..45b00cbc 100644 --- a/app/services/file_manager/file_list.py +++ b/app/services/file_manager/file_list.py @@ -9,6 +9,7 @@ import app.services.logger_services.log_functions as logger from app.configs.app_config import AppConfig from app.configs.user_config import UserConfig +from app.models.item import ItemType from app.models.service_meta_class import MetaService from app.services.output_manager.error_handler import ECustomizedError from app.services.output_manager.error_handler import SrvErrorHandler @@ -59,10 +60,17 @@ def list_files(self, paths, zone, page, page_size): # then format the console output files, folders = '', '' for f in res: - if 'file' == f.get('type'): + item_type = ItemType(f.get('type')) + + if item_type == ItemType.FILE: files = files + f.get('name') + ' ...' - elif f.get('type') in ['folder', 'name_folder', 'project_folder']: + else: + # add [p] in front of the project folder + if item_type == ItemType.PROJECTFOLDER: + f['name'] = f'[p]{f.get("name")}' + folders = folders + f"\033[34m{f.get('name')}\033[0m ..." + f_string = folders + files return f_string diff --git a/app/services/file_manager/file_upload/file_upload.py b/app/services/file_manager/file_upload/file_upload.py index 4dda080b..9f5e335f 100644 --- a/app/services/file_manager/file_upload/file_upload.py +++ b/app/services/file_manager/file_upload/file_upload.py @@ -18,7 +18,7 @@ import app.services.logger_services.log_functions as logger import app.services.output_manager.message_handler as mhandler from app.configs.app_config import AppConfig -from app.models.folder import FolderType +from app.models.item import FolderPrefix from app.services.file_manager.file_upload.models import FileObject from app.services.file_manager.file_upload.models import ItemStatus from app.services.file_manager.file_upload.models import UploadType @@ -44,7 +44,7 @@ def compress_folder_to_zip(path): def assemble_path( - f: str, target_folder: str, project_code: str, folder_type: FolderType, zone: str + f: str, target_folder: str, project_code: str, folder_type: FolderPrefix, zone: str ) -> Tuple[str, Dict, bool, str]: ''' Summary: diff --git a/app/utils/aggregated.py b/app/utils/aggregated.py index 662db673..e18c21eb 100644 --- a/app/utils/aggregated.py +++ b/app/utils/aggregated.py @@ -17,7 +17,7 @@ from app.configs.app_config import AppConfig from app.configs.config import ConfigClass from app.configs.user_config import UserConfig -from app.models.folder import FolderType +from app.models.item import FolderPrefix from app.services.output_manager.error_handler import ECustomizedError from app.services.output_manager.error_handler import SrvErrorHandler from app.services.user_authentication.decorator import require_valid_token @@ -166,7 +166,7 @@ def get_file_in_folder(path): return files_list -def identify_target_folder(project_path: str) -> Tuple[str, FolderType, str]: +def identify_target_folder(project_path: str) -> Tuple[str, FolderPrefix, str]: ''' Summary: the function will validate if input folder path doesn't @@ -187,14 +187,14 @@ def identify_target_folder(project_path: str) -> Tuple[str, FolderType, str]: # check folder type if is project folder or name folder # there will be a extra string for project folder between project code and folder name if len(temp_paths) == 2: - folder_type = FolderType.NAMEFOLDER + folder_type = FolderPrefix.NAMEFOLDER folder_name = temp_paths[1] elif len(temp_paths) >= 3: - if temp_paths[1] == FolderType.PROJECTFOLDER.value: - folder_type = FolderType.PROJECTFOLDER + if temp_paths[1] == FolderPrefix.PROJECTFOLDER.value: + folder_type = FolderPrefix.PROJECTFOLDER folder_name = temp_paths[2] else: - folder_type = FolderType.NAMEFOLDER + folder_type = FolderPrefix.NAMEFOLDER folder_name = os.path.join(temp_paths[1], temp_paths[2]) else: SrvErrorHandler.customized_handle(ECustomizedError.INVALID_NAMEFOLDER, True) diff --git a/tests/app/commands/test_file.py b/tests/app/commands/test_file.py index 3abe2cab..2492102c 100644 --- a/tests/app/commands/test_file.py +++ b/tests/app/commands/test_file.py @@ -193,7 +193,7 @@ def test_file_list_with_pagination_with_name_project_folder(requests_mock, mocke questionary.select.return_value.ask.return_value = 'exit' result = cli_runner.invoke(file_list, ['testproject/admin', '-z', 'greenroom']) outputs = result.output.split('\n') - assert outputs[0] == 'folder1 name_folder1 project_folder1 ' + assert outputs[0] == 'folder1 name_folder1 [p]project_folder1 ' def test_empty_file_list_with_pagination(requests_mock, mocker, cli_runner): diff --git a/tests/app/services/file_manager/file_upload/test_file_upload.py b/tests/app/services/file_manager/file_upload/test_file_upload.py index b4a9ffb2..655f823b 100644 --- a/tests/app/services/file_manager/file_upload/test_file_upload.py +++ b/tests/app/services/file_manager/file_upload/test_file_upload.py @@ -3,7 +3,7 @@ # Contact Indoc Systems for any questions regarding the use of this source code. from app.configs.app_config import AppConfig -from app.models.folder import FolderType +from app.models.item import FolderPrefix from app.services.file_manager.file_upload.file_upload import assemble_path from app.services.file_manager.file_upload.file_upload import resume_upload from app.services.file_manager.file_upload.file_upload import simple_upload @@ -34,7 +34,7 @@ def test_assemble_path_at_name_folder(mocker): ) current_file_path, parent_folder, create_folder_flag, _ = assemble_path( - local_file_path, target_folder, project_code, FolderType.NAMEFOLDER, zone + local_file_path, target_folder, project_code, FolderPrefix.NAMEFOLDER, zone ) assert current_file_path == 'admin/file.txt' assert parent_folder.get('name') == 'admin' @@ -73,7 +73,7 @@ def test_assemble_path_at_exsting_folder(mocker): mocker.patch('app.services.file_manager.file_upload.file_upload.search_item', side_effect=node_list) current_file_path, parent_folder, create_folder_flag, _ = assemble_path( - local_file_path, target_folder, project_code, FolderType.NAMEFOLDER, zone + local_file_path, target_folder, project_code, FolderPrefix.NAMEFOLDER, zone ) assert current_file_path == 'admin/test_folder_exist/file.txt' assert parent_folder.get('name') == 'test_folder_exist' @@ -104,7 +104,7 @@ def test_assemble_path_at_non_existing_folder(mocker): mocker.patch('app.services.file_manager.file_upload.file_upload.click.confirm', return_value=None) current_file_path, parent_folder, create_folder_flag, _ = assemble_path( - local_file_path, target_folder, project_code, FolderType.NAMEFOLDER, zone + local_file_path, target_folder, project_code, FolderPrefix.NAMEFOLDER, zone ) assert current_file_path == 'admin/test_folder_not_exist' assert parent_folder.get('name') == 'admin' @@ -132,7 +132,7 @@ def test_assemble_path_at_project_folder(mocker): ) current_file_path, parent_folder, create_folder_flag, target_folder = assemble_path( - local_file_path, target_folder, project_code, FolderType.PROJECTFOLDER, zone + local_file_path, target_folder, project_code, FolderPrefix.PROJECTFOLDER, zone ) assert current_file_path == 'shared/project_folder/file.txt' assert parent_folder.get('name') == 'project_folder' diff --git a/tests/app/utils/test_aggregated.py b/tests/app/utils/test_aggregated.py index 88194ca2..d6912e00 100644 --- a/tests/app/utils/test_aggregated.py +++ b/tests/app/utils/test_aggregated.py @@ -5,7 +5,7 @@ import pytest from app.configs.app_config import AppConfig -from app.models.folder import FolderType +from app.models.item import FolderPrefix from app.utils.aggregated import check_item_duplication from app.utils.aggregated import identify_target_folder from app.utils.aggregated import search_item @@ -136,10 +136,10 @@ def test_validate_folder_name(folder_name): @pytest.mark.parametrize( 'input_path,expected_result', [ - ('project_code/username', ('project_code', FolderType.NAMEFOLDER, 'username')), - ('project_code/username/folder1', ('project_code', FolderType.NAMEFOLDER, 'username/folder1')), - ('project_code/projectfolder/folder1', ('project_code', FolderType.PROJECTFOLDER, 'folder1')), - ('project_code/projectfolder/folder1/folder2', ('project_code', FolderType.PROJECTFOLDER, 'folder1/folder2')), + ('project_code/username', ('project_code', FolderPrefix.NAMEFOLDER, 'username')), + ('project_code/username/folder1', ('project_code', FolderPrefix.NAMEFOLDER, 'username/folder1')), + ('project_code/projectfolder/folder1', ('project_code', FolderPrefix.PROJECTFOLDER, 'folder1')), + ('project_code/projectfolder/folder1/folder2', ('project_code', FolderPrefix.PROJECTFOLDER, 'folder1/folder2')), ], ) def test_identify_target_folder_success_with_different_path(mocker, input_path, expected_result): From 777843726688a987678d38d4e3f272c87695de68 Mon Sep 17 00:00:00 2001 From: zhiren Date: Fri, 22 Mar 2024 11:52:58 -0400 Subject: [PATCH 02/15] group itemprefix class with itemtype class --- app/models/item.py | 57 +++++++------------ .../file_manager/file_upload/file_upload.py | 8 +-- app/utils/aggregated.py | 11 ++-- .../file_upload/test_file_upload.py | 11 ++-- tests/app/utils/test_aggregated.py | 10 ++-- 5 files changed, 39 insertions(+), 58 deletions(-) diff --git a/app/models/item.py b/app/models/item.py index 233bca73..2269bc40 100644 --- a/app/models/item.py +++ b/app/models/item.py @@ -5,32 +5,6 @@ from enum import Enum -class FolderPrefix(str, Enum): - """In database, name folders and project folders will prefix with different path. and user will need to key in the - keyword to get the correct path. eg. - - - project folder: - - key in: /projectfolder/ - - path: /shared/ - - name folder: - - key in: // - - path: // - """ - - NAMEFOLDER = 'namefolder' - PROJECTFOLDER = 'projectfolder' - - def get_prefix(self) -> str: - """Get the prefix for the folder type.""" - - prefix = { - 'namefolder': '', - 'projectfolder': 'shared/', - } - - return prefix.get(self.value) - - class ItemType(str, Enum): """The class to reflect the type of item in database.""" @@ -40,16 +14,25 @@ class ItemType(str, Enum): PROJECTFOLDER = 'project_folder' @classmethod - def get_item_type(cls, value): - # Define a mapping for alternative values + def get_type_from_keyword(self, keyword: str): + """The function will return the type of the item based on the keyword. + + - name folder will have keyword 'namefolder' as input + - project folder will not have any keyword + """ + alternative_mapping = { - 'namefolder': cls.NAMEFOLDER, + 'projectfolder': self.PROJECTFOLDER, + } + + return alternative_mapping.get(keyword, self.NAMEFOLDER) + + def get_prefix_by_type(self) -> str: + """Get the prefix for the folder type.""" + + prefix = { + self.NAMEFOLDER: '', + self.PROJECTFOLDER: 'shared/', } - # Check if the value is in the alternative mapping - if value in alternative_mapping: - return alternative_mapping[value] - # Fall back to normal lookup by value - for item in cls: - if item.value == value: - return item - return None + + return prefix.get(self.value, '') diff --git a/app/services/file_manager/file_upload/file_upload.py b/app/services/file_manager/file_upload/file_upload.py index 9f5e335f..952ec259 100644 --- a/app/services/file_manager/file_upload/file_upload.py +++ b/app/services/file_manager/file_upload/file_upload.py @@ -18,7 +18,7 @@ import app.services.logger_services.log_functions as logger import app.services.output_manager.message_handler as mhandler from app.configs.app_config import AppConfig -from app.models.item import FolderPrefix +from app.models.item import ItemType from app.services.file_manager.file_upload.models import FileObject from app.services.file_manager.file_upload.models import ItemStatus from app.services.file_manager.file_upload.models import UploadType @@ -44,7 +44,7 @@ def compress_folder_to_zip(path): def assemble_path( - f: str, target_folder: str, project_code: str, folder_type: FolderPrefix, zone: str + f: str, target_folder: str, project_code: str, folder_type: ItemType, zone: str ) -> Tuple[str, Dict, bool, str]: ''' Summary: @@ -80,8 +80,8 @@ def assemble_path( current_folder_node = target_folder if os.path.isfile(f) else current_file_path create_folder_flag = False # add prefix to folder - current_folder_node = folder_type.get_prefix() + current_folder_node - target_folder = folder_type.get_prefix() + target_folder + current_folder_node = folder_type.get_prefix_by_type() + current_folder_node + target_folder = folder_type.get_prefix_by_type() + target_folder if len(current_file_path.split('/')) > 2: sub_path = target_folder.split('/') diff --git a/app/utils/aggregated.py b/app/utils/aggregated.py index e18c21eb..025c5008 100644 --- a/app/utils/aggregated.py +++ b/app/utils/aggregated.py @@ -17,7 +17,7 @@ from app.configs.app_config import AppConfig from app.configs.config import ConfigClass from app.configs.user_config import UserConfig -from app.models.item import FolderPrefix +from app.models.item import ItemType from app.services.output_manager.error_handler import ECustomizedError from app.services.output_manager.error_handler import SrvErrorHandler from app.services.user_authentication.decorator import require_valid_token @@ -166,7 +166,7 @@ def get_file_in_folder(path): return files_list -def identify_target_folder(project_path: str) -> Tuple[str, FolderPrefix, str]: +def identify_target_folder(project_path: str) -> Tuple[str, ItemType, str]: ''' Summary: the function will validate if input folder path doesn't @@ -187,14 +187,13 @@ def identify_target_folder(project_path: str) -> Tuple[str, FolderPrefix, str]: # check folder type if is project folder or name folder # there will be a extra string for project folder between project code and folder name if len(temp_paths) == 2: - folder_type = FolderPrefix.NAMEFOLDER + folder_type = ItemType.NAMEFOLDER folder_name = temp_paths[1] elif len(temp_paths) >= 3: - if temp_paths[1] == FolderPrefix.PROJECTFOLDER.value: - folder_type = FolderPrefix.PROJECTFOLDER + folder_type = ItemType.get_type_from_keyword(temp_paths[1]) + if folder_type == ItemType.PROJECTFOLDER: folder_name = temp_paths[2] else: - folder_type = FolderPrefix.NAMEFOLDER folder_name = os.path.join(temp_paths[1], temp_paths[2]) else: SrvErrorHandler.customized_handle(ECustomizedError.INVALID_NAMEFOLDER, True) diff --git a/tests/app/services/file_manager/file_upload/test_file_upload.py b/tests/app/services/file_manager/file_upload/test_file_upload.py index 655f823b..5fa26447 100644 --- a/tests/app/services/file_manager/file_upload/test_file_upload.py +++ b/tests/app/services/file_manager/file_upload/test_file_upload.py @@ -3,7 +3,7 @@ # Contact Indoc Systems for any questions regarding the use of this source code. from app.configs.app_config import AppConfig -from app.models.item import FolderPrefix +from app.models.item import ItemType from app.services.file_manager.file_upload.file_upload import assemble_path from app.services.file_manager.file_upload.file_upload import resume_upload from app.services.file_manager.file_upload.file_upload import simple_upload @@ -34,7 +34,7 @@ def test_assemble_path_at_name_folder(mocker): ) current_file_path, parent_folder, create_folder_flag, _ = assemble_path( - local_file_path, target_folder, project_code, FolderPrefix.NAMEFOLDER, zone + local_file_path, target_folder, project_code, ItemType.NAMEFOLDER, zone ) assert current_file_path == 'admin/file.txt' assert parent_folder.get('name') == 'admin' @@ -71,9 +71,8 @@ def test_assemble_path_at_exsting_folder(mocker): ] mocker.patch('app.services.file_manager.file_upload.file_upload.search_item', side_effect=node_list) - current_file_path, parent_folder, create_folder_flag, _ = assemble_path( - local_file_path, target_folder, project_code, FolderPrefix.NAMEFOLDER, zone + local_file_path, target_folder, project_code, ItemType.NAMEFOLDER, zone ) assert current_file_path == 'admin/test_folder_exist/file.txt' assert parent_folder.get('name') == 'test_folder_exist' @@ -104,7 +103,7 @@ def test_assemble_path_at_non_existing_folder(mocker): mocker.patch('app.services.file_manager.file_upload.file_upload.click.confirm', return_value=None) current_file_path, parent_folder, create_folder_flag, _ = assemble_path( - local_file_path, target_folder, project_code, FolderPrefix.NAMEFOLDER, zone + local_file_path, target_folder, project_code, ItemType.NAMEFOLDER, zone ) assert current_file_path == 'admin/test_folder_not_exist' assert parent_folder.get('name') == 'admin' @@ -132,7 +131,7 @@ def test_assemble_path_at_project_folder(mocker): ) current_file_path, parent_folder, create_folder_flag, target_folder = assemble_path( - local_file_path, target_folder, project_code, FolderPrefix.PROJECTFOLDER, zone + local_file_path, target_folder, project_code, ItemType.PROJECTFOLDER, zone ) assert current_file_path == 'shared/project_folder/file.txt' assert parent_folder.get('name') == 'project_folder' diff --git a/tests/app/utils/test_aggregated.py b/tests/app/utils/test_aggregated.py index d6912e00..b81254df 100644 --- a/tests/app/utils/test_aggregated.py +++ b/tests/app/utils/test_aggregated.py @@ -5,7 +5,7 @@ import pytest from app.configs.app_config import AppConfig -from app.models.item import FolderPrefix +from app.models.item import ItemType from app.utils.aggregated import check_item_duplication from app.utils.aggregated import identify_target_folder from app.utils.aggregated import search_item @@ -136,10 +136,10 @@ def test_validate_folder_name(folder_name): @pytest.mark.parametrize( 'input_path,expected_result', [ - ('project_code/username', ('project_code', FolderPrefix.NAMEFOLDER, 'username')), - ('project_code/username/folder1', ('project_code', FolderPrefix.NAMEFOLDER, 'username/folder1')), - ('project_code/projectfolder/folder1', ('project_code', FolderPrefix.PROJECTFOLDER, 'folder1')), - ('project_code/projectfolder/folder1/folder2', ('project_code', FolderPrefix.PROJECTFOLDER, 'folder1/folder2')), + ('project_code/username', ('project_code', ItemType.NAMEFOLDER, 'username')), + ('project_code/username/folder1', ('project_code', ItemType.NAMEFOLDER, 'username/folder1')), + ('project_code/projectfolder/folder1', ('project_code', ItemType.PROJECTFOLDER, 'folder1')), + ('project_code/projectfolder/folder1/folder2', ('project_code', ItemType.PROJECTFOLDER, 'folder1/folder2')), ], ) def test_identify_target_folder_success_with_different_path(mocker, input_path, expected_result): From e86765f65a1180798afce7bf617530eb4fa7559d Mon Sep 17 00:00:00 2001 From: zhiren Date: Fri, 22 Mar 2024 16:50:42 -0400 Subject: [PATCH 03/15] add double quotation when item name contains space --- app/services/file_manager/file_list.py | 3 +++ tests/app/commands/test_file.py | 7 +++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/app/services/file_manager/file_list.py b/app/services/file_manager/file_list.py index 45b00cbc..35338de2 100644 --- a/app/services/file_manager/file_list.py +++ b/app/services/file_manager/file_list.py @@ -61,6 +61,9 @@ def list_files(self, paths, zone, page, page_size): files, folders = '', '' for f in res: item_type = ItemType(f.get('type')) + # if there is space within the nane add double quotation to aviod confusion + if ' ' in f.get('name'): + f['name'] = f'"{f.get("name")}"' if item_type == ItemType.FILE: files = files + f.get('name') + ' ...' diff --git a/tests/app/commands/test_file.py b/tests/app/commands/test_file.py index 2492102c..ab9e64bc 100644 --- a/tests/app/commands/test_file.py +++ b/tests/app/commands/test_file.py @@ -185,7 +185,9 @@ def test_file_list_with_pagination_with_name_project_folder(requests_mock, mocke 'result': [ {'type': 'folder', 'name': 'folder1'}, {'type': 'name_folder', 'name': 'name_folder1'}, - {'type': 'project_folder', 'name': 'project_folder1'}, + {'type': 'project_folder', 'name': 'project folder1'}, + {'type': 'folder', 'name': 'test folder2'}, + {'type': 'project_folder', 'name': 'project folder2'}, ], }, ) @@ -193,7 +195,8 @@ def test_file_list_with_pagination_with_name_project_folder(requests_mock, mocke questionary.select.return_value.ask.return_value = 'exit' result = cli_runner.invoke(file_list, ['testproject/admin', '-z', 'greenroom']) outputs = result.output.split('\n') - assert outputs[0] == 'folder1 name_folder1 [p]project_folder1 ' + assert outputs[0] == 'folder1 name_folder1 [p]"project folder1" ' + assert outputs[1] == '"test folder2" [p]"project folder2" ' def test_empty_file_list_with_pagination(requests_mock, mocker, cli_runner): From 3d76446bb3a24ce665103764bdafe05c8b8f6dba Mon Sep 17 00:00:00 2001 From: zhiren Date: Mon, 1 Apr 2024 16:50:57 -0400 Subject: [PATCH 04/15] change enum type PROJECTFOLDER to SHAREDFOLDER --- app/models/item.py | 6 +++--- app/services/file_manager/file_list.py | 2 +- app/utils/aggregated.py | 2 +- .../services/file_manager/file_upload/test_file_upload.py | 2 +- tests/app/utils/test_aggregated.py | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/app/models/item.py b/app/models/item.py index 2269bc40..a7a91029 100644 --- a/app/models/item.py +++ b/app/models/item.py @@ -11,7 +11,7 @@ class ItemType(str, Enum): FILE = 'file' Folder = 'folder' NAMEFOLDER = 'name_folder' - PROJECTFOLDER = 'project_folder' + SHAREDFOLDER = 'project_folder' @classmethod def get_type_from_keyword(self, keyword: str): @@ -22,7 +22,7 @@ def get_type_from_keyword(self, keyword: str): """ alternative_mapping = { - 'projectfolder': self.PROJECTFOLDER, + 'projectfolder': self.SHAREDFOLDER, } return alternative_mapping.get(keyword, self.NAMEFOLDER) @@ -32,7 +32,7 @@ def get_prefix_by_type(self) -> str: prefix = { self.NAMEFOLDER: '', - self.PROJECTFOLDER: 'shared/', + self.SHAREDFOLDER: 'shared/', } return prefix.get(self.value, '') diff --git a/app/services/file_manager/file_list.py b/app/services/file_manager/file_list.py index 35338de2..2131903a 100644 --- a/app/services/file_manager/file_list.py +++ b/app/services/file_manager/file_list.py @@ -69,7 +69,7 @@ def list_files(self, paths, zone, page, page_size): files = files + f.get('name') + ' ...' else: # add [p] in front of the project folder - if item_type == ItemType.PROJECTFOLDER: + if item_type == ItemType.SHAREDFOLDER: f['name'] = f'[p]{f.get("name")}' folders = folders + f"\033[34m{f.get('name')}\033[0m ..." diff --git a/app/utils/aggregated.py b/app/utils/aggregated.py index 025c5008..e338ae5f 100644 --- a/app/utils/aggregated.py +++ b/app/utils/aggregated.py @@ -191,7 +191,7 @@ def identify_target_folder(project_path: str) -> Tuple[str, ItemType, str]: folder_name = temp_paths[1] elif len(temp_paths) >= 3: folder_type = ItemType.get_type_from_keyword(temp_paths[1]) - if folder_type == ItemType.PROJECTFOLDER: + if folder_type == ItemType.SHAREDFOLDER: folder_name = temp_paths[2] else: folder_name = os.path.join(temp_paths[1], temp_paths[2]) diff --git a/tests/app/services/file_manager/file_upload/test_file_upload.py b/tests/app/services/file_manager/file_upload/test_file_upload.py index 5fa26447..fb385057 100644 --- a/tests/app/services/file_manager/file_upload/test_file_upload.py +++ b/tests/app/services/file_manager/file_upload/test_file_upload.py @@ -131,7 +131,7 @@ def test_assemble_path_at_project_folder(mocker): ) current_file_path, parent_folder, create_folder_flag, target_folder = assemble_path( - local_file_path, target_folder, project_code, ItemType.PROJECTFOLDER, zone + local_file_path, target_folder, project_code, ItemType.SHAREDFOLDER, zone ) assert current_file_path == 'shared/project_folder/file.txt' assert parent_folder.get('name') == 'project_folder' diff --git a/tests/app/utils/test_aggregated.py b/tests/app/utils/test_aggregated.py index b81254df..91454cbb 100644 --- a/tests/app/utils/test_aggregated.py +++ b/tests/app/utils/test_aggregated.py @@ -138,8 +138,8 @@ def test_validate_folder_name(folder_name): [ ('project_code/username', ('project_code', ItemType.NAMEFOLDER, 'username')), ('project_code/username/folder1', ('project_code', ItemType.NAMEFOLDER, 'username/folder1')), - ('project_code/projectfolder/folder1', ('project_code', ItemType.PROJECTFOLDER, 'folder1')), - ('project_code/projectfolder/folder1/folder2', ('project_code', ItemType.PROJECTFOLDER, 'folder1/folder2')), + ('project_code/projectfolder/folder1', ('project_code', ItemType.SHAREDFOLDER, 'folder1')), + ('project_code/projectfolder/folder1/folder2', ('project_code', ItemType.SHAREDFOLDER, 'folder1/folder2')), ], ) def test_identify_target_folder_success_with_different_path(mocker, input_path, expected_result): From 09c4ca3b746fe3939daf2ff014b842dbfcce5bcd Mon Sep 17 00:00:00 2001 From: zhiren Date: Wed, 3 Apr 2024 11:18:55 -0400 Subject: [PATCH 05/15] replace PROJECTFOLDER with SHAREDFOLDER --- app/models/folder.py | 22 ----------- app/models/item.py | 39 +++++++++++++++++++ .../file_manager/file_upload/file_upload.py | 8 ++-- app/utils/aggregated.py | 12 +++--- .../file_upload/test_file_upload.py | 10 ++--- tests/app/utils/test_aggregated.py | 10 ++--- 6 files changed, 59 insertions(+), 42 deletions(-) delete mode 100644 app/models/folder.py create mode 100644 app/models/item.py diff --git a/app/models/folder.py b/app/models/folder.py deleted file mode 100644 index 180c337c..00000000 --- a/app/models/folder.py +++ /dev/null @@ -1,22 +0,0 @@ -# Copyright (C) 2023-2024 Indoc Systems -# -# Contact Indoc Systems for any questions regarding the use of this source code. - -from enum import Enum - - -class FolderType(str, Enum): - """Available folder types.""" - - NAMEFOLDER = 'namefolder' - PROJECTFOLDER = 'projectfolder' - - def get_prefix(self) -> str: - """Get the prefix for the folder type.""" - - prefix = { - 'namefolder': '', - 'projectfolder': 'shared/', - } - - return prefix.get(self.value) diff --git a/app/models/item.py b/app/models/item.py new file mode 100644 index 00000000..569bc066 --- /dev/null +++ b/app/models/item.py @@ -0,0 +1,39 @@ +# Copyright (C) 2023-2024 Indoc Systems +# +# Contact Indoc Systems for any questions regarding the use of this source code. + +from enum import Enum + + +class ItemType(str, Enum): + """The class to reflect the type of item in database.""" + + FILE = 'file' + Folder = 'folder' + NAMEFOLDER = 'name_folder' + SHAREDFOLDER = 'project_folder' + + @classmethod + def get_type_from_keyword(self, keyword: str): + """The function will return the type of the item based on the keyword. + + - name folder will have keyword 'namefolder' as input + - project folder will not have any keyword + """ + + alternative_mapping = { + 'shared': self.SHAREDFOLDER, + 'users': self.NAMEFOLDER, + } + + return alternative_mapping.get(keyword, self.NAMEFOLDER) + + def get_prefix_by_type(self) -> str: + """Get the prefix for the folder type.""" + + prefix = { + self.NAMEFOLDER: 'users/', + self.SHAREDFOLDER: 'shared/', + } + + return prefix.get(self.value, '') diff --git a/app/services/file_manager/file_upload/file_upload.py b/app/services/file_manager/file_upload/file_upload.py index 4dda080b..952ec259 100644 --- a/app/services/file_manager/file_upload/file_upload.py +++ b/app/services/file_manager/file_upload/file_upload.py @@ -18,7 +18,7 @@ import app.services.logger_services.log_functions as logger import app.services.output_manager.message_handler as mhandler from app.configs.app_config import AppConfig -from app.models.folder import FolderType +from app.models.item import ItemType from app.services.file_manager.file_upload.models import FileObject from app.services.file_manager.file_upload.models import ItemStatus from app.services.file_manager.file_upload.models import UploadType @@ -44,7 +44,7 @@ def compress_folder_to_zip(path): def assemble_path( - f: str, target_folder: str, project_code: str, folder_type: FolderType, zone: str + f: str, target_folder: str, project_code: str, folder_type: ItemType, zone: str ) -> Tuple[str, Dict, bool, str]: ''' Summary: @@ -80,8 +80,8 @@ def assemble_path( current_folder_node = target_folder if os.path.isfile(f) else current_file_path create_folder_flag = False # add prefix to folder - current_folder_node = folder_type.get_prefix() + current_folder_node - target_folder = folder_type.get_prefix() + target_folder + current_folder_node = folder_type.get_prefix_by_type() + current_folder_node + target_folder = folder_type.get_prefix_by_type() + target_folder if len(current_file_path.split('/')) > 2: sub_path = target_folder.split('/') diff --git a/app/utils/aggregated.py b/app/utils/aggregated.py index 662db673..af4a0b08 100644 --- a/app/utils/aggregated.py +++ b/app/utils/aggregated.py @@ -17,7 +17,7 @@ from app.configs.app_config import AppConfig from app.configs.config import ConfigClass from app.configs.user_config import UserConfig -from app.models.folder import FolderType +from app.models.item import ItemType from app.services.output_manager.error_handler import ECustomizedError from app.services.output_manager.error_handler import SrvErrorHandler from app.services.user_authentication.decorator import require_valid_token @@ -166,7 +166,7 @@ def get_file_in_folder(path): return files_list -def identify_target_folder(project_path: str) -> Tuple[str, FolderType, str]: +def identify_target_folder(project_path: str) -> Tuple[str, ItemType, str]: ''' Summary: the function will validate if input folder path doesn't @@ -187,14 +187,14 @@ def identify_target_folder(project_path: str) -> Tuple[str, FolderType, str]: # check folder type if is project folder or name folder # there will be a extra string for project folder between project code and folder name if len(temp_paths) == 2: - folder_type = FolderType.NAMEFOLDER + folder_type = ItemType.NAMEFOLDER folder_name = temp_paths[1] elif len(temp_paths) >= 3: - if temp_paths[1] == FolderType.PROJECTFOLDER.value: - folder_type = FolderType.PROJECTFOLDER + if temp_paths[1] == ItemType.SHAREDFOLDER.value: + folder_type = ItemType.SHAREDFOLDER folder_name = temp_paths[2] else: - folder_type = FolderType.NAMEFOLDER + folder_type = ItemType.NAMEFOLDER folder_name = os.path.join(temp_paths[1], temp_paths[2]) else: SrvErrorHandler.customized_handle(ECustomizedError.INVALID_NAMEFOLDER, True) diff --git a/tests/app/services/file_manager/file_upload/test_file_upload.py b/tests/app/services/file_manager/file_upload/test_file_upload.py index b4a9ffb2..4be1b77b 100644 --- a/tests/app/services/file_manager/file_upload/test_file_upload.py +++ b/tests/app/services/file_manager/file_upload/test_file_upload.py @@ -3,7 +3,7 @@ # Contact Indoc Systems for any questions regarding the use of this source code. from app.configs.app_config import AppConfig -from app.models.folder import FolderType +from app.models.item import ItemType from app.services.file_manager.file_upload.file_upload import assemble_path from app.services.file_manager.file_upload.file_upload import resume_upload from app.services.file_manager.file_upload.file_upload import simple_upload @@ -34,7 +34,7 @@ def test_assemble_path_at_name_folder(mocker): ) current_file_path, parent_folder, create_folder_flag, _ = assemble_path( - local_file_path, target_folder, project_code, FolderType.NAMEFOLDER, zone + local_file_path, target_folder, project_code, ItemType.NAMEFOLDER, zone ) assert current_file_path == 'admin/file.txt' assert parent_folder.get('name') == 'admin' @@ -73,7 +73,7 @@ def test_assemble_path_at_exsting_folder(mocker): mocker.patch('app.services.file_manager.file_upload.file_upload.search_item', side_effect=node_list) current_file_path, parent_folder, create_folder_flag, _ = assemble_path( - local_file_path, target_folder, project_code, FolderType.NAMEFOLDER, zone + local_file_path, target_folder, project_code, ItemType.NAMEFOLDER, zone ) assert current_file_path == 'admin/test_folder_exist/file.txt' assert parent_folder.get('name') == 'test_folder_exist' @@ -104,7 +104,7 @@ def test_assemble_path_at_non_existing_folder(mocker): mocker.patch('app.services.file_manager.file_upload.file_upload.click.confirm', return_value=None) current_file_path, parent_folder, create_folder_flag, _ = assemble_path( - local_file_path, target_folder, project_code, FolderType.NAMEFOLDER, zone + local_file_path, target_folder, project_code, ItemType.NAMEFOLDER, zone ) assert current_file_path == 'admin/test_folder_not_exist' assert parent_folder.get('name') == 'admin' @@ -132,7 +132,7 @@ def test_assemble_path_at_project_folder(mocker): ) current_file_path, parent_folder, create_folder_flag, target_folder = assemble_path( - local_file_path, target_folder, project_code, FolderType.PROJECTFOLDER, zone + local_file_path, target_folder, project_code, ItemType.SHAREDFOLDER, zone ) assert current_file_path == 'shared/project_folder/file.txt' assert parent_folder.get('name') == 'project_folder' diff --git a/tests/app/utils/test_aggregated.py b/tests/app/utils/test_aggregated.py index 88194ca2..91454cbb 100644 --- a/tests/app/utils/test_aggregated.py +++ b/tests/app/utils/test_aggregated.py @@ -5,7 +5,7 @@ import pytest from app.configs.app_config import AppConfig -from app.models.folder import FolderType +from app.models.item import ItemType from app.utils.aggregated import check_item_duplication from app.utils.aggregated import identify_target_folder from app.utils.aggregated import search_item @@ -136,10 +136,10 @@ def test_validate_folder_name(folder_name): @pytest.mark.parametrize( 'input_path,expected_result', [ - ('project_code/username', ('project_code', FolderType.NAMEFOLDER, 'username')), - ('project_code/username/folder1', ('project_code', FolderType.NAMEFOLDER, 'username/folder1')), - ('project_code/projectfolder/folder1', ('project_code', FolderType.PROJECTFOLDER, 'folder1')), - ('project_code/projectfolder/folder1/folder2', ('project_code', FolderType.PROJECTFOLDER, 'folder1/folder2')), + ('project_code/username', ('project_code', ItemType.NAMEFOLDER, 'username')), + ('project_code/username/folder1', ('project_code', ItemType.NAMEFOLDER, 'username/folder1')), + ('project_code/projectfolder/folder1', ('project_code', ItemType.SHAREDFOLDER, 'folder1')), + ('project_code/projectfolder/folder1/folder2', ('project_code', ItemType.SHAREDFOLDER, 'folder1/folder2')), ], ) def test_identify_target_folder_success_with_different_path(mocker, input_path, expected_result): From bfadd0f6be2cf85e8c086a6eb14e97574b978646 Mon Sep 17 00:00:00 2001 From: zhiren Date: Wed, 3 Apr 2024 11:40:57 -0400 Subject: [PATCH 06/15] fixup test cases --- app/utils/aggregated.py | 27 ++++++++++-------- tests/app/commands/test_file.py | 11 +++++++- .../file_upload/test_file_upload.py | 28 ++++++++++++++++--- tests/app/utils/test_aggregated.py | 20 ++++++++++--- 4 files changed, 65 insertions(+), 21 deletions(-) diff --git a/app/utils/aggregated.py b/app/utils/aggregated.py index af4a0b08..c975783a 100644 --- a/app/utils/aggregated.py +++ b/app/utils/aggregated.py @@ -173,8 +173,8 @@ def identify_target_folder(project_path: str) -> Tuple[str, ItemType, str]: contain invalid characters and return the project code and target folder Parameters: - project_path: - - for project folder the input folder path (eg. /projectfolder/) - - for name folder the input folder path will be (eg. /) + - for project folder the input folder path (eg. /shared/) + - for name folder the input folder path will be (eg. /users/) Return: - project_code: the project code - folder_type: the folder type @@ -186,16 +186,19 @@ def identify_target_folder(project_path: str) -> Tuple[str, ItemType, str]: # check folder type if is project folder or name folder # there will be a extra string for project folder between project code and folder name - if len(temp_paths) == 2: - folder_type = ItemType.NAMEFOLDER - folder_name = temp_paths[1] - elif len(temp_paths) >= 3: - if temp_paths[1] == ItemType.SHAREDFOLDER.value: - folder_type = ItemType.SHAREDFOLDER - folder_name = temp_paths[2] - else: - folder_type = ItemType.NAMEFOLDER - folder_name = os.path.join(temp_paths[1], temp_paths[2]) + # if len(temp_paths) == 2: + # folder_type = ItemType.NAMEFOLDER + # folder_name = temp_paths[1] + # el + if len(temp_paths) >= 3: + # if temp_paths[1] == ItemType.SHAREDFOLDER.value: + # folder_type = ItemType.SHAREDFOLDER + # folder_name = temp_paths[2] + # else: + # folder_type = ItemType.NAMEFOLDER + # folder_name = os.path.join(temp_paths[1], temp_paths[2]) + folder_type = ItemType.get_type_from_keyword(temp_paths[1]) + folder_name = temp_paths[2] else: SrvErrorHandler.customized_handle(ECustomizedError.INVALID_NAMEFOLDER, True) target_folder = '' diff --git a/tests/app/commands/test_file.py b/tests/app/commands/test_file.py index 3abe2cab..1679c8f7 100644 --- a/tests/app/commands/test_file.py +++ b/tests/app/commands/test_file.py @@ -16,6 +16,7 @@ from app.commands.file import file_move from app.commands.file import file_put from app.commands.file import file_resume +from app.models.item import ItemType from app.services.file_manager.file_metadata.file_metadata_client import FileMetaClient from app.services.file_manager.file_upload.models import FileObject from app.services.output_manager.error_handler import ECustomizedError @@ -45,7 +46,15 @@ def test_file_upload_command_success_with_attribute(mocker, cli_runner): result = cli_runner.invoke( file_put, - ['--project-path', 'test_project/admin', '--thread', 1, '--attribute', 'template.json', 'test.txt'], + [ + '--project-path', + f'test_project/{ItemType.NAMEFOLDER.get_prefix_by_type()}admin', + '--thread', + 1, + '--attribute', + 'template.json', + 'test.txt', + ], ) assert result.exit_code == 0 diff --git a/tests/app/services/file_manager/file_upload/test_file_upload.py b/tests/app/services/file_manager/file_upload/test_file_upload.py index 4be1b77b..15277aab 100644 --- a/tests/app/services/file_manager/file_upload/test_file_upload.py +++ b/tests/app/services/file_manager/file_upload/test_file_upload.py @@ -36,7 +36,7 @@ def test_assemble_path_at_name_folder(mocker): current_file_path, parent_folder, create_folder_flag, _ = assemble_path( local_file_path, target_folder, project_code, ItemType.NAMEFOLDER, zone ) - assert current_file_path == 'admin/file.txt' + assert current_file_path == f'{ItemType.NAMEFOLDER.get_prefix_by_type()}admin/file.txt' assert parent_folder.get('name') == 'admin' assert create_folder_flag is False @@ -53,6 +53,16 @@ def test_assemble_path_at_exsting_folder(mocker): 'id': 'test', 'parent_id': 'test_parent', 'parent_path': '', + 'name': ItemType.NAMEFOLDER.get_prefix_by_type().strip('/'), + 'zone': 0, + 'type': 'folder', + } + }, + { + 'result': { + 'id': 'test', + 'parent_id': 'test_parent', + 'parent_path': ItemType.NAMEFOLDER.get_prefix_by_type(), 'name': 'admin', 'zone': 0, 'type': 'folder', @@ -62,7 +72,7 @@ def test_assemble_path_at_exsting_folder(mocker): 'result': { 'id': 'test', 'parent_id': 'test_parent', - 'parent_path': 'admin', + 'parent_path': ItemType.NAMEFOLDER.get_prefix_by_type() + 'admin', 'name': 'test_folder_exist', 'zone': 0, 'type': 'folder', @@ -75,7 +85,7 @@ def test_assemble_path_at_exsting_folder(mocker): current_file_path, parent_folder, create_folder_flag, _ = assemble_path( local_file_path, target_folder, project_code, ItemType.NAMEFOLDER, zone ) - assert current_file_path == 'admin/test_folder_exist/file.txt' + assert current_file_path == f'{ItemType.NAMEFOLDER.get_prefix_by_type()}admin/test_folder_exist/file.txt' assert parent_folder.get('name') == 'test_folder_exist' assert create_folder_flag is False @@ -92,6 +102,16 @@ def test_assemble_path_at_non_existing_folder(mocker): 'id': 'test', 'parent_id': 'test_parent', 'parent_path': '', + 'name': ItemType.NAMEFOLDER.get_prefix_by_type().strip('/'), + 'zone': 0, + 'type': 'folder', + } + }, + { + 'result': { + 'id': 'test', + 'parent_id': 'test_parent', + 'parent_path': ItemType.NAMEFOLDER.get_prefix_by_type(), 'name': 'admin', 'zone': 0, 'type': 'folder', @@ -106,7 +126,7 @@ def test_assemble_path_at_non_existing_folder(mocker): current_file_path, parent_folder, create_folder_flag, _ = assemble_path( local_file_path, target_folder, project_code, ItemType.NAMEFOLDER, zone ) - assert current_file_path == 'admin/test_folder_not_exist' + assert current_file_path == f'{ItemType.NAMEFOLDER.get_prefix_by_type()}admin/test_folder_not_exist' assert parent_folder.get('name') == 'admin' assert create_folder_flag is True diff --git a/tests/app/utils/test_aggregated.py b/tests/app/utils/test_aggregated.py index 91454cbb..1a892dc7 100644 --- a/tests/app/utils/test_aggregated.py +++ b/tests/app/utils/test_aggregated.py @@ -136,10 +136,22 @@ def test_validate_folder_name(folder_name): @pytest.mark.parametrize( 'input_path,expected_result', [ - ('project_code/username', ('project_code', ItemType.NAMEFOLDER, 'username')), - ('project_code/username/folder1', ('project_code', ItemType.NAMEFOLDER, 'username/folder1')), - ('project_code/projectfolder/folder1', ('project_code', ItemType.SHAREDFOLDER, 'folder1')), - ('project_code/projectfolder/folder1/folder2', ('project_code', ItemType.SHAREDFOLDER, 'folder1/folder2')), + ( + f'project_code/{ItemType.NAMEFOLDER.get_prefix_by_type()}username', + ('project_code', ItemType.NAMEFOLDER, 'username'), + ), + ( + f'project_code/{ItemType.NAMEFOLDER.get_prefix_by_type()}username/folder1', + ('project_code', ItemType.NAMEFOLDER, 'username/folder1'), + ), + ( + f'project_code/{ItemType.SHAREDFOLDER.get_prefix_by_type()}folder1', + ('project_code', ItemType.SHAREDFOLDER, 'folder1'), + ), + ( + f'project_code/{ItemType.SHAREDFOLDER.get_prefix_by_type()}folder1/folder2', + ('project_code', ItemType.SHAREDFOLDER, 'folder1/folder2'), + ), ], ) def test_identify_target_folder_success_with_different_path(mocker, input_path, expected_result): From 1ce8df747a42755b7b80f19234a402204aefad33 Mon Sep 17 00:00:00 2001 From: zhiren Date: Wed, 3 Apr 2024 16:28:04 -0400 Subject: [PATCH 07/15] fixup logic for different prefix --- app/models/item.py | 2 +- app/resources/custom_help.py | 6 +----- app/utils/aggregated.py | 10 ---------- 3 files changed, 2 insertions(+), 16 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/resources/custom_help.py b/app/resources/custom_help.py index 3e4b17e6..f0edb329 100644 --- a/app/resources/custom_help.py +++ b/app/resources/custom_help.py @@ -43,11 +43,7 @@ class HelpPage: 'FILE_SYNC_ZIP': 'Download files as a zip.', 'FILE_SYNC_I': 'Enable downloading by geid.', 'FILE_SYNC_Z': 'Target Zone (i.e., core/greenroom).', - 'FILE_UPLOAD_P': ( - 'Project folder path starting from Project Code(i.e. /user/folder). ' - 'A new key word `projectfolder` is required to specify project folder(i.e. ' - '/projectfolder/folder1)' - ), + 'FILE_UPLOAD_P': 'Project folder path starting from Project Code(i.e. /users/admin/folder). ', 'FILE_UPLOAD_A': 'Add attributes to the file using a File Attribute Template.', 'FILE_UPLOAD_T': 'Add tags to the file using a Tag file.', 'FILE_UPLOAD_M': 'The message used to comment on the purpose of uploading your processed file.', diff --git a/app/utils/aggregated.py b/app/utils/aggregated.py index c975783a..a645d972 100644 --- a/app/utils/aggregated.py +++ b/app/utils/aggregated.py @@ -186,17 +186,7 @@ def identify_target_folder(project_path: str) -> Tuple[str, ItemType, str]: # check folder type if is project folder or name folder # there will be a extra string for project folder between project code and folder name - # if len(temp_paths) == 2: - # folder_type = ItemType.NAMEFOLDER - # folder_name = temp_paths[1] - # el if len(temp_paths) >= 3: - # if temp_paths[1] == ItemType.SHAREDFOLDER.value: - # folder_type = ItemType.SHAREDFOLDER - # folder_name = temp_paths[2] - # else: - # folder_type = ItemType.NAMEFOLDER - # folder_name = os.path.join(temp_paths[1], temp_paths[2]) folder_type = ItemType.get_type_from_keyword(temp_paths[1]) folder_name = temp_paths[2] else: From 7020626ac24e512556c2425382fec27fcacc4398 Mon Sep 17 00:00:00 2001 From: zhiren Date: Wed, 3 Apr 2024 16:32:00 -0400 Subject: [PATCH 08/15] add prefix for name folder --- app/models/item.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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/', } From 77133af00443e3846b3ce0b1a5534cd25db35150 Mon Sep 17 00:00:00 2001 From: zhiren Date: Wed, 3 Apr 2024 16:36:34 -0400 Subject: [PATCH 09/15] bump up version to 3.0.0 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 07a4eeb4..c5a8b4c7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "app" -version = "2.10.0" +version = "3.0.0" description = "This service is designed to support pilot platform" authors = ["Indoc Systems"] From 0602417ed62d048ee2d9a9ac896dccdf55bc9a49 Mon Sep 17 00:00:00 2001 From: zhiren Date: Wed, 3 Apr 2024 17:42:20 -0400 Subject: [PATCH 10/15] fixup test cases --- .../app/services/file_manager/file_upload/test_file_upload.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/app/services/file_manager/file_upload/test_file_upload.py b/tests/app/services/file_manager/file_upload/test_file_upload.py index 15277aab..efacf163 100644 --- a/tests/app/services/file_manager/file_upload/test_file_upload.py +++ b/tests/app/services/file_manager/file_upload/test_file_upload.py @@ -154,9 +154,9 @@ def test_assemble_path_at_project_folder(mocker): current_file_path, parent_folder, create_folder_flag, target_folder = assemble_path( local_file_path, target_folder, project_code, ItemType.SHAREDFOLDER, zone ) - assert current_file_path == 'shared/project_folder/file.txt' + assert current_file_path == f'{ItemType.SHAREDFOLDER.get_prefix_by_type()}project_folder/file.txt' assert parent_folder.get('name') == 'project_folder' - assert target_folder == 'shared/project_folder' + assert target_folder == f'{ItemType.SHAREDFOLDER.get_prefix_by_type()}project_folder' assert create_folder_flag is False From 36a8a662283a6e83a2e74f9641e549fbc27529ea Mon Sep 17 00:00:00 2001 From: zhiren Date: Thu, 4 Apr 2024 10:39:55 -0400 Subject: [PATCH 11/15] fixup test cases --- app/services/file_manager/file_list.py | 7 +++---- tests/app/commands/test_file.py | 3 +-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/app/services/file_manager/file_list.py b/app/services/file_manager/file_list.py index 2131903a..385ae885 100644 --- a/app/services/file_manager/file_list.py +++ b/app/services/file_manager/file_list.py @@ -68,10 +68,9 @@ def list_files(self, paths, zone, page, page_size): if item_type == ItemType.FILE: files = files + f.get('name') + ' ...' else: - # add [p] in front of the project folder - if item_type == ItemType.SHAREDFOLDER: - f['name'] = f'[p]{f.get("name")}' - + # # add [p] in front of the project folder + # if item_type == ItemType.SHAREDFOLDER: + # f['name'] = f'[p]{f.get("name")}' folders = folders + f"\033[34m{f.get('name')}\033[0m ..." f_string = folders + files diff --git a/tests/app/commands/test_file.py b/tests/app/commands/test_file.py index 4b45c6b3..901face1 100644 --- a/tests/app/commands/test_file.py +++ b/tests/app/commands/test_file.py @@ -204,8 +204,7 @@ def test_file_list_with_pagination_with_name_project_folder(requests_mock, mocke questionary.select.return_value.ask.return_value = 'exit' result = cli_runner.invoke(file_list, ['testproject/admin', '-z', 'greenroom']) outputs = result.output.split('\n') - assert outputs[0] == 'folder1 name_folder1 [p]"project folder1" ' - assert outputs[1] == '"test folder2" [p]"project folder2" ' + assert outputs[0] == 'folder1 name_folder1 "project folder1" "test folder2" "project folder2" ' def test_empty_file_list_with_pagination(requests_mock, mocker, cli_runner): From 78698a52bd948f5d940288b3555e00d394f435e7 Mon Sep 17 00:00:00 2001 From: zhiren Date: Thu, 4 Apr 2024 10:51:51 -0400 Subject: [PATCH 12/15] replace hardcoded string with enum value in test cases --- app/models/item.py | 2 +- tests/app/commands/test_file.py | 29 +++++++++++++++++------------ 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/app/models/item.py b/app/models/item.py index 569bc066..c66de41f 100644 --- a/app/models/item.py +++ b/app/models/item.py @@ -9,7 +9,7 @@ class ItemType(str, Enum): """The class to reflect the type of item in database.""" FILE = 'file' - Folder = 'folder' + FOLDER = 'folder' NAMEFOLDER = 'name_folder' SHAREDFOLDER = 'project_folder' diff --git a/tests/app/commands/test_file.py b/tests/app/commands/test_file.py index 901face1..b922eef1 100644 --- a/tests/app/commands/test_file.py +++ b/tests/app/commands/test_file.py @@ -147,7 +147,7 @@ def test_file_list_with_pagination_with_folder_success(requests_mock, mocker, cl 'app.services.file_manager.file_list.search_item', return_value={ 'result': { - 'type': 'folder', + 'type': ItemType.FOLDER.value, 'id': 'id', } }, @@ -158,8 +158,8 @@ def test_file_list_with_pagination_with_folder_success(requests_mock, mocker, cl 'code': 200, 'error_msg': '', 'result': [ - {'type': 'file', 'name': 'file1'}, - {'type': 'file', 'name': 'file2'}, + {'type': ItemType.FILE.value, 'name': 'file1'}, + {'type': ItemType.FILE.value, 'name': 'file2'}, ], }, ) @@ -186,17 +186,21 @@ def test_file_list_with_pagination_with_name_project_folder(requests_mock, mocke } }, ) + + folder = 'folder1' + folder_with_underline = 'folder_1' + folder_with_space = 'folder 1' requests_mock.get( 'http://bff_cli' + '/v1/testproject/files/query', json={ 'code': 200, 'error_msg': '', 'result': [ - {'type': 'folder', 'name': 'folder1'}, - {'type': 'name_folder', 'name': 'name_folder1'}, - {'type': 'project_folder', 'name': 'project folder1'}, - {'type': 'folder', 'name': 'test folder2'}, - {'type': 'project_folder', 'name': 'project folder2'}, + {'type': ItemType.FOLDER.value, 'name': folder}, + {'type': ItemType.NAMEFOLDER.value, 'name': folder_with_underline}, + {'type': ItemType.SHAREDFOLDER.value, 'name': folder_with_underline}, + {'type': ItemType.FOLDER.value, 'name': folder_with_space}, + {'type': ItemType.SHAREDFOLDER.value, 'name': folder_with_space}, ], }, ) @@ -204,7 +208,8 @@ def test_file_list_with_pagination_with_name_project_folder(requests_mock, mocke questionary.select.return_value.ask.return_value = 'exit' result = cli_runner.invoke(file_list, ['testproject/admin', '-z', 'greenroom']) outputs = result.output.split('\n') - assert outputs[0] == 'folder1 name_folder1 "project folder1" "test folder2" "project folder2" ' + assert outputs[0] == f'{folder} {folder_with_underline} {folder_with_underline} "{folder_with_space}" ' + assert outputs[1] == f'"{folder_with_space}" ' def test_empty_file_list_with_pagination(requests_mock, mocker, cli_runner): @@ -217,7 +222,7 @@ def test_empty_file_list_with_pagination(requests_mock, mocker, cli_runner): 'app.services.file_manager.file_list.search_item', return_value={ 'result': { - 'type': 'folder', + 'type': ItemType.FOLDER.value, 'id': 'id', } }, @@ -233,7 +238,7 @@ def test_empty_file_list_with_pagination(requests_mock, mocker, cli_runner): assert outputs[0] == ' ' -@pytest.mark.parametrize('parent_folder_type', ['name_folder', 'project_folder']) +@pytest.mark.parametrize('parent_folder_type', [ItemType.NAMEFOLDER.value, ItemType.SHAREDFOLDER.value]) def test_file_download_success(requests_mock, mocker, cli_runner, parent_folder_type): mocker.patch( 'app.services.user_authentication.token_manager.SrvTokenManager.decode_access_token', @@ -254,7 +259,7 @@ def test_file_download_success(requests_mock, mocker, cli_runner, parent_folder_ { 'code': 200, 'result': { - 'type': 'file', + 'type': ItemType.FILE.value, 'id': 'id', }, }, From db9b73be461b6efe610bd478431f35673aff9d15 Mon Sep 17 00:00:00 2001 From: zhiren Date: Thu, 4 Apr 2024 10:56:17 -0400 Subject: [PATCH 13/15] remove the reference of project_folder --- app/services/file_manager/file_list.py | 8 ++------ tests/app/commands/test_file.py | 4 ++-- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/app/services/file_manager/file_list.py b/app/services/file_manager/file_list.py index 385ae885..5d054602 100644 --- a/app/services/file_manager/file_list.py +++ b/app/services/file_manager/file_list.py @@ -31,10 +31,9 @@ def list_files(self, paths, zone, page, page_size): else: source_type = 'project' res = search_item(project_code, zone, folder_rel_path) - parent_folder = res.get('result') + parent_type = ItemType(res.get('result').get('type')) # if the target folder is project folder add the default path - if parent_folder.get('type') == 'project_folder': - folder_rel_path = 'shared/' + folder_rel_path + folder_rel_path = parent_type.get_prefix_by_type() + folder_rel_path # now query the backend to get the file list get_url = AppConfig.Connections.url_bff + f'/v1/{project_code}/files/query' @@ -68,9 +67,6 @@ def list_files(self, paths, zone, page, page_size): if item_type == ItemType.FILE: files = files + f.get('name') + ' ...' else: - # # add [p] in front of the project folder - # if item_type == ItemType.SHAREDFOLDER: - # f['name'] = f'[p]{f.get("name")}' folders = folders + f"\033[34m{f.get('name')}\033[0m ..." f_string = folders + files diff --git a/tests/app/commands/test_file.py b/tests/app/commands/test_file.py index b922eef1..53ae9a4d 100644 --- a/tests/app/commands/test_file.py +++ b/tests/app/commands/test_file.py @@ -170,8 +170,8 @@ def test_file_list_with_pagination_with_folder_success(requests_mock, mocker, cl assert outputs[0] == 'file1 file2 ' -@pytest.mark.parametrize('parent_folder_type', ['name_folder', 'project_folder']) -def test_file_list_with_pagination_with_name_project_folder(requests_mock, mocker, cli_runner, parent_folder_type): +@pytest.mark.parametrize('parent_folder_type', [ItemType.NAMEFOLDER.value, ItemType.SHAREDFOLDER.value]) +def test_file_list_with_pagination_with_root_folder(requests_mock, mocker, cli_runner, parent_folder_type): mocker.patch( 'app.services.user_authentication.token_manager.SrvTokenManager.decode_access_token', return_value=decoded_token(), From 0f0a91462908055fe475c0889f4d09f275f9451c Mon Sep 17 00:00:00 2001 From: zhiren Date: Tue, 23 Apr 2024 11:10:20 -0400 Subject: [PATCH 14/15] fixup test cases --- app/models/item.py | 4 ++- app/services/file_manager/file_list.py | 16 ++++------ tests/app/commands/test_file.py | 41 +++++--------------------- 3 files changed, 16 insertions(+), 45 deletions(-) diff --git a/app/models/item.py b/app/models/item.py index c66de41f..db1068d8 100644 --- a/app/models/item.py +++ b/app/models/item.py @@ -12,6 +12,7 @@ class ItemType(str, Enum): FOLDER = 'folder' NAMEFOLDER = 'name_folder' SHAREDFOLDER = 'project_folder' + ROOTFOLDER = 'root_folder' @classmethod def get_type_from_keyword(self, keyword: str): @@ -26,7 +27,7 @@ def get_type_from_keyword(self, keyword: str): 'users': self.NAMEFOLDER, } - return alternative_mapping.get(keyword, self.NAMEFOLDER) + return alternative_mapping.get(keyword, '') def get_prefix_by_type(self) -> str: """Get the prefix for the folder type.""" @@ -34,6 +35,7 @@ def get_prefix_by_type(self) -> str: prefix = { self.NAMEFOLDER: 'users/', self.SHAREDFOLDER: 'shared/', + self.ROOTFOLDER: '', } return prefix.get(self.value, '') diff --git a/app/services/file_manager/file_list.py b/app/services/file_manager/file_list.py index 5d054602..d543d952 100644 --- a/app/services/file_manager/file_list.py +++ b/app/services/file_manager/file_list.py @@ -15,7 +15,6 @@ from app.services.output_manager.error_handler import SrvErrorHandler from app.services.user_authentication.decorator import require_valid_token from app.utils.aggregated import fit_terminal_width -from app.utils.aggregated import search_item class SrvFileList(metaclass=MetaService): @@ -23,17 +22,14 @@ class SrvFileList(metaclass=MetaService): @require_valid_token() def list_files(self, paths, zone, page, page_size): + # path is formatted as // + # split the path in to project_code, root_folder, and folder1 project_path = paths.strip('/').split('/') - project_code = project_path[0] + project_code, source_type = project_path[0], 'project' folder_rel_path = '/'.join(project_path[1:]) - if len(project_path) == 1: - source_type = 'project' - else: - source_type = 'project' - res = search_item(project_code, zone, folder_rel_path) - parent_type = ItemType(res.get('result').get('type')) - # if the target folder is project folder add the default path - folder_rel_path = parent_type.get_prefix_by_type() + folder_rel_path + if len(project_path) > 1: + root_folder = ItemType.get_type_from_keyword(project_path[1]) + folder_rel_path = folder_rel_path.replace(project_path[1], root_folder.get_prefix_by_type()[:-1], 1) # now query the backend to get the file list get_url = AppConfig.Connections.url_bff + f'/v1/{project_code}/files/query' diff --git a/tests/app/commands/test_file.py b/tests/app/commands/test_file.py index 53ae9a4d..2331a535 100644 --- a/tests/app/commands/test_file.py +++ b/tests/app/commands/test_file.py @@ -143,15 +143,6 @@ def test_file_list_with_pagination_with_folder_success(requests_mock, mocker, cl return_value=decoded_token(), ) - mocker.patch( - 'app.services.file_manager.file_list.search_item', - return_value={ - 'result': { - 'type': ItemType.FOLDER.value, - 'id': 'id', - } - }, - ) requests_mock.get( 'http://bff_cli' + '/v1/testproject/files/query', json={ @@ -165,31 +156,21 @@ def test_file_list_with_pagination_with_folder_success(requests_mock, mocker, cl ) mocker.patch.object(questionary, 'select') questionary.select.return_value.ask.return_value = 'exit' - result = cli_runner.invoke(file_list, ['testproject/admin', '-z', 'greenroom']) + result = cli_runner.invoke(file_list, ['testproject/users/admin', '-z', 'greenroom']) outputs = result.output.split('\n') assert outputs[0] == 'file1 file2 ' -@pytest.mark.parametrize('parent_folder_type', [ItemType.NAMEFOLDER.value, ItemType.SHAREDFOLDER.value]) -def test_file_list_with_pagination_with_root_folder(requests_mock, mocker, cli_runner, parent_folder_type): +def test_file_list_with_pagination_with_root_folder(requests_mock, mocker, cli_runner): mocker.patch( 'app.services.user_authentication.token_manager.SrvTokenManager.decode_access_token', return_value=decoded_token(), ) - mocker.patch( - 'app.services.file_manager.file_list.search_item', - return_value={ - 'result': { - 'type': parent_folder_type, - 'id': 'id', - } - }, - ) - folder = 'folder1' folder_with_underline = 'folder_1' folder_with_space = 'folder 1' + root_folder = 'root_folder' requests_mock.get( 'http://bff_cli' + '/v1/testproject/files/query', json={ @@ -201,15 +182,16 @@ def test_file_list_with_pagination_with_root_folder(requests_mock, mocker, cli_r {'type': ItemType.SHAREDFOLDER.value, 'name': folder_with_underline}, {'type': ItemType.FOLDER.value, 'name': folder_with_space}, {'type': ItemType.SHAREDFOLDER.value, 'name': folder_with_space}, + {'type': ItemType.ROOTFOLDER.value, 'name': root_folder}, ], }, ) mocker.patch.object(questionary, 'select') questionary.select.return_value.ask.return_value = 'exit' - result = cli_runner.invoke(file_list, ['testproject/admin', '-z', 'greenroom']) + result = cli_runner.invoke(file_list, ['testproject/users/admin', '-z', 'greenroom']) outputs = result.output.split('\n') assert outputs[0] == f'{folder} {folder_with_underline} {folder_with_underline} "{folder_with_space}" ' - assert outputs[1] == f'"{folder_with_space}" ' + assert outputs[1] == f'"{folder_with_space}" {root_folder} ' def test_empty_file_list_with_pagination(requests_mock, mocker, cli_runner): @@ -218,15 +200,6 @@ def test_empty_file_list_with_pagination(requests_mock, mocker, cli_runner): return_value=decoded_token(), ) - mocker.patch( - 'app.services.file_manager.file_list.search_item', - return_value={ - 'result': { - 'type': ItemType.FOLDER.value, - 'id': 'id', - } - }, - ) requests_mock.get( 'http://bff_cli' + '/v1/testproject/files/query', json={'code': 200, 'error_msg': '', 'result': []}, @@ -235,7 +208,7 @@ def test_empty_file_list_with_pagination(requests_mock, mocker, cli_runner): questionary.select.return_value.ask.return_value = 'exit' result = cli_runner.invoke(file_list, ['testproject/admin', '-z', 'greenroom']) outputs = result.output.split('\n') - assert outputs[0] == ' ' + assert outputs[0] == '' @pytest.mark.parametrize('parent_folder_type', [ItemType.NAMEFOLDER.value, ItemType.SHAREDFOLDER.value]) From f0a93598e3da56589af62c33ced4384ad41d3d86 Mon Sep 17 00:00:00 2001 From: zhiren Date: Tue, 23 Apr 2024 11:36:50 -0400 Subject: [PATCH 15/15] update help page --- app/resources/custom_help.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/resources/custom_help.py b/app/resources/custom_help.py index f0edb329..aa750847 100644 --- a/app/resources/custom_help.py +++ b/app/resources/custom_help.py @@ -9,9 +9,9 @@ class HelpPage: page = { 'update': { 'version': pkg_resources.get_distribution('app').version, - '1': 'Add new feature for folder merging', - '2': 'Secure the config file', - '3': 'Optimize logic, input and error message', + '1': 'Add a new feature for file metadata downloading.', + '2': 'Add a new feature for file moving/renaming.', + '3': 'Support shared folder within project.', }, 'dataset': { 'DATASET_DOWNLOAD': 'Download a dataset or a particular version of a dataset.',