#2064: added a method that checks if the class can perform actions and added it where necessary + tests everywhere

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

@@ -2,9 +2,11 @@ from abc import abstractmethod
 from enum import Enum
 from typing import Any, Dict, Set
 
-from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState
+from primaite import getLogger
 from primaite.simulator.system.software import IOSoftware, SoftwareHealthState
 
+_LOGGER = getLogger(__name__)
+
 
 class ApplicationOperatingState(Enum):
     """Enumeration of Application Operating States."""
@@ -52,7 +54,7 @@ class Application(IOSoftware):
         state = super().describe_state()
         state.update(
             {
-                "opearting_state": self.operating_state.value,
+                "operating_state": self.operating_state.value,
                 "execution_control_status": self.execution_control_status,
                 "num_executions": self.num_executions,
                 "groups": list(self.groups),
@@ -60,10 +62,28 @@ class Application(IOSoftware):
         )
         return state
 
+    def _can_perform_action(self) -> bool:
+        """
+        Checks if the application can perform actions.
+
+        This is done by checking if the application is operating properly or the node it is installed
+        in is operational.
+
+        Returns true if the software can perform actions.
+        """
+        if not super()._can_perform_action():
+            return False
+
+        if self.operating_state is not self.operating_state.RUNNING:
+            # service is not running
+            _LOGGER.error(f"Cannot perform action: {self.name} is {self.operating_state.name}")
+            return False
+
+        return True
+
     def run(self) -> None:
         """Open the Application."""
-        if self.software_manager and self.software_manager.node.operating_state is not NodeOperatingState.ON:
-            self.sys_log.error(f"Unable to run application. {self.software_manager.node.hostname} is not turned on.")
+        if not super()._can_perform_action():
             return
 
         if self.operating_state == ApplicationOperatingState.CLOSED:
@@ -78,6 +98,9 @@ class Application(IOSoftware):
 
     def install(self) -> None:
         """Install Application."""
+        if self._can_perform_action():
+            return
+
         super().install()
         if self.operating_state == ApplicationOperatingState.CLOSED:
             self.sys_log.info(f"Installing Application {self.name}")
@@ -102,4 +125,4 @@ class Application(IOSoftware):
         :param payload: The payload to receive.
         :return: True if successful, False otherwise.
         """
-        pass
+        return super().receive(payload=payload, session_id=session_id, **kwargs)

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

@@ -54,7 +54,10 @@ class DatabaseClient(Application):
 
     def connect(self) -> bool:
         """Connect to a Database Service."""
-        if not self.connected and self.operating_state.RUNNING:
+        if not self._can_perform_action():
+            return False
+
+        if not self.connected:
             return self._connect(self.server_ip_address, self.server_password)
         return False
 
@@ -135,19 +138,31 @@ class DatabaseClient(Application):
         self.operating_state = ApplicationOperatingState.RUNNING
         self.connect()
 
-    def query(self, sql: str) -> bool:
+    def query(self, sql: str, is_reattempt: bool = False) -> bool:
         """
         Send a query to the Database Service.
 
-        :param sql: The SQL query.
+        :param: sql: The SQL query.
+        :param: is_reattempt: If true, the action has been reattempted.
         :return: True if the query was successful, otherwise False.
         """
-        if self.connected and self.operating_state.RUNNING:
+        if not self._can_perform_action():
+            return False
+
+        if self.connected:
             query_id = str(uuid4())
 
             # Initialise the tracker of this ID to False
             self._query_success_tracker[query_id] = False
             return self._query(sql=sql, query_id=query_id)
+        else:
+            if is_reattempt:
+                return False
+
+            if not self.connect():
+                return False
+
+            self.query(sql=sql, is_reattempt=True)
 
     def receive(self, payload: Any, session_id: str, **kwargs) -> bool:
         """

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

@@ -65,6 +65,9 @@ class WebBrowser(Application):
         :param: url: The address of the web page the browser requests
         :type: url: str
         """
+        if not self._can_perform_action():
+            return False
+
         # reset latest response
         self.latest_response = HttpResponsePacket(status_code=HttpStatusCode.NOT_FOUND)