Add tests for unix_socket server processes

Author: consideRatio

tests/resources/httpinfo.py

@@ -1,5 +1,11 @@
+"""
+Simple webserver to respond with an echo of the sent request. It can listen to
+either a tcp port or a unix socket.
+"""
+import argparse
+import socket
+from pathlib import Path
 from http.server import HTTPServer, BaseHTTPRequestHandler
-import sys
 
 class EchoRequestInfo(BaseHTTPRequestHandler):
     def do_GET(self):
@@ -9,9 +15,31 @@ def do_GET(self):
         self.wfile.write('{}\n'.format(self.requestline).encode())
         self.wfile.write('{}\n'.format(self.headers).encode())
 
+    def address_string(self):
+        """
+        Overridden to fix logging when serving on Unix socket.
+
+        FIXME: There are still broken pipe messages showing up in the jupyter
+               server logs when running tests with the unix sockets.
+        """
+        if isinstance(self.client_address, str):
+            return self.client_address  # Unix sock
+        return super().address_string()
+
+
+class HTTPUnixServer(HTTPServer):
+    address_family = socket.AF_UNIX
+
 
 if __name__ == '__main__':
-    port = int(sys.argv[1])
-    server_address = ('', port)
-    httpd = HTTPServer(server_address, EchoRequestInfo)
+    ap = argparse.ArgumentParser()
+    ap.add_argument('--port', type=int)
+    ap.add_argument('--unix-socket')
+    args = ap.parse_args()
+
+    if args.unix_socket:
+        Path(args.unix_socket).unlink(missing_ok=True)
+        httpd = HTTPUnixServer(args.unix_socket, EchoRequestInfo)
+    else:
+        httpd = HTTPServer(('127.0.0.1', args.port), EchoRequestInfo)
     httpd.serve_forever()

tests/resources/jupyter_server_config.py

@@ -30,24 +30,24 @@ def cats_only(response, path):
 
 c.ServerProxy.servers = {
     'python-http': {
-        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'command': ['python3', './tests/resources/httpinfo.py', '--port={port}'],
     },
     'python-http-abs': {
-        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'command': ['python3', './tests/resources/httpinfo.py', '--port={port}'],
         'absolute_url': True
     },
     'python-http-port54321': {
-        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'command': ['python3', './tests/resources/httpinfo.py', '--port={port}'],
         'port': 54321,
     },
     'python-http-mappath': {
-        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'command': ['python3', './tests/resources/httpinfo.py', '--port={port}'],
         'mappath': {
             '/': '/index.html',
         }
     },
     'python-http-mappathf': {
-        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'command': ['python3', './tests/resources/httpinfo.py', '--port={port}'],
         'mappath': mappathf,
     },
     'python-websocket' : {
@@ -56,8 +56,21 @@ def cats_only(response, path):
             'X-Custom-Header': 'pytest-23456',
         }
     },
+    'python-unix-socket-true' : {
+        'command': ['python3', './tests/resources/httpinfo.py', '--unix-socket={unix_socket}'],
+        'unix_socket': True,
+    },
+    'python-unix-socket-file' : {
+        'command': ['python3', './tests/resources/httpinfo.py', '--unix-socket={unix_socket}'],
+        'unix_socket': "/tmp/jupyter-server-proxy-test-socket",
+    },
+    'python-unix-socket-file-no-command' : {
+        # this server process can be started earlier by first interacting with
+        # python-unix-socket-file
+        'unix_socket': "/tmp/jupyter-server-proxy-test-socket",
+    },
     'python-request-headers': {
-        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'command': ['python3', './tests/resources/httpinfo.py', '--port={port}'],
         'request_headers_override': {
             'X-Custom-Header': 'pytest-23456',
         }
@@ -66,20 +79,20 @@ def cats_only(response, path):
         'command': ['python3', './tests/resources/gzipserver.py', '{port}'],
     },
     'python-http-rewrite-response': {
-        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'command': ['python3', './tests/resources/httpinfo.py', '--port={port}'],
         'rewrite_response': translate_ciao,
         'port': 54323,
     },
     'python-chained-rewrite-response': {
-        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'command': ['python3', './tests/resources/httpinfo.py', '--port={port}'],
         'rewrite_response': [translate_ciao, hello_to_foo],
     },
     'python-cats-only-rewrite-response': {
-        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'command': ['python3', './tests/resources/httpinfo.py', '--port={port}'],
         'rewrite_response': [dog_to_cat, cats_only],
     },
     'python-dogs-only-rewrite-response': {
-        'command': ['python3', './tests/resources/httpinfo.py', '{port}'],
+        'command': ['python3', './tests/resources/httpinfo.py', '--port={port}'],
         'rewrite_response': [cats_only, dog_to_cat],
     },
     'python-proxyto54321-no-command': {

tests/test_proxies.py

@@ -22,18 +22,36 @@ def request_get(port, path, token, host='localhost'):
     return h.getresponse()
 
 
-def test_server_proxy_minimal_proxy_path_encoding():
+@pytest.mark.parametrize(
+    'server_process_path',
+    [
+        "/python-http/",
+        "/python-unix-socket-true/",
+        "/python-unix-socket-file/",
+        "/python-unix-socket-file-no-command/",
+    ],
+)
+def test_server_proxy_minimal_proxy_path_encoding(server_process_path):
     """Test that we don't encode anything more than we must to have a valid web
     request."""
     special_path = quote("Hello world 123 åäö 🎉你好世界±¥ :/[]@!$&'()*+,;=-._~?key1=value1", safe=":/?#[]@!$&'()*+,;=-._~")
-    test_url = '/python-http/' + special_path
+    test_url = server_process_path + special_path
     r = request_get(PORT, test_url, TOKEN)
     assert r.code == 200
     s = r.read().decode('ascii')
     assert 'GET /{}&token='.format(special_path) in s
 
 
-def test_server_proxy_hash_sign_encoding():
+@pytest.mark.parametrize(
+    'server_process_path',
+    [
+        "/python-http/",
+        "/python-unix-socket-true/",
+        "/python-unix-socket-file/",
+        "/python-unix-socket-file-no-command/",
+    ],
+)
+def test_server_proxy_hash_sign_encoding(server_process_path):
     """
     FIXME: This is a test to establish the current behavior, but if it should be
            like this is a separate question not yet addressed.
@@ -44,23 +62,23 @@ def test_server_proxy_hash_sign_encoding():
 
     # Case 0: a reference case
     path = "?token={}".format(TOKEN)
-    h.request('GET', '/python-http/' + path)
+    h.request('GET', server_process_path + path)
     r = h.getresponse()
     assert r.code == 200
     s = r.read().decode('ascii')
     assert 'GET /{} '.format(path) in s
 
     # Case 1: #bla?token=secret -> everything following # ignored -> redirect because no token
     path = "#bla?token={}".format(TOKEN)
-    h.request('GET', '/python-http/' + path)
+    h.request('GET', server_process_path + path)
     r = h.getresponse()
     assert r.code == 200
     s = r.read().decode('ascii')
     assert 'GET / ' in s
 
     # Case 2: %23bla?token=secret -> %23 is # -> everything following # ignored -> redirect because no token
     path = "%23?token={}".format(TOKEN)
-    h.request('GET', '/python-http/' + path)
+    h.request('GET', server_process_path + path)
     r = h.getresponse()
     assert r.code == 200
     s = r.read().decode('ascii')
@@ -79,7 +97,7 @@ def test_server_proxy_hash_sign_encoding():
     #       return await self.proxy(self.port, path)
     #   TypeError: object NoneType can't be used in 'await' expression
     path = "?token={}#test".format(TOKEN)
-    h.request('GET', '/python-http/' + path)
+    h.request('GET', server_process_path + path)
     r = h.getresponse()
     assert r.code == 302
     s = r.read().decode('ascii')