Pilot 3970: update cli logic with project folder implementation

app/commands/file.py

@@ -195,7 +195,7 @@ def file_put(**kwargs):  # noqa: C901
     # and process them one by one
     for f in files:
         # so this function will always return the furthest folder node as current_folder_node+parent_folder_id
-        current_folder_node, parent_folder, create_folder_flag, result_file = assemble_path(
+        current_folder_node, parent_folder, create_folder_flag, target_folder = assemble_path(
             f,
             target_folder,
             project_code,
@@ -418,17 +418,18 @@ def file_download(**kwargs):
     else:
         item_res = []
         for path in paths:
-            project_code = path.strip('/').split('/')[0]
+            project_code, root_folder = path.strip('/').split('/')[:2]
             target_path = '/'.join(path.split('/')[1::])
-            item = search_item(project_code, zone, target_path, '')
+            # search the root to check for name folder or project folder
+            root_item = search_item(project_code, zone, root_folder).get('result', {})
+            target_path = 'shared/' + target_path if root_item.get('type') == 'project_folder' else target_path
+
+            # search the target item and download to local
+            item = search_item(project_code, zone, target_path)
             if item.get('code') == 200 and item.get('result'):
                 item_status = 'success'
                 item_result = item.get('result')
                 item_geid = item.get('result').get('id')
-            elif item.get('code') == 403 and item.get('error_msg'):
-                item_status = item.get('error_msg')
-                item_result = {}
-                item_geid = path
             else:
                 item_status = 'File Not Exist'
                 item_result = {}

app/configs/config.py

@@ -17,10 +17,7 @@ class Settings(BaseSettings):
     project: str = 'pilot'
     app_name: str = 'pilotcli'
 
-    @computed_field
-    def config_path(self) -> str:
-        return str(Path.home() / f'.{self.app_name}')
-
+    config_path: str = str(Path.home() / f'.{app_name}')
     config_file: str = 'config.ini'
 
     keycloak_device_client_id: str = 'cli'

app/services/file_manager/file_list.py

@@ -29,7 +29,13 @@ def list_files(self, paths, zone, page, page_size):
             source_type = 'project'
         else:
             source_type = 'project'
-            res = search_item(project_code, zone, folder_rel_path, 'folder')
+            res = search_item(project_code, zone, folder_rel_path)
+            parent_folder = res.get('result')
+            # 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
+
+        # now query the backend to get the file list
         get_url = AppConfig.Connections.url_bff + f'/v1/{project_code}/files/query'
         headers = {
             'Authorization': 'Bearer ' + self.user.access_token,
@@ -49,12 +55,13 @@ def list_files(self, paths, zone, page, page_size):
         elif res_json.get('error_msg') == 'Folder not exist':
             SrvErrorHandler.customized_handle(ECustomizedError.INVALID_FOLDER, True)
         res = res_json.get('result')
-        files = ''
-        folders = ''
+
+        # then format the console output
+        files, folders = '', ''
         for f in res:
             if 'file' == f.get('type'):
                 files = files + f.get('name') + ' ...'
-            elif f.get('type') in ['folder', 'name_folder']:
+            elif f.get('type') in ['folder', 'name_folder', 'project_folder']:
                 folders = folders + f"\033[34m{f.get('name')}\033[0m ..."
         f_string = folders + files
         return f_string

app/services/file_manager/file_upload/file_upload.py

@@ -66,29 +66,30 @@ def assemble_path(
          - current_file_path: the format file path on platform
          - parent_folder: the item information of longest parent folder
          - create_folder_flag: the flag to indicate if need to create new folder
-         - result_file: the result file if zipping
+         - target_folder: result object path on platform
 
     '''
 
     current_file_path = target_folder + '/' + f.rstrip('/').split('/')[-1]
-    result_file = current_file_path
-    if zipping:
-        result_file = result_file + '.zip'
-
     # set name folder as first parent folder
     name_folder = target_folder.split('/')[0]
-    parent_folder = search_item(project_code, zone, name_folder, 'name_folder')
-    parent_folder = parent_folder.get('result')
+    parent_folder = search_item(project_code, zone, name_folder).get('result', {})
 
     # if f input is a file then current_folder_node is target_folder
     # otherwise it is target_folder + f input name
     current_folder_node = target_folder if os.path.isfile(f) else current_file_path
     create_folder_flag = False
+    # always add `shared/` as prefix to folder/file if
+    # they directly under the project root folder
+    if parent_folder.get('type') == 'project_folder':
+        current_folder_node = 'shared/' + current_folder_node
+        target_folder = 'shared/' + target_folder
+
     if len(current_file_path.split('/')) > 2:
         sub_path = target_folder.split('/')
         for index in range(len(sub_path) - 1):
             folder_path = '/'.join(sub_path[0 : 2 + index])
-            res = search_item(project_code, zone, folder_path, 'folder')
+            res = search_item(project_code, zone, folder_path)
 
             # find the longest existing folder as parent folder
             # if user input a path that need to create some folders
@@ -111,7 +112,7 @@ def assemble_path(
     if not parent_folder:
         SrvErrorHandler.customized_handle(ECustomizedError.PERMISSION_DENIED, True)
 
-    return current_folder_node, parent_folder, create_folder_flag, result_file
+    return current_folder_node, parent_folder, create_folder_flag, target_folder
 
 
 def simple_upload(  # noqa: C901

app/services/file_manager/file_upload/upload_validator.py

@@ -32,7 +32,7 @@ def validate_zone(self):
                 ECustomizedError.INVALID_UPLOAD_REQUEST, True, value='upload-message is required'
             )
         if self.source:
-            source_file_info = search_item(self.project_code, AppConfig.Env.core_zone.lower(), self.source, 'file')
+            source_file_info = search_item(self.project_code, AppConfig.Env.core_zone.lower(), self.source)
             source_file_info = source_file_info['result']
             if not source_file_info:
                 SrvErrorHandler.customized_handle(ECustomizedError.INVALID_SOURCE_FILE, True, value=self.source)

app/utils/aggregated.py

@@ -28,14 +28,13 @@ def resilient_session():
 
 
 @require_valid_token()
-def search_item(project_code, zone, folder_relative_path, item_type, container_type='project'):
+def search_item(project_code, zone, folder_relative_path, container_type='project'):
     token = UserConfig().access_token
     url = AppConfig.Connections.url_bff + '/v1/project/{}/search'.format(project_code)
     params = {
         'zone': zone,
         'project_code': project_code,
         'path': folder_relative_path,
-        'item_type': item_type,
         'container_type': container_type,
     }
     headers = {'Authorization': 'Bearer ' + token}

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "app"
-version = "2.9.2"
+version = "2.9.3"
 description = "This service is designed to support pilot platform"
 authors = ["Indoc Systems"]
 

tests/app/commands/test_file.py

@@ -7,8 +7,10 @@
 from os.path import dirname
 
 import click
+import pytest
 import questionary
 
+from app.commands.file import file_download
 from app.commands.file import file_list
 from app.commands.file import file_metadata_download
 from app.commands.file import file_put
@@ -95,19 +97,30 @@ def test_resumable_upload_command_failed_with_file_not_exists(mocker, cli_runner
     assert result.output == customized_error_msg(ECustomizedError.INVALID_RESUMABLE) + '\n'
 
 
-def test_file_list_with_pagination(requests_mock, mocker, cli_runner):
+def test_file_list_with_pagination_with_folder_success(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=None)
+    mocker.patch(
+        'app.services.file_manager.file_list.search_item',
+        return_value={
+            'result': {
+                'type': 'folder',
+                'id': 'id',
+            }
+        },
+    )
     requests_mock.get(
         'http://bff_cli' + '/v1/testproject/files/query',
         json={
             'code': 200,
             'error_msg': '',
-            'result': [{'type': 'file', 'name': 'file1'}, {'type': 'file', 'name': 'file2'}],
+            'result': [
+                {'type': 'file', 'name': 'file1'},
+                {'type': 'file', 'name': 'file2'},
+            ],
         },
     )
     mocker.patch.object(questionary, 'select')
@@ -117,13 +130,56 @@ def test_file_list_with_pagination(requests_mock, mocker, cli_runner):
     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):
+    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',
+            }
+        },
+    )
+    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'},
+            ],
+        },
+    )
+    mocker.patch.object(questionary, 'select')
+    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   '
+
+
 def test_empty_file_list_with_pagination(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=None)
+    mocker.patch(
+        'app.services.file_manager.file_list.search_item',
+        return_value={
+            'result': {
+                'type': 'folder',
+                'id': 'id',
+            }
+        },
+    )
     requests_mock.get(
         'http://bff_cli' + '/v1/testproject/files/query',
         json={'code': 200, 'error_msg': '', 'result': []},
@@ -135,6 +191,49 @@ 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'])
+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',
+        return_value=decoded_token(),
+    )
+
+    search_mock = mocker.patch(
+        'app.commands.file.search_item',
+        side_effect=[
+            {
+                'code': 200,
+                'result': {
+                    'type': parent_folder_type,
+                    'name': 'test',
+                    'id': 'id',
+                },
+            },
+            {
+                'code': 200,
+                'result': {
+                    'type': 'file',
+                    'id': 'id',
+                },
+            },
+        ],
+    )
+
+    download_mock = mocker.patch(
+        'app.services.file_manager.file_download.download_client.SrvFileDownload.simple_download_file',
+        return_value=None,
+    )
+
+    project_code, target_folder = 'testproject', 'test/test.txt'
+    result = cli_runner.invoke(file_download, [f'{project_code}/{target_folder}', './'])
+    outputs = result.output.split('\n')
+    assert outputs[0] == ''
+
+    except_target_folder = 'test/test.txt' if parent_folder_type == 'name_folder' else 'shared/test/test.txt'
+    search_mock.assert_called_with(project_code, 'greenroom', except_target_folder)
+    download_mock.assert_called_once()
+
+
 def test_download_file_metadata_file_duplicate_success(mocker, cli_runner):
     mocker.patch(
         'app.services.user_authentication.token_manager.SrvTokenManager.decode_access_token',

tests/app/services/file_manager/file_upload/test_file_upload.py

@@ -28,6 +28,7 @@ def test_assemble_path_at_name_folder(mocker):
                 'parent_path': '',
                 'name': 'admin',
                 'zone': 0,
+                'type': 'name_folder',
             }
         },
     )
@@ -55,6 +56,7 @@ def test_assemble_path_at_exsting_folder(mocker):
                 'parent_path': '',
                 'name': 'admin',
                 'zone': 0,
+                'type': 'folder',
             }
         },
         {
@@ -64,6 +66,7 @@ def test_assemble_path_at_exsting_folder(mocker):
                 'parent_path': 'admin',
                 'name': 'test_folder_exist',
                 'zone': 0,
+                'type': 'folder',
             }
         },
     ]
@@ -93,6 +96,7 @@ def test_assemble_path_at_non_existing_folder(mocker):
                 'parent_path': '',
                 'name': 'admin',
                 'zone': 0,
+                'type': 'folder',
             }
         },
         {'result': {}},
@@ -109,6 +113,36 @@ def test_assemble_path_at_non_existing_folder(mocker):
     assert create_folder_flag is True
 
 
+def test_assemble_path_at_project_folder(mocker):
+    local_file_path = './test/file.txt'
+    target_folder = 'project_folder'
+    project_code = 'test_project'
+    zone = 0
+    resumable_id = None
+
+    mocker.patch(
+        'app.services.file_manager.file_upload.file_upload.search_item',
+        return_value={
+            'result': {
+                'id': 'test',
+                'parent_id': 'test_parent',
+                'parent_path': '',
+                'name': 'project_folder',
+                'zone': 0,
+                'type': 'project_folder',
+            }
+        },
+    )
+
+    current_file_path, parent_folder, create_folder_flag, target_folder = assemble_path(
+        local_file_path, target_folder, project_code, zone, resumable_id
+    )
+    assert current_file_path == 'shared/project_folder/file.txt'
+    assert parent_folder.get('name') == 'project_folder'
+    assert target_folder == 'shared/project_folder'
+    assert create_folder_flag is False
+
+
 def test_file_upload_skip_empty_file(mocker, tmp_path, capfd):
     file_name = 'test'
     upload_event = {