Add helpful error messages to action index errors

src/primaite/game/agent/actions.py

@@ -812,6 +812,13 @@ class ActionManager:
         :return: The node hostname.
         :rtype: str
         """
+        if not node_idx < len(self.node_names):
+            msg = (
+                f"Error: agent attempted to perform an action on node {node_idx}, but its action space only"
+                f"has {len(self.node_names)} nodes."
+            )
+            _LOGGER.error(msg)
+            raise RuntimeError(msg)
         return self.node_names[node_idx]
 
     def get_folder_name_by_idx(self, node_idx: int, folder_idx: int) -> Optional[str]:
@@ -825,6 +832,13 @@ class ActionManager:
         :return: The name of the folder. Or None if the node has fewer folders than the given index.
         :rtype: Optional[str]
         """
+        if node_idx >= len(self.folder_names) or folder_idx >= len(self.folder_names[node_idx]):
+            msg = (
+                f"Error: agent attempted to perform an action on node {node_idx} and folder {folder_idx}, but this"
+                f" is out of range for its action space.   Folder on each node:  {self.folder_names}"
+            )
+            _LOGGER.error(msg)
+            raise RuntimeError(msg)
         return self.folder_names[node_idx][folder_idx]
 
     def get_file_name_by_idx(self, node_idx: int, folder_idx: int, file_idx: int) -> Optional[str]:
@@ -840,6 +854,17 @@ class ActionManager:
             fewer files than the given index.
         :rtype: Optional[str]
         """
+        if (
+            node_idx >= len(self.file_names)
+            or folder_idx >= len(self.file_names[node_idx])
+            or file_idx >= len(self.file_names[node_idx][folder_idx])
+        ):
+            msg = (
+                f"Error: agent attempted to perform an action on node {node_idx} folder {folder_idx} file {file_idx}"
+                f" but this is out of range for its action space.   Files on each node:  {self.file_names}"
+            )
+            _LOGGER.error(msg)
+            raise RuntimeError(msg)
         return self.file_names[node_idx][folder_idx][file_idx]
 
     def get_service_name_by_idx(self, node_idx: int, service_idx: int) -> Optional[str]:
@@ -852,6 +877,13 @@ class ActionManager:
         :return: The name of the service. Or None if the node has fewer services than the given index.
         :rtype: Optional[str]
         """
+        if node_idx >= len(self.service_names) or service_idx >= len(self.service_names[node_idx]):
+            msg = (
+                f"Error: agent attempted to perform an action on node {node_idx} and service {service_idx}, but this"
+                f" is out of range for its action space.   Services on each node:  {self.service_names}"
+            )
+            _LOGGER.error(msg)
+            raise RuntimeError(msg)
         return self.service_names[node_idx][service_idx]
 
     def get_application_name_by_idx(self, node_idx: int, application_idx: int) -> Optional[str]:
@@ -864,6 +896,13 @@ class ActionManager:
         :return: The name of the service. Or None if the node has fewer services than the given index.
         :rtype: Optional[str]
         """
+        if node_idx >= len(self.application_names) or application_idx >= len(self.application_names[node_idx]):
+            msg = (
+                f"Error: agent attempted to perform an action on node {node_idx} and app {application_idx}, but "
+                f"this is out of range for its action space.   Applications on each node:  {self.application_names}"
+            )
+            _LOGGER.error(msg)
+            raise RuntimeError(msg)
         return self.application_names[node_idx][application_idx]
 
     def get_internet_protocol_by_idx(self, protocol_idx: int) -> str:
@@ -874,6 +913,13 @@ class ActionManager:
         :return: The protocol.
         :rtype: str
         """
+        if protocol_idx >= len(self.protocols):
+            msg = (
+                f"Error: agent attempted to perform an action on protocol {protocol_idx} but this"
+                f" is out of range for its action space.   Protocols:  {self.protocols}"
+            )
+            _LOGGER.error(msg)
+            raise RuntimeError(msg)
         return self.protocols[protocol_idx]
 
     def get_ip_address_by_idx(self, ip_idx: int) -> str:
@@ -885,6 +931,13 @@ class ActionManager:
         :return: The IP address.
         :rtype: str
         """
+        if ip_idx >= len(self.ip_address_list):
+            msg = (
+                f"Error: agent attempted to perform an action on ip address {ip_idx} but this"
+                f" is out of range for its action space.   IP address list:  {self.ip_address_list}"
+            )
+            _LOGGER.error(msg)
+            raise RuntimeError(msg)
         return self.ip_address_list[ip_idx]
 
     def get_port_by_idx(self, port_idx: int) -> str:
@@ -896,6 +949,13 @@ class ActionManager:
         :return: The port.
         :rtype: str
         """
+        if port_idx >= len(self.ports):
+            msg = (
+                f"Error: agent attempted to perform an action on port {port_idx} but this"
+                f" is out of range for its action space.   Port list:  {self.ip_address_list}"
+            )
+            _LOGGER.error(msg)
+            raise RuntimeError(msg)
         return self.ports[port_idx]
 
     def get_nic_num_by_idx(self, node_idx: int, nic_idx: int) -> int: