p34709852
/
monkey
forked from p15670423/monkey
1
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Island: Prefix private functions with "_" in FileUpload resource

This commit is contained in:
Mike Salvatore 2022-04-26 13:38:52 -04:00
parent e296cd5225
commit 1d938e58f8
2 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
monkey/monkey_island/cc/resources/pba_file_upload.py
View File

@ -30,7 +30,6 @@ class FileUpload(flask_restful.Resource):
# TODO: Fix references/coupling to filepond # TODO: Fix references/coupling to filepond
# TODO: Replace "file_type" with "target_os" or similar # TODO: Replace "file_type" with "target_os" or similar
# TODO: Prefix private functions with "_"
# TODO: Add comment explaining why this is basically a duplicate of the endpoint in the # TODO: Add comment explaining why this is basically a duplicate of the endpoint in the
# PBAFileDownload resource. # PBAFileDownload resource.
@jwt_required @jwt_required
@ -40,7 +39,7 @@ class FileUpload(flask_restful.Resource):
:param file_type: Type indicates which file to send, linux or windows :param file_type: Type indicates which file to send, linux or windows
:return: Returns file contents :return: Returns file contents
""" """
if self.is_pba_file_type_supported(file_type): if self._is_pba_file_type_supported(file_type):
return Response(status=HTTPStatus.UNPROCESSABLE_ENTITY, mimetype="text/plain") return Response(status=HTTPStatus.UNPROCESSABLE_ENTITY, mimetype="text/plain")
# Verify that file_name is indeed a file from config # Verify that file_name is indeed a file from config
@ -67,10 +66,10 @@ class FileUpload(flask_restful.Resource):
:param file_type: Type indicates which file was received, linux or windows :param file_type: Type indicates which file was received, linux or windows
:return: Returns flask response object with uploaded file's filename :return: Returns flask response object with uploaded file's filename
""" """
if self.is_pba_file_type_supported(file_type): if self._is_pba_file_type_supported(file_type):
return Response(status=HTTPStatus.UNPROCESSABLE_ENTITY, mimetype="text/plain") return Response(status=HTTPStatus.UNPROCESSABLE_ENTITY, mimetype="text/plain")
filename = self.upload_pba_file( filename = self._upload_pba_file(
# TODO: This "filepond" string can be changed to be more generic in the `react-filepond` # TODO: This "filepond" string can be changed to be more generic in the `react-filepond`
# component. # component.
request.files["filepond"], request.files["filepond"],
@ -80,7 +79,7 @@ class FileUpload(flask_restful.Resource):
response = Response(response=filename, status=200, mimetype="text/plain") response = Response(response=filename, status=200, mimetype="text/plain")
return response return response
def upload_pba_file(self, file_storage: FileStorage, is_linux=True): def _upload_pba_file(self, file_storage: FileStorage, is_linux=True):
""" """
Uploads PBA file to island's file system Uploads PBA file to island's file system
:param request_: Request object containing PBA file :param request_: Request object containing PBA file
@ -103,7 +102,7 @@ class FileUpload(flask_restful.Resource):
:param file_type: Type indicates which file was deleted, linux of windows :param file_type: Type indicates which file was deleted, linux of windows
:return: Empty response :return: Empty response
""" """
if self.is_pba_file_type_supported(file_type): if self._is_pba_file_type_supported(file_type):
return Response(status=HTTPStatus.UNPROCESSABLE_ENTITY, mimetype="text/plain") return Response(status=HTTPStatus.UNPROCESSABLE_ENTITY, mimetype="text/plain")
filename_path = ( filename_path = (
@ -117,5 +116,5 @@ class FileUpload(flask_restful.Resource):
return make_response({}, 200) return make_response({}, 200)
@staticmethod @staticmethod
def is_pba_file_type_supported(file_type: str) -> bool: def _is_pba_file_type_supported(file_type: str) -> bool:
return file_type not in {LINUX_PBA_TYPE, WINDOWS_PBA_TYPE} return file_type not in {LINUX_PBA_TYPE, WINDOWS_PBA_TYPE}

2
monkey/tests/unit_tests/monkey_island/cc/resources/test_pba_file_upload.py
View File

@ -94,7 +94,7 @@ def test_pba_file_upload_post__internal_server_error(
flask_client, pba_os, monkeypatch, mock_set_config_value flask_client, pba_os, monkeypatch, mock_set_config_value
): ):
monkeypatch.setattr( monkeypatch.setattr(
"monkey_island.cc.resources.pba_file_upload.FileUpload.upload_pba_file", "monkey_island.cc.resources.pba_file_upload.FileUpload._upload_pba_file",
lambda x, y: raise_(Exception()), lambda x, y: raise_(Exception()),
) )