Make all requests return a RequestResponse

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

@@ -3,6 +3,7 @@ from typing import Any, Dict, Optional
 from uuid import uuid4
 
 from primaite import getLogger
+from primaite.interface.request import RequestResponse
 from primaite.simulator.core import RequestManager, RequestType
 from primaite.simulator.network.transmission.network_layer import IPProtocol
 from primaite.simulator.network.transmission.transport_layer import Port
@@ -37,7 +38,7 @@ class DatabaseClient(Application):
 
     def _init_request_manager(self) -> RequestManager:
         rm = super()._init_request_manager()
-        rm.add_request("execute", RequestType(func=lambda request, context: self.execute()))
+        rm.add_request("execute", RequestType(func=lambda request, context: RequestResponse.from_bool(self.execute())))
         return rm
 
     def execute(self) -> bool:

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

@@ -4,6 +4,7 @@ from typing import Dict, Optional
 
 from primaite import getLogger
 from primaite.game.science import simulate_trial
+from primaite.interface.request import RequestResponse
 from primaite.simulator.core import RequestManager, RequestType
 from primaite.simulator.network.transmission.network_layer import IPProtocol
 from primaite.simulator.network.transmission.transport_layer import Port
@@ -76,7 +77,10 @@ class DataManipulationBot(Application):
     def _init_request_manager(self) -> RequestManager:
         rm = super()._init_request_manager()
 
-        rm.add_request(name="execute", request_type=RequestType(func=lambda request, context: self.attack()))
+        rm.add_request(
+            name="execute",
+            request_type=RequestType(func=lambda request, context: RequestResponse.from_bool(self.attack())),
+        )
 
         return rm
 
@@ -179,21 +183,21 @@ class DataManipulationBot(Application):
         """
         super().run()
 
-    def attack(self):
+    def attack(self) -> bool:
         """Perform the attack steps after opening the application."""
         if not self._can_perform_action():
             _LOGGER.debug("Data manipulation application attempted to execute but it cannot perform actions right now.")
             self.run()
-        self._application_loop()
+        return self._application_loop()
 
-    def _application_loop(self):
+    def _application_loop(self) -> bool:
         """
         The main application loop of the bot, handling the attack process.
 
         This is the core loop where the bot sequentially goes through the stages of the attack.
         """
         if not self._can_perform_action():
-            return
+            return False
         if self.server_ip_address and self.payload:
             self.sys_log.info(f"{self.name}: Running")
             self._logon()
@@ -205,8 +209,12 @@ class DataManipulationBot(Application):
                 DataManipulationAttackStage.FAILED,
             ):
                 self.attack_stage = DataManipulationAttackStage.NOT_STARTED
+
+            return True
+
         else:
             self.sys_log.error(f"{self.name}: Failed to start as it requires both a target_ip_address and payload.")
+            return False
 
     def apply_timestep(self, timestep: int) -> None:
         """

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

@@ -4,6 +4,7 @@ from typing import Optional
 
 from primaite import getLogger
 from primaite.game.science import simulate_trial
+from primaite.interface.request import RequestResponse
 from primaite.simulator.core import RequestManager, RequestType
 from primaite.simulator.network.transmission.transport_layer import Port
 from primaite.simulator.system.applications.database_client import DatabaseClient
@@ -59,7 +60,10 @@ class DoSBot(DatabaseClient):
     def _init_request_manager(self) -> RequestManager:
         rm = super()._init_request_manager()
 
-        rm.add_request(name="execute", request_type=RequestType(func=lambda request, context: self.run()))
+        rm.add_request(
+            name="execute",
+            request_type=RequestType(func=lambda request, context: RequestResponse.from_bool(self.run())),
+        )
 
         return rm
 
@@ -97,26 +101,26 @@ class DoSBot(DatabaseClient):
             f"{repeat=}, {port_scan_p_of_success=}, {dos_intensity=}, {max_sessions=}."
         )
 
-    def run(self):
+    def run(self) -> bool:
         """Run the Denial of Service Bot."""
         super().run()
-        self._application_loop()
+        return self._application_loop()
 
-    def _application_loop(self):
+    def _application_loop(self) -> bool:
         """
         The main application loop for the Denial of Service bot.
 
         The loop goes through the stages of a DoS attack.
         """
         if not self._can_perform_action():
-            return
+            return False
 
         # DoS bot cannot do anything without a target
         if not self.target_ip_address or not self.target_port:
             self.sys_log.error(
                 f"{self.name} is not properly configured. {self.target_ip_address=}, {self.target_port=}"
             )
-            return
+            return True
 
         self.clear_connections()
         self._perform_port_scan(p_of_success=self.port_scan_p_of_success)
@@ -126,6 +130,7 @@ class DoSBot(DatabaseClient):
             self.attack_stage = DoSAttackStage.NOT_STARTED
         else:
             self.attack_stage = DoSAttackStage.COMPLETED
+        return True
 
     def _perform_port_scan(self, p_of_success: Optional[float] = 0.1):
         """

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

@@ -6,6 +6,7 @@ from urllib.parse import urlparse
 from pydantic import BaseModel, ConfigDict
 
 from primaite import getLogger
+from primaite.interface.request import RequestResponse
 from primaite.simulator.core import RequestManager, RequestType
 from primaite.simulator.network.protocols.http import (
     HttpRequestMethod,
@@ -52,7 +53,10 @@ class WebBrowser(Application):
     def _init_request_manager(self) -> RequestManager:
         rm = super()._init_request_manager()
         rm.add_request(
-            name="execute", request_type=RequestType(func=lambda request, context: self.get_webpage())  # noqa
+            name="execute",
+            request_type=RequestType(
+                func=lambda request, context: RequestResponse.from_bool(self.get_webpage())
+            ),  # noqa
         )
 
         return rm