1 Commits

Author SHA1 Message Date
klemek 069998f8ac tests: more coverage
Python Lint CI / ruff-format-check (push) Successful in 57s
Python Lint CI / ty (push) Successful in 57s
Python Lint CI / ruff (push) Successful in 58s
Docker CI / docker-build (push) Successful in 1m43s
Python Test CI / coverage (push) Failing after 1m59s
2026-05-05 15:10:03 +02:00
13 changed files with 125 additions and 242 deletions
+1 -2
View File
@@ -1,6 +1,6 @@
[project]
name = "stapler"
version = "1.4.0"
version = "1.2.4"
description = "Static pages as simple as a gzip file"
requires-python = ">=3.14"
dependencies = [
@@ -21,7 +21,6 @@ module-name = "stapler"
[dependency-groups]
dev = [
"coverage>=7.13.5",
"parameterized>=0.9.0",
"pytest>=9.0.3",
"ruff>=0.15.10",
"ty>=0.0.29",
+6 -12
View File
@@ -5,8 +5,6 @@ import ssl
import subprocess
import typing
from stapler.strings import valid_host
if typing.TYPE_CHECKING:
from .params import Parameters
@@ -37,7 +35,7 @@ class CertManager:
self.with_certbot: bool = params.with_certbot
self.last_file_change: int | float = 0
def init(self) -> None:
def init(self, hosts: list[str]) -> None:
self.logger.debug("Initializing...")
if not self.certbot_www.exists():
self.certbot_www.mkdir(parents=True)
@@ -45,6 +43,8 @@ class CertManager:
if not self.self_signed_path.exists():
self.self_signed_path.mkdir(parents=True)
self.logger.debug("Created %s", self.self_signed_path)
for host in hosts:
self.init_cert(host)
def exists(self, host: str) -> bool:
return self.__exists_certbot(host) or self.__exists_self_signed(host)
@@ -57,7 +57,7 @@ class CertManager:
def create_or_update(self, host: str) -> bool:
created = self.init_cert(host)
if self.with_certbot and valid_host(host) and self.__create_certbot(host):
if self.with_certbot and self.__create_certbot(host):
return True
return created or self.__create_self_signed(host)
@@ -185,16 +185,11 @@ class CertManager:
return False
return self.__exists_certbot(host)
def servername_callback(
self,
socket: ssl.SSLSocket | ssl.SSLObject,
host: str | None,
_: ssl.SSLSocket,
/,
def sni_callback(
self, socket: ssl.SSLObject, host: str | None, _: ssl.SSLContext, /
) -> None | int:
if host is None:
return None
self.logger.debug("servername callback: %s", host)
if not self.exists(host) and not self.create_or_update(host):
return None
cert_file = self.get_cert(host)
@@ -205,7 +200,6 @@ class CertManager:
cert_file,
key_file,
)
new_context.set_alpn_protocols(["http/1.1"])
socket.context = new_context
except Exception:
self.logger.exception("Could not create HTTPS context for %s", host)
+1 -1
View File
@@ -16,7 +16,7 @@ class DataDir:
]
PATH_REGEX = re.compile(r"^[\w-]+$")
NEEDED_FILES: typing.ClassVar[list[str]] = ["favicon.ico", "robots.txt"]
NEEDED_FILES: typing.ClassVar[list[str]] = ["favicon.ico"]
def __init__(self, root_path: str) -> None:
self.logger: logging.Logger = logging.getLogger(self.__class__.__name__)
+31 -51
View File
@@ -16,7 +16,6 @@ import requests
from . import PKG_VERSION, STAPLER_ASCII, logs
from .data_dir import DataDir
from .strings import sanitize_string, valid_host
if typing.TYPE_CHECKING:
from .page import Page
@@ -26,9 +25,8 @@ if typing.TYPE_CHECKING:
class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
SANITIZE_REGEX = re.compile(r"[^\x20-\x7F]+")
timeout = 10
protocol_version = "HTTP/1.1"
REQUEST_COUNT = 0
@typing.override
def __init__(
@@ -43,7 +41,6 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
self.__host: str | None = None
self.__in_size: int | None = None
self.https: bool = params.https
self.__class__.REQUEST_COUNT += 1
super().__init__(*args, **kwargs)
with contextlib.suppress(Exception):
self.connection.close()
@@ -83,7 +80,7 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
@typing.override
def address_string(self) -> str: # pragma: no cover
return sanitize_string(super().address_string())
return self.SANITIZE_REGEX.sub("?", super().address_string())
@typing.override
def log_message(self, format: str, *args: typing.Any) -> None: # pragma: no cover
@@ -95,25 +92,9 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
fmt = "%s - " + format
self.logger.error(fmt, self.address_string(), *args)
def _pre_log_request(self) -> None: # pragma: no cover
args = (
"...",
self.address_string(),
self.host,
format(self.__class__.REQUEST_COUNT, "07_d"),
sanitize_string(self.requestline),
)
fmt = "%s - %s - %s - %s - %s"
if self.in_size > 0:
args = (*args, self.in_size)
fmt += " - %s"
self.logger.debug(fmt, *args)
@typing.override
def log_request(self, code: str = "?", size: str = "-") -> None: # ty:ignore[invalid-method-override] # pragma: no cover
if isinstance(code, http.HTTPStatus):
code = code.value
if isinstance(code, int):
color = logs.TermColor.RED
if 100 <= code < 200:
color = logs.TermColor.CYAN
@@ -123,17 +104,16 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
color = logs.TermColor.BLUE
elif 400 <= code < 500:
color = logs.TermColor.YELLOW
code = color + str(code) + logs.TermColor.RESET
code = color + str(code.value) + logs.TermColor.RESET
if size == "" and self.out_size > 0:
size = str(self.out_size)
args = (
code,
self.address_string(),
self.host,
format(self.__class__.REQUEST_COUNT, "07_d"),
sanitize_string(self.requestline),
self.SANITIZE_REGEX.sub("?", self.requestline),
)
fmt = "%s - %s - %s - %s - %s"
fmt = "%s - %s - %s - %s"
if size != "":
args = (*args, size)
fmt += " - %s"
@@ -153,8 +133,7 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
self.send_header("Content-Length", str(len(encoded)))
self.send_header("Connection", "close")
self.end_headers()
if self.command != http.HTTPMethod.HEAD:
self.wfile.write(encoded)
self.wfile.write(encoded)
self.close_connection = True
def send_status_only(
@@ -197,7 +176,6 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
headers=headers,
allow_redirects=False,
timeout=480,
stream=False,
)
except Exception as e:
self.send_error(
@@ -223,7 +201,7 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
self.send_header("Content-Length", str(out_size := len(response.content)))
self.send_header("Connection", "close")
self.end_headers()
if out_size > 0 and self.command != http.HTTPMethod.HEAD:
if out_size > 0:
self.wfile.write(response.content)
self.close_connection = True
@@ -258,6 +236,19 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
and len(self.headers[key]) > 0
)
def _pre_log_request(self) -> None: # pragma: no cover
args = (
"...",
self.address_string(),
self.host,
self.SANITIZE_REGEX.sub("?", self.requestline),
)
fmt = "%s - %s - %s - %s"
if self.in_size > 0:
args = (*args, self.in_size)
fmt += " - %s"
self.logger.debug(fmt, *args)
def server_signature(self) -> str:
return self.server_version + "\n\n" + STAPLER_ASCII + "\n"
@@ -277,7 +268,7 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
UPDATE_PATH_REGEX = re.compile(r"^\/([\w-]+)\/?$")
GET_PATH_REGEX = re.compile(r"^\/([\w-]+)($|\/)")
HOST_PART_REGEX = re.compile(r"^([a-z0-9]|[a-z0-9][a-z0-9-]{,61}[a-z0-9])$")
AUTHORIZED_PATHS: typing.ClassVar[list[str]] = ["/favicon.ico", "/robots.txt"]
AUTHORIZED_PATHS: typing.ClassVar[list[str]] = ["/favicon.ico"]
TOKEN_HEADER = "X-Token" # noqa: S105
HOST_HEADER = "X-Host"
HOST_ONLY_HEADER = "X-Host-Only"
@@ -309,8 +300,6 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
self.__target_spa: str | None = None
try:
super().__init__(*args, directory=params.data_dir, **kwargs, params=params) # ty:ignore[unknown-argument]
except (BrokenPipeError, ConnectionResetError) as e:
self.logger.error("Connection lost: %s", str(e)) # noqa: TRY400
except:
self.logger.exception("Could not handle request")
@@ -388,13 +377,8 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
def do_HEAD(self) -> None:
with self.handle_errors():
self._pre_log_request()
if self._proxy_or_redirect():
return None
if self.path == "/" and self.host == self.default_host:
return self.send_basic_body(self.server_signature())
super().do_HEAD()
self.close_connection = True
return None
if not self._proxy_or_redirect():
super().do_HEAD()
@typing.override
def do_GET(self) -> None:
@@ -404,9 +388,7 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
return None
if self.path == "/" and self.host == self.default_host:
return self.send_basic_body(self.server_signature())
super().do_GET()
self.close_connection = True
return None
return super().do_GET()
def do_PUT(self) -> None:
with self.handle_errors():
@@ -554,11 +536,6 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
return super().translate_path(path)
return ""
if self.host != self.default_host:
if (
not (self.root_path / page.path / path).is_file()
and path in self.AUTHORIZED_PATHS
):
return super().translate_path(path)
path = f"/{page.path}" + path
if pathlib.Path(path).name.startswith("."): # hidden files
return ""
@@ -596,7 +573,7 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
f"Cannot use {self.HOST_ONLY_HEADER} with {self.HOST_HEADER}",
)
return None
if self.has_target_host and not valid_host(self.target_host):
if self.has_target_host and not self.__valid_host(self.target_host):
self.send_error(http.HTTPStatus.BAD_REQUEST, "Invalid requested host")
return None
if self.has_target_proxy and self.has_target_redirect:
@@ -619,6 +596,12 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
return match.group(1)
return None
def __valid_host(self, host: str) -> bool:
return (
all(self.HOST_PART_REGEX.fullmatch(part) for part in host.split("."))
and len(host) < 256
)
def __get_page(self, src_path: str) -> Page | None:
if self.host == self.default_host:
if (
@@ -632,19 +615,16 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
class UpgradeHandler(RequestHandler):
protocol_version = "HTTP/1.0"
server_version = "StaplerUpgradeServer/" + PKG_VERSION
def do_HEAD(self) -> None:
with self.handle_errors():
self._pre_log_request()
self.send_redirect(f"https://{self.host}{self.path}")
self.close_connection = True
def do_GET(self) -> None:
with self.handle_errors():
if self.path.startswith(self.CERTBOT_CHALLENGE_PATH):
super().do_GET()
self.close_connection = True
else:
self.do_HEAD()
-2
View File
@@ -1,2 +0,0 @@
User-agent: *
Disallow: /
+7 -5
View File
@@ -29,6 +29,7 @@ class StaplerServer:
"logger",
"params",
"registry",
"server",
"token_manager",
]
@@ -40,6 +41,7 @@ class StaplerServer:
self.token_manager: TokenManager = TokenManager(params, self.registry)
self.data_dir: DataDir = DataDir(params.data_dir)
self.default_host: str = params.host.split(":", maxsplit=2)[0]
self.server: http.server.ThreadingHTTPServer | None = None
def __get_all_hosts(self) -> list[str]:
return [self.default_host, *self.registry.get_hosts()]
@@ -48,7 +50,7 @@ class StaplerServer:
self.logger.info("Starting up...")
self.registry.load_pages()
if self.params.with_certificates:
self.cert_manager.init()
self.cert_manager.init(self.__get_all_hosts())
self.data_dir.init()
self.token_manager.init()
@@ -73,7 +75,7 @@ class StaplerServer:
)
context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
server.socket = context.wrap_socket(server.socket, server_side=True)
context.set_servername_callback(self.cert_manager.servername_callback)
context.sni_callback = self.cert_manager.sni_callback
else:
server = http.server.ThreadingHTTPServer(
(
@@ -129,7 +131,7 @@ class StaplerServer:
for line in STAPLER_ASCII.split("\n"):
self.logger.debug(line.ljust(36))
self.__startup()
base_server = self.__create_base_server()
self.server = self.__create_base_server()
upgrade_server = self.__start_upgrade_server() if self.params.https else None
self.logger.info(
"Server up and ready on %s://%s",
@@ -138,7 +140,7 @@ class StaplerServer:
)
self.__start_background_tasks()
with contextlib.suppress(KeyboardInterrupt):
base_server.serve_forever()
self.server.serve_forever()
self.logger.info("Shutting down...")
if upgrade_server is not None:
upgrade_server.shutdown()
@@ -150,7 +152,7 @@ class StaplerServer:
self.logger.warning("Cannot renew without certificates")
return 1
self.registry.load_pages()
self.cert_manager.init()
self.cert_manager.init(self.__get_all_hosts())
for host in self.__get_all_hosts():
self.cert_manager.create_or_update(host)
return 0
-19
View File
@@ -1,19 +0,0 @@
import re
__HOST_PART_REGEX = re.compile(r"^([a-z0-9]|[a-z0-9][a-z0-9-]{,61}[a-z0-9])$")
__SANITIZE_REGEX = re.compile(r"[^\x20-\x7F]")
def valid_host(host: str) -> bool:
parts = host.split(".")
return (
len(parts) > 1
and len(parts[-1]) > 1
and all(__HOST_PART_REGEX.fullmatch(part) for part in parts)
and not all(part.isnumeric() for part in parts)
and len(host) < 256
)
def sanitize_string(raw: str) -> str:
return __SANITIZE_REGEX.sub("?", raw)
+64 -60
View File
@@ -35,33 +35,41 @@ class TestRegistry(BaseTestCase):
self.patch("shutil.which", count=0),
self.patch("subprocess.check_output", count=0),
):
self.cert_manager.init()
self.cert_manager.init([])
assert self.self_signed_path.is_dir()
assert self.certbot_www.is_dir()
def test_init_with_hosts(self) -> None:
with (
self.patch("shutil.which", count=0),
self.patch("subprocess.check_output", count=0),
):
self._make_self_signed("localhost")
self.cert_manager.init(["localhost"])
def test_exists_self_signed(self) -> None:
self._make_self_signed("example.com")
assert self.cert_manager.exists("example.com")
self._make_self_signed("localhost")
assert self.cert_manager.exists("localhost")
def test_exists_certbot(self) -> None:
self._make_certbot("example.com")
assert self.cert_manager.exists("example.com")
self._make_certbot("localhost")
assert self.cert_manager.exists("localhost")
def test_exists_fail(self) -> None:
assert not self.cert_manager.exists("example.com")
assert not self.cert_manager.exists("localhost")
def test_exists_fail_without_certbot(self) -> None:
self.cert_manager.with_certbot = False
self._make_certbot("example.com")
assert not self.cert_manager.exists("example.com")
self._make_certbot("localhost")
assert not self.cert_manager.exists("localhost")
def test_init_cert_existing(self) -> None:
with (
self.patch("shutil.which", count=0),
self.patch("subprocess.check_output", count=0),
):
self._make_self_signed("example.com")
assert not self.cert_manager.init_cert("example.com")
self._make_self_signed("localhost")
assert not self.cert_manager.init_cert("localhost")
def test_init_cert_fail(self) -> None:
with (
@@ -69,7 +77,7 @@ class TestRegistry(BaseTestCase):
self.patch("subprocess.check_output") as process_mock,
):
process_mock.side_effect = subprocess.CalledProcessError(1, "", output=b"")
assert not self.cert_manager.init_cert("example.com")
assert not self.cert_manager.init_cert("localhost")
def test_init_cert_new(self) -> None:
with (
@@ -77,139 +85,135 @@ class TestRegistry(BaseTestCase):
self.patch("subprocess.check_output") as process_mock,
):
process_mock.side_effect = lambda *_, **__: self._make_self_signed(
"example.com"
"localhost"
)
assert self.cert_manager.init_cert("example.com")
assert self.cert_manager.init_cert("localhost")
def test_create_or_update_existing_no_certbot(self) -> None:
self._make_self_signed("example.com")
self._make_self_signed("localhost")
self.cert_manager.with_certbot = False
with (
self.patch("shutil.which", return_value=""),
self.patch("subprocess.check_output") as process_mock,
):
process_mock.side_effect = lambda *_, **__: self._make_self_signed(
"example.com"
"localhost"
)
assert self.cert_manager.create_or_update("example.com")
assert self.cert_manager.create_or_update("localhost")
def test_create_or_update_existing_certbot(self) -> None:
self._make_certbot("example.com")
self._make_certbot("localhost")
with (
self.patch("shutil.which", return_value=""),
self.patch("subprocess.check_output") as process_mock,
):
process_mock.side_effect = lambda *_, **__: self._make_certbot(
"example.com"
)
assert self.cert_manager.create_or_update("example.com")
process_mock.side_effect = lambda *_, **__: self._make_certbot("localhost")
assert self.cert_manager.create_or_update("localhost")
def test_create_or_update_existing_fail_both(self) -> None:
self._make_certbot("example.com")
self._make_certbot("localhost")
with (
self.patch("shutil.which", return_value="", count=2),
self.patch("subprocess.check_output", count=2) as process_mock,
):
process_mock.side_effect = subprocess.CalledProcessError(1, "", output=b"")
assert not self.cert_manager.create_or_update("example.com")
assert not self.cert_manager.create_or_update("localhost")
def test_create_or_update_existing_fail_both_binary(self) -> None:
self._make_certbot("example.com")
self._make_certbot("localhost")
with (
self.patch("shutil.which", count=2),
self.patch("subprocess.check_output", count=0),
):
assert not self.cert_manager.create_or_update("example.com")
assert not self.cert_manager.create_or_update("localhost")
def test_get_cert_certbot(self) -> None:
self._make_certbot("example.com")
self._make_certbot("localhost")
self.assertEqual(
self.cert_manager.get_cert("example.com"),
self.certbot_conf / "live" / "example.com" / CertManager.CRT_FILE,
self.cert_manager.get_cert("localhost"),
self.certbot_conf / "live" / "localhost" / CertManager.CRT_FILE,
)
def test_get_cert_self_signed(self) -> None:
self._make_self_signed("example.com")
self._make_self_signed("localhost")
self.assertEqual(
self.cert_manager.get_cert("example.com"),
self.self_signed_path / "example.com" / CertManager.CRT_FILE,
self.cert_manager.get_cert("localhost"),
self.self_signed_path / "localhost" / CertManager.CRT_FILE,
)
def test_get_cert_fail(self) -> None:
self.assertRaises(
CertManagerError,
lambda: self.cert_manager.get_cert("example.com"),
lambda: self.cert_manager.get_cert("localhost"),
)
def test_get_key_certbot(self) -> None:
self._make_certbot("example.com")
self._make_certbot("localhost")
self.assertEqual(
self.cert_manager.get_key("example.com"),
self.certbot_conf / "live" / "example.com" / CertManager.KEY_FILE,
self.cert_manager.get_key("localhost"),
self.certbot_conf / "live" / "localhost" / CertManager.KEY_FILE,
)
def test_get_key_self_signed(self) -> None:
self._make_self_signed("example.com")
self._make_self_signed("localhost")
self.assertEqual(
self.cert_manager.get_key("example.com"),
self.self_signed_path / "example.com" / CertManager.KEY_FILE,
self.cert_manager.get_key("localhost"),
self.self_signed_path / "localhost" / CertManager.KEY_FILE,
)
def test_get_key_fail(self) -> None:
self.assertRaises(
CertManagerError,
lambda: self.cert_manager.get_key("example.com"),
lambda: self.cert_manager.get_key("localhost"),
)
def test_servername_callback_no_host(self) -> None:
self._make_self_signed("example.com")
def test_sni_callback_no_host(self) -> None:
self._make_self_signed("localhost")
with (
self.patch("ssl.create_default_context", count=0),
):
self.cert_manager.servername_callback(
self.socket_mock, None, self.context_mock
)
self.cert_manager.sni_callback(self.socket_mock, None, self.context_mock)
def test_servername_callback_fail(self) -> None:
self._make_self_signed("example.com")
def test_sni_callback_fail(self) -> None:
self._make_self_signed("localhost")
with (
self.patch("shutil.which", count=3),
self.patch("ssl.create_default_context", count=0),
):
self.cert_manager.servername_callback(
self.socket_mock, "example.fr", self.context_mock
self.cert_manager.sni_callback(
self.socket_mock, "new_host", self.context_mock
)
def test_servername_callback_create_context(self) -> None:
self._make_self_signed("example.com")
def test_sni_callback_create_context(self) -> None:
self._make_self_signed("localhost")
with (
self.patch("ssl.create_default_context", return_value=self.context_mock),
self.mock_call(
self.context_mock.load_cert_chain,
[
self.self_signed_path / "example.com" / CertManager.CRT_FILE,
self.self_signed_path / "example.com" / CertManager.KEY_FILE,
self.self_signed_path / "localhost" / CertManager.CRT_FILE,
self.self_signed_path / "localhost" / CertManager.KEY_FILE,
],
),
self.patch("shutil.which", count=0),
):
self.cert_manager.servername_callback(
self.socket_mock, "example.com", self.context_mock
self.cert_manager.sni_callback(
self.socket_mock, "localhost", self.context_mock
)
def test_servername_callback_create_context_fail(self) -> None:
self._make_self_signed("example.com")
def test_sni_callback_create_context_fail(self) -> None:
self._make_self_signed("localhost")
with (
self.patch("ssl.create_default_context", return_value=self.context_mock),
self.patch("shutil.which", count=0),
):
self.context_mock.load_cert_chain.side_effect = Exception
self.cert_manager.servername_callback(
self.socket_mock, "example.com", self.context_mock
self.cert_manager.sni_callback(
self.socket_mock, "localhost", self.context_mock
)
self.context_mock.load_cert_chain.assert_called_once_with(
self.self_signed_path / "example.com" / CertManager.CRT_FILE,
self.self_signed_path / "example.com" / CertManager.KEY_FILE,
self.self_signed_path / "localhost" / CertManager.CRT_FILE,
self.self_signed_path / "localhost" / CertManager.KEY_FILE,
)
def _make_self_signed(self, host: str) -> None:
+5
View File
@@ -59,6 +59,11 @@ class TestDataDir(BaseTestCase):
self.__create_path("test_1")
self.assertIsNone(self.data_dir.get_file("test_1", ".value"))
def test_get_file_cannot_read(self) -> None:
self.__create_path("test_1", {".value": "value"})
(self.tmp_path / "test_1" / ".value").chmod(0o300)
self.assertIsNone(self.data_dir.get_file("test_1", ".value"))
def test_get_file_invalid_path(self) -> None:
self.assertIsNone(self.data_dir.get_file("test_1", ".value"))
+2 -51
View File
@@ -36,7 +36,6 @@ class BaseHandlerTestCase(BaseTestCase, abc.ABC):
code: int,
message: str | None = None,
headers: dict[str, str] | None = None,
content_length: int = 0,
) -> typing.Iterator[None]:
if headers is None:
headers = {}
@@ -47,7 +46,7 @@ class BaseHandlerTestCase(BaseTestCase, abc.ABC):
send_response_mock.assert_called_once_with(code, message)
send_header_mock.assert_has_calls(
[
unittest.mock.call("Content-Length", str(content_length)),
unittest.mock.call("Content-Length", "0"),
]
+ [unittest.mock.call(header, value) for header, value in headers.items()],
any_order=True,
@@ -178,36 +177,9 @@ class TestRequestHandler(BaseHandlerTestCase):
token_manager=self.token_manager,
)
def test_handle_disconnect_silently(self) -> None:
with self.patch("http.server.BaseHTTPRequestHandler.__init__") as mock:
mock.side_effect = BrokenPipeError
logging.basicConfig(level=logging.CRITICAL)
RequestHandler(
unittest.mock.MagicMock(),
"127.0.0.1",
unittest.mock.MagicMock(),
params=Parameters(
data_dir=self.get_tmp_dir(), certbot_www=str(self.certbot_www)
),
registry=self.registry,
token_manager=self.token_manager,
)
def test_do_head_index(self) -> None:
def test_do_head_forward(self) -> None:
handler = self._get_handler()
with (
self.expects_status_only(
handler, 200, content_length=len(handler.server_signature())
),
self.patch("http.server.SimpleHTTPRequestHandler.do_HEAD", count=0),
self.seal_mocks(),
):
handler.do_HEAD()
def test_do_head_forward(self) -> None:
handler = self._get_handler("/file")
with (
self.mock_call(self.registry.get_from_path, ["file"], Page("file")),
self.patch("http.server.SimpleHTTPRequestHandler.do_HEAD"),
self.seal_mocks(),
):
@@ -872,7 +844,6 @@ class TestRequestHandler(BaseHandlerTestCase):
},
"allow_redirects": False,
"timeout": 480,
"stream": False,
},
),
self.expects_status_only(handler, 200, "OK"),
@@ -917,7 +888,6 @@ class TestRequestHandler(BaseHandlerTestCase):
},
"allow_redirects": False,
"timeout": 480,
"stream": False,
},
),
self.expects_status_only(handler, 200, "OK"),
@@ -960,7 +930,6 @@ class TestRequestHandler(BaseHandlerTestCase):
},
"allow_redirects": False,
"timeout": 480,
"stream": False,
},
),
self.expects_basic_body(handler, "hello", message="OK"),
@@ -995,7 +964,6 @@ class TestRequestHandler(BaseHandlerTestCase):
},
"allow_redirects": False,
"timeout": 480,
"stream": False,
},
) as request_mock,
self.expects_status_only(
@@ -1039,7 +1007,6 @@ class TestRequestHandler(BaseHandlerTestCase):
},
"allow_redirects": False,
"timeout": 480,
"stream": False,
},
),
self.expects_status_only(handler, 200, "OK"),
@@ -1080,7 +1047,6 @@ class TestRequestHandler(BaseHandlerTestCase):
},
"allow_redirects": False,
"timeout": 480,
"stream": False,
},
),
self.expects_status_only(handler, 200, "OK"),
@@ -1211,21 +1177,6 @@ class TestRequestHandler(BaseHandlerTestCase):
None,
)
def test_translate_path_with_host_favicon(self) -> None:
handler = self._get_handler(headers={"Host": "example.com"})
with (
self.mock_call(self.registry.get_from_host, ["example.com"], Page("path")),
self.patch_call(
"http.server.SimpleHTTPRequestHandler.translate_path",
["/favicon.ico"],
),
self.seal_mocks(),
):
self.assertEqual(
handler.translate_path("/favicon.ico"),
None,
)
def test_translate_path_default_host(self) -> None:
handler = self._get_handler()
with (
+7 -5
View File
@@ -26,8 +26,10 @@ class TestStaplerServer(BaseTestCase):
def test_renew(self) -> None:
with (
self.mock_call(self.registry.load_pages),
self.mock_calls(self.registry.get_hosts, [[]], [["host_1"]]),
self.mock_call(self.cert_manager.init),
self.mock_calls(
self.registry.get_hosts, [[], []], [["host_1"], ["host_1"]]
),
self.mock_call(self.cert_manager.init, [["localhost", "host_1"]]),
self.mock_calls(
self.cert_manager.create_or_update, [["localhost"], ["host_1"]]
),
@@ -65,16 +67,16 @@ class TestStaplerServer(BaseTestCase):
def test_run_https(self) -> None:
self.token_manager.detect_file_change.side_effect = KeyboardInterrupt
self.cert_manager.servername_callback = unittest.mock.Mock()
self.cert_manager.sni_callback = unittest.mock.Mock()
with (
self.mock_call(self.registry.load_pages),
self.mock_call(self.cert_manager.init),
self.mock_call(self.registry.get_hosts, [], []),
self.mock_call(self.cert_manager.init, [["localhost"]]),
self.mock_call(self.data_dir.init),
self.mock_call(self.token_manager.init),
self.patch("ssl.create_default_context", return_value=self.context_mock),
self.patch("http.server.ThreadingHTTPServer", self.server_mock, 2),
self.mock_call_unchecked(self.context_mock.wrap_socket),
self.mock_call_unchecked(self.context_mock.set_servername_callback),
self.mock_calls_unchecked(self.server_mock.serve_forever, 2),
self.mock_call(self.server_mock.shutdown),
self.seal_mocks(),
-22
View File
@@ -1,22 +0,0 @@
import parameterized
from stapler.strings import sanitize_string, valid_host
from . import BaseTestCase
class TestStrings(BaseTestCase):
def test_sanitize(self) -> None:
self.assertEqual("??A??", sanitize_string("\n\tA\x00\x99"))
@parameterized.parameterized.expand(
[("example.com"), ("test-test.com"), ("subdomain.example.com")]
)
def test_valid_host(self, host: str) -> None:
self.assertTrue(valid_host(host), host)
@parameterized.parameterized.expand(
[("example.c"), ("localhost"), ("127.0.0.1"), ("test..com"), ("www-.test.com")]
)
def test_invalid_host(self, host: str) -> None:
self.assertFalse(valid_host(host), host)
Generated
+1 -12
View File
@@ -127,15 +127,6 @@ wheels = [
{ url = "https://files.pythonhosted.org/packages/df/b2/87e62e8c3e2f4b32e5fe99e0b86d576da1312593b39f47d8ceef365e95ed/packaging-26.2-py3-none-any.whl", hash = "sha256:5fc45236b9446107ff2415ce77c807cee2862cb6fac22b8a73826d0693b0980e", size = 100195, upload-time = "2026-04-24T20:15:22.081Z" },
]
[[package]]
name = "parameterized"
version = "0.9.0"
source = { registry = "https://pypi.org/simple" }
sdist = { url = "https://files.pythonhosted.org/packages/ea/49/00c0c0cc24ff4266025a53e41336b79adaa5a4ebfad214f433d623f9865e/parameterized-0.9.0.tar.gz", hash = "sha256:7fc905272cefa4f364c1a3429cbbe9c0f98b793988efb5bf90aac80f08db09b1", size = 24351, upload-time = "2023-03-27T02:01:11.592Z" }
wheels = [
{ url = "https://files.pythonhosted.org/packages/00/2f/804f58f0b856ab3bf21617cccf5b39206e6c4c94c2cd227bde125ea6105f/parameterized-0.9.0-py2.py3-none-any.whl", hash = "sha256:4e0758e3d41bea3bbd05ec14fc2c24736723f243b28d702081aef438c9372b1b", size = 20475, upload-time = "2023-03-27T02:01:09.31Z" },
]
[[package]]
name = "pluggy"
version = "1.6.0"
@@ -212,7 +203,7 @@ wheels = [
[[package]]
name = "stapler"
version = "1.4.0"
version = "1.2.4"
source = { editable = "." }
dependencies = [
{ name = "requests" },
@@ -221,7 +212,6 @@ dependencies = [
[package.dev-dependencies]
dev = [
{ name = "coverage" },
{ name = "parameterized" },
{ name = "pytest" },
{ name = "ruff" },
{ name = "ty" },
@@ -233,7 +223,6 @@ requires-dist = [{ name = "requests", specifier = ">=2.33.1" }]
[package.metadata.requires-dev]
dev = [
{ name = "coverage", specifier = ">=7.13.5" },
{ name = "parameterized", specifier = ">=0.9.0" },
{ name = "pytest", specifier = ">=9.0.3" },
{ name = "ruff", specifier = ">=0.15.10" },
{ name = "ty", specifier = ">=0.0.29" },