Merged PR 318: #2418 Add Printer and Wireless router to config parser

## Summary
Add ability to parse printers and wireless routers from yaml config.

## Test process
Existing unit tests pass. Added a printer to one of the test yamls. Adding a wireless router as well now.

## Checklist
- [x] PR is linked to a **work item**
- [x] **acceptance criteria** of linked ticket are met
- [x] performed **self-review** of the code
- [ ] written **tests** for any new functionality added with this PR
- [ ] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [ ] updated the **change log**
- [x] ran **pre-commit** checks for code style
- [x] attended to any **TO-DOs** left in the code

Related work items: #2418

src/primaite/game/game.py

@@ -15,10 +15,11 @@ from primaite.game.science import graph_has_cycle, topological_sort
 from primaite.simulator.network.hardware.base import NodeOperatingState
 from primaite.simulator.network.hardware.nodes.host.computer import Computer
 from primaite.simulator.network.hardware.nodes.host.host_node import NIC
-from primaite.simulator.network.hardware.nodes.host.server import Server
+from primaite.simulator.network.hardware.nodes.host.server import Printer, Server
 from primaite.simulator.network.hardware.nodes.network.firewall import Firewall
 from primaite.simulator.network.hardware.nodes.network.router import Router
 from primaite.simulator.network.hardware.nodes.network.switch import Switch
+from primaite.simulator.network.hardware.nodes.network.wireless_router import WirelessRouter
 from primaite.simulator.network.nmne import set_nmne_config
 from primaite.simulator.network.transmission.transport_layer import Port
 from primaite.simulator.sim_container import Simulation
@@ -273,8 +274,18 @@ class PrimaiteGame:
                 new_node = Router.from_config(node_cfg)
             elif n_type == "firewall":
                 new_node = Firewall.from_config(node_cfg)
+            elif n_type == "wireless_router":
+                new_node = WirelessRouter.from_config(node_cfg)
+            elif n_type == "printer":
+                new_node = Printer(
+                    hostname=node_cfg["hostname"],
+                    ip_address=node_cfg["ip_address"],
+                    subnet_mask=node_cfg["subnet_mask"],
+                )
             else:
-                _LOGGER.warning(f"invalid node type {n_type} in config")
+                msg = f"invalid node type {n_type} in config"
+                _LOGGER.error(msg)
+                raise ValueError(msg)
             if "services" in node_cfg:
                 for service_cfg in node_cfg["services"]:
                     new_service = None

src/primaite/simulator/network/container.py

@@ -8,6 +8,7 @@ from prettytable import MARKDOWN, PrettyTable
 from primaite import getLogger
 from primaite.simulator.core import RequestManager, RequestType, SimComponent
 from primaite.simulator.network.hardware.base import Link, Node, WiredNetworkInterface
+from primaite.simulator.network.hardware.nodes.host.server import Printer
 from primaite.simulator.system.applications.application import Application
 from primaite.simulator.system.services.service import Service
 
@@ -110,6 +111,16 @@ class Network(SimComponent):
         """The Firewalls in the Network."""
         return [node for node in self.nodes.values() if node.__class__.__name__ == "Firewall"]
 
+    @property
+    def printer_nodes(self) -> List[Node]:
+        """The printers on the network."""
+        return [node for node in self.nodes.values() if isinstance(node, Printer)]
+
+    @property
+    def wireless_router_nodes(self) -> List[Node]:
+        """The Routers in the Network."""
+        return [node for node in self.nodes.values() if node.__class__.__name__ == "WirelessRouter"]
+
     def show(self, nodes: bool = True, ip_addresses: bool = True, links: bool = True, markdown: bool = False):
         """
         Print tables describing the Network.
@@ -128,6 +139,8 @@ class Network(SimComponent):
             "Switch": self.switch_nodes,
             "Server": self.server_nodes,
             "Computer": self.computer_nodes,
+            "Printer": self.printer_nodes,
+            "Wireless Router": self.wireless_router_nodes,
         }
         if nodes:
             table = PrettyTable(["Node", "Type", "Operating State"])

src/primaite/simulator/network/hardware/nodes/host/server.py

@@ -28,3 +28,9 @@ class Server(HostNode):
     * Applications:
         * Web Browser
     """
+
+
+class Printer(HostNode):
+    """Printer? I don't even know her!."""
+
+    # TODO: Implement printer-specific behaviour

src/primaite/simulator/network/hardware/nodes/network/router.py

@@ -1418,7 +1418,7 @@ class Router(NetworkNode):
         :return: Configured router.
         :rtype: Router
         """
-        router = Router(
+        router = cls(
             hostname=cfg["hostname"],
             num_ports=int(cfg.get("num_ports", "5")),
             operating_state=NodeOperatingState.ON
@@ -1441,6 +1441,8 @@ class Router(NetworkNode):
                     protocol=None if not (p := r_cfg.get("protocol")) else IPProtocol[p],
                     src_ip_address=r_cfg.get("src_ip"),
                     dst_ip_address=r_cfg.get("dst_ip"),
+                    src_wildcard_mask=r_cfg.get("src_wildcard_mask"),
+                    dst_wildcard_mask=r_cfg.get("dst_wildcard_mask"),
                     position=r_num,
                 )
         if "routes" in cfg:

src/primaite/simulator/network/hardware/nodes/network/wireless_router.py

@@ -1,10 +1,14 @@
+from ipaddress import IPv4Address
 from typing import Any, Dict, Union
 
 from pydantic import validate_call
 
 from primaite.simulator.network.airspace import AirSpaceFrequency, IPWirelessNetworkInterface
-from primaite.simulator.network.hardware.nodes.network.router import Router, RouterInterface
+from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState
+from primaite.simulator.network.hardware.nodes.network.router import ACLAction, Router, RouterInterface
 from primaite.simulator.network.transmission.data_link_layer import Frame
+from primaite.simulator.network.transmission.network_layer import IPProtocol
+from primaite.simulator.network.transmission.transport_layer import Port
 from primaite.utils.validators import IPV4Address
 
 
@@ -209,3 +213,68 @@ class WirelessRouter(Router):
         raise NotImplementedError(
             "Please use the 'configure_wireless_access_point' and 'configure_router_interface' functions."
         )
+
+    @classmethod
+    def from_config(cls, cfg: Dict) -> "WirelessRouter":
+        """Generate the wireless router from config.
+
+        Schema:
+          - hostname (str): unique name for this router.
+          - router_interface (dict): The values should be another dict specifying
+                - ip_address (str)
+                - subnet_mask (str)
+          - wireless_access_point (dict): Dict with
+                - ip address,
+                - subnet mask,
+                - frequency, (string: either WIFI_2_4 or WIFI_5)
+          - acl (dict): Dict with integers from 1 - max_acl_rules as keys. The key defines the position within the ACL
+                where the rule will be added (lower number is resolved first). The values should describe valid ACL
+                Rules as:
+              - action (str): either PERMIT or DENY
+              - src_port (str, optional): the named port such as HTTP, HTTPS, or POSTGRES_SERVER
+              - dst_port (str, optional): the named port such as HTTP, HTTPS, or POSTGRES_SERVER
+              - protocol (str, optional): the named IP protocol such as ICMP, TCP, or UDP
+              - src_ip_address (str, optional): IP address octet written in base 10
+              - dst_ip_address (str, optional): IP address octet written in base 10
+
+        :param cfg: Config dictionary
+        :type cfg: Dict
+        :return: WirelessRouter instance.
+        :rtype: WirelessRouter
+        """
+        operating_state = (
+            NodeOperatingState.ON if not (p := cfg.get("operating_state")) else NodeOperatingState[p.upper()]
+        )
+        router = cls(hostname=cfg["hostname"], operating_state=operating_state)
+        if "router_interface" in cfg:
+            ip_address = cfg["router_interface"]["ip_address"]
+            subnet_mask = cfg["router_interface"]["subnet_mask"]
+            router.configure_router_interface(ip_address=ip_address, subnet_mask=subnet_mask)
+        if "wireless_access_point" in cfg:
+            ip_address = cfg["wireless_access_point"]["ip_address"]
+            subnet_mask = cfg["wireless_access_point"]["subnet_mask"]
+            frequency = AirSpaceFrequency[cfg["wireless_access_point"]["frequency"]]
+            router.configure_wireless_access_point(ip_address=ip_address, subnet_mask=subnet_mask, frequency=frequency)
+
+        if "acl" in cfg:
+            for r_num, r_cfg in cfg["acl"].items():
+                router.acl.add_rule(
+                    action=ACLAction[r_cfg["action"]],
+                    src_port=None if not (p := r_cfg.get("src_port")) else Port[p],
+                    dst_port=None if not (p := r_cfg.get("dst_port")) else Port[p],
+                    protocol=None if not (p := r_cfg.get("protocol")) else IPProtocol[p],
+                    src_ip_address=r_cfg.get("src_ip"),
+                    dst_ip_address=r_cfg.get("dst_ip"),
+                    src_wildcard_mask=r_cfg.get("src_wildcard_mask"),
+                    dst_wildcard_mask=r_cfg.get("dst_wildcard_mask"),
+                    position=r_num,
+                )
+        if "routes" in cfg:
+            for route in cfg.get("routes"):
+                router.route_table.add_route(
+                    address=IPv4Address(route.get("address")),
+                    subnet_mask=IPv4Address(route.get("subnet_mask", "255.255.255.0")),
+                    next_hop_ip_address=IPv4Address(route.get("next_hop_ip_address")),
+                    metric=float(route.get("metric", 0)),
+                )
+        return router

tests/assets/configs/test_primaite_session.yaml

@@ -681,6 +681,39 @@ simulation:
       - ref: client_2_dns_client
         type: DNSClient
 
+    - ref: HP_LaserJet_Pro_4102fdn_printer
+      type: printer
+      hostname: HP_LaserJet_Pro_4102fdn_printer
+      ip_address: 192.168.10.99
+      subnet_mask: 255.255.255.0
+
+    - ref: router_2
+      type: wireless_router
+      hostname: router_2
+      router_interface:
+        ip_address: 192.169.1.1
+        subnet_mask: 255.255.255.0
+      wireless_access_point:
+        ip_address: 192.170.1.1
+        subnet_mask: 255.255.255.0
+        frequency: WIFI_2_4
+      acl:
+        0:
+          action: PERMIT
+          src_port: POSTGRES_SERVER
+          dst_port: POSTGRES_SERVER
+        1:
+          action: PERMIT
+          src_port: DNS
+          dst_port: DNS
+        22:
+          action: PERMIT
+          src_port: ARP
+          dst_port: ARP
+        23:
+          action: PERMIT
+          protocol: ICMP
+
     links:
     - ref: router_1___switch_1
       endpoint_a_ref: router_1

tests/e2e_integration_tests/test_primaite_session.py

@@ -1,6 +1,8 @@
 import pydantic
 import pytest
 
+from primaite.simulator.network.hardware.nodes.host.server import Printer
+from primaite.simulator.network.hardware.nodes.network.wireless_router import WirelessRouter
 from tests import TEST_ASSETS_ROOT
 from tests.conftest import TempPrimaiteSession
 
@@ -11,7 +13,6 @@ MISCONFIGURED_PATH = TEST_ASSETS_ROOT / "configs/bad_primaite_session.yaml"
 MULTI_AGENT_PATH = TEST_ASSETS_ROOT / "configs/multi_agent_session.yaml"
 
 
-# @pytest.mark.skip(reason="no way of currently testing this")
 class TestPrimaiteSession:
     @pytest.mark.parametrize("temp_primaite_session", [[CFG_PATH]], indirect=True)
     def test_creating_session(self, temp_primaite_session):
@@ -29,7 +30,11 @@ class TestPrimaiteSession:
             assert session.env
 
             assert session.env.game.simulation.network
-            assert len(session.env.game.simulation.network.nodes) == 10
+            assert len(session.env.game.simulation.network.nodes) == 12
+            wireless = session.env.game.simulation.network.get_node_by_hostname("router_2")
+            assert isinstance(wireless, WirelessRouter)
+            printer = session.env.game.simulation.network.get_node_by_hostname("HP_LaserJet_Pro_4102fdn_printer")
+            assert isinstance(printer, Printer)
 
     @pytest.mark.skip(reason="Session is not being maintained and will be removed in the subsequent beta release.")
     @pytest.mark.parametrize("temp_primaite_session", [[CFG_PATH]], indirect=True)

tests/unit_tests/_primaite/_simulator/_network/_hardware/nodes/test_router.py

@@ -0,0 +1,111 @@
+from ipaddress import IPv4Address
+
+from primaite.simulator.network.hardware.nodes.network.router import ACLAction, Router
+from primaite.simulator.network.transmission.network_layer import IPProtocol
+from primaite.simulator.network.transmission.transport_layer import Port
+
+
+def test_wireless_router_from_config():
+    cfg = {
+        "ref": "router_1",
+        "type": "router",
+        "hostname": "router_1",
+        "num_ports": 6,
+        "ports": {
+            1: {
+                "ip_address": "192.168.1.1",
+                "subnet_mask": "255.255.255.0",
+            },
+            2: {
+                "ip_address": "192.168.2.1",
+                "subnet_mask": "255.255.255.0",
+            },
+        },
+        "acl": {
+            0: {
+                "action": "PERMIT",
+                "src_port": "POSTGRES_SERVER",
+                "dst_port": "POSTGRES_SERVER",
+            },
+            1: {
+                "action": "PERMIT",
+                "protocol": "ICMP",
+            },
+            2: {
+                "action": "PERMIT",
+                "src_ip": "100.100.100.1",
+                "dst_ip": "100.100.101.1",
+            },
+            3: {
+                "action": "PERMIT",
+                "src_ip": "100.100.102.0",
+                "dst_ip": "100.100.103.0",
+                "src_wildcard_mask": "0.0.0.255",
+                "dst_wildcard_mask": "0.0.0.255",
+            },
+            20: {
+                "action": "DENY",
+            },
+        },
+    }
+
+    rt = Router.from_config(cfg=cfg)
+
+    assert rt.num_ports == 6
+
+    assert rt.network_interface[1].ip_address == IPv4Address("192.168.1.1")
+    assert rt.network_interface[1].subnet_mask == IPv4Address("255.255.255.0")
+
+    assert rt.network_interface[2].ip_address == IPv4Address("192.168.2.1")
+    assert rt.network_interface[2].subnet_mask == IPv4Address("255.255.255.0")
+
+    assert not rt.network_interface[3].enabled
+    assert not rt.network_interface[4].enabled
+    assert not rt.network_interface[5].enabled
+    assert not rt.network_interface[6].enabled
+
+    r0 = rt.acl.acl[0]
+    assert r0.action == ACLAction.PERMIT
+    assert r0.src_port == r0.dst_port == Port.POSTGRES_SERVER
+    assert r0.src_ip_address == r0.dst_ip_address == r0.dst_wildcard_mask == r0.src_wildcard_mask == r0.protocol == None
+
+    r1 = rt.acl.acl[1]
+    assert r1.action == ACLAction.PERMIT
+    assert r1.protocol == IPProtocol.ICMP
+    assert (
+        r1.src_ip_address
+        == r1.dst_ip_address
+        == r1.dst_wildcard_mask
+        == r1.src_wildcard_mask
+        == r1.src_port
+        == r1.dst_port
+        == None
+    )
+
+    r2 = rt.acl.acl[2]
+    assert r2.action == ACLAction.PERMIT
+    assert r2.src_ip_address == IPv4Address("100.100.100.1")
+    assert r2.dst_ip_address == IPv4Address("100.100.101.1")
+    assert r2.src_wildcard_mask == r2.dst_wildcard_mask == None
+    assert r2.src_port == r2.dst_port == r2.protocol == None
+
+    r3 = rt.acl.acl[3]
+    assert r3.action == ACLAction.PERMIT
+    assert r3.src_ip_address == IPv4Address("100.100.102.0")
+    assert r3.dst_ip_address == IPv4Address("100.100.103.0")
+    assert r3.src_wildcard_mask == IPv4Address("0.0.0.255")
+    assert r3.dst_wildcard_mask == IPv4Address("0.0.0.255")
+    assert r3.src_port == r3.dst_port == r3.protocol == None
+
+    r20 = rt.acl.acl[20]
+    assert r20.action == ACLAction.DENY
+    assert (
+        r20.src_ip_address
+        == r20.dst_ip_address
+        == r20.src_wildcard_mask
+        == r20.dst_wildcard_mask
+        == r20.src_port
+        == r20.dst_port
+        == r20.protocol
+        == None
+    )

tests/unit_tests/_primaite/_simulator/_network/_hardware/nodes/test_wireless_router.py

@@ -0,0 +1,97 @@
+from ipaddress import IPv4Address
+
+from primaite.simulator.network.hardware.nodes.network.router import ACLAction
+from primaite.simulator.network.hardware.nodes.network.wireless_router import WirelessRouter
+from primaite.simulator.network.transmission.network_layer import IPProtocol
+from primaite.simulator.network.transmission.transport_layer import Port
+
+
+def test_wireless_router_from_config():
+    cfg = {
+        "ref": "router_2",
+        "type": "wireless_router",
+        "hostname": "router_2",
+        "router_interface": {
+            "ip_address": "192.168.1.1",
+            "subnet_mask": "255.255.255.0",
+        },
+        "wireless_access_point": {
+            "ip_address": "192.170.1.1",
+            "subnet_mask": "255.255.255.0",
+            "frequency": "WIFI_2_4",
+        },
+        "acl": {
+            0: {
+                "action": "PERMIT",
+                "src_port": "POSTGRES_SERVER",
+                "dst_port": "POSTGRES_SERVER",
+            },
+            1: {
+                "action": "PERMIT",
+                "protocol": "ICMP",
+            },
+            2: {
+                "action": "PERMIT",
+                "src_ip": "100.100.100.1",
+                "dst_ip": "100.100.101.1",
+            },
+            3: {
+                "action": "PERMIT",
+                "src_ip": "100.100.102.0",
+                "dst_ip": "100.100.103.0",
+                "src_wildcard_mask": "0.0.0.255",
+                "dst_wildcard_mask": "0.0.0.255",
+            },
+            20: {
+                "action": "DENY",
+            },
+        },
+    }
+
+    rt = WirelessRouter.from_config(cfg=cfg)
+
+    r0 = rt.acl.acl[0]
+    assert r0.action == ACLAction.PERMIT
+    assert r0.src_port == r0.dst_port == Port.POSTGRES_SERVER
+    assert r0.src_ip_address == r0.dst_ip_address == r0.dst_wildcard_mask == r0.src_wildcard_mask == r0.protocol == None
+
+    r1 = rt.acl.acl[1]
+    assert r1.action == ACLAction.PERMIT
+    assert r1.protocol == IPProtocol.ICMP
+    assert (
+        r1.src_ip_address
+        == r1.dst_ip_address
+        == r1.dst_wildcard_mask
+        == r1.src_wildcard_mask
+        == r1.src_port
+        == r1.dst_port
+        == None
+    )
+
+    r2 = rt.acl.acl[2]
+    assert r2.action == ACLAction.PERMIT
+    assert r2.src_ip_address == IPv4Address("100.100.100.1")
+    assert r2.dst_ip_address == IPv4Address("100.100.101.1")
+    assert r2.src_wildcard_mask == r2.dst_wildcard_mask == None
+    assert r2.src_port == r2.dst_port == r2.protocol == None
+
+    r3 = rt.acl.acl[3]
+    assert r3.action == ACLAction.PERMIT
+    assert r3.src_ip_address == IPv4Address("100.100.102.0")
+    assert r3.dst_ip_address == IPv4Address("100.100.103.0")
+    assert r3.src_wildcard_mask == IPv4Address("0.0.0.255")
+    assert r3.dst_wildcard_mask == IPv4Address("0.0.0.255")
+    assert r3.src_port == r3.dst_port == r3.protocol == None
+
+    r20 = rt.acl.acl[20]
+    assert r20.action == ACLAction.DENY
+    assert (
+        r20.src_ip_address
+        == r20.dst_ip_address
+        == r20.src_wildcard_mask
+        == r20.dst_wildcard_mask
+        == r20.src_port
+        == r20.dst_port
+        == r20.protocol
+        == None
+    )