#2888 - Put software configuration items in the ConfigSchema

src/primaite/simulator/system/software.py

@@ -1,13 +1,13 @@
 # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import copy
-from abc import abstractmethod
+from abc import ABC, abstractmethod
 from datetime import datetime
 from enum import Enum
 from ipaddress import IPv4Address, IPv4Network
 from typing import Any, Dict, Optional, Set, TYPE_CHECKING, Union
 
 from prettytable import MARKDOWN, PrettyTable
-from pydantic import Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from primaite.interface.request import RequestResponse
 from primaite.simulator.core import RequestManager, RequestType, SimComponent
@@ -70,7 +70,7 @@ class SoftwareCriticality(Enum):
     "The highest level of criticality."
 
 
-class Software(SimComponent):
+class Software(SimComponent, ABC):
     """
     A base class representing software in a simulator environment.
 
@@ -78,6 +78,16 @@ class Software(SimComponent):
     It outlines the fundamental attributes and behaviors expected of any software in the simulation.
     """
 
+    class ConfigSchema(BaseModel, ABC):
+        """Configurable options for all software."""
+
+        model_config = ConfigDict(extra="forbid")
+        starting_health_state: SoftwareHealthState = SoftwareHealthState.UNUSED
+        criticality: SoftwareCriticality = SoftwareCriticality.LOWEST
+        fixing_duration: int = 2
+
+    config: ConfigSchema = Field(default_factory=lambda: Software.ConfigSchema())
+
     name: str
     "The name of the software."
     health_state_actual: SoftwareHealthState = SoftwareHealthState.UNUSED
@@ -105,6 +115,12 @@ class Software(SimComponent):
     _fixing_countdown: Optional[int] = None
     "Current number of ticks left to patch the software."
 
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.health_state_actual = self.config.starting_health_state
+        self.criticality = self.config.criticality
+        self.fixing_duration = self.config.fixing_duration
+
     def _init_request_manager(self) -> RequestManager:
         """
         Initialise the request manager.
@@ -233,7 +249,7 @@ class Software(SimComponent):
         super().pre_timestep(timestep)
 
 
-class IOSoftware(Software):
+class IOSoftware(Software, ABC):
     """
     Represents software in a simulator environment that is capable of input/output operations.
 
@@ -243,6 +259,13 @@ class IOSoftware(Software):
     required.
     """
 
+    class ConfigSchema(Software.ConfigSchema, ABC):
+        """Configuration options for all IO Software."""
+
+        listen_on_ports: Set[Port] = Field(default_factory=set)
+
+    config: ConfigSchema = Field(default_factory=lambda: IOSoftware.ConfigSchema())
+
     installing_count: int = 0
     "The number of times the software has been installed. Default is 0."
     max_sessions: int = 100
@@ -260,6 +283,10 @@ class IOSoftware(Software):
     _connections: Dict[str, Dict] = {}
     "Active connections."
 
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.listen_on_ports = self.config.listen_on_ports
+
     @abstractmethod
     def describe_state(self) -> Dict:
         """