#1816 - Added the final pieces of the puzzle to get data up from NIC → session manager → software manager → service.

- Implemented a basic sim DB that matches UC2 data manipulation DB in IY.
- Added a test that confirms DB queries can be sent over the network.

src/primaite/simulator/system/core/packet_capture.py

@@ -1,7 +1,7 @@
 import json
 import logging
 from pathlib import Path
-from typing import Optional
+from typing import Any, Dict, List, Optional
 
 from primaite.simulator import SIM_OUTPUT
 
@@ -52,7 +52,12 @@ class PacketCapture:
 
         self.logger.addFilter(_JSONFilter())
 
-    def read(self):
+    def read(self) -> List[Dict[Any]]:
+        """
+        Read packet capture logs and return them as a list of dictionaries.
+
+        :return: List of frames captured, represented as dictionaries.
+        """
         frames = []
         with open(self._get_log_path(), "r") as file:
             while line := file.readline():

src/primaite/simulator/system/core/session_manager.py

@@ -38,9 +38,7 @@ class Session(SimComponent):
     connected: bool = False
 
     @classmethod
-    def from_session_key(
-            cls, session_key: Tuple[IPProtocol, IPv4Address, Optional[Port], Optional[Port]]
-    ) -> Session:
+    def from_session_key(cls, session_key: Tuple[IPProtocol, IPv4Address, Optional[Port], Optional[Port]]) -> Session:
         """
         Create a Session instance from a session key tuple.
 
@@ -97,7 +95,7 @@ class SessionManager:
 
     @staticmethod
     def _get_session_key(
-            frame: Frame, inbound_frame: bool = True
+        frame: Frame, inbound_frame: bool = True
     ) -> Tuple[IPProtocol, IPv4Address, Optional[Port], Optional[Port]]:
         """
         Extracts the session key from the given frame.
@@ -136,12 +134,12 @@ class SessionManager:
         return protocol, with_ip_address, src_port, dst_port
 
     def receive_payload_from_software_manager(
-            self,
-            payload: Any,
-            dst_ip_address: Optional[IPv4Address] = None,
-            dst_port: Optional[Port] = None,
-            session_id: Optional[str] = None,
-            is_reattempt: bool = False,
+        self,
+        payload: Any,
+        dst_ip_address: Optional[IPv4Address] = None,
+        dst_port: Optional[Port] = None,
+        session_id: Optional[str] = None,
+        is_reattempt: bool = False,
     ) -> Union[Any, None]:
         """
         Receive a payload from the SoftwareManager.
@@ -164,9 +162,12 @@ class SessionManager:
             if not is_reattempt:
                 self.arp_cache.send_arp_request(dst_ip_address)
                 return self.receive_payload_from_software_manager(
-                    payload=payload, dst_ip_address=dst_ip_address, dst_port=dst_port, session_id=session_id,
-                    is_reattempt=True
-                    )
+                    payload=payload,
+                    dst_ip_address=dst_ip_address,
+                    dst_port=dst_port,
+                    session_id=session_id,
+                    is_reattempt=True,
+                )
             else:
                 return
 

src/primaite/simulator/system/core/software_manager.py

@@ -7,7 +7,6 @@ from primaite.simulator.file_system.file_system import FileSystem
 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.session_manager import Session
 from primaite.simulator.system.core.sys_log import SysLog
 from primaite.simulator.system.services.service import Service
 from primaite.simulator.system.software import SoftwareType
@@ -100,7 +99,7 @@ class SoftwareManager:
         """
         self.session_manager.receive_payload_from_software_manager(
             payload=payload, dst_ip_address=dest_ip_address, dst_port=dest_port, session_id=session_id
-            )
+        )
 
     def receive_payload_from_session_manger(self, payload: Any, port: Port, protocol: IPProtocol, session_id: str):
         """

src/primaite/simulator/system/services/database.py

@@ -1,9 +1,9 @@
 import sqlite3
 from ipaddress import IPv4Address
 from sqlite3 import OperationalError
-from typing import Dict, Optional, Any, List, Union
+from typing import Any, Dict, List, Optional, Union
 
-from prettytable import PrettyTable, MARKDOWN
+from prettytable import MARKDOWN, PrettyTable
 
 from primaite.simulator.file_system.file_system import File
 from primaite.simulator.network.transmission.network_layer import IPProtocol
@@ -13,7 +13,12 @@ from primaite.simulator.system.services.service import Service
 
 
 class DatabaseService(Service):
-    """A generic SQL Server Service."""
+    """
+    A class for simulating a generic SQL Server service.
+
+    This class inherits from the `Service` class and provides methods to manage and query a SQLite database.
+    """
+
     backup_server: Optional[IPv4Address] = None
     "The IP Address of the server the "
 
@@ -28,12 +33,21 @@ class DatabaseService(Service):
         self._cursor = self._conn.cursor()
 
     def tables(self) -> List[str]:
+        """
+        Get a list of table names present in the database.
+
+        :return: List of table names.
+        """
         sql = "SELECT name FROM sqlite_master WHERE type='table' AND name != 'sqlite_sequence';"
         results = self._process_sql(sql)
         return [row[0] for row in results["data"]]
 
     def show(self, markdown: bool = False):
-        """Prints a Table names in the Database."""
+        """
+        Prints a list of table names in the database using PrettyTable.
+
+        :param markdown: Whether to output the table in Markdown format.
+        """
         table = PrettyTable(["Table"])
         if markdown:
             table.set_style(MARKDOWN)
@@ -44,10 +58,17 @@ class DatabaseService(Service):
         print(table)
 
     def _create_db_file(self):
+        """Creates the Simulation File and sqlite file in the file system."""
         self._db_file: File = self.file_system.create_file(folder_name="database", file_name="database.db", real=True)
         self.folder = self._db_file.folder
 
     def _process_sql(self, query: str) -> Dict[str, Union[int, List[Any]]]:
+        """
+        Executes the given SQL query and returns the result.
+
+        :param query: The SQL query to be executed.
+        :return: Dictionary containing status code and data fetched.
+        """
         try:
             self._cursor.execute(query)
             self._conn.commit()
@@ -69,11 +90,15 @@ class DatabaseService(Service):
         return super().describe_state()
 
     def receive(self, payload: Any, session_id: str, **kwargs) -> bool:
+        """
+        Processes the incoming SQL payload and sends the result back.
+
+        :param payload: The SQL query to be executed.
+        :param session_id: The session identifier.
+        :return: The status code of the SQL execution.
+        """
         result = self._process_sql(payload)
         software_manager: SoftwareManager = self.software_manager
         software_manager.send_payload_to_session_manager(payload=result, session_id=session_id)
 
-        return result["status_code"]
-
-    def send(self, payload: Any, session_id: str, **kwargs) -> bool:
-        pass
+        return result["status_code"] == 200