#1706 - Got the core Node class build and working with ARP and the ability to ping another node. Added some basic tests in. Next job is to create the Node subclasses. Then move ARP and ICMP into a service that is used by all nodes.

src/primaite/simulator/network/protocols/arp.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+from ipaddress import IPv4Address
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class ARPEntry(BaseModel):
+    """
+    Represents an entry in the ARP cache.
+
+    :param mac_address: The MAC address associated with the IP address.
+    :param nic: The NIC through which the NIC with the IP address is reachable.
+    """
+
+    mac_address: str
+    nic_uuid: str
+
+
+class ARPPacket(BaseModel):
+    """
+    Represents the ARP layer of a network frame.
+
+    :param request: ARP operation. True if a request, False if a reply.
+    :param sender_mac_addr: Sender MAC address.
+    :param sender_ip: Sender IP address.
+    :param target_mac_addr: Target MAC address.
+    :param target_ip: Target IP address.
+
+    :Example:
+
+    >>> arp_request = ARPPacket(
+    ...     sender_mac_addr="aa:bb:cc:dd:ee:ff",
+    ...     sender_ip=IPv4Address("192.168.0.1"),
+    ...     target_ip=IPv4Address("192.168.0.2")
+    ... )
+    >>> arp_response = ARPPacket(
+    ...     sender_mac_addr="aa:bb:cc:dd:ee:ff",
+    ...     sender_ip=IPv4Address("192.168.0.1"),
+    ...     target_ip=IPv4Address("192.168.0.2")
+    ... )
+    """
+
+    request: bool = True
+    "ARP operation. True if a request, False if a reply."
+    sender_mac_addr: str
+    "Sender MAC address."
+    sender_ip: IPv4Address
+    "Sender IP address."
+    target_mac_addr: Optional[str] = None
+    "Target MAC address."
+    target_ip: IPv4Address
+    "Target IP address."
+
+    def generate_reply(self, mac_address: str) -> ARPPacket:
+        """
+        Generate a new ARPPacket to be sent as a response with a given mac address.
+
+        :param mac_address: The mac_address that was being sought after from the original target IP address.
+        :return: A new instance of ARPPacket.
+        """
+        return ARPPacket(
+            request=False,
+            sender_ip=self.target_ip,
+            sender_mac_addr=mac_address,
+            target_ip=self.sender_ip,
+            target_mac_addr=self.sender_mac_addr,
+        )