From f7997a6a509f4db335bfd93a3fc7771ede63e0a7 Mon Sep 17 00:00:00 2001 From: Mike Salvatore Date: Thu, 22 Sep 2022 10:04:56 -0400 Subject: [PATCH] Island: Fix tenses in repository docstrings --- .../monkey_island/cc/repository/i_agent_repository.py | 8 ++++---- .../cc/repository/i_machine_repository.py | 10 +++++----- .../monkey_island/cc/repository/i_node_repository.py | 6 +++--- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/monkey/monkey_island/cc/repository/i_agent_repository.py b/monkey/monkey_island/cc/repository/i_agent_repository.py index ae12e8eea..619738ab5 100644 --- a/monkey/monkey_island/cc/repository/i_agent_repository.py +++ b/monkey/monkey_island/cc/repository/i_agent_repository.py @@ -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 """ diff --git a/monkey/monkey_island/cc/repository/i_machine_repository.py b/monkey/monkey_island/cc/repository/i_machine_repository.py index d60346eb2..85e8e71f3 100644 --- a/monkey/monkey_island/cc/repository/i_machine_repository.py +++ b/monkey/monkey_island/cc/repository/i_machine_repository.py @@ -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 """ diff --git a/monkey/monkey_island/cc/repository/i_node_repository.py b/monkey/monkey_island/cc/repository/i_node_repository.py index d848d58fe..53fc53bc9 100644 --- a/monkey/monkey_island/cc/repository/i_node_repository.py +++ b/monkey/monkey_island/cc/repository/i_node_repository.py @@ -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 """