Führe die Konfigurationsansicht der Connectoren ein, damit Paperless und IMAP ihre Felder selbst deklarieren.
Deploy Development / deploy (push) Successful in 40s
Test Suite / pytest-backend (push) Successful in 3m12s
Test Suite / smoke-dev (push) Successful in 0s
Test Suite / frontend-build (push) Successful in 21s

Das Modul liefert ein Feldmanifest und validiert es; ein leeres Geheimnisfeld behält das gespeicherte. Die Oberfläche rendert die Felder generisch in einer Detailansicht je Zugang mit Prüfstand, Fähigkeiten und Verwendung. Die providerspezifischen Formulare in Sources.jsx entfallen, die flachen API-Felder bleiben als Kompatibilität. Das Standardfach eines IMAP-Kontos öffnet der Picker zuerst.

Die Backend-Tests wurden in der Entwicklungsumgebung nicht ausgeführt; der Lauf auf develop steht aus.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
LarsandClaude Sonnet 5.5 committed 2026-10-20 09:34:37 +02:00
1 parent c29bd29f34
commit eb58dce4cd
20 files changed
+1071 -244

No files matched your search

+12 -8
View File
@@ -10,7 +10,7 @@ from uuid import UUID
from app.core.errors import not_found, unprocessable
from app.retrieval import FilePayload, RetrievalFailure
from app.sourcebind import resolve_for_read
from app.sourceregistry import SourceModule, register_source, unregister_source
from app.sourceregistry import ConfigField, SourceModule, register_source, unregister_source
from app.sourceaccess import borrow_original, complete_borrow
KIND = "sample"
@@ -51,13 +51,16 @@ CAPABILITIES = {
}
def parse_config(payload: dict) -> tuple[str, dict, str]:
config = payload.get("config") or {}
catalog = str(config.get("catalog") or "").strip()
name = str(payload.get("name") or "").strip() or catalog
if catalog not in CATALOG:
CONFIG_FIELDS = (
ConfigField("catalog", "Katalog", required=True, default="alpha", help="Name des Beispielkatalogs."),
)
def normalize_config(settings: dict, secret: str) -> dict:
del secret
if settings["catalog"] not in CATALOG:
raise unprocessable("Der Katalog dieser Beispielquelle ist unbekannt.")
return name, {"catalog": catalog}, ""
return settings
def probe(row) -> dict:
@@ -109,7 +112,8 @@ def install_sample_source() -> None:
label="Beispielquelle",
representation="text",
capabilities=CAPABILITIES,
parse_config=parse_config,
config_fields=CONFIG_FIELDS,
normalize_config=normalize_config,
probe=probe,
find=find,
open_original=open_original,
+215
View File
@@ -0,0 +1,215 @@
"""Connector configuration: fields come from the module, secrets never leave the server."""
from __future__ import annotations
import pytest
from app.core.errors import Problem
from app.sourceregistry import ConfigField, parse_fields
from tests.sample_source import install_sample_source, remove_sample_source
from tests.support import Actor, register
SECRET_WORDS = ("secret", "token-geheim-1234", "passwort-geheim")
PAPERLESS = {"kind": "paperless", "name": "Archiv", "base_url": "https://paper.example.test", "token": "token-geheim-1234"}
IMAP = {
"kind": "imap",
"name": "Postfach",
"host": "imap.example.test",
"port": 993,
"username": "ada",
"password": "passwort-geheim",
"security": "ssl",
}
@pytest.fixture
def sample_source():
install_sample_source()
try:
yield
finally:
remove_sample_source()
def _ada(client, db) -> Actor:
ada = Actor(client, "ada-config@example.test", "Ada Konfig")
register(db, ada.email, ada.name)
ada.login()
return ada
def _stored(db, connector_id: str) -> dict:
return db.execute("SELECT settings, secret FROM connectors WHERE id = %s", (connector_id,)).fetchone()
def test_parse_fields_checks_types_and_refuses_unknown_keys():
fields = (
ConfigField("host", "Server", required=True),
ConfigField("port", "Port", type="number", default=993, minimum=1, maximum=65535),
ConfigField("mode", "Modus", type="select", default="a", options=(("a", "A"), ("b", "B"))),
ConfigField("key", "Schlüssel", type="password", required=True, secret=True),
)
settings, secret = parse_fields(fields, {"host": " h ", "key": "k"})
assert settings == {"host": "h", "port": 993, "mode": "a"}
assert secret == "k"
for bad in (
{"host": "h", "key": "k", "port": "abc"},
{"host": "h", "key": "k", "port": 0},
{"host": "h", "key": "k", "mode": "c"},
{"host": "h", "key": "k", "fremd": "x"},
{"key": "k"},
{"host": "h"},
):
with pytest.raises(Problem) as caught:
parse_fields(fields, bad)
assert caught.value.status == 422
kept_settings, kept_secret = parse_fields(fields, {"host": "neu", "key": ""}, {"host": "alt", "port": 143}, "bleibt")
assert kept_settings["host"] == "neu" and kept_settings["port"] == 143
assert kept_secret == "bleibt"
def test_capabilities_list_the_fields_of_each_module(client, db):
ada = _ada(client, db)
modules = {item["kind"]: item for item in ada.request("GET", "/api/v1/sources/capabilities")["modules"]}
assert {"paperless", "imap"} <= set(modules)
paperless = {item["key"]: item for item in modules["paperless"]["config_fields"]}
assert paperless["token"]["secret"] is True and paperless["base_url"]["required"] is True
imap = {item["key"]: item for item in modules["imap"]["config_fields"]}
assert imap["password"]["secret"] is True
assert imap["port"]["type"] == "number" and imap["port"]["default"] == 993
assert [option["value"] for option in imap["security"]["options"]] == ["ssl", "starttls"]
assert imap["mailbox"]["default"] == "INBOX"
def test_create_with_config_and_flat_fields_gives_the_same_stored_result(client, db):
ada = _ada(client, db)
flat = ada.request("POST", "/api/v1/connectors", json=PAPERLESS, status=201)
config = ada.request(
"POST",
"/api/v1/connectors",
json={
"kind": "paperless",
"name": "Zweites Archiv",
"config": {"base_url": "https://paper.example.test/", "token": "token-geheim-1234"},
},
status=201,
)
assert _stored(db, flat["id"]) == _stored(db, config["id"])
assert _stored(db, flat["id"])["settings"] == {"base_url": "https://paper.example.test"}
def test_secrets_never_leave_the_server(client, db):
ada = _ada(client, db)
created = ada.request("POST", "/api/v1/connectors", json=IMAP, status=201)
detail = ada.request("GET", f"/api/v1/connectors/{created['id']}")
listed = ada.request("GET", "/api/v1/connectors")
for body in (created, detail, listed):
text = str(body)
assert not any(word in text for word in SECRET_WORDS if word != "secret"), text
assert "'secret'" not in text and "'password'" not in text and "'token'" not in text
assert detail["has_secret"] is True
assert detail["settings"]["mailbox"] == "INBOX"
assert detail["settings"]["port"] == 993
assert detail["protection_profile"] == "legacy-plaintext"
assert detail["references"] == 0
assert detail["probe"] is None
def test_change_without_secret_keeps_the_stored_one_and_the_instance(client, db):
ada = _ada(client, db)
created = ada.request("POST", "/api/v1/connectors", json=IMAP, status=201)
changed = ada.request(
"PATCH",
f"/api/v1/connectors/{created['id']}",
json={"kind": "imap", "name": "Umbenannt", "config": {"host": "mail.example.test", "port": "143", "security": "starttls"}},
)
assert changed["id"] == created["id"]
assert changed["name"] == "Umbenannt"
stored = _stored(db, created["id"])
assert stored["secret"] == "passwort-geheim"
assert stored["settings"]["host"] == "mail.example.test"
assert stored["settings"]["port"] == 143
assert stored["settings"]["security"] == "starttls"
assert stored["settings"]["username"] == "ada"
renewed = ada.request(
"PATCH",
f"/api/v1/connectors/{created['id']}",
json={"kind": "imap", "name": "Umbenannt", "config": {"password": "neues-passwort"}},
)
assert renewed["id"] == created["id"]
assert _stored(db, created["id"])["secret"] == "neues-passwort"
def test_module_validation_refuses_bad_input(client, db):
ada = _ada(client, db)
ada.request("POST", "/api/v1/connectors", json={**PAPERLESS, "base_url": "ftp://paper.example.test"}, status=422)
ada.request("POST", "/api/v1/connectors", json={**PAPERLESS, "token": "kurz"}, status=422)
ada.request("POST", "/api/v1/connectors", json={**IMAP, "host": "mail server"}, status=422)
ada.request("POST", "/api/v1/connectors", json={**IMAP, "port": 70000}, status=422)
ada.request("POST", "/api/v1/connectors", json={**IMAP, "password": None}, status=422)
ada.request(
"POST",
"/api/v1/connectors",
json={"kind": "paperless", "name": "Fremdfeld", "config": {"base_url": "https://paper.example.test", "token": "token-geheim-1234", "host": "x"}},
status=422,
)
created = ada.request("POST", "/api/v1/connectors", json=PAPERLESS, status=201)
ada.request(
"PATCH",
f"/api/v1/connectors/{created['id']}",
json={**PAPERLESS, "kind": "imap"},
status=422,
)
assert _stored(db, created["id"])["settings"] == {"base_url": "https://paper.example.test"}
def test_a_foreign_instance_is_not_found(client, db):
ada = _ada(client, db)
ben = Actor(client, "ben-config@example.test", "Ben Konfig")
register(db, ben.email, ben.name)
created = ada.request("POST", "/api/v1/connectors", json=PAPERLESS, status=201)
ben.login()
ben.request("GET", f"/api/v1/connectors/{created['id']}", status=404)
ben.request("PATCH", f"/api/v1/connectors/{created['id']}", json=PAPERLESS, status=404)
ben.request("DELETE", f"/api/v1/connectors/{created['id']}", status=404)
def test_probe_result_is_kept_for_display(client, db, sample_source):
del sample_source
ada = _ada(client, db)
created = ada.request(
"POST",
"/api/v1/connectors",
json={"kind": "sample", "name": "Katalog", "config": {"catalog": "alpha"}},
status=201,
)
probed = ada.request("POST", f"/api/v1/connectors/{created['id']}/probe")
detail = ada.request("GET", f"/api/v1/connectors/{created['id']}")
assert detail["probe"]["ok"] is True
assert detail["probe"]["detail"] == probed["detail"]
ada.request(
"PATCH",
f"/api/v1/connectors/{created['id']}",
json={"kind": "sample", "name": "Katalog", "config": {"catalog": "alpha"}},
)
assert ada.request("GET", f"/api/v1/connectors/{created['id']}")["probe"] is None
def test_a_module_with_fields_needs_no_central_schema(client, db, sample_source):
del sample_source
ada = _ada(client, db)
modules = {item["kind"]: item for item in ada.request("GET", "/api/v1/sources/capabilities")["modules"]}
assert [item["key"] for item in modules["sample"]["config_fields"]] == ["catalog"]
ada.request(
"POST",
"/api/v1/connectors",
json={"kind": "sample", "name": "Ohne Wert", "config": {}},
status=201,
)
ada.request(
"POST",
"/api/v1/connectors",
json={"kind": "sample", "name": "Falsch", "config": {"catalog": "kein-katalog"}},
status=422,
)