Merge pull request #392 from manics/windows

Test Windows

Author: consideRatio

.github/workflows/test.yaml

@@ -25,19 +25,24 @@ on:
 
 jobs:
   test:
-    # NOTE: The worker environment running this job needs firefox and
-    #       geckowebdriver available. Before upgrading to ubuntu-24.04 in the
-    #       future, check and see its available in a location like this:
-    #       https://github.com/actions/runner-images/blob/main/images/linux/Ubuntu2204-Readme.md#browsers-and-drivers
-    #
-    runs-on: ubuntu-22.04
-
+    timeout-minutes: 30
     strategy:
       fail-fast: false
       matrix:
         python-version: ["3.8", "3.11"]
         jupyter_server-version: ["1", "2"]
         jupyterlab-version: ["3"]
+        os: [ubuntu-22.04]
+        include:
+          - python-version: "3.11"
+            jupyter_server-version: "2"
+            jupyterlab-version: "3"
+            os: windows-2022
+
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
 
     steps:
       - uses: actions/checkout@v3
@@ -76,7 +81,7 @@ jobs:
 
       - name: Run tests
         run: |
-          pytest -k "not acceptance"
+          pytest -k "not acceptance" -vv
 
       - name: Upload pytest and coverage reports
         if: always()

pyproject.toml

@@ -35,6 +35,7 @@ classifiers = [
     "Framework :: Jupyter :: JupyterLab :: Extensions",
     "License :: OSI Approved :: BSD License",
     "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
     "Operating System :: POSIX :: Linux",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
@@ -47,7 +48,7 @@ dependencies = [
     "aiohttp",
     "importlib_metadata >=4.8.3 ; python_version<\"3.10\"",
     "jupyter-server >=1.0",
-    "simpervisor >=0.4",
+    "simpervisor >=1.0",
 ]
 
 [project.optional-dependencies]
@@ -86,6 +87,10 @@ exclude = [
 "jupyter_server_proxy/labextension" = "share/jupyter/labextensions/@jupyterhub/jupyter-server-proxy"
 "jupyter_server_proxy/static" = "share/jupyter/nbextensions/jupyter_server_proxy"
 
+[tool.hatch.metadata]
+# Set to true to allow testing of git+https://github.com/user/repo@sha dependencies
+allow-direct-references = false
+
 [tool.hatch.metadata.hooks.nodejs]
 path = "labextension/package.json"
 fields = ["description", "authors", "urls"]

tests/conftest.py

@@ -81,16 +81,19 @@ def a_server(
         try:
             urlopen(canary_url)
             break
-        except URLError as err:
-            if "Connection refused" in str(err):
+        except URLError:
+            if not retries:
                 print(
-                    f"{a_server_cmd} not ready, will try again in 0.5s [{retries} retries]",
+                    f"{a_server_cmd} not ready, aborting",
                     flush=True,
                 )
-                time.sleep(0.5)
-                retries -= 1
-                continue
-            raise err
+                raise
+            print(
+                f"{a_server_cmd} not ready, will try again in 0.5s [{retries} retries]",
+                flush=True,
+            )
+            time.sleep(0.5)
+            retries -= 1
 
     print(f"{a_server_cmd} is ready...", flush=True)
 

tests/resources/httpinfo.py

@@ -4,6 +4,7 @@
 """
 import argparse
 import socket
+import sys
 from http.server import BaseHTTPRequestHandler, HTTPServer
 from pathlib import Path
 
@@ -28,8 +29,10 @@ def address_string(self):
         return super().address_string()
 
 
-class HTTPUnixServer(HTTPServer):
-    address_family = socket.AF_UNIX
+if sys.platform != "win32":
+
+    class HTTPUnixServer(HTTPServer):
+        address_family = socket.AF_UNIX
 
 
 if __name__ == "__main__":

tests/resources/jupyter_server_config.py

@@ -45,43 +45,43 @@ def cats_only(response, path):
 
 c.ServerProxy.servers = {
     "python-http": {
-        "command": ["python3", "./tests/resources/httpinfo.py", "--port={port}"],
+        "command": [sys.executable, "./tests/resources/httpinfo.py", "--port={port}"],
     },
     "python-http-abs": {
-        "command": ["python3", "./tests/resources/httpinfo.py", "--port={port}"],
+        "command": [sys.executable, "./tests/resources/httpinfo.py", "--port={port}"],
         "absolute_url": True,
     },
     "python-http-port54321": {
-        "command": ["python3", "./tests/resources/httpinfo.py", "--port={port}"],
+        "command": [sys.executable, "./tests/resources/httpinfo.py", "--port={port}"],
         "port": 54321,
     },
     "python-http-mappath": {
-        "command": ["python3", "./tests/resources/httpinfo.py", "--port={port}"],
+        "command": [sys.executable, "./tests/resources/httpinfo.py", "--port={port}"],
         "mappath": {
             "/": "/index.html",
         },
     },
     "python-http-mappathf": {
-        "command": ["python3", "./tests/resources/httpinfo.py", "--port={port}"],
+        "command": [sys.executable, "./tests/resources/httpinfo.py", "--port={port}"],
         "mappath": mappathf,
     },
     "python-websocket": {
-        "command": ["python3", "./tests/resources/websocket.py", "--port={port}"],
+        "command": [sys.executable, "./tests/resources/websocket.py", "--port={port}"],
         "request_headers_override": {
             "X-Custom-Header": "pytest-23456",
         },
     },
     "python-unix-socket-true": {
         "command": [
-            "python3",
+            sys.executable,
             "./tests/resources/httpinfo.py",
             "--unix-socket={unix_socket}",
         ],
         "unix_socket": True,
     },
     "python-unix-socket-file": {
         "command": [
-            "python3",
+            sys.executable,
             "./tests/resources/httpinfo.py",
             "--unix-socket={unix_socket}",
         ],
@@ -93,29 +93,29 @@ def cats_only(response, path):
         "unix_socket": "/tmp/jupyter-server-proxy-test-socket",
     },
     "python-request-headers": {
-        "command": ["python3", "./tests/resources/httpinfo.py", "--port={port}"],
+        "command": [sys.executable, "./tests/resources/httpinfo.py", "--port={port}"],
         "request_headers_override": {
             "X-Custom-Header": "pytest-23456",
         },
     },
     "python-gzipserver": {
-        "command": ["python3", "./tests/resources/gzipserver.py", "{port}"],
+        "command": [sys.executable, "./tests/resources/gzipserver.py", "{port}"],
     },
     "python-http-rewrite-response": {
-        "command": ["python3", "./tests/resources/httpinfo.py", "--port={port}"],
+        "command": [sys.executable, "./tests/resources/httpinfo.py", "--port={port}"],
         "rewrite_response": translate_ciao,
         "port": 54323,
     },
     "python-chained-rewrite-response": {
-        "command": ["python3", "./tests/resources/httpinfo.py", "--port={port}"],
+        "command": [sys.executable, "./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={port}"],
+        "command": [sys.executable, "./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={port}"],
+        "command": [sys.executable, "./tests/resources/httpinfo.py", "--port={port}"],
         "rewrite_response": [cats_only, dog_to_cat],
     },
     "python-proxyto54321-no-command": {"port": 54321},

tests/test_proxies.py

@@ -1,6 +1,7 @@
 import asyncio
 import gzip
 import json
+import sys
 from http.client import HTTPConnection
 from io import BytesIO
 from typing import Tuple
@@ -23,15 +24,30 @@ def request_get(port, path, token, host=LOCALHOST):
     return h.getresponse()
 
 
-@pytest.mark.parametrize(
-    "server_process_path",
-    [
-        "/python-http/",
+PARAMETERIZED_SERVER_PROCESS_PATHS = [
+    "/python-http/",
+    pytest.param(
         "/python-unix-socket-true/",
+        marks=pytest.mark.skipif(
+            sys.platform == "win32", reason="Unix socket not supported on Windows"
+        ),
+    ),
+    pytest.param(
         "/python-unix-socket-file/",
+        marks=pytest.mark.skipif(
+            sys.platform == "win32", reason="Unix socket not supported on Windows"
+        ),
+    ),
+    pytest.param(
         "/python-unix-socket-file-no-command/",
-    ],
-)
+        marks=pytest.mark.skipif(
+            sys.platform == "win32", reason="Unix socket not supported on Windows"
+        ),
+    ),
+]
+
+
+@pytest.mark.parametrize("server_process_path", PARAMETERIZED_SERVER_PROCESS_PATHS)
 def test_server_proxy_minimal_proxy_path_encoding(
     server_process_path: str, a_server_port_and_token: Tuple[int, str]
 ) -> None:
@@ -50,15 +66,7 @@ def test_server_proxy_minimal_proxy_path_encoding(
     assert f"GET /{special_path}&token=" in s
 
 
-@pytest.mark.parametrize(
-    "server_process_path",
-    [
-        "/python-http/",
-        "/python-unix-socket-true/",
-        "/python-unix-socket-file/",
-        "/python-unix-socket-file-no-command/",
-    ],
-)
+@pytest.mark.parametrize("server_process_path", PARAMETERIZED_SERVER_PROCESS_PATHS)
 def test_server_proxy_hash_sign_encoding(
     server_process_path: str, a_server_port_and_token: Tuple[int, str]
 ) -> None: