#2869 - Commit before changing branches. Addition of properties to Agent classes and removal of if/else chain in game.py

src/primaite/game/agent/scripted_agents/data_manipulation_bot.py

@@ -10,9 +10,6 @@ from primaite.game.agent.interface import AbstractScriptedAgent
 class DataManipulationAgent(AbstractScriptedAgent, identifier="Data_Manipulation_Agent"):
     """Agent that uses a DataManipulationBot to perform an SQL injection attack."""
 
-    next_execution_timestep: int = 0
-    starting_node_idx: int = 0
-
     config: "DataManipulationAgent.ConfigSchema"
 
     class ConfigSchema(AbstractScriptedAgent.ConfigSchema):
@@ -27,13 +24,23 @@ class DataManipulationAgent(AbstractScriptedAgent, identifier="Data_Manipulation
         super().__init__(*args, **kwargs)
         self.setup_agent()
 
+    @property
+    def next_execution_timestep(self):
+        """Returns the agents next execution timestep."""
+        return self.config.next_execution_timestep
+
+    @property
+    def starting_node_name(self):
+        """Returns the agents starting node name."""
+        return self.config.starting_node_name
+
     def _set_next_execution_timestep(self, timestep: int) -> None:
         """Set the next execution timestep with a configured random variance.
 
         :param timestep: The timestep to add variance to.
         """
         random_timestep_increment = random.randint(
-            -self.agent_settings.start_settings.variance, self.agent_settings.start_settings.variance
+            -self.config.agent_settings.start_settings.variance, self.config.agent_settings.start_settings.variance
         )
         self.next_execution_timestep = timestep + random_timestep_increment
 
@@ -48,11 +55,11 @@ class DataManipulationAgent(AbstractScriptedAgent, identifier="Data_Manipulation
         :rtype: Tuple[str, Dict]
         """
         if timestep < self.next_execution_timestep:
-            self.logger.debug(msg="Performing do nothing action")
+            self.config.logger.debug(msg="Performing do nothing action")
             return "do_nothing", {}
 
-        self._set_next_execution_timestep(timestep + self.agent_settings.start_settings.frequency)
-        self.logger.info(msg="Performing a data manipulation attack!")
+        self._set_next_execution_timestep(timestep + self.config.agent_settings.start_settings.frequency)
+        self.config.logger.info(msg="Performing a data manipulation attack!")
         return "node_application_execute", {
             "node_name": self.config.starting_node_name,
             "application_name": self.config.starting_application_name,
@@ -68,4 +75,4 @@ class DataManipulationAgent(AbstractScriptedAgent, identifier="Data_Manipulation
         # we are assuming that every node in the node manager has a data manipulation application at idx 0
         num_nodes = len(self.action_manager.node_names)
         self.starting_node_idx = random.randint(0, num_nodes - 1)
-        self.logger.debug(msg=f"Select Start Node ID: {self.starting_node_idx}")
+        self.config.logger.debug(msg=f"Select Start Node ID: {self.starting_node_idx}")