|
| 1 | +"""Reusable test fixtures for ``jupyter_server_proxy``.""" |
| 2 | +import os |
| 3 | +import shutil |
| 4 | +import socket |
| 5 | +import sys |
| 6 | +import time |
| 7 | +from pathlib import Path |
| 8 | +from subprocess import Popen |
| 9 | +from typing import Any, Generator, Tuple |
| 10 | +from urllib.error import URLError |
| 11 | +from urllib.request import urlopen |
| 12 | +from uuid import uuid4 |
| 13 | + |
| 14 | +from pytest import fixture |
| 15 | + |
| 16 | +HERE = Path(__file__).parent |
| 17 | +RESOURCES = HERE / "resources" |
| 18 | + |
| 19 | + |
| 20 | +@fixture |
| 21 | +def a_token() -> str: |
| 22 | + """Get a random UUID to use for a token.""" |
| 23 | + return str(uuid4()) |
| 24 | + |
| 25 | + |
| 26 | +@fixture |
| 27 | +def an_unused_port() -> int: |
| 28 | + """Get a random unused port.""" |
| 29 | + s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
| 30 | + s.bind(("127.0.0.1", 0)) |
| 31 | + s.listen(1) |
| 32 | + port = s.getsockname()[1] |
| 33 | + s.close() |
| 34 | + return port |
| 35 | + |
| 36 | + |
| 37 | +@fixture(params=["notebook", "lab"]) |
| 38 | +def a_server_cmd(request: Any) -> str: |
| 39 | + """Get a viable name for a command.""" |
| 40 | + return request.param |
| 41 | + |
| 42 | + |
| 43 | +@fixture |
| 44 | +def a_server( |
| 45 | + a_server_cmd: str, |
| 46 | + tmp_path: Path, |
| 47 | + an_unused_port: int, |
| 48 | + a_token: str, |
| 49 | +) -> Generator[str, None, None]: |
| 50 | + """Get a running server.""" |
| 51 | + # get a copy of the resources |
| 52 | + tests = tmp_path / "tests" |
| 53 | + tests.mkdir() |
| 54 | + shutil.copytree(RESOURCES, tests / "resources") |
| 55 | + args = [ |
| 56 | + sys.executable, |
| 57 | + "-m", |
| 58 | + "jupyter", |
| 59 | + a_server_cmd, |
| 60 | + f"--port={an_unused_port}", |
| 61 | + "--no-browser", |
| 62 | + "--config=./tests/resources/jupyter_server_config.py", |
| 63 | + "--debug", |
| 64 | + ] |
| 65 | + |
| 66 | + # prepare an env |
| 67 | + env = dict(os.environ) |
| 68 | + env.update(JUPYTER_TOKEN=a_token) |
| 69 | + |
| 70 | + # start the process |
| 71 | + server_proc = Popen(args, cwd=str(tmp_path), env=env) |
| 72 | + |
| 73 | + # prepare some URLss |
| 74 | + url = f"http://127.0.0.1:{an_unused_port}/" |
| 75 | + canary_url = f"{url}favicon.ico" |
| 76 | + shutdown_url = f"{url}api/shutdown?token={a_token}" |
| 77 | + |
| 78 | + retries = 10 |
| 79 | + |
| 80 | + while retries: |
| 81 | + try: |
| 82 | + urlopen(canary_url) |
| 83 | + break |
| 84 | + except URLError as err: |
| 85 | + if "Connection refused" in str(err): |
| 86 | + print( |
| 87 | + f"{a_server_cmd} not ready, will try again in 0.5s [{retries} retries]", |
| 88 | + flush=True, |
| 89 | + ) |
| 90 | + time.sleep(0.5) |
| 91 | + retries -= 1 |
| 92 | + continue |
| 93 | + raise err |
| 94 | + |
| 95 | + print(f"{a_server_cmd} is ready...", flush=True) |
| 96 | + |
| 97 | + yield url |
| 98 | + |
| 99 | + # clean up after server is no longer needed |
| 100 | + print(f"{a_server_cmd} shutting down...", flush=True) |
| 101 | + urlopen(shutdown_url, data=[]) |
| 102 | + server_proc.wait() |
| 103 | + print(f"{a_server_cmd} is stopped", flush=True) |
| 104 | + |
| 105 | + |
| 106 | +@fixture |
| 107 | +def a_server_port_and_token( |
| 108 | + a_server: str, # noqa |
| 109 | + an_unused_port: int, |
| 110 | + a_token: str, |
| 111 | +) -> Tuple[int, str]: |
| 112 | + """Get the port and token for a running server.""" |
| 113 | + return an_unused_port, a_token |
0 commit comments