Merge branch 'feature/1816_Database-Service-(Network-and-User-Interaction)' into feature/1752-dns-server-and-client

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

@@ -23,9 +23,9 @@ class Application(IOSoftware):
     Applications are user-facing programs that may perform input/output operations.
     """
 
-    operating_state: ApplicationOperatingState
+    operating_state: ApplicationOperatingState = ApplicationOperatingState.CLOSED
     "The current operating state of the Application."
-    execution_control_status: str
+    execution_control_status: str = "manual"
     "Control status of the application's execution. It could be 'manual' or 'automatic'."
     num_executions: int = 0
     "The number of times the application has been executed. Default is 0."
@@ -53,6 +53,25 @@ class Application(IOSoftware):
         )
         return state
 
+    def run(self) -> None:
+        """Open the Application"""
+        if self.operating_state == ApplicationOperatingState.CLOSED:
+            self.sys_log.info(f"Running Application {self.name}")
+            self.operating_state = ApplicationOperatingState.RUNNING
+
+    def close(self) -> None:
+        """Close the Application"""
+        if self.operating_state == ApplicationOperatingState.RUNNING:
+            self.sys_log.info(f"Closed Application{self.name}")
+            self.operating_state = ApplicationOperatingState.CLOSED
+
+    def install(self) -> None:
+        """Install Application."""
+        super().install()
+        if self.operating_state == ApplicationOperatingState.CLOSED:
+            self.sys_log.info(f"Installing Application {self.name}")
+            self.operating_state = ApplicationOperatingState.INSTALLING
+
     def reset_component_for_episode(self, episode: int):
         """
         Resets the Application component for a new episode.

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

@@ -0,0 +1,83 @@
+from ipaddress import IPv4Address
+from typing import Any, Dict, Optional
+
+from prettytable import PrettyTable
+
+from primaite.simulator.network.transmission.network_layer import IPProtocol
+from primaite.simulator.network.transmission.transport_layer import Port
+from primaite.simulator.system.applications.application import Application
+from primaite.simulator.system.core.software_manager import SoftwareManager
+
+
+class DatabaseClient(Application):
+    server_ip_address: Optional[IPv4Address] = None
+    connected: bool = False
+
+    def __init__(self, **kwargs):
+        kwargs["name"] = "DatabaseClient"
+        kwargs["port"] = Port.POSTGRES_SERVER
+        kwargs["protocol"] = IPProtocol.TCP
+        super().__init__(**kwargs)
+
+    def describe_state(self) -> Dict:
+        return super().describe_state()
+
+    def connect(self, server_ip_address: IPv4Address, password: Optional[str] = None) -> bool:
+        if not self.connected and self.operating_state.RUNNING:
+            return self._connect(server_ip_address, password)
+
+    def _connect(
+        self, server_ip_address: IPv4Address, password: Optional[str] = None, is_reattempt: bool = False
+    ) -> bool:
+        if is_reattempt:
+            if self.connected:
+                self.sys_log.info(f"DatabaseClient connected to {server_ip_address} authorised")
+                self.server_ip_address = server_ip_address
+                return self.connected
+            else:
+                self.sys_log.info(f"DatabaseClient connected to {server_ip_address} declined")
+        payload = {"type": "connect_request", "password": password}
+        software_manager: SoftwareManager = self.software_manager
+        software_manager.send_payload_to_session_manager(
+            payload=payload, dest_ip_address=server_ip_address, dest_port=self.port
+        )
+        return self._connect(server_ip_address, password, True)
+
+    def disconnect(self):
+        if self.connected and self.operating_state.RUNNING:
+            software_manager: SoftwareManager = self.software_manager
+            software_manager.send_payload_to_session_manager(
+                payload={"type": "disconnect"}, dest_ip_address=self.server_ip_address, dest_port=self.port
+            )
+
+            self.sys_log.info(f"DatabaseClient disconnected from {self.server_ip_address}")
+            self.server_ip_address = None
+
+    def query(self, sql: str):
+        if self.connected and self.operating_state.RUNNING:
+            software_manager: SoftwareManager = self.software_manager
+            software_manager.send_payload_to_session_manager(
+                payload={"type": "sql", "sql": sql}, dest_ip_address=self.server_ip_address, dest_port=self.port
+            )
+
+    def _print_data(self, data: Dict):
+        """
+        Display the contents of the Folder in tabular format.
+
+        :param markdown: Whether to display the table in Markdown format or not. Default is `False`.
+        """
+        table = PrettyTable(list(data.values())[0])
+
+        table.align = "l"
+        table.title = f"{self.sys_log.hostname} Database Client"
+        for row in data.values():
+            table.add_row(row.values())
+        print(table)
+
+    def receive(self, payload: Any, session_id: str, **kwargs) -> bool:
+        if isinstance(payload, dict) and payload.get("type"):
+            if payload["type"] == "connect_response":
+                self.connected = payload["response"] == True
+            elif payload["type"] == "sql":
+                self._print_data(payload["data"])
+        return True