Merged PR 455: Add folder and file request permissions validators
## Summary Implemented the last of the request validators from https://dev.azure.com/ma-dev-uk/PrimAITE/_wiki/wikis/PrimAITE.wiki/703/Action-Masking files and folders validators ## Test process integration tests for files and folders added unit tests for previous validators as well ## Checklist - [X] PR is linked to a **work item** - [X] **acceptance criteria** of linked ticket are met - [X] performed **self-review** of the code - [X] written **tests** for any new functionality added with this PR - [ ] updated the **documentation** if this PR changes or adds functionality - [ ] written/updated **design docs** if this PR implements new functionality - [ ] updated the **change log** - [X] ran **pre-commit** checks for code style - [ ] attended to any **TO-DOs** left in the code Related work items: #2740
This commit is contained in:
Czar Echavez
@@ -34,6 +34,20 @@ class RequestPermissionValidator(BaseModel):
|
||||
"""Message that is reported when a request is rejected by this validator."""
|
||||
return "request rejected"
|
||||
|
||||
def __add__(self, other: "RequestPermissionValidator") -> "_CombinedValidator":
|
||||
return _CombinedValidator(validators=[self, other])
|
||||
|
||||
|
||||
class _CombinedValidator(RequestPermissionValidator):
|
||||
validators: List[RequestPermissionValidator] = []
|
||||
|
||||
def __call__(self, request, context) -> bool:
|
||||
return all(x(request, context) for x in self.validators)
|
||||
|
||||
@property
|
||||
def fail_message(self):
|
||||
return f"One of the following conditions are not met: {[v.fail_message for v in self.validators]}"
|
||||
|
||||
|
||||
class AllowAllValidator(RequestPermissionValidator):
|
||||
"""Always allows the request."""
|
||||
|
||||
@@ -6,8 +6,8 @@ from typing import Any, Dict, List, Optional
|
||||
|
||||
from prettytable import MARKDOWN, PrettyTable
|
||||
|
||||
from primaite.interface.request import RequestResponse
|
||||
from primaite.simulator.core import RequestManager, RequestType, SimComponent
|
||||
from primaite.interface.request import RequestFormat, RequestResponse
|
||||
from primaite.simulator.core import RequestManager, RequestPermissionValidator, RequestType, SimComponent
|
||||
from primaite.simulator.file_system.file import File
|
||||
from primaite.simulator.file_system.file_type import FileType
|
||||
from primaite.simulator.file_system.folder import Folder
|
||||
@@ -42,6 +42,10 @@ class FileSystem(SimComponent):
|
||||
|
||||
More information in user guide and docstring for SimComponent._init_request_manager.
|
||||
"""
|
||||
self._folder_exists = FileSystem._FolderExistsValidator(file_system=self)
|
||||
self._folder_not_deleted = FileSystem._FolderNotDeletedValidator(file_system=self)
|
||||
self._file_exists = FileSystem._FileExistsValidator(file_system=self)
|
||||
|
||||
rm = super()._init_request_manager()
|
||||
|
||||
self._delete_manager = RequestManager()
|
||||
@@ -50,13 +54,15 @@ class FileSystem(SimComponent):
|
||||
request_type=RequestType(
|
||||
func=lambda request, context: RequestResponse.from_bool(
|
||||
self.delete_file(folder_name=request[0], file_name=request[1])
|
||||
)
|
||||
),
|
||||
validator=self._file_exists,
|
||||
),
|
||||
)
|
||||
self._delete_manager.add_request(
|
||||
name="folder",
|
||||
request_type=RequestType(
|
||||
func=lambda request, context: RequestResponse.from_bool(self.delete_folder(folder_name=request[0]))
|
||||
func=lambda request, context: RequestResponse.from_bool(self.delete_folder(folder_name=request[0])),
|
||||
validator=self._folder_exists,
|
||||
),
|
||||
)
|
||||
rm.add_request(
|
||||
@@ -144,10 +150,13 @@ class FileSystem(SimComponent):
|
||||
)
|
||||
|
||||
self._folder_request_manager = RequestManager()
|
||||
rm.add_request("folder", RequestType(func=self._folder_request_manager))
|
||||
rm.add_request(
|
||||
"folder",
|
||||
RequestType(func=self._folder_request_manager, validator=self._folder_exists + self._folder_not_deleted),
|
||||
)
|
||||
|
||||
self._file_request_manager = RequestManager()
|
||||
rm.add_request("file", RequestType(func=self._file_request_manager))
|
||||
rm.add_request("file", RequestType(func=self._file_request_manager, validator=self._file_exists))
|
||||
|
||||
return rm
|
||||
|
||||
@@ -626,3 +635,62 @@ class FileSystem(SimComponent):
|
||||
self.sys_log.error(f"Unable to access file that does not exist. (file name: {file_name})")
|
||||
|
||||
return False
|
||||
|
||||
class _FolderExistsValidator(RequestPermissionValidator):
|
||||
"""
|
||||
When requests come in, this validator will only let them through if the Folder exists.
|
||||
|
||||
Actions cannot be performed on a non-existent folder.
|
||||
"""
|
||||
|
||||
file_system: FileSystem
|
||||
"""Save a reference to the FileSystem instance."""
|
||||
|
||||
def __call__(self, request: RequestFormat, context: Dict) -> bool:
|
||||
"""Returns True if folder exists."""
|
||||
return self.file_system.get_folder(folder_name=request[0]) is not None
|
||||
|
||||
@property
|
||||
def fail_message(self) -> str:
|
||||
"""Message that is reported when a request is rejected by this validator."""
|
||||
return "Cannot perform request on folder because it does not exist."
|
||||
|
||||
class _FolderNotDeletedValidator(RequestPermissionValidator):
|
||||
"""
|
||||
When requests come in, this validator will only let them through if the Folder has not been deleted.
|
||||
|
||||
Actions cannot be performed on a deleted folder.
|
||||
"""
|
||||
|
||||
file_system: FileSystem
|
||||
"""Save a reference to the FileSystem instance."""
|
||||
|
||||
def __call__(self, request: RequestFormat, context: Dict) -> bool:
|
||||
"""Returns True if folder exists and is not deleted."""
|
||||
# get folder
|
||||
folder = self.file_system.get_folder(folder_name=request[0], include_deleted=True)
|
||||
return folder is not None and not folder.deleted
|
||||
|
||||
@property
|
||||
def fail_message(self) -> str:
|
||||
"""Message that is reported when a request is rejected by this validator."""
|
||||
return "Cannot perform request on folder because it is deleted."
|
||||
|
||||
class _FileExistsValidator(RequestPermissionValidator):
|
||||
"""
|
||||
When requests come in, this validator will only let them through if the File exists.
|
||||
|
||||
Actions cannot be performed on a non-existent file.
|
||||
"""
|
||||
|
||||
file_system: FileSystem
|
||||
"""Save a reference to the FileSystem instance."""
|
||||
|
||||
def __call__(self, request: RequestFormat, context: Dict) -> bool:
|
||||
"""Returns True if file exists."""
|
||||
return self.file_system.get_file(folder_name=request[0], file_name=request[1]) is not None
|
||||
|
||||
@property
|
||||
def fail_message(self) -> str:
|
||||
"""Message that is reported when a request is rejected by this validator."""
|
||||
return "Cannot perform request on a file that does not exist."
|
||||
|
||||
@@ -6,8 +6,8 @@ from typing import Dict, Optional
|
||||
|
||||
from prettytable import MARKDOWN, PrettyTable
|
||||
|
||||
from primaite.interface.request import RequestResponse
|
||||
from primaite.simulator.core import RequestManager, RequestType
|
||||
from primaite.interface.request import RequestFormat, RequestResponse
|
||||
from primaite.simulator.core import RequestManager, RequestPermissionValidator, RequestType
|
||||
from primaite.simulator.file_system.file import File
|
||||
from primaite.simulator.file_system.file_system_item_abc import FileSystemItemABC, FileSystemItemHealthStatus
|
||||
|
||||
@@ -55,6 +55,9 @@ class Folder(FileSystemItemABC):
|
||||
|
||||
More information in user guide and docstring for SimComponent._init_request_manager.
|
||||
"""
|
||||
self._file_exists = Folder._FileExistsValidator(folder=self)
|
||||
self._file_not_deleted = Folder._FileNotDeletedValidator(folder=self)
|
||||
|
||||
rm = super()._init_request_manager()
|
||||
rm.add_request(
|
||||
name="delete",
|
||||
@@ -65,7 +68,9 @@ class Folder(FileSystemItemABC):
|
||||
self._file_request_manager = RequestManager()
|
||||
rm.add_request(
|
||||
name="file",
|
||||
request_type=RequestType(func=self._file_request_manager),
|
||||
request_type=RequestType(
|
||||
func=self._file_request_manager, validator=self._file_exists + self._file_not_deleted
|
||||
),
|
||||
)
|
||||
return rm
|
||||
|
||||
@@ -469,3 +474,42 @@ class Folder(FileSystemItemABC):
|
||||
|
||||
self.deleted = True
|
||||
return True
|
||||
|
||||
class _FileExistsValidator(RequestPermissionValidator):
|
||||
"""
|
||||
When requests come in, this validator will only let them through if the File exists.
|
||||
|
||||
Actions cannot be performed on a non-existent file.
|
||||
"""
|
||||
|
||||
folder: Folder
|
||||
"""Save a reference to the Folder instance."""
|
||||
|
||||
def __call__(self, request: RequestFormat, context: Dict) -> bool:
|
||||
"""Returns True if file exists."""
|
||||
return self.folder.get_file(file_name=request[0]) is not None
|
||||
|
||||
@property
|
||||
def fail_message(self) -> str:
|
||||
"""Message that is reported when a request is rejected by this validator."""
|
||||
return "Cannot perform request on a file that does not exist."
|
||||
|
||||
class _FileNotDeletedValidator(RequestPermissionValidator):
|
||||
"""
|
||||
When requests come in, this validator will only let them through if the File is not deleted.
|
||||
|
||||
Actions cannot be performed on a deleted file.
|
||||
"""
|
||||
|
||||
folder: Folder
|
||||
"""Save a reference to the Folder instance."""
|
||||
|
||||
def __call__(self, request: RequestFormat, context: Dict) -> bool:
|
||||
"""Returns True if file exists and is not deleted."""
|
||||
file = self.folder.get_file(file_name=request[0])
|
||||
return file is not None and not file.deleted
|
||||
|
||||
@property
|
||||
def fail_message(self) -> str:
|
||||
"""Message that is reported when a request is rejected by this validator."""
|
||||
return "Cannot perform request on a file that is deleted."
|
||||
|
||||
Reference in New Issue
Block a user