autonomic-bot
9a7772563a
Push builds have been RED on the lint step since ~build 209 from accumulated formatting drift. This is the mechanical cleanup: ruff format + ruff --fix (UP038 isinstance unions, SIM105 contextlib.suppress, UP031 f-strings, SIM115 tempfile context manager), shfmt -i 2 -ci, nixpkgs-fmt/statix/deadnix (merged attrsets, dropped unused lib args), yamllint, and shell quoting fixes in tests/lasuite-docs/setup_custom_tests.sh. No behaviour changes intended; lint: PASS, unit tests: 138 passed.
89 lines
4.1 KiB
Python
89 lines
4.1 KiB
Python
"""n8n — recipe-specific functional test (Phase 2 P3, ≥2 beyond parity).
|
|
|
|
n8n's editor SPA bootstraps by calling `/rest/settings` to obtain its public settings (webhook URL
|
|
base, version, defaults). A working n8n returns a JSON body from this endpoint; a still-starting
|
|
n8n returns the placeholder HTML page "n8n is starting up. Please wait" with the SAME 200 status.
|
|
So this test polls until the response is real JSON (not the SPA fallback) and asserts known n8n
|
|
public-settings keys are present. Non-vacuous: a broken n8n that boots but cannot serve its public
|
|
settings (the API the editor SPA literally requires) would fail here, distinguishing it from a
|
|
"the HTTP layer is up but n8n itself is dead" failure that /healthz can't catch.
|
|
|
|
Runs in the custom tier against the shared post-install deployment (live_app).
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
import os
|
|
import ssl
|
|
import sys
|
|
import urllib.request
|
|
|
|
sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "..", "..", "runner"))
|
|
from harness import http as harness_http # noqa: E402
|
|
|
|
|
|
def _raw_get_json(url: str, timeout: int = 15):
|
|
"""GET the URL and parse the body as JSON only if Content-Type is application/json — n8n's
|
|
"starting up" placeholder returns text/html with status 200, so a content-type check
|
|
distinguishes a real JSON response from the SPA fallback without relying on path-specific shape.
|
|
Returns (status, content_type, json_or_None)."""
|
|
ctx = ssl.create_default_context()
|
|
ctx.check_hostname = False
|
|
ctx.verify_mode = ssl.CERT_NONE
|
|
req = urllib.request.Request(url, method="GET")
|
|
try:
|
|
with urllib.request.urlopen(req, timeout=timeout, context=ctx) as resp:
|
|
ct = resp.headers.get("Content-Type", "")
|
|
raw = resp.read()
|
|
except Exception as e: # noqa: BLE001
|
|
return 0, "", None, str(e)
|
|
if "application/json" not in ct:
|
|
return resp.status, ct, None, raw.decode(errors="replace")[:80]
|
|
try:
|
|
return resp.status, ct, json.loads(raw), None
|
|
except (json.JSONDecodeError, ValueError) as e:
|
|
return resp.status, ct, None, str(e)
|
|
|
|
|
|
def test_rest_settings_returns_json_with_known_keys(live_app):
|
|
"""Poll /rest/settings until it returns real JSON (not the "starting up" SPA placeholder), then
|
|
assert known n8n public-settings keys are present in the response — proves the editor's primary
|
|
API contract is intact."""
|
|
url = f"https://{live_app}/rest/settings"
|
|
|
|
last_state: dict = {}
|
|
|
|
def _ready():
|
|
status, ct, body, err = _raw_get_json(url)
|
|
last_state.update({"status": status, "ct": ct, "err": err})
|
|
return body if (status == 200 and body is not None) else None
|
|
|
|
body = harness_http.assert_converges(
|
|
_ready,
|
|
f"GET {url} returns JSON (n8n REST ready)",
|
|
max_wait=180,
|
|
interval=5,
|
|
)
|
|
|
|
# n8n /rest/settings shape: {"data": {<settings dict>}, ...}. The exact key set evolves over
|
|
# versions; assert STRUCTURE (the "data" envelope) + a few stable bootstrap keys that have been
|
|
# part of /rest/settings since n8n introduced user-management — verified on this live deploy
|
|
# (e.g. version 3.2.0+2.20.6).
|
|
assert isinstance(body, dict), f"/rest/settings returned non-dict JSON: {type(body).__name__}"
|
|
data = body.get("data") if "data" in body else body
|
|
assert isinstance(
|
|
data, dict
|
|
), f"/rest/settings response missing 'data' envelope: keys={list(body.keys())[:10]}"
|
|
# Bootstrap keys the editor SPA relies on across versions:
|
|
# - `userManagement`: the auth-mode dict (whether owner-setup is needed, smtp/email mode).
|
|
# - `defaultLocale`: i18n bootstrap; present on every n8n install.
|
|
# - `authCookie`: the auth-cookie configuration; consumed by the SPA on every page load.
|
|
expected_any = ("userManagement", "defaultLocale", "authCookie")
|
|
present = [k for k in expected_any if k in data]
|
|
assert present, (
|
|
f"/rest/settings 'data' missing all of {expected_any}; "
|
|
f"got keys: {sorted(data.keys())[:20]} — n8n version may have rotated these names; "
|
|
"update the test."
|
|
)
|