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

Agent: Modify docstrings in IIslandAPIClient

This commit is contained in:
Shreya Malviya 2022-09-20 12:35:21 +05:30
parent 1b4f834f46
commit 1480203627
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
monkey/infection_monkey/island_api_client/i_island_api_client.py
View File

@ -9,10 +9,14 @@ class IIslandAPIClient(ABC):
@abstractmethod
def __init__(self, island_server: str):
"""
Construct and island API client and connect it to the island
Construct an island API client and connect it to the island
:param island_server: The socket address of the API
:raises IslandAPIConnectionError: If the client cannot successfully connect to the island
:raises IslandAPIRequestError: If an error occurs while attempting to connect to the
island due to an issue in the request sent from the client
:raises IslandAPIRequestFailedError: If an error occurs while attempting to connect to the
island due to an error on the server
:raises IslandAPITimeoutError: If a timeout occurs while attempting to connect to the island
:raises IslandAPIError: If an unexpected error occurs while attempting to connect to the
island
@ -24,10 +28,13 @@ class IIslandAPIClient(ABC):
Send the contents of the agent's log to the island
:param log_contents: The contents of the agent's log
:raises IslandAPIConnectionError: If a connection cannot be made to the island
:raises IslandAPIConnectionError: If the client cannot successfully connect to the island
:raises IslandAPIRequestError: If an error occurs while attempting to connect to the
island due to an issue in the request sent from the client
:raises IslandAPIRequestFailedError: If an error occurs while attempting to connect to the
island due to an error on the server
:raises IslandAPITimeoutError: If a timeout occurs while attempting to connect to the island
or send the log contents
:raises IslandAPIError: If an unexpected error occurred while attempting to send the
:raises IslandAPIError: If an unexpected error occurs while attempting to send the
contents of the agent's log to the island
"""
@ -38,9 +45,12 @@ class IIslandAPIClient(ABC):
:param filename: The name of the custom PBA file
:return: The contents of the custom PBA file in bytes
:raises IslandAPIConnectionError: If a connection cannot be made to the island
:raises IslandAPIConnectionError: If the client cannot successfully connect to the island
:raises IslandAPIRequestError: If an error occurs while attempting to connect to the
island due to an issue in the request sent from the client
:raises IslandAPIRequestFailedError: If an error occurs while attempting to connect to the
island due to an error on the server
:raises IslandAPITimeoutError: If a timeout occurs while attempting to connect to the island
or retrieve the custom PBA file
:raises IslandAPIError: If an unexpected error occurred while attempting to retrieve the
:raises IslandAPIError: If an unexpected error occurs while attempting to retrieve the
custom PBA file
"""