Merge remote-tracking branch 'origin/dev' into feature/1972-remove-sqlite

src/primaite/simulator/__init__.py

@@ -1,14 +1,26 @@
+"""Warning: SIM_OUTPUT is a mutable global variable for the simulation output directory."""
 from datetime import datetime
+from pathlib import Path
 
 from primaite import _PRIMAITE_ROOT
 
-SIM_OUTPUT = None
-"A path at the repo root dir to use temporarily for sim output testing while in dev."
-# TODO: Remove once we integrate the simulation into PrimAITE and it uses the primaite session path
+__all__ = ["SIM_OUTPUT"]
 
-if not SIM_OUTPUT:
-    session_timestamp = datetime.now()
-    date_dir = session_timestamp.strftime("%Y-%m-%d")
-    sim_path = session_timestamp.strftime("%Y-%m-%d_%H-%M-%S")
-    SIM_OUTPUT = _PRIMAITE_ROOT.parent.parent / "simulation_output" / date_dir / sim_path
-    SIM_OUTPUT.mkdir(exist_ok=True, parents=True)
+
+class __SimOutput:
+    def __init__(self):
+        self._path: Path = (
+            _PRIMAITE_ROOT.parent.parent / "simulation_output" / datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+        )
+
+    @property
+    def path(self) -> Path:
+        return self._path
+
+    @path.setter
+    def path(self, new_path: Path) -> None:
+        self._path = new_path
+        self._path.mkdir(exist_ok=True, parents=True)
+
+
+SIM_OUTPUT = __SimOutput()

src/primaite/simulator/network/hardware/base.py

@@ -957,7 +957,7 @@ class Node(SimComponent):
         if not kwargs.get("session_manager"):
             kwargs["session_manager"] = SessionManager(sys_log=kwargs.get("sys_log"), arp_cache=kwargs.get("arp"))
         if not kwargs.get("root"):
-            kwargs["root"] = SIM_OUTPUT / kwargs["hostname"]
+            kwargs["root"] = SIM_OUTPUT.path / kwargs["hostname"]
         if not kwargs.get("file_system"):
             kwargs["file_system"] = FileSystem(sys_log=kwargs["sys_log"], sim_root=kwargs["root"] / "fs")
         if not kwargs.get("software_manager"):

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

@@ -75,7 +75,7 @@ class PacketCapture:
 
     def _get_log_path(self) -> Path:
         """Get the path for the log file."""
-        root = SIM_OUTPUT / self.hostname
+        root = SIM_OUTPUT.path / self.hostname
         root.mkdir(exist_ok=True, parents=True)
         return root / f"{self._logger_name}.log"
 

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

@@ -41,7 +41,6 @@ class SysLog:
         JSON-like messages.
         """
         log_path = self._get_log_path()
-
         file_handler = logging.FileHandler(filename=log_path)
         file_handler.setLevel(logging.DEBUG)
 
@@ -81,7 +80,7 @@ class SysLog:
 
         :return: Path object representing the location of the log file.
         """
-        root = SIM_OUTPUT / self.hostname
+        root = SIM_OUTPUT.path / self.hostname
         root.mkdir(exist_ok=True, parents=True)
         return root / f"{self.hostname}_sys.log"