code cleanup

Author: ccie18643

pytcp/tests/integration/test__packet_handler__ethernet_802_3__rx.py

@@ -29,9 +29,9 @@
 
 
 """
-This module contains unit tests for the Packet Handler Ethernet 802.3 RX operations.
+This module contains integration tests for the Packet Handler Ethernet 802.3 RX operations.
 
-pytcp/tests/unit/test__packet_handler__ethernet_802_3__rx.py
+pytcp/tests/integration/test__packet_handler__ethernet_802_3__rx.py
 
 ver 3.0.4
 """
@@ -49,6 +49,12 @@
         {
             "_description": "Ethernet 802.3 - dst unknown",
             "_frames_rx": [
+                # Ethernet 802.3
+                #   Destination MAC : 02:00:00:99:99:99 (foreign)
+                #   Source MAC      : 52:54:00:df:85:37
+                #   Length          : 0x0000 (invalid/treated as LLC length)
+                #
+                # Summary: Frame addressed to an unknown MAC; stack drops before further processing.
                 b"\x02\x00\x00\x99\x99\x99\x52\x54\x00\xdf\x85\x37\x00\x00",
             ],
             "_expected__frames_tx": [],
@@ -61,6 +67,12 @@
         {
             "_description": "Ethernet 802.3 - malformed header",
             "_frames_rx": [
+                # Ethernet 802.3
+                #   Destination MAC : 02:00:00:77:77:77 (foreign)
+                #   Source MAC      : 52:54:00:df:85:37
+                #   Length          : <missing byte> (frame too short)
+                #
+                # Summary: Malformed Ethernet 802.3 header (length field truncated) triggers parse drop.
                 b"\x02\x00\x00\x77\x77\x77\x52\x54\x00\xdf\x85\x37\x00",
             ],
             "_expected__frames_tx": [],

pytcp/tests/integration/test__packet_handler__ethernet_802_3__tx.py

@@ -29,9 +29,9 @@
 
 
 """
-This module contains unit tests for the Packet Handler Ethernet 802.3 TX operations.
+This module contains integration tests for the Packet Handler Ethernet 802.3 TX operations.
 
-pytcp/tests/unit/test__packet_handler__ethernet_802_3__tx.py
+pytcp/tests/integration/test__packet_handler__ethernet_802_3__tx.py
 
 ver 3.0.4
 """
@@ -61,6 +61,12 @@
                 "ethernet_802_3__dst": HOST_A__MAC_ADDRESS,
             },
             "_expected__frames_tx": [
+                # Ethernet 802.3
+                #   Destination MAC : 02:00:00:00:00:91
+                #   Source MAC      : 02:00:00:00:00:07
+                #   Length          : 0x0000 (header-only frame)
+                #
+                # Summary: Raw 802.3 frame transmitted with caller-specified MAC addresses.
                 b"\x02\x00\x00\x00\x00\x91\x02\x00\x00\x00\x00\x07\x00\x00",
             ],
             "_expected__tx_status": TxStatus.PASSED__ETHERNET_802_3__TO_TX_RING,
@@ -77,7 +83,15 @@
                 "ethernet_802_3__src": MAC__UNSPECIFIED,
                 "ethernet_802_3__dst": HOST_A__MAC_ADDRESS,
             },
-            "_expected__frames_tx": [b"\x02\x00\x00\x00\x00\x91\x02\x00\x00\x00\x00\x07\x00\x00"],
+            "_expected__frames_tx": [
+                # Ethernet 802.3
+                #   Destination MAC : 02:00:00:00:00:91
+                #   Source MAC      : 02:00:00:00:00:07 (filled by stack)
+                #   Length          : 0x0000 (header-only frame)
+                #
+                # Summary: Source MAC unspecified; stack fills in before transmitting the 802.3 header.
+                b"\x02\x00\x00\x00\x00\x91\x02\x00\x00\x00\x00\x07\x00\x00",
+            ],
             "_expected__tx_status": TxStatus.PASSED__ETHERNET_802_3__TO_TX_RING,
             "_expected__packet_stats_tx": PacketStatsTx(
                 ethernet_802_3__pre_assemble=1,
@@ -109,6 +123,15 @@
                 "ethernet_802_3__payload": RawAssembler(raw__payload=bytes(range(16))),
             },
             "_expected__frames_tx": [
+                # Ethernet 802.3
+                #   Destination MAC : 02:00:00:00:00:91
+                #   Source MAC      : 02:00:00:00:00:07
+                #   Length          : 0x0010 (16 bytes of payload)
+                #
+                # Payload
+                #   Bytes           : 00..0f (RawAssembler content)
+                #
+                # Summary: 802.3 frame with a 16-byte LLC payload assembled by RawAssembler.
                 b"\x02\x00\x00\x00\x00\x91\x02\x00\x00\x00\x00\x07\x00\x10\x00\x01"
                 b"\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f",
             ],