tests(testserver): added support for SSL (#80)

Author: mxschmitt

local-requirements.txt

@@ -11,3 +11,5 @@ black==19.10b0
 pre-commit==2.6.0
 flake8==3.8.3
 twine==3.2.0
+pyOpenSSL==19.1.0
+service_identity==18.1.0

tests/conftest.py

@@ -19,7 +19,7 @@
 
 import playwright
 
-from .server import server as server_object
+from .server import test_server
 from .utils import utils as utils_object
 
 
@@ -92,7 +92,12 @@ async def page(context):
 
 @pytest.fixture
 def server():
-    yield server_object
+    yield test_server.server
+
+
+@pytest.fixture
+def https_server():
+    yield test_server.https_server
 
 
 @pytest.fixture
@@ -101,16 +106,16 @@ def utils():
 
 
 @pytest.fixture(autouse=True, scope="session")
-async def start_http_server():
-    server_object.start()
+async def start_server():
+    test_server.start()
     yield
-    server_object.stop()
+    test_server.stop()
 
 
 @pytest.fixture(autouse=True)
 def after_each_hook():
     yield
-    server_object.reset()
+    test_server.reset()
 
 
 @pytest.fixture(scope="session")

tests/server.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import abc
 import asyncio
 import gzip
 import mimetypes
@@ -20,24 +21,30 @@
 import threading
 from contextlib import closing
 from http import HTTPStatus
+from pathlib import Path
 
-from twisted.internet import reactor
+from OpenSSL import crypto
+from twisted.internet import reactor, ssl
 from twisted.web import http
 
+_dirname = Path(os.path.join(os.path.dirname(__file__)))
 
-def find_free_port():
+
+def _find_free_port():
     with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
         s.bind(("", 0))
         s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
         return s.getsockname()[1]
 
 
 class Server:
+    protocol = "http"
+
     def __init__(self):
-        self.PORT = find_free_port()
-        self.EMPTY_PAGE = f"http://localhost:{self.PORT}/empty.html"
-        self.PREFIX = f"http://localhost:{self.PORT}"
-        self.CROSS_PROCESS_PREFIX = f"http://127.0.0.1:{self.PORT}"
+        self.PORT = _find_free_port()
+        self.EMPTY_PAGE = f"{self.protocol}://localhost:{self.PORT}/empty.html"
+        self.PREFIX = f"{self.protocol}://localhost:{self.PORT}"
+        self.CROSS_PROCESS_PREFIX = f"{self.protocol}://127.0.0.1:{self.PORT}"
         # On Windows, this list can be empty, reporting text/plain for scripts.
         mimetypes.add_type("text/html", ".html")
         mimetypes.add_type("text/css", ".css")
@@ -48,6 +55,10 @@ def __init__(self):
     def __repr__(self) -> str:
         return self.PREFIX
 
+    @abc.abstractmethod
+    def listen(self, factory):
+        pass
+
     def start(self):
         request_subscribers = {}
         auth = {}
@@ -59,7 +70,7 @@ def start(self):
         self.csp = csp
         self.routes = routes
         self.gzip_routes = gzip_routes
-        static_path = os.path.join(os.path.dirname(__file__), "assets")
+        static_path = _dirname / "assets"
 
         class TestServerHTTPHandler(http.Request):
             def process(self):
@@ -116,15 +127,7 @@ class MyHttp(http.HTTPChannel):
         class MyHttpFactory(http.HTTPFactory):
             protocol = MyHttp
 
-        reactor.listenTCP(self.PORT, MyHttpFactory())
-        self.thread = threading.Thread(
-            target=lambda: reactor.run(installSignalHandlers=0)
-        )
-        self.thread.start()
-
-    def stop(self):
-        reactor.stop()
-        self.thread.join()
+        self.listen(MyHttpFactory())
 
     async def wait_for_request(self, path):
         if path in self.request_subscribers:
@@ -161,4 +164,47 @@ def handle_redirect(request):
         self.set_route(from_, handle_redirect)
 
 
-server = Server()
+class HTTPServer(Server):
+    def listen(self, factory):
+        reactor.listenTCP(self.PORT, factory)
+
+
+class HTTPSServer(Server):
+    protocol = "https"
+
+    def listen(self, factory):
+        cert = ssl.PrivateCertificate.fromCertificateAndKeyPair(
+            ssl.Certificate.loadPEM(
+                (_dirname / "testserver" / "cert.pem").read_bytes()
+            ),
+            ssl.KeyPair.load(
+                (_dirname / "testserver" / "key.pem").read_bytes(), crypto.FILETYPE_PEM
+            ),
+        )
+        contextFactory = cert.options()
+        reactor.listenSSL(self.PORT, factory, contextFactory)
+
+
+class TestServer:
+    def __init__(self) -> None:
+        self.server = HTTPServer()
+        self.https_server = HTTPSServer()
+
+    def start(self) -> None:
+        self.server.start()
+        self.https_server.start()
+        self.thread = threading.Thread(
+            target=lambda: reactor.run(installSignalHandlers=0)
+        )
+        self.thread.start()
+
+    def stop(self) -> None:
+        reactor.stop()
+        self.thread.join()
+
+    def reset(self) -> None:
+        self.server.reset()
+        self.https_server.reset()
+
+
+test_server = TestServer()

tests/test_ignore_https_errors.py

@@ -0,0 +1,33 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import pytest
+
+from playwright import Error
+
+
+async def test_ignore_https_error_should_work(browser, https_server):
+    context = await browser.newContext(ignoreHTTPSErrors=True)
+    page = await context.newPage()
+    response = await page.goto(https_server.EMPTY_PAGE)
+    assert response.ok
+    await context.close()
+
+
+async def test_ignore_https_error_should_work_negative_case(browser, https_server):
+    context = await browser.newContext()
+    page = await context.newPage()
+    with pytest.raises(Error):
+        await page.goto(https_server.EMPTY_PAGE)
+    await context.close()

tests/testserver/cert.pem

@@ -0,0 +1,28 @@
+-----BEGIN CERTIFICATE-----
+MIIEsjCCApoCCQCIPLvQDgoZojANBgkqhkiG9w0BAQsFADAaMRgwFgYDVQQDDA9w
+dXBwZXRlZXItdGVzdHMwIBcNMTkwMjEzMTkwNzQzWhgPMzAxODA2MTYxOTA3NDNa
+MBoxGDAWBgNVBAMMD3B1cHBldGVlci10ZXN0czCCAiIwDQYJKoZIhvcNAQEBBQAD
+ggIPADCCAgoCggIBAJue1yqA4qn0SJR3rgTd6sCYVHMKqUouD0No09H7qf+5ZaIb
+3yGpC5J9Bsf/ZbvD5xpgqbGEYkHj7Qh6Z/cPCSHA+ZpsUzDXVrLFXrdwwiK1FrIS
+rDI2RYsiP+e52XPC/acWC/7f+E54C62oMjYojaVaDn8gu06gyS1rXK2JITQ6CrKn
+b+PVSkjtPB4ku245u1qCKoblkNEZSkEmw8Csl+gw6ydGqOSQAoo8rsDte5zCMnPX
+7XzL6EhRqpiVx7PCuQWnXhL7j9N214Pit7s7F8TeAA6yZR9oswW+h0dWO+XwocJ1
+rwkODXOngbCqO+GUxyuavIl2m0d2MP8n6Wa9RVqYetmPQzafKkR5hjiV4mgCFqNQ
+bHMTjI6udcR+h5pYoWKxN9/gJaWwyAAzck0AiMeGVrvKR3JKACqlTMzy/Y30obRF
+dddURoFf2wjKJvuTK9hHI7pwM5tlPEwu9bTCWNA6XXs2Bq1f6N2OAKhpKOcihNem
+aeGUPmygLPb66z9JO75yZXM+1yk1ScXaNHWZLmluVpEPk7maWULpSpxPAlaN3PmK
+8lEihgfBBovampxZo8SvPEt+g5jGyPq9weNg8ic8476PuRVQdg7D8spVxl6whDlJ
+bcFojzgrX70t13jqZOtla4WK1vRnZAGplfoH0i5WvAVw+i5S/OVzsmNDtGFbAgMB
+AAEwDQYJKoZIhvcNAQELBQADggIBADUAjA/dH+b5UxDC5SL98w1hphw9PvD1cuGS
+sVnKPM236JoTiO3KVfm3NMBfSoBi1hPNkXzqr/R4xbyje4Kc4oYcdjGtpll3T5da
+wkx1+qumx6O2mEaOshxh76dfZfZne6SQphQKHw8PD10CfDb/NMnmdEbiOSENSqS4
+jGELuGviUl361oCBU45UEN7lfs7ANAhwSZyEO7deroyGdvsxfQUaqQrEQsG30jn3
+t0cCamYU6eK3bNR/yNXJrZFv3dzoquRY9H52YtVElRqdAIsNlnbxbqz0cm5xFKFt
+YTIrMSO1EvDTbB0PPwC5FJvONHhjwiWzgVXSnZrcs/05TsWWnSHH92S+wGCIBC+0
+6fcSKnjdBn9ks5TrDX0TRY6N890KyDQWxPRhHYrMVpn833WY8y/SguxqiMgLFgMD
+WLy6yZzJloW7NgpLGAfMA0nMG1O92hfKmQw82Pyf3SVXGTDiXiEOXn0vN6bsPaV/
+3Ws2LJQECnVfHj3TsuxdtwcO+VGcFCarMOqlhE6IlQzfK8ykYdP6wCkVgXEtiVCR
+T1OWUWCFowoFpwBFLf1lA065qsAymddnkrUEOMiScZ/3OZhmd+FvgQ+O0iYuqpeI
+xauiQ68+Jb4KjVWnu5QBVq8n1vUJ5+gAzowNMN9G+1+A282Ox23T48dce22BTS6B
+3Taaccm+
+-----END CERTIFICATE-----

tests/testserver/key.pem

@@ -0,0 +1,52 @@
+-----BEGIN PRIVATE KEY-----
+MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQCbntcqgOKp9EiU
+d64E3erAmFRzCqlKLg9DaNPR+6n/uWWiG98hqQuSfQbH/2W7w+caYKmxhGJB4+0I
+emf3DwkhwPmabFMw11ayxV63cMIitRayEqwyNkWLIj/nudlzwv2nFgv+3/hOeAut
+qDI2KI2lWg5/ILtOoMkta1ytiSE0Ogqyp2/j1UpI7TweJLtuObtagiqG5ZDRGUpB
+JsPArJfoMOsnRqjkkAKKPK7A7XucwjJz1+18y+hIUaqYlcezwrkFp14S+4/TdteD
+4re7OxfE3gAOsmUfaLMFvodHVjvl8KHCda8JDg1zp4GwqjvhlMcrmryJdptHdjD/
+J+lmvUVamHrZj0M2nypEeYY4leJoAhajUGxzE4yOrnXEfoeaWKFisTff4CWlsMgA
+M3JNAIjHhla7ykdySgAqpUzM8v2N9KG0RXXXVEaBX9sIyib7kyvYRyO6cDObZTxM
+LvW0wljQOl17NgatX+jdjgCoaSjnIoTXpmnhlD5soCz2+us/STu+cmVzPtcpNUnF
+2jR1mS5pblaRD5O5mllC6UqcTwJWjdz5ivJRIoYHwQaL2pqcWaPErzxLfoOYxsj6
+vcHjYPInPOO+j7kVUHYOw/LKVcZesIQ5SW3BaI84K1+9Ldd46mTrZWuFitb0Z2QB
+qZX6B9IuVrwFcPouUvzlc7JjQ7RhWwIDAQABAoICAFUvM5SejHR/taMfh/A+EZxv
+RfrbISPr5or9vMU6vymuMIX2P8PLJvx+19Fuah/H8p8rvnffgXGT9FIpvvMsFdGW
+MotnNHqNxXWCOICthnc9LTk4o22w64xnqReNUgzd9b8agGJ58w/xAmOCqEmhFTgn
+/bt1DVLTDIyCMm8Dm1tdUjHNGaBbRph40+mkLbz+eSHoEqNY0lbDQzQ6pfi4AUcm
+T/Jl6VmDwwAsi3QsCvgaDUgAMI2ZiILdwUZY5sHtmx4PKZ22elpEuWAGIJCqni4z
+X1CsMlJpG2XPj3lrKMqLV+B8Tt3kBVUDoig0ZybqK8QgpYeRlxodBmEFVevZOzar
+r/qDRh+vrQQxjpFYfrMkPiueRmz0+K1a7KiKSmrjHIb9CTi3BpgEhawbsOB7M+9z
+G5Q7YtGbVyJPmEAAva89ZZqYvyAwxZk3V4pwpoUYzjgPiHm6Oq0vzKPuCgQxsYzx
+UrCVRo7pSE4tTin4SRThY2/yHiMJl8QY//MkahgY8KEHtXE36km6pMRH/ssdSm+C
+SNCOtzUDY8wpaDQ++aB29NWqgnSgwoBrRUXr5NHq+wNpWtmD7L0wDSKUCPfiCduR
+DoSHBIno5U2jgPrH5Wk7X7loG2XxiDR0qtNOiH24SCI+C1nsLRGBS2Tmo0Qby/Ll
+oYYCZ0U3S7wk9UY5HcuRAoIBAQDIl8HTaIuzyOrrpsRdUv8jAxnkdhVjYhWGp7mU
+5concRazcEO5/vDJlsIuQI/w7U+xS7PCBPRq7NxUtaUntlQ00s224Ws0sPHIWUD0
+NBsodTX8hik2PdmZ5ZbBHVaeVbMV/5zV8eOPGGCsAn//7l4YIp2I2Abs79leqSDI
+7tBpF4IsUq7xqcVZ1QhWBZmTqE4gYDVqFEVe9O6OmAdkM1qxVSur2E5Ib+islnu8
+yKlu0QlXg596zLVAjxajKYf20NXxh7O+xt5QDEy3dmJEhz5viS6eI7QECM7Lid2T
+c22mABSKzYfbwQroM9yBiI3p0zjwRhha0hRKocLkSiNUlOWHAoIBAQDGmwRM6Xmu
+j7/lV3KvrOmvcNIbUwMbYY/ATY3Wuph6GFjwdliRiju9F3ZUHMV+yNlVDqH3DeRC
+QwGKIcFiVk+4fq1AbWVCWk2MOf49akeJwqFzgF8nkxVXF9PS73VdEvreSvy7g89t
+ABqJN6pmGHWVkE1mf/3LJyS2Y7WCZqSaWG3TBZ2SRb2t/t/DnX1L6tzNMkuNAizA
+sDB3J1hH1eGcWn/24NB9sc7i2Bk+Cpi0S/xDn9FfoBo5U0p/lpopgfFoSeQZXq1A
+KIQdtUPLp3KR9EG/ItimfW875zqFe8bekB9/gakyLsbIyINz1iQQS1L1FFmOO8zN
+RtRmm3MrG9qNAoIBAQC1v2rLFgqeVwkjgvKgbDbnjkPDkIpIhfJjE00+8AV+PyUG
+aE21FJ0uyf4e0jiZXyu5xJGW1c5vozTvO7XsiXM6eVYSwaPVFg28LcKAgUWqHqlP
+qG9myhuDKVaymtaEl7mv0O5VmtlIKhpNP+aiCWQQEi0SdEmyHI+jCTK/XEJRNg+o
+ATKpm91IS5FF/8Tq2LAQ/ZroBn3kT6BmarEnxLADxNvQ1Cf50gvLdH2gy19ZHOWN
++aBiL2B6oissotCifQ2bzgy6ao27kalhAU6AMNoNTQqEFm1gymo0WTH+C7PpmGEE
+cr0KC5rKUVMVuph6p/sLGTev8nCYPoDLP7FLTa25AoIBAGmP559B0c141pR+AJVj
+oOoBW4vueY5KMvARyLxDfdwXqN5W6QiiotIE8H4QtOCIvQu6tVftaE/X8a+L9Y/h
+NIppuoiuHM5B1UodYQcfwFp2uv37U5hjU0pxfcN2R7lq5zDURrUcgFn9Xh1lGwsd
+IRKYGqvKiAk9CwRuxwFCsWbgba9mIrSmoQUknacJxJlfgnEGtKWEbGkWvQv4O7Ii
++sHyUGXWZLsKkV59Yh1Z4ISkhrci8VSUcpvZq5VZZSN+z+OQss7RReD+KArqV9id
+bgYp//AqA2Gq9j6uzqo4eiG+FR/euSHVPw9llIkzXwPSJYvifx9cpaTOawMGyRY2
+vdkCggEBAJECl41qbQE7OIPsSmhcz0nK6L4aIkdOxZ6hs6xO7fPwh7EntojPIB6J
+bMuvfujqW4SZ+ZpwZkCc8p8j2VuQvlXLI+s6923IdYAOK5ND9q3Xj7AqgJjUKbhH
+lpYUtfDmIjqVADoiIYXmZBPAo7QvzkX7A2qclV7VL/Dc94bBS6M+v/JGh7QyTCsO
+oPK6IOlGL1yg+CdZIzdSiJKVeESPMOBhNtPhm+vOXvRV08ECEILD1j52rUKcPs+I
+uINxopeXePgekedm7nyAW3IMHFKa4EiuEU3LQOaWeKEnaxNdOh12Pyyd6w2iAmrr
+rj/p/2CWVN8OTi7CY5cOTCadHZRyjYA=
+-----END PRIVATE KEY-----