klemek/stapler
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

feat: X-Host-Only

Browse Source
This commit is contained in:
klemek
2026-04-21 22:51:35 +02:00
parent 18c718d24a
commit c0c281e25c
11 changed files with 229 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/test_data_dir.py
+15
View File
@@ -82,6 +82,21 @@ class TestDataDir(BaseTestCase):
assert not (self.tmp_path / "test_1").exists()
assert not (self.tmp_path / "test_1" / ".value").exists()
def test_remove_file_do_nothing(self) -> None:
self.__create_path("test_1")
self.data_dir.remove_file("test_1", ".value")
assert not (self.tmp_path / "test_1" / ".value").exists()
def test_remove_file_ok(self) -> None:
self.__create_path("test_1", {".value": "test_value\nother_line"})
self.data_dir.remove_file("test_1", ".value")
assert not (self.tmp_path / "test_1" / ".value").exists()
def test_remove_file_invalid_path(self) -> None:
self.data_dir.remove_file("test_1", ".value")
assert not (self.tmp_path / "test_1").exists()
assert not (self.tmp_path / "test_1" / ".value").exists()
def test_remove(self) -> None:
self.__create_path("test_1")
self.data_dir.remove("test_1")
tests/test_handlers.py
+79 -31
View File
@@ -122,7 +122,6 @@ class TestRequestHandler(BaseHandlerTestCase):
def setUp(self) -> None:
self.get_tmp_dir()
self.registry = self.new_mock()
self.cert_manager = self.new_mock()
self.token_manager = self.new_mock()
self.certbot_www = self.tmp_path / "certbot_www"
self.data_dir = self.new_mock()
@@ -146,7 +145,6 @@ class TestRequestHandler(BaseHandlerTestCase):
data_dir=self.get_tmp_dir(), certbot_www=str(self.certbot_www)
),
registry=self.registry,
cert_manager=self.cert_manager,
token_manager=self.token_manager,
)
handler.address_string = lambda: "127.0.0.1" # ty:ignore[invalid-assignment]
@@ -285,6 +283,44 @@ class TestRequestHandler(BaseHandlerTestCase):
):
handler.do_PUT()
def test_do_put_invalid_host_only(self) -> None:
handler = self._get_handler(
"/path", {"X-Token": "secret", "X-Host-Only": "invalid_host"}
)
with (
self.mock_call(self.token_manager.is_valid, ["secret"], True), # noqa: FBT003
self.mock_call(
self.token_manager.is_valid_for_path,
["secret", "path"],
True, # noqa: FBT003
),
self.expects_error(
handler, http.HTTPStatus.BAD_REQUEST, "Invalid requested host"
),
self.seal_mocks(),
):
handler.do_PUT()
def test_do_put_invalid_host_and_host_only(self) -> None:
handler = self._get_handler(
"/path", {"X-Token": "secret", "X-Host": "host", "X-Host-Only": "host"}
)
with (
self.mock_call(self.token_manager.is_valid, ["secret"], True), # noqa: FBT003
self.mock_call(
self.token_manager.is_valid_for_path,
["secret", "path"],
True, # noqa: FBT003
),
self.expects_error(
handler,
http.HTTPStatus.BAD_REQUEST,
"Cannot use X-Host-Only with X-Host",
),
self.seal_mocks(),
):
handler.do_PUT()
def test_do_put_invalid_host_for_path(self) -> None:
handler = self._get_handler(
"/path", {"X-Token": "secret", "X-Host": "example.com"}
@@ -404,31 +440,6 @@ class TestRequestHandler(BaseHandlerTestCase):
):
handler.do_PUT()
def test_do_put_extract_with_host_fail_init(self) -> None:
handler = self._get_handler(
"/path",
{"X-Token": "secret", "Content-Length": "1", "X-Host": "example.com"},
)
handler.rfile.write(b"\0")
with (
self.mock_call(self.token_manager.is_valid, ["secret"], True), # noqa: FBT003
self.mock_call(
self.token_manager.is_valid_for_path,
["secret", "path"],
True, # noqa: FBT003
),
self.mock_call(self.registry.get_from_host, ["example.com"], Page("path")),
self.mock_call_unchecked(self.data_dir.extract_tar_bytes),
self.mock_call(self.registry.add, ["path"]),
self.mock_call(self.token_manager.set_token, ["path", "secret"]),
self.mock_call(self.cert_manager.create_or_update, ["example.com"], False), # noqa: FBT003
self.expects_status_only(
handler, http.HTTPStatus.CREATED, "Resource /path/ updated"
),
self.seal_mocks(),
):
handler.do_PUT()
def test_do_put_extract_with_host(self) -> None:
handler = self._get_handler(
"/path",
@@ -446,7 +457,6 @@ class TestRequestHandler(BaseHandlerTestCase):
self.mock_call_unchecked(self.data_dir.extract_tar_bytes),
self.mock_call(self.registry.add, ["path"]),
self.mock_call(self.token_manager.set_token, ["path", "secret"]),
self.mock_call(self.cert_manager.create_or_update, ["example.com"], True), # noqa: FBT003
self.mock_call(self.registry.set_host, ["path", "example.com"]),
self.expects_status_only(
handler, http.HTTPStatus.CREATED, "Resource /path/ updated"
@@ -523,7 +533,6 @@ class TestRequestHandler(BaseHandlerTestCase):
self.mock_call(self.registry.get_from_host, ["example.com"], Page("path")),
self.mock_call(self.registry.set_redirect, ["path", "https://example.com"]),
self.mock_call(self.token_manager.set_token, ["path", "secret"]),
self.mock_call(self.cert_manager.create_or_update, ["example.com"], True), # noqa: FBT003
self.mock_call(self.registry.set_host, ["path", "example.com"]),
self.expects_status_only(
handler, http.HTTPStatus.CREATED, "Resource /path/ updated"
@@ -532,6 +541,33 @@ class TestRequestHandler(BaseHandlerTestCase):
):
handler.do_PUT()
def test_do_put_redirect_with_host_only(self) -> None:
handler = self._get_handler(
"/path",
{
"X-Token": "secret",
"X-Redirect": "https://example.com",
"X-Host-Only": "example.com",
},
)
with (
self.mock_call(self.token_manager.is_valid, ["secret"], True), # noqa: FBT003
self.mock_call(
self.token_manager.is_valid_for_path,
["secret", "path"],
True, # noqa: FBT003
),
self.mock_call(self.registry.get_from_host, ["example.com"], Page("path")),
self.mock_call(self.registry.set_redirect, ["path", "https://example.com"]),
self.mock_call(self.token_manager.set_token, ["path", "secret"]),
self.mock_call(self.registry.set_host_only, ["path", "example.com"]),
self.expects_status_only(
handler, http.HTTPStatus.CREATED, "Resource /path/ updated"
),
self.seal_mocks(),
):
handler.do_PUT()
def test_do_put_proxy_with_content(self) -> None:
handler = self._get_handler(
"/path",
@@ -600,7 +636,6 @@ class TestRequestHandler(BaseHandlerTestCase):
self.mock_call(self.registry.get_from_host, ["example.com"], Page("path")),
self.mock_call(self.registry.set_proxy, ["path", "https://example.com"]),
self.mock_call(self.token_manager.set_token, ["path", "secret"]),
self.mock_call(self.cert_manager.create_or_update, ["example.com"], True), # noqa: FBT003
self.mock_call(self.registry.set_host, ["path", "example.com"]),
self.expects_status_only(
handler, http.HTTPStatus.CREATED, "Resource /path/ updated"
@@ -626,7 +661,6 @@ class TestRequestHandler(BaseHandlerTestCase):
["secret", "path"],
True, # noqa: FBT003
),
self.mock_call(self.registry.get_from_host, ["example.com"], Page("path")),
self.expects_status_only(
handler,
http.HTTPStatus.BAD_REQUEST,
@@ -1106,6 +1140,20 @@ class TestRequestHandler(BaseHandlerTestCase):
None,
)
def test_translate_path_default_host_only(self) -> None:
handler = self._get_handler()
with (
self.mock_call(
self.registry.get_from_path, ["path"], Page("path", host_only=True)
),
self.patch("http.server.SimpleHTTPRequestHandler.translate_path", count=0),
self.seal_mocks(),
):
self.assertEqual(
handler.translate_path("/path/index.html"),
"",
)
def test_translate_path_default_host_not_found(self) -> None:
handler = self._get_handler()
with (
tests/test_page.py
+6
View File
@@ -27,3 +27,9 @@ class TestPage(BaseTestCase):
str(Page("test_1", proxy="https://example.com")),
"/test_1/ (proxy: https://example.com)",
)
def test_repr_with_host_only(self) -> None:
self.assertEqual(
str(Page("test_1", with_index=True, host_only=True)),
"/test_1/ (host only)",
)
tests/test_registry.py
+26
View File
@@ -28,20 +28,24 @@ class TestRegistry(BaseTestCase):
self.data_dir.get_file,
[
["test_1", Registry.HOST_FILE],
["test_1", Registry.HOST_ONLY_FILE],
["test_1", Registry.TOKEN_FILE],
["test_1", Registry.REDIRECT_FILE],
["test_1", Registry.PROXY_FILE],
["test_2", Registry.HOST_FILE],
["test_2", Registry.HOST_ONLY_FILE],
["test_2", Registry.TOKEN_FILE],
["test_2", Registry.REDIRECT_FILE],
["test_2", Registry.PROXY_FILE],
],
[
None,
"test_1_host",
"test_1_token",
None,
None,
None,
None,
"test_2_token",
"test_2_redirect",
None,
@@ -58,6 +62,7 @@ class TestRegistry(BaseTestCase):
"test_1",
True, # noqa: FBT003
"test_1_host",
True, # noqa: FBT003
"test_1_token",
None,
),
@@ -68,6 +73,7 @@ class TestRegistry(BaseTestCase):
"test_2",
False, # noqa: FBT003
None,
False, # noqa: FBT003
"test_2_token",
"test_2_redirect",
),
@@ -98,10 +104,30 @@ class TestRegistry(BaseTestCase):
self.mock_call(
self.data_dir.set_file, ["test_1", Registry.HOST_FILE, "new_value"]
),
self.mock_call(
self.data_dir.remove_file, ["test_1", Registry.HOST_ONLY_FILE]
),
self.seal_mocks(),
):
self.registry.set_host("test_1", "new_value")
self.assertEqual(self.registry.pages["test_1"].host, "new_value")
assert not self.registry.pages["test_1"].host_only
def test_set_host_only(self) -> None:
self.registry.pages["test_1"] = Page(
"test_1",
host="test_1_host",
)
with (
self.mock_call(
self.data_dir.set_file, ["test_1", Registry.HOST_ONLY_FILE, "new_value"]
),
self.mock_call(self.data_dir.remove_file, ["test_1", Registry.HOST_FILE]),
self.seal_mocks(),
):
self.registry.set_host_only("test_1", "new_value")
self.assertEqual(self.registry.pages["test_1"].host, "new_value")
assert self.registry.pages["test_1"].host_only
def test_set_token_hash(self) -> None:
self.registry.pages["test_1"] = Page(