Merge pull request #194 from akquinet/192

rwxd · web-flow · commit 1d9d664eb359 · 2026-03-02T11:18:25.000+01:00
tests for index &amp; author quote
diff --git a/README.md b/README.md
@@ -300,7 +300,18 @@ The index page can be deactivated with the `index_enabled` option and customized
 
 ```yaml
 index_enabled: false # default is true
+
+# Single line HTML
 index_html: "<html><body><h1>PowerDNS API Proxy</h1></body></html>"
+
+# Or multiline HTML
+index_html: |
+  <html>
+    <body>
+      <h1>PowerDNS API Proxy</h1>
+      <p>Custom content here</p>
+    </body>
+  </html>
 ```
 
 ## Development
diff --git a/powerdns_api_proxy/models.py b/powerdns_api_proxy/models.py
@@ -157,6 +157,7 @@ class ProxyConfig(BaseModel):
             <p><a href="/docs">Swagger Docs</a></p>
             <q>The Domain Name Server (DNS) is the Achilles heel of the Web.<br>
             The important thing is that it's managed responsibly.</q>
+            <p style="margin-top: 1em; font-size: 0.9em; color: #666;">— Tim Berners-Lee</p>
             </center>
         </body>
     </html>
diff --git a/tests/unit/config_parsing_test.py b/tests/unit/config_parsing_test.py
@@ -0,0 +1,73 @@
+import tempfile
+from pathlib import Path
+
+from powerdns_api_proxy.config import load_config
+
+
+def test_index_html_from_yaml_single_line():
+    config_content = """
+pdns_api_url: "https://test.example.com"
+pdns_api_token: "testtoken123"
+index_html: "<html><body><h1>PowerDNS API Proxy</h1></body></html>"
+environments:
+  - name: "Test"
+    token_sha512: "127aab81f4caab9c00e72f26e4c5c4b20146201a1548a787494d999febf1b9422c1711932117f38d9be9efe46f78aa72d8f6a391101bedd6e200014f6738450d"
+    zones:
+      - name: "example.com"
+"""
+    with tempfile.NamedTemporaryFile(mode="w", suffix=".yml") as f:
+        f.write(config_content)
+        f.flush()
+
+        config_path = Path(f.name)
+        config = load_config(config_path)
+        assert (
+            config.index_html == "<html><body><h1>PowerDNS API Proxy</h1></body></html>"
+        )
+        assert config.index_enabled is True
+
+
+def test_index_html_from_yaml_multiline():
+    config_content = """
+pdns_api_url: "https://test.example.com"
+pdns_api_token: "testtoken123"
+index_html: |
+  <html>
+    <body>
+      <h1>Custom Page</h1>
+    </body>
+  </html>
+environments:
+  - name: "Test"
+    token_sha512: "127aab81f4caab9c00e72f26e4c5c4b20146201a1548a787494d999febf1b9422c1711932117f38d9be9efe46f78aa72d8f6a391101bedd6e200014f6738450d"
+    zones:
+      - name: "example.com"
+"""
+    with tempfile.NamedTemporaryFile(mode="w", suffix=".yml") as f:
+        f.write(config_content)
+        f.flush()
+
+        config_path = Path(f.name)
+        config = load_config(config_path)
+        assert "<h1>Custom Page</h1>" in config.index_html
+        assert config.index_enabled is True
+
+
+def test_index_disabled_from_yaml():
+    config_content = """
+pdns_api_url: "https://test.example.com"
+pdns_api_token: "testtoken123"
+index_enabled: false
+environments:
+  - name: "Test"
+    token_sha512: "127aab81f4caab9c00e72f26e4c5c4b20146201a1548a787494d999febf1b9422c1711932117f38d9be9efe46f78aa72d8f6a391101bedd6e200014f6738450d"
+    zones:
+      - name: "example.com"
+"""
+    with tempfile.NamedTemporaryFile(mode="w", suffix=".yml") as f:
+        f.write(config_content)
+        f.flush()
+
+        config_path = Path(f.name)
+        config = load_config(config_path)
+        assert config.index_enabled is False
diff --git a/tests/unit/proxy_test.py b/tests/unit/proxy_test.py
@@ -56,6 +56,42 @@ def fixture_patch_pdns() -> Generator[AsyncMock, None, None]:
         yield pdns_patch
 
 
+def test_index_default_html():
+    response = client.get("/")
+    assert response.status_code == 200
+    assert "text/html" in response.headers["content-type"]
+    assert "PowerDNS API Proxy" in response.text
+
+
+def test_index_custom_html():
+    custom_html = "<html><body><h1>Custom Page</h1></body></html>"
+    custom_config = ProxyConfig(
+        pdns_api_token="blaaa",
+        pdns_api_url="bluub",
+        environments=[dummy_proxy_environment],
+        index_html=custom_html,
+    )
+
+    with patch("powerdns_api_proxy.proxy.config", custom_config):
+        response = client.get("/")
+        assert response.status_code == 200
+        assert response.text == custom_html
+        assert "<h1>Custom Page</h1>" in response.text
+
+
+def test_index_disabled():
+    custom_config = ProxyConfig(
+        pdns_api_token="blaaa",
+        pdns_api_url="bluub",
+        environments=[dummy_proxy_environment],
+        index_enabled=False,
+    )
+
+    with patch("powerdns_api_proxy.proxy.config", custom_config):
+        response = client.get("/")
+        assert response.status_code == 404
+
+
 def test_api_root(fixture_patch_dummy_config):
     answer = client.get("/api", headers={"X-API-Key": dummy_proxy_environment_token})
     data = answer.json()
