extmod/asyncio/stream.py: Add ipv6 support to start_server().

pi-anl · pi-anl · commit 6227c48858e7 · 2025-05-22T19:02:59.000+10:00
Ensures that the underlying socket is opened with the correct protocol
as parsed by getaddrinfo().

Signed-off-by: Andrew Leech &lt;andrew.leech@planetinnovation.com.au&gt;
diff --git a/extmod/asyncio/stream.py b/extmod/asyncio/stream.py
@@ -180,11 +180,11 @@ async def start_server(cb, host, port, backlog=5, ssl=None):
     import socket
 
     # Create and bind server socket.
-    host = socket.getaddrinfo(host, port)[0]  # TODO this is blocking!
-    s = socket.socket()
+    addr_info = socket.getaddrinfo(host, port)[0]  # TODO this is blocking!
+    s = socket.socket(addr_info[0])  # Use address family from getaddrinfo
     s.setblocking(False)
     s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-    s.bind(host[-1])
+    s.bind(addr_info[-1])
     s.listen(backlog)
 
     # Create and return server object and task.
diff --git a/tests/multi_net/asyncio_tcp_server_client_ipv6.py b/tests/multi_net/asyncio_tcp_server_client_ipv6.py
@@ -0,0 +1,72 @@
+# Test asyncio TCP server and client using start_server() and open_connection() with IPv6
+
+try:
+    import asyncio
+    import socket
+except ImportError:
+    print("SKIP")
+    raise SystemExit
+
+try:
+    # Check if IPv6 is supported
+    socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
+except (AttributeError, OSError):
+    print("SKIP")
+    raise SystemExit
+
+PORT = 8001  # Different from other tests to avoid conflicts
+
+
+async def handle_connection(reader, writer):
+    # Test that peername exists
+    peer = writer.get_extra_info("peername")
+    print("peer connected")
+
+    data = await reader.read(100)
+    print("echo:", data)
+    writer.write(data)
+    await writer.drain()
+
+    print("close")
+    writer.close()
+    await writer.wait_closed()
+
+    print("done")
+    ev.set()
+
+
+async def tcp_server_ipv6():
+    global ev
+    ev = asyncio.Event()
+
+    # Start server with IPv6 address
+    server = await asyncio.start_server(handle_connection, "::", PORT)
+    print("ipv6 server running")
+    multitest.next()
+
+    async with server:
+        await asyncio.wait_for(ev.wait(), 10)
+
+
+async def tcp_client_ipv6(message):
+    # Connect to the IPv6 server
+    reader, writer = await asyncio.open_connection(IPV6, PORT)
+    print("write:", message)
+    writer.write(message)
+    await writer.drain()
+
+    data = await reader.read(100)
+    print("read:", data)
+    assert data == message, "Data mismatch"
+
+
+def instance0():
+    # Get the IPv6 address using the new parameter
+    ipv6 = multitest.get_network_ip(ipv6=True)
+    multitest.globals(IPV6=ipv6)
+    asyncio.run(tcp_server_ipv6())
+
+
+def instance1():
+    multitest.next()
+    asyncio.run(tcp_client_ipv6(b"ipv6 client data"))
diff --git a/tests/net_hosted/asyncio_start_server_ipv6.py b/tests/net_hosted/asyncio_start_server_ipv6.py
@@ -0,0 +1,79 @@
+# Test asyncio.start_server() with IPv6 address
+
+try:
+    import asyncio
+    import socket
+except ImportError:
+    print("SKIP")
+    raise SystemExit
+
+try:
+    # Check if IPv6 is supported
+    socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
+except (AttributeError, OSError):
+    print("SKIP")
+    raise SystemExit
+
+PORT = 8000
+
+
+async def handle_connection(reader, writer):
+    data = await reader.read(100)
+    print("echo:", data)
+    writer.write(data)
+    await writer.drain()
+
+    print("close")
+    writer.close()
+    await writer.wait_closed()
+
+    print("done")
+    global server_done
+    server_done = True
+
+
+async def test_ipv6_server():
+    global server_done
+    server_done = False
+
+    # Start server with IPv6 address
+    print("create ipv6 server")
+    server = await asyncio.start_server(handle_connection, "::", PORT)
+    print("server running")
+
+    try:
+        # Connect with IPv6 client
+        print("connect to ipv6 server")
+        reader, writer = await asyncio.open_connection("::", PORT)
+
+        # Send test data
+        test_msg = b"ipv6 test data"
+        print("write:", test_msg)
+        writer.write(test_msg)
+        await writer.drain()
+
+        # Read response
+        data = await reader.read(100)
+        print("read:", data)
+        assert data == test_msg, "Data mismatch"
+
+        # Close client connection
+        print("close client")
+        writer.close()
+        await writer.wait_closed()
+
+        # Wait for server to complete handling
+        while not server_done:
+            await asyncio.sleep(0.1)
+
+    finally:
+        # Ensure server is closed
+        print("close server")
+        server.close()
+        await server.wait_closed()
+
+    print("test passed")
+
+
+# Run the test
+asyncio.run(test_ipv6_server())
