#2266 - Fixed some minor bugs that prevented basic networks without a default gateway from being parsed. Completed the basic client-server P2P network documentation, file and retrieval method.

src/primaite/config/_package_data/client-server-p2p-network-example.yaml

@@ -1,3 +1,11 @@
+game:
+  ports:
+  - ARP
+  protocols:
+  - ICMP
+  - TCP
+  - UDP
+
 simulation:
   network:
     nodes:
@@ -8,7 +16,7 @@ simulation:
 
       - hostname: server_1
         type: server
-        ip_address: 192.168.1.11
+        ip_address: 192.168.1.13
         subnet_mask: 255.255.255.0
 
     links:

src/primaite/game/agent/observations/observations.py

@@ -1,6 +1,6 @@
 """Manages the observation space for the agent."""
 from abc import ABC, abstractmethod
-from typing import Any, Dict, Iterable, Type
+from typing import Any, Dict, Iterable, Type, Optional, Union
 
 from gymnasium import spaces
 from gymnasium.core import ObsType
@@ -9,7 +9,7 @@ from pydantic import BaseModel, ConfigDict
 from primaite import getLogger
 
 _LOGGER = getLogger(__name__)
-WhereType = Iterable[str | int] | None
+WhereType = Optional[Iterable[Union[str, int]]]
 
 
 class AbstractObservation(ABC):

src/primaite/game/agent/rewards.py

@@ -26,7 +26,7 @@ the structure:
 ```
 """
 from abc import abstractmethod
-from typing import Callable, Dict, Iterable, List, Optional, Tuple, Type, TYPE_CHECKING
+from typing import Callable, Dict, Iterable, List, Optional, Tuple, Type, TYPE_CHECKING, Union
 
 from typing_extensions import Never
 
@@ -37,7 +37,7 @@ if TYPE_CHECKING:
     from primaite.game.agent.interface import AgentActionHistoryItem
 
 _LOGGER = getLogger(__name__)
-WhereType = Iterable[str | int] | None
+WhereType = Optional[Iterable[Union[str, int]]]
 
 
 class AbstractReward:

src/primaite/game/game.py

@@ -244,7 +244,7 @@ class PrimaiteGame:
                     hostname=node_cfg["hostname"],
                     ip_address=node_cfg["ip_address"],
                     subnet_mask=IPv4Address(node_cfg.get("subnet_mask", "255.255.255.0")),
-                    default_gateway=node_cfg["default_gateway"],
+                    default_gateway=node_cfg.get("default_gateway"),
                     dns_server=node_cfg.get("dns_server", None),
                     operating_state=NodeOperatingState.ON
                     if not (p := node_cfg.get("operating_state"))
@@ -255,7 +255,7 @@ class PrimaiteGame:
                     hostname=node_cfg["hostname"],
                     ip_address=node_cfg["ip_address"],
                     subnet_mask=IPv4Address(node_cfg.get("subnet_mask", "255.255.255.0")),
-                    default_gateway=node_cfg["default_gateway"],
+                    default_gateway=node_cfg.get("default_gateway"),
                     dns_server=node_cfg.get("dns_server", None),
                     operating_state=NodeOperatingState.ON
                     if not (p := node_cfg.get("operating_state"))

src/primaite/simulator/network/networks.py

@@ -1,5 +1,9 @@
 from ipaddress import IPv4Address
 
+import yaml
+
+from primaite import PRIMAITE_PATHS
+from primaite.game.game import PrimaiteGame
 from primaite.simulator.network.container import Network
 from primaite.simulator.network.hardware.nodes.host.computer import Computer
 from primaite.simulator.network.hardware.nodes.host.host_node import NIC
@@ -279,3 +283,13 @@ def arcd_uc2_network() -> Network:
     router_1.acl.add_rule(action=ACLAction.PERMIT, src_port=Port.HTTP, dst_port=Port.HTTP, position=3)
 
     return network
+
+
+def client_server_p2p_network_example() -> Network:
+    path = PRIMAITE_PATHS.user_config_path / "example_config" / "client-server-p2p-network-example.yaml"
+    with open(path, "r") as file:
+        cfg = yaml.safe_load(file)
+
+    game = PrimaiteGame.from_config(cfg)
+
+    return game.simulation.network