Skip to content

~95% on SimpleQA (e.g. Qwen3.6-27B on a 3090). Supports all local and cloud LLMs (llama.cpp, Ollama, Google, ...). 10+ search engines - arXiv, PubMed, your private documents. Everything Local & Encrypted.

4.6 KB
Raw Blame
"""Registry contract for the engine-URL guard/banner machinery.

The whole chain (save-time validator, runtime resolver, warning banners,
orchestrator wiring) is driven by ``guarded_engine_url_descriptors()``,
which derives from engine-class declarations. These tests pin the contract
a NEW engine must satisfy when it declares ``url_setting``: its derived
dismiss key must be registered, and the generic banner must derive all its
identifiers correctly.
"""

import json
from pathlib import Path

from local_deep_research.security.egress.validators import (
    guarded_engine_url_descriptors,
)
from local_deep_research.security.egress.warnings import (
    check_private_engine_url_blocked,
)

DEFAULTS_PATH = (
    Path(__file__).resolve().parents[2]
    / "src"
    / "local_deep_research"
    / "defaults"
    / "default_settings.json"
)

APPROVAL_ENVS = (
    "LDR_SEARCH_ALLOW_PRIVATE_ENGINE_URLS",
    "LDR_SEARCH_PRIVATE_ENGINE_URL_ALLOWLIST",
)


class TestDescriptorRegistry:
    def test_known_engines_present_with_correct_nature(self):
        by_name = {d.engine_name: d for d in guarded_engine_url_descriptors()}
        assert by_name["searxng"].is_public is True
        assert by_name["paperless"].is_public is False
        assert by_name["elasticsearch"].is_public is False

    def test_every_descriptor_has_registered_dismiss_key(self):
        """A new engine declaring url_setting MUST register its derived
        dismiss key in defaults/default_settings.json — otherwise the
        banner's dismiss button would POST an unknown settings key."""
        defaults = json.loads(DEFAULTS_PATH.read_text())
        missing = []
        for d in guarded_engine_url_descriptors():
            suffix = "private_url" if d.is_public else "public_url"
            key = f"app.warnings.dismiss_{d.engine_name}_{suffix}"
            if key not in defaults:
                missing.append(key)
        assert not missing, (
            "unregistered dismiss keys for guarded engine URLs: "
            f"{missing} — add them to defaults/default_settings.json"
        )

    def test_descriptor_url_settings_are_nonempty_strings(self):
        for d in guarded_engine_url_descriptors():
            assert isinstance(d.url_setting, str) and d.url_setting


class TestGenericBannerDerivation:
    """The generic banner derives type / dismiss key / env-lock var /
    settings anchor purely from the engine declaration."""

    def test_identifiers_derived_from_declaration(self, monkeypatch):
        for var in APPROVAL_ENVS:
            monkeypatch.delenv(var, raising=False)
        url_setting = "search.engine.web.myengine.default_params.api_url"
        monkeypatch.delenv(
            "LDR_SEARCH_ENGINE_WEB_MYENGINE_DEFAULT_PARAMS_API_URL",
            raising=False,
        )
        w = check_private_engine_url_blocked(
            "MyEngine",
            "myengine",
            url_setting,
            "http://localhost:1234",
            True,
            False,
        )
        assert w is not None
        assert w["type"] == "myengine_private_url_blocked"
        assert w["dismissKey"] == "app.warnings.dismiss_myengine_private_url"
        assert (
            "LDR_SEARCH_ENGINE_WEB_MYENGINE_DEFAULT_PARAMS_API_URL"
            in w["message"]
        )
        assert "MyEngine" in w["title"]
        assert w["actionUrl"] == (
            "/settings#setting-search-engine-web-myengine-"
            "default_params-api_url"
        )

    def test_env_locked_engine_specific_key_silences(self, monkeypatch):
        """The env-lock approval is keyed to the ENGINE'S OWN url_setting,
        not SearXNG's."""
        for var in APPROVAL_ENVS:
            monkeypatch.delenv(var, raising=False)
        monkeypatch.setenv(
            "LDR_SEARCH_ENGINE_WEB_MYENGINE_DEFAULT_PARAMS_API_URL",
            "http://localhost:1234",
        )
        assert (
            check_private_engine_url_blocked(
                "MyEngine",
                "myengine",
                "search.engine.web.myengine.default_params.api_url",
                "http://localhost:1234",
                True,
                False,
            )
            is None
        )

    def test_inactive_engine_is_silent(self, monkeypatch):
        for var in APPROVAL_ENVS:
            monkeypatch.delenv(var, raising=False)
        assert (
            check_private_engine_url_blocked(
                "MyEngine",
                "myengine",
                "search.engine.web.myengine.default_params.api_url",
                "http://localhost:1234",
                False,
                False,
            )
            is None
        )