Merge remote-tracking branch 'origin/dev' into feature/2327-green-action-failure-part-II

src/primaite/simulator/domain/controller.py

@@ -80,6 +80,11 @@ class DomainController(SimComponent):
         super().__init__(**kwargs)
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
         # Action 'account' matches requests like:
         # ['account', '<account-uuid>', *account_action]

src/primaite/simulator/file_system/file_system.py

@@ -36,6 +36,11 @@ class FileSystem(SimComponent):
             self.create_folder("root")
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
 
         self._delete_manager = RequestManager()

src/primaite/simulator/file_system/file_system_item_abc.py

@@ -101,6 +101,11 @@ class FileSystemItemABC(SimComponent):
         return state
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
 
         rm.add_request(

src/primaite/simulator/file_system/folder.py

@@ -51,6 +51,11 @@ class Folder(FileSystemItemABC):
         self.sys_log.info(f"Created file /{self.name} (id: {self.uuid})")
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
         rm.add_request(
             name="delete",

src/primaite/simulator/network/container.py

@@ -61,6 +61,11 @@ class Network(SimComponent):
                     software.run()
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
         self._node_request_manager = RequestManager()
         rm.add_request(

src/primaite/simulator/network/hardware/base.py

@@ -114,6 +114,11 @@ class NetworkInterface(SimComponent, ABC):
         self.enable()
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
 
         rm.add_request("enable", RequestType(func=lambda request, context: RequestResponse.from_bool(self.enable())))
@@ -786,6 +791,11 @@ class Node(SimComponent):
             return self.node.operating_state == NodeOperatingState.ON
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         _node_is_on = Node._NodeIsOnValidator(node=self)
 
         rm = super()._init_request_manager()

src/primaite/simulator/network/hardware/nodes/network/router.py

@@ -294,6 +294,11 @@ class AccessControlList(SimComponent):
         self._acl = [None] * (self.max_acl_rules - 1)
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         # TODO: Add src and dst wildcard masks as positional args in this request.
         rm = super()._init_request_manager()
 
@@ -1092,6 +1097,11 @@ class Router(NetworkNode):
         super().setup_for_episode(episode=episode)
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
         rm.add_request("acl", RequestType(func=self.acl._request_manager))
         return rm

src/primaite/simulator/sim_container.py

@@ -27,6 +27,11 @@ class Simulation(SimComponent):
         self.network.setup_for_episode(episode=episode)
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
         # pass through network requests to the network objects
         rm.add_request("network", RequestType(func=self.network._request_manager))

src/primaite/simulator/system/applications/database_client.py

@@ -37,6 +37,11 @@ class DatabaseClient(Application):
         super().__init__(**kwargs)
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
         rm.add_request("execute", RequestType(func=lambda request, context: RequestResponse.from_bool(self.execute())))
         return rm

src/primaite/simulator/system/applications/red_applications/data_manipulation_bot.py

@@ -75,6 +75,11 @@ class DataManipulationBot(Application):
         return db_client
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
 
         rm.add_request(

src/primaite/simulator/system/applications/red_applications/dos_bot.py

@@ -58,6 +58,11 @@ class DoSBot(DatabaseClient):
         self.max_sessions = 1000  # override normal max sessions
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
 
         rm.add_request(

src/primaite/simulator/system/applications/web_browser.py

@@ -51,6 +51,11 @@ class WebBrowser(Application):
         self.run()
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
         rm.add_request(
             name="execute",

src/primaite/simulator/system/services/service.py

@@ -80,6 +80,11 @@ class Service(IOSoftware):
         return super().receive(payload=payload, session_id=session_id, **kwargs)
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
         rm.add_request("scan", RequestType(func=lambda request, context: RequestResponse.from_bool(self.scan())))
         rm.add_request("stop", RequestType(func=lambda request, context: RequestResponse.from_bool(self.stop())))

src/primaite/simulator/system/software.py

@@ -102,6 +102,11 @@ class Software(SimComponent):
     "Current number of ticks left to patch the software."
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
         rm.add_request(
             "compromise",