p15670423
/
monkey
1
0
Fork 5
Code Issues Pull Requests 3 Projects Releases Wiki Activity

Island: Fix tenses in repository docstrings

This commit is contained in:
Mike Salvatore 2022-09-22 10:04:56 -04:00
parent 92dd564299
commit f7997a6a50
3 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
monkey/monkey_island/cc/repository/i_agent_repository.py
View File

@ -16,7 +16,7 @@ class IAgentRepository(ABC):
already exists, update it.
:param agent: The `agent` to be inserted or updated
:raises StorageError: If an error occurred while attempting to store the `Agent`
:raises StorageError: If an error occurs while attempting to store the `Agent`
"""
@abstractmethod
@ -28,7 +28,7 @@ class IAgentRepository(ABC):
:return: An `Agent` with a matching `id`
:raises UnknownRecordError: If an `Agent` with the specified `id` does not exist in the
repository
:raises RetrievalError: If an error occurred while attempting to retrieve the `Agent`
:raises RetrievalError: If an error occurs while attempting to retrieve the `Agent`
"""
@abstractmethod
@ -37,7 +37,7 @@ class IAgentRepository(ABC):
Get all `Agents` that are currently running
:return: All `Agents` that are currently running
:raises RetrievalError: If an error occurred while attempting to retrieve the `Agents`
:raises RetrievalError: If an error occurs while attempting to retrieve the `Agents`
"""
@abstractmethod
@ -47,7 +47,7 @@ class IAgentRepository(ABC):
:param agent: The Agent for which we want the progenitor
:return: `Agent` progenitor ( an initial agent that started the exploitation chain)
:raises RetrievalError: If an error occured while attempting to retrieve the `Agent`
:raises RetrievalError: If an error occurrs while attempting to retrieve the `Agent`
:raises UnknownRecordError: If the agent ID is not in the repository
"""

10
monkey/monkey_island/cc/repository/i_machine_repository.py
View File

@ -26,7 +26,7 @@ class IMachineRepository(ABC):
`Machine` already exists, update it.
:param machine: The `Machine` to be inserted or updated
:raises StorageError: If an error occurred while attempting to store the `Machine`
:raises StorageError: If an error occurs while attempting to store the `Machine`
"""
@abstractmethod
@ -38,7 +38,7 @@ class IMachineRepository(ABC):
:return: A `Machine` with a matching `id`
:raises UnknownRecordError: If a `Machine` with the specified `id` does not exist in the
repository
:raises RetrievalError: If an error occurred while attempting to retrieve the `Machine`
:raises RetrievalError: If an error occurs while attempting to retrieve the `Machine`
"""
@abstractmethod
@ -50,7 +50,7 @@ class IMachineRepository(ABC):
:return: A `Machine` with a matching `hardware_id`
:raises UnknownRecordError: If a `Machine` with the specified `hardware_id` does not exist
in the repository
:raises RetrievalError: If an error occurred while attempting to retrieve the `Machine`
:raises RetrievalError: If an error occurs while attempting to retrieve the `Machine`
"""
@abstractmethod
@ -62,7 +62,7 @@ class IMachineRepository(ABC):
:return: A sequence of Machines that have a network interface with a matching IP
:raises UnknownRecordError: If a `Machine` with the specified `ip` does not exist in the
repository
:raises RetrievalError: If an error occurred while attempting to retrieve the `Machine`
:raises RetrievalError: If an error occurs while attempting to retrieve the `Machine`
"""
@abstractmethod
@ -70,6 +70,6 @@ class IMachineRepository(ABC):
"""
Removes all data from the repository
:raises RemovalError: If an error occurred while attempting to remove all `Machines` from
:raises RemovalError: If an error occurs while attempting to remove all `Machines` from
the repository
"""

6
monkey/monkey_island/cc/repository/i_node_repository.py
View File

@ -22,7 +22,7 @@ class INodeRepository(ABC):
:param src: The machine that the connection or communication originated from
:param dst: The machine that the src communicated with
:param communication_type: The way the machines communicated
:raises StorageError: If an error occurred while attempting to upsert the Node
:raises StorageError: If an error occurs while attempting to upsert the Node
"""
@abstractmethod
@ -31,7 +31,7 @@ class INodeRepository(ABC):
Return all nodes that are stored in the repository
:return: All known Nodes
:raises RetrievalError: If an error occurred while attempting to retrieve the nodes
:raises RetrievalError: If an error occurs while attempting to retrieve the nodes
"""
@abstractmethod
@ -39,6 +39,6 @@ class INodeRepository(ABC):
"""
Removes all data from the repository
:raises RemovalError: If an error occurred while attempting to remove all `Nodes` from the
:raises RemovalError: If an error occurs while attempting to remove all `Nodes` from the
repository
"""