Files
haproxy-openmanager/backend/tests/test_backend_service_extraction.py
taylanbakircioglu 02b1cb2bca feat: v1.5.0 — Site Wizard (Issue #14) + ACME Diagnostic Panel (Issue #13)
Closes #13, Closes #14.

This release squashes the v1.4.0 → v1.5.0 development line. v1.4.0
shipped the ACME stability & enterprise audit (Issues #10/#11/#12).
v1.5.0 builds on that foundation with two co-equal headline features
plus a 22-round audit campaign hardening the prior configuration
surface. License remains MIT for v1.5.0 (relicense to AGPL-3.0
lands in v1.5.2).

------------------------------------------------------------------
HEADLINE FEATURE A — ACME Diagnostic Panel (Issue #13)
------------------------------------------------------------------
A live pre-flight + post-failure diagnostic surface for every ACME
order, reachable from the ACME Automation page. The panel exists
to make ACME failures legible to operators who do NOT have shell
access to the API host.

Endpoints (`backend/routers/acme_diagnostics.py`):
  POST /api/letsencrypt/orders/{order_id}/diagnostics
       Run the full 5-check suite (DNS / port-80 / routing /
       account / agents) and humanize the order's `error_detail`
       (>=11 RFC-8555 problem types, backwards compatible with
       legacy plain-string failures).
  POST /api/letsencrypt/orders/{order_id}/diagnostics/
                                {check_id}/rerun
       Re-run a single check in place — used by the "Re-run"
       button on every row of the modal's pre-flight table.
  GET  /api/letsencrypt/orders/{order_id}/events
       Merged event timeline combining the typed
       `acme_order_events` rows with correlated
       `user_activity_logs` entries (resource_type =
       'letsencrypt_order' AND resource_id = order_id). The
       diagnostic modal auto-tails this timeline every 5 seconds
       while open.

Service-level checks (`backend/services/acme_diagnostics.py`):
  * DNS resolution via stdlib socket.gethostbyname_ex through
    run_in_executor (intentionally avoiding an aiodns runtime
    dep for v1.5.0).
  * Port-80 HEAD probe, target locked to the order's domains,
    success on HTTP 200 OR 404, warns on egress timeout
    (corp egress policies routinely blackhole outbound 80 —
    fail-hard would be too noisy).
  * SSRF guard: probe refuses non-public IPs and surfaces the
    skip in the diagnostic result; IPv4-mapped IPv6 normalisation
    closes the `::ffff:169.254.169.254` cloud-metadata vector.
  * HAProxy routing presence check: matches the order's
    cluster_ids to a port-80 HTTP frontend.
  * ACME account validity check against `letsencrypt_accounts`.
  * Agent presence check (>=1 active agent in target cluster).
  * Every sub-check wrapped in a wall-clock timeout to bound
    impact on the API event loop.

RBAC: ssl.read for run, ssl.read for events. Per-user 5/min rate
limit on both run and rerun, backed by the (user_id, action,
created_at DESC) composite index.

Frontend (`frontend/src/components/ACMEAutomation.js`):
  * "Diagnose" button on every order row + the existing
    "stuck order" warning row.
  * Modal with two tabs:
    - Pre-flight Checks (Antd Table with status pills + Re-run
      buttons + humanized error banner)
    - Event Log (Antd Timeline with auto-tail polling, scroll-
      to-bottom, pause-on-hover)
  * Correlation IDs surfaced in error banners and individual
    check fail details for backend-log lookup.

------------------------------------------------------------------
HEADLINE FEATURE B — Site Setup Wizard (Issue #14)
------------------------------------------------------------------
A single guided flow that creates a Backend + Servers + HTTP
Frontend (and optional HTTPS Frontend) in one atomic transaction.

Endpoints (`backend/routers/site_wizard.py`):
  POST /api/site-wizard/preview     — diff-preview the changeset
  POST /api/site-wizard/create      — atomic execute
  POST /api/site-wizard/reject      — clean rollback (including
                                       any wizard_staged ACME
                                       orders)
  GET  /api/site-wizard/drafts      — draft persistence
  PUT  /api/site-wizard/drafts/{id} — save/update
  DELETE /api/site-wizard/drafts/{id}

Feature surface:
  * One screen captures both backend (mode + servers) AND
    frontend (http + optional https + SSL mode) inputs.
  * SSL modes: ACME (new order, HTTP-01 only for v1.5.0),
    Upload (existing PEM), Existing (link to a stored cert),
    or None.
  * ACME-staged path: wizard_staged_until watermark on the
    `letsencrypt_orders` row defers finalisation until agent
    confirmation; per-mode reject cleanly cancels and rolls
    back the staged order.
  * Live diff preview against the cluster's current generated
    config (renderer-evolution noise stripped — track-sc<N>
    dedup, per-server cookie strip, defaults-cookie
    inheritance, listen-block flattening).
  * Draft persistence with PEM stripped at save time (private
    keys never round-trip through the drafts table).
  * Per-cluster multi-tenancy: drafts and wizard_staged orders
    are isolated to the creating user's cluster scope.

Frontend (`frontend/src/components/SiteWizard.js`):
  * 4-step Antd Steps flow: Backend → Frontend → SSL → Review.
  * Render the live diff preview inline before commit.
  * Antd Form-level validation mirrors backend Pydantic
    validators (numeric bounds, HAProxy reserved keywords, ALPN
    consistency, IPv6 scope-id, domain regex, server name
    dedup).

------------------------------------------------------------------
AUDIT CAMPAIGN — Rounds 1 → 22 (Bulgu #1#82)
------------------------------------------------------------------
v1.5.0 includes 22 adversarial review passes. Each round produced
its own commit set in the corporate development line; this squash
collapses those into the v1.5.0 release artefact. Highlights:

  Round 1-4   Site Wizard core: dry-run parity, single-line
              value injection guard, ACL -f pattern-file block,
              SSL parity, timeout regex, form-state pin.
  Round 5-7   defaults-cookie inheritance, server-named-cookie
              guard, fe/be mode mismatch, duplicate server
              names, health_check_uri + server_address
              validators.
  Round 8-10  cookie_name / cookie_options newline-injection
              guard, dry-run parity (round 9), TCP-mode HTTP-only
              feature blockers.
  Round 11    SSL name path traversal + health-check >= 1.
  Round 12-13 SSL & ACME deep dive (Bulgu #23-#32).
  Round 14    single-line value injection (Bulgu #33).
  Round 15-17 ACME multi-tenant UX, numeric bounds, HAProxy
              reserved keywords, ALPN/TLS consistency,
              all-backup, multi-domain & multi-user enterprise
              edges, drain/HSTS/post-completion (Bulgu
              #34-#53).
  Round 18-21 concurrency, agent state, TCP-mode HTTP-only,
              list size caps, IPv6 scope-id, preview account
              validation, TCP backend + balance uri reject
              (Bulgu #54-#61).
  Round 22    FE error visibility + 3x stale-data lockouts,
              referential integrity + cascade safety,
              authentication & authorization, multi-cluster
              isolation, apply_pending_changes concurrency,
              script injection + bulk import multi-tenancy,
              prefix-stripped signature comparison
              (Bulgu #62-#82).

------------------------------------------------------------------
NO CORPORATE-SPECIFIC ARTIFACTS
------------------------------------------------------------------
This squash deliberately sanitises corporate hostnames, container
registry references, and TLS secret names into generic
placeholders (`your-registry.example.com/your-org`,
`haproxy-openmanager*.example.com`, `wildcard-tls`,
`taylanbakircioglu/haproxy-openmanager-*`) so the public artefact
contains no internal infrastructure detail. Pilot / development
history that retained those values stays in the corporate fork
and is NOT part of this commit.
2026-05-14 00:04:19 +03:00

177 lines
5.9 KiB
Python

"""
v1.5.0 service extraction parity — backend_service.
Asserts that create_backend_row + create_server_row pass the SAME column-set
and ordering that POST /api/backends and POST /api/backends/{id}/servers
already use. This protects us from a subtle field-drift regression that
would only surface as silent NULL columns in the wizard's bulk-create.
Notes:
- We don't run the actual SQL, we capture the SQL+args via a mock conn and
assert on the column names + argument count.
- M13 helper extension: mark_pending=True must follow the INSERT with a
UPDATE last_config_status='PENDING' (matching the existing endpoint).
"""
from types import SimpleNamespace
from unittest.mock import AsyncMock
import pytest
from services.backend_service import (
_filter_httpchk_from_options,
create_backend_row,
create_server_row,
)
# ----------------------------------------------------------------------------
# _filter_httpchk_from_options
# ----------------------------------------------------------------------------
def test_filter_httpchk_strips_only_httpchk_lines():
raw = "option httpchk GET /healthz\noption http-server-close\nbalance roundrobin"
out = _filter_httpchk_from_options(raw)
assert "httpchk" not in out
assert "http-server-close" in out
assert "balance roundrobin" in out
def test_filter_httpchk_handles_empty_input():
assert _filter_httpchk_from_options(None) is None
assert _filter_httpchk_from_options("") == ""
def test_filter_httpchk_handles_only_httpchk_returns_none():
assert _filter_httpchk_from_options("option httpchk GET /") is None
# ----------------------------------------------------------------------------
# create_backend_row column parity
# ----------------------------------------------------------------------------
@pytest.mark.asyncio
async def test_create_backend_row_inserts_all_expected_columns():
conn = AsyncMock()
conn.fetchval.return_value = 7
payload = SimpleNamespace(
name="be_test",
balance_method="leastconn",
mode="http",
health_check_uri="/healthz",
health_check_interval=2000,
health_check_expected_status=200,
timeout_connect=10000,
timeout_server=60000,
timeout_queue=60000,
options=None,
)
new_id = await create_backend_row(conn, payload, cluster_id=1)
assert new_id == 7
# Verify INSERT shape
sql, *args = conn.fetchval.call_args.args
assert "INSERT INTO backends" in sql
# 19 placeholders => 19 args
assert len(args) == 19
assert args[0] == "be_test"
assert args[1] == "leastconn"
assert args[18] == 1 # cluster_id last positional
# mark_pending=True default → UPDATE last_config_status='PENDING'
update_calls = [c for c in conn.execute.call_args_list
if c.args and "UPDATE backends" in c.args[0]]
assert len(update_calls) == 1
assert "last_config_status='PENDING'" in update_calls[0].args[0]
@pytest.mark.asyncio
async def test_create_backend_row_mark_pending_false_skips_update():
conn = AsyncMock()
conn.fetchval.return_value = 5
payload = SimpleNamespace(
name="be_x", balance_method="roundrobin", mode="http",
)
await create_backend_row(conn, payload, cluster_id=1, mark_pending=False)
update_calls = [c for c in conn.execute.call_args_list
if c.args and "UPDATE backends" in c.args[0]]
assert update_calls == []
@pytest.mark.asyncio
async def test_create_backend_row_filters_httpchk_from_options():
conn = AsyncMock()
conn.fetchval.return_value = 1
payload = SimpleNamespace(
name="be_x",
balance_method="roundrobin",
mode="http",
options="option httpchk GET /\nbalance roundrobin",
)
await create_backend_row(conn, payload, cluster_id=1)
sql, *args = conn.fetchval.call_args.args
options_arg = args[14] # 15th positional (1-indexed $15)
assert "httpchk" not in (options_arg or "")
assert "balance roundrobin" in (options_arg or "")
# ----------------------------------------------------------------------------
# create_server_row column parity
# ----------------------------------------------------------------------------
@pytest.mark.asyncio
async def test_create_server_row_inserts_all_expected_columns():
conn = AsyncMock()
conn.fetchval.return_value = 11
server = SimpleNamespace(
server_name="srv1",
server_address="10.0.0.1",
server_port=8080,
weight=100,
check_enabled=True,
backup_server=False,
ssl_enabled=False,
)
new_id = await create_server_row(
conn, backend_id=7, backend_name="be_test", cluster_id=1, server=server,
)
assert new_id == 11
sql, *args = conn.fetchval.call_args.args
assert "INSERT INTO backend_servers" in sql
assert len(args) == 22
assert args[0] == 7 # backend_id
assert args[1] == "be_test" # backend_name
assert args[2] == "srv1"
assert args[3] == "10.0.0.1"
assert args[4] == 8080
assert args[21] == 1 # cluster_id last positional
# mark_pending=True default → UPDATE
update_calls = [c for c in conn.execute.call_args_list
if c.args and "UPDATE backend_servers" in c.args[0]]
assert len(update_calls) == 1
@pytest.mark.asyncio
async def test_create_server_row_uses_server_address_not_host():
"""Schema accuracy R38: column is server_address NOT host or ip."""
conn = AsyncMock()
conn.fetchval.return_value = 1
server = SimpleNamespace(
server_name="s", server_address="10.1.1.1", server_port=80,
weight=100, check_enabled=True, backup_server=False, ssl_enabled=False,
)
await create_server_row(conn, 1, "be", 1, server)
sql, *_ = conn.fetchval.call_args.args
# Verify the column list explicitly mentions server_address, server_port, server_name
assert "server_address" in sql
assert "server_port" in sql
assert "server_name" in sql