LEDMatrix/test/test_api_v3_optional_body.py

"""
Regression tests: POST endpoints whose body is optional must accept a
request that has no body at all.

Six handlers in api_v3 read their body as ``request.get_json() or {}``.
The ``or {}`` states the intent plainly — every field is optional, so a
bodyless POST should fall back to defaults. But ``get_json()`` without
``silent=True`` raises ``UnsupportedMediaType`` when the request carries
no JSON Content-Type, and it raises *before* ``or {}`` is evaluated. Each
handler's catch-all then turned that into a 500.

So the natural way to call these endpoints — a POST with no body, which
is what curl, a fetch() without options, and most HTTP clients send by
default — failed on every one of them. The shipped UI always sends a JSON
object, which is why this went unnoticed.

This file covers the endpoints whose bodyless behaviour is not already
tested in their own suite.
"""

import re
import sys
from pathlib import Path
from unittest.mock import MagicMock

import pytest

sys.path.insert(0, str(Path(__file__).parent.parent))

from test._api_v3_test_helpers import api_v3_client, api_v3_module  # noqa: F401,E402


class TestOnDemandStart:
    URL = "/api/v3/display/on-demand/start"

    def test_bodyless_post_is_not_a_server_error(self, api_v3_client, api_v3_module):
        response = api_v3_client.post(self.URL)
        # The endpoint may still reject the request on its own terms (no
        # plugin_id, nothing to display); what it must not do is fail with
        # a 500 raised out of body parsing.
        assert response.status_code != 500

    def test_json_body_still_works(self, api_v3_client, api_v3_module):
        assert api_v3_client.post(self.URL, json={}).status_code != 500


class TestResetPluginConfig:
    URL = "/api/v3/plugins/config/reset"

    def test_bodyless_post_is_not_a_server_error(self, api_v3_client, api_v3_module):
        assert api_v3_client.post(self.URL).status_code != 500

    def test_json_body_still_works(self, api_v3_client, api_v3_module):
        assert api_v3_client.post(self.URL, json={}).status_code != 500


class TestDeleteOfTheDayJson:
    URL = "/api/v3/plugins/of-the-day/json/delete"

    def test_bodyless_post_is_not_a_server_error(self, api_v3_client, api_v3_module):
        assert api_v3_client.post(self.URL).status_code != 500

    def test_json_body_still_works(self, api_v3_client, api_v3_module):
        assert api_v3_client.post(self.URL, json={}).status_code != 500


class TestPluginLimits:
    URL = "/api/v3/plugins/clock/limits"

    def test_bodyless_post_is_not_a_server_error(self, api_v3_client, api_v3_module):
        assert api_v3_client.post(self.URL).status_code != 500


class TestMissingBodyGivesTheDeclaredError:
    """Handlers that answer "No data provided" must actually be able to.

    A second group of handlers reads `data = request.get_json()` and then
    guards with `if not data: return 400`. That guard is unreachable for a
    request with no JSON body, because get_json() raises first — so the
    caller got a 500 "an error occurred; see logs for details" instead of
    the 400 the handler plainly intends to send.
    """

    @pytest.mark.parametrize("url", [
        "/api/v3/plugins/install",
        "/api/v3/plugins/install-from-url",
        "/api/v3/plugins/registry-from-url",
        "/api/v3/config/raw/main",
        "/api/v3/config/raw/secrets",
        "/api/v3/cache/delete",
    ])
    def test_bodyless_post_gets_a_400_not_a_500(self, api_v3_client, api_v3_module, url):
        response = api_v3_client.post(url)
        assert response.status_code == 400, (
            f"{url} answered {response.status_code}: "
            f"{response.get_data(as_text=True)[:200]}")

    @pytest.mark.parametrize("url", [
        "/api/v3/plugins/install",
        "/api/v3/config/raw/main",
    ])
    def test_malformed_json_gets_a_400_not_a_500(self, api_v3_client, api_v3_module, url):
        response = api_v3_client.post(
            url, data="{not json", content_type="application/json")
        assert response.status_code == 400


class TestNoBodyReadContradictsItsOwnGuard:
    PKG = Path(__file__).parent.parent / "web_interface/blueprints/api_v3"

    @property
    def _source(self) -> str:
        """api_v3 is a package; read every module of it."""
        return "\n".join(p.read_text() for p in sorted(self.PKG.glob("*.py")))

    def test_no_or_default_read_is_unguarded(self):
        """`get_json() or <default>` is a contradiction without silent=True.

        Writing `or {}` declares the body optional; omitting silent=True
        means the call raises before the default can apply.
        """
        offenders = [
            line.strip() for line in self._source.splitlines()
            if "request.get_json()" in line and " or " in line
        ]
        assert offenders == [], (
            "these reads declare a default but raise before reaching it; "
            f"use get_json(silent=True): {offenders}")

    def test_no_not_data_guard_is_unreachable(self):
        """A `if not data:` guard needs a read that can actually return None."""
        lines = self._source.splitlines()
        offenders = []
        for i, line in enumerate(lines):
            if re.search(r"=\s*request\.get_json\(\)\s*$", line):
                window = "\n".join(lines[i + 1:i + 3])
                if re.search(r"if\s+(not\s+data\b|data\s+is\s+None)", window):
                    offenders.append(f"line {i + 1}: {line.strip()}")
        assert offenders == [], (
            "these handlers guard on a missing body but raise before the "
            f"guard runs; use get_json(silent=True): {offenders}")