[sans-io] minor test improvements

test/mitmproxy/proxy2/layers/test_tls.py

@@ -1,5 +1,6 @@
 import os
 import ssl
+import typing
 
 import pytest
 
@@ -81,63 +82,34 @@ class SSLTest:
         )
 
 
-def test_server_no_tls(tctx: context.Context):
-    """Test TLS layer without TLS"""
-    layer = tls.ServerTLSLayer(tctx)
-    playbook = tutils.playbook(layer)
-
-    # Handshake
-    assert (
-        playbook
-        >> events.DataReceived(tctx.client, b"Hello World")
-        << commands.Hook("next_layer", tutils.Placeholder())
-        >> tutils.next_layer(tutils.EchoLayer)
-        << commands.SendData(tctx.client, b"hello world")
-    )
-
-
-def test_client_tls_only(tctx: context.Context):
-    """Test TLS with client only"""
+def _test_tls_client_server(
+    tctx: context.Context,
+    alpn: typing.Optional[str]
+) -> typing.Tuple[tutils.playbook[tls.ClientTLSLayer], SSLTest]:
     layer = tls.ClientTLSLayer(tctx)
     playbook = tutils.playbook(layer)
-    tssl = SSLTest()
+    tctx.server.tls = True
+    tctx.server.address = ("example.com", 443)
+    tssl_client = SSLTest(alpn=alpn)
 
     # Handshake
-    assert playbook
-    assert layer._handle_event == layer.state_wait_for_clienthello
-
-    def interact():
-        data = tutils.Placeholder()
     assert (
         playbook
-            >> events.DataReceived(tctx.client, tssl.out.read())
-            << commands.SendData(tctx.client, data)
+        << None
     )
-        tssl.inc.write(data())
-        try:
-            tssl.obj.do_handshake()
-        except ssl.SSLWantReadError:
-            return False
-        else:
-            return True
 
-    # receive ClientHello, send ServerHello
     with pytest.raises(ssl.SSLWantReadError):
-        tssl.obj.do_handshake()
-    assert not interact()
-    # Finish Handshake
-    assert interact()
-    tssl.obj.do_handshake()
-
-    assert layer._handle_event == layer.state_process
-
-    # Echo
-    echo(playbook, tssl, tctx.client)
+        tssl_client.obj.do_handshake()
+    client_hello = tssl_client.out.read()
     assert (
         playbook
-        >> events.DataReceived(tctx.server, b"Hello")
-        << commands.SendData(tctx.server, b"hello")
+        >> events.DataReceived(tctx.client, client_hello[:42])
+        << None
     )
+    # Still waiting...
+    # Finish sending ClientHello
+    playbook >> events.DataReceived(tctx.client, client_hello[42:])
+    return playbook, tssl_client
 
 
 def echo(playbook: tutils.playbook, tssl: SSLTest, conn: context.Connection) -> None:
@@ -154,7 +126,22 @@ def echo(playbook: tutils.playbook, tssl: SSLTest, conn: context.Connection) ->
     assert tssl.obj.read() == b"hello world"
 
 
-def test_server_tls_no_conn(tctx):
+class TestServerTLS:
+    def test_no_tls(self, tctx: context.Context):
+        """Test TLS layer without TLS"""
+        layer = tls.ServerTLSLayer(tctx)
+        playbook = tutils.playbook(layer)
+
+        # Handshake
+        assert (
+            playbook
+            >> events.DataReceived(tctx.client, b"Hello World")
+            << commands.Hook("next_layer", tutils.Placeholder())
+            >> tutils.next_layer(tutils.EchoLayer)
+            << commands.SendData(tctx.client, b"hello world")
+        )
+
+    def test_no_connection(self, tctx):
         """
         The server TLS layer is initiated, but there is no active connection yet, so nothing
         should be done.
@@ -169,8 +156,7 @@ def test_server_tls_no_conn(tctx):
             << None
         )
 
-
-def test_server_tls(tctx):
+    def test_simple(self, tctx):
         layer = tls.ServerTLSLayer(tctx)
         playbook = tutils.playbook(layer)
         tctx.server.connected = True
@@ -213,34 +199,51 @@ def test_server_tls(tctx):
         echo(playbook, tssl, tctx.server)
 
 
-def _test_tls_client_server(tctx, alpn):
+class TestClientTLS:
+    def test_simple(self, tctx: context.Context):
+        """Test TLS with client only"""
         layer = tls.ClientTLSLayer(tctx)
         playbook = tutils.playbook(layer)
-    tctx.server.tls = True
-    tctx.server.address = ("example.com", 443)
-    tssl_client = SSLTest(alpn=alpn)
+        tssl = SSLTest()
 
         # Handshake
+        assert playbook
+        assert layer._handle_event == layer.state_wait_for_clienthello
+
+        def interact():
+            data = tutils.Placeholder()
             assert (
                 playbook
-        << None
+                >> events.DataReceived(tctx.client, tssl.out.read())
+                << commands.SendData(tctx.client, data)
             )
+            tssl.inc.write(data())
+            try:
+                tssl.obj.do_handshake()
+            except ssl.SSLWantReadError:
+                return False
+            else:
+                return True
 
+        # receive ClientHello, send ServerHello
         with pytest.raises(ssl.SSLWantReadError):
-        tssl_client.obj.do_handshake()
-    client_hello = tssl_client.out.read()
+            tssl.obj.do_handshake()
+        assert not interact()
+        # Finish Handshake
+        assert interact()
+        tssl.obj.do_handshake()
+
+        assert layer._handle_event == layer.state_process
+
+        # Echo
+        echo(playbook, tssl, tctx.client)
         assert (
             playbook
-        >> events.DataReceived(tctx.client, client_hello[:42])
-        << None
+            >> events.DataReceived(tctx.server, b"Hello")
+            << commands.SendData(tctx.server, b"hello")
         )
-    # Still waiting...
-    # Finish sending ClientHello
-    playbook >> events.DataReceived(tctx.client, client_hello[42:])
-    return playbook, tssl_client
 
-
-def test_tls_client_server_no_server_conn(tctx):
+    def test_no_server_conn_required(self, tctx):
         """
         Here we test the scenario where a server connection is _not_ required
         to establish TLS with the client. After determining this when parsing the ClientHello,
@@ -256,8 +259,7 @@ def test_tls_client_server_no_server_conn(tctx):
         assert data()
         assert playbook.layer._handle_event == playbook.layer.state_process
 
-
-def test_tls_client_server_alpn(tctx):
+    def test_alpn(self, tctx):
         """
         Here we test the scenario where a server connection is required (e.g. because of ALPN negotation)
         to establish TLS with the client.

test/mitmproxy/proxy2/tutils.py

@@ -30,9 +30,9 @@ def _eq(
         x, y = a[k], b[k]
 
         # if there's a placeholder, make it x.
-        if isinstance(y, Placeholder):
+        if isinstance(y, _Placeholder):
             x, y = y, x
-        if isinstance(x, Placeholder):
+        if isinstance(x, _Placeholder):
             if x.obj is None:
                 x.obj = y
             x = x.obj
@@ -56,7 +56,11 @@ def eq(
     return _eq(a, b)
 
 
-class playbook:
+T = typing.TypeVar('T', bound=Layer)
+
+
+# noinspection PyPep8Naming
+class playbook(typing.Generic[T]):
     """
     Assert that a layer emits the expected commands in reaction to a given sequence of events.
     For example, the following code asserts that the TCP layer emits an OpenConnection command
@@ -76,7 +80,7 @@ class playbook:
     x2 = list(t.handle_event(events.OpenConnectionReply(x1[-1])))
     assert x2 == []
     """
-    layer: Layer
+    layer: T
     """The base layer"""
     expected: TPlaybook
     """expected command/event sequence"""
@@ -89,7 +93,7 @@ class playbook:
 
     def __init__(
         self,
-        layer: Layer,
+        layer: T,
         expected: typing.Optional[TPlaybook] = None,
         ignore_log: bool = True
     ):
@@ -176,7 +180,7 @@ class playbook:
         return copy.deepcopy(self)
 
 
-class Placeholder:
+class _Placeholder:
     """
     Placeholder value in playbooks, so that objects (flows in particular) can be referenced before
     they are known. Example:
@@ -205,6 +209,10 @@ class Placeholder:
         return f"Placeholder:{str(self.obj)}"
 
 
+def Placeholder() -> typing.Any:
+    return _Placeholder()
+
+
 class EchoLayer(Layer):
     """Echo layer that sends all data back to the client in lowercase."""