#1859 - First pass at an implementation of the full reset method. Will now start testing...

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

@@ -38,6 +38,23 @@ class DatabaseService(Service):
         self._db_file: File
         self._create_db_file()
 
+    def set_original_state(self):
+        """Sets the original state."""
+        super().set_original_state()
+        vals_to_include = {
+            "password",
+            "connections",
+            "backup_server",
+            "latest_backup_directory",
+            "latest_backup_file_name",
+        }
+        self._original_state.update(self.model_dump(include=vals_to_include))
+
+    def reset_component_for_episode(self, episode: int):
+        """Reset the original state of the SimComponent."""
+        self.connections.clear()
+        super().reset_component_for_episode(episode)
+
     def configure_backup(self, backup_server: IPv4Address):
         """
         Set up the database backup.

src/primaite/simulator/system/services/dns/dns_client.py

@@ -29,6 +29,17 @@ class DNSClient(Service):
         super().__init__(**kwargs)
         self.start()
 
+    def set_original_state(self):
+        """Sets the original state."""
+        super().set_original_state()
+        vals_to_include = {"dns_server"}
+        self._original_state.update(self.model_dump(include=vals_to_include))
+
+    def reset_component_for_episode(self, episode: int):
+        """Reset the original state of the SimComponent."""
+        self.dns_cache.clear()
+        super().reset_component_for_episode(episode)
+
     def describe_state(self) -> Dict:
         """
         Describes the current state of the software.
@@ -42,15 +53,6 @@ class DNSClient(Service):
         state = super().describe_state()
         return state
 
-    def reset_component_for_episode(self, episode: int):
-        """
-        Resets the Service component for a new episode.
-
-        This method ensures the Service is ready for a new episode, including resetting any
-        stateful properties or statistics, and clearing any message queues.
-        """
-        pass
-
     def add_domain_to_cache(self, domain_name: str, ip_address: IPv4Address):
         """
         Adds a domain name to the DNS Client cache.

src/primaite/simulator/system/services/dns/dns_server.py

@@ -28,6 +28,11 @@ class DNSServer(Service):
         super().__init__(**kwargs)
         self.start()
 
+    def reset_component_for_episode(self, episode: int):
+        """Reset the original state of the SimComponent."""
+        self.dns_table.clear()
+        super().reset_component_for_episode(episode)
+
     def describe_state(self) -> Dict:
         """
         Describes the current state of the software.
@@ -62,15 +67,6 @@ class DNSServer(Service):
         """
         self.dns_table[domain_name] = domain_ip_address
 
-    def reset_component_for_episode(self, episode: int):
-        """
-        Resets the Service component for a new episode.
-
-        This method ensures the Service is ready for a new episode, including resetting any
-        stateful properties or statistics, and clearing any message queues.
-        """
-        pass
-
     def receive(
         self,
         payload: Any,

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

@@ -46,6 +46,12 @@ class Service(IOSoftware):
         self.health_state_visible = SoftwareHealthState.UNUSED
         self.health_state_actual = SoftwareHealthState.UNUSED
 
+    def set_original_state(self):
+        """Sets the original state."""
+        super().set_original_state()
+        vals_to_include = {"operating_state", "restart_duration", "restart_countdown"}
+        self._original_state.update(self.model_dump(include=vals_to_include))
+
     def _init_request_manager(self) -> RequestManager:
         rm = super()._init_request_manager()
         rm.add_request("scan", RequestType(func=lambda request, context: self.scan()))
@@ -73,15 +79,6 @@ class Service(IOSoftware):
         state["health_state_visible"] = self.health_state_visible
         return state
 
-    def reset_component_for_episode(self, episode: int):
-        """
-        Resets the Service component for a new episode.
-
-        This method ensures the Service is ready for a new episode, including resetting any
-        stateful properties or statistics, and clearing any message queues.
-        """
-        pass
-
     def stop(self) -> None:
         """Stop the service."""
         if self.operating_state in [ServiceOperatingState.RUNNING, ServiceOperatingState.PAUSED]:

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

@@ -19,8 +19,14 @@ class WebServer(Service):
 
     _last_response_status_code: Optional[HttpStatusCode] = None
 
+    def reset_component_for_episode(self, episode: int):
+        """Reset the original state of the SimComponent."""
+        self._last_response_status_code = None
+        super().reset_component_for_episode(episode)
+
     @property
     def last_response_status_code(self) -> HttpStatusCode:
+        """The latest http response code."""
         return self._last_response_status_code
 
     @last_response_status_code.setter
@@ -41,14 +47,6 @@ class WebServer(Service):
         state["last_response_status_code"] = (
             self.last_response_status_code.value if isinstance(self.last_response_status_code, HttpStatusCode) else None
         )
-
-        print(
-            f""
-            f"Printing state from Webserver describe func: "
-            f"val={state['last_response_status_code']}, "
-            f"type={type(state['last_response_status_code'])}, "
-            f"Service obj ID={id(self)}"
-        )
         return state
 
     def __init__(self, **kwargs):
@@ -102,13 +100,6 @@ class WebServer(Service):
         # return true if response is OK
         self.last_response_status_code = response.status_code
 
-        print(
-            f""
-            f"Printing state from Webserver http request func: "
-            f"val={self.last_response_status_code}, "
-            f"type={type(self.last_response_status_code)}, "
-            f"Service obj ID={id(self)}"
-        )
         return response.status_code == HttpStatusCode.OK
 
     def _handle_get_request(self, payload: HttpRequestPacket) -> HttpResponsePacket: