knowledge-platform/tests/unit/test_helm_deployment.py

184 lines
6.7 KiB
Python

"""Static and rendered contracts for the DEPLOY-002 Helm delivery."""
import json
import shutil
import subprocess
from pathlib import Path
import pytest
ROOT = Path(__file__).resolve().parents[2]
CHART = ROOT / "deploy" / "helm" / "knowledge-platform"
EXAMPLE_VALUES = ROOT / "deploy" / "helm" / "environments" / "values.example.yaml"
def _helm(*arguments: str, expect_success: bool = True) -> subprocess.CompletedProcess[str]:
"""Run Helm when installed; static checks still run on Python-only hosts."""
executable = shutil.which("helm")
if executable is None:
pytest.skip("Helm is required for rendered chart assertions")
result = subprocess.run(
[executable, *arguments],
cwd=ROOT,
check=False,
capture_output=True,
text=True,
)
if expect_success and result.returncode != 0:
pytest.fail(f"Helm failed: {result.stderr or result.stdout}")
return result
def _render(*extra_arguments: str) -> str:
"""Render deterministic manifests without contacting a cluster."""
result = _helm(
"template",
"knowledge-platform",
str(CHART),
"--namespace",
"knowledge-platform",
"--values",
str(EXAMPLE_VALUES),
*extra_arguments,
)
return result.stdout
def test_chart_has_machine_validated_values_schemas() -> None:
"""Both the application and optional broker expose valid JSON Schemas."""
for schema_path in (
CHART / "values.schema.json",
CHART / "charts" / "rabbitmq" / "values.schema.json",
):
schema = json.loads(schema_path.read_text())
assert schema["$schema"] == "https://json-schema.org/draft-07/schema#"
assert schema["type"] == "object"
def test_default_chart_renders_secret_only_sensitive_configuration() -> None:
"""Credentials are references; the chart never creates or embeds a Secret."""
rendered = _render()
assert "kind: Secret\n" not in rendered
assert "secretRef:\n name: knowledge-platform-runtime" in rendered
assert "key: DATABASE_URL" in rendered
assert "helm.sh/hook: pre-install,pre-upgrade" in rendered
assert 'args: ["upgrade", "head"]' in rendered
assert "value: mysql+pymysql://" not in rendered
assert "change-me" not in rendered
def test_workloads_render_availability_and_restricted_pod_defaults() -> None:
"""API/MCP are multi-replica and every application process is non-root."""
rendered = _render()
assert "name: knowledge-platform-api" in rendered
assert "name: knowledge-platform-mcp" in rendered
assert rendered.count("replicas: 2") >= 3
assert rendered.count("readOnlyRootFilesystem: true") >= 5
assert rendered.count("allowPrivilegeEscalation: false") >= 5
assert rendered.count("automountServiceAccountToken: false") >= 6
assert "maxUnavailable: 0" in rendered
assert "readinessProbe:" in rendered
assert "livenessProbe:" in rendered
assert "startupProbe:" in rendered
assert rendered.count("kind: PodDisruptionBudget") == 2
assert 'prometheus.io/path: "/metrics"' in rendered
def test_scheduler_is_singleton_and_workers_do_not_embed_beat() -> None:
"""Scaled workers cannot accidentally create multiple periodic schedulers."""
rendered = _render()
scheduler = rendered[rendered.index("name: knowledge-platform-scheduler") :]
scheduler = scheduler[: scheduler.index("---", 1)]
worker = rendered[rendered.index("name: knowledge-platform-worker") :]
worker = worker[: worker.index("---", 1)]
assert "replicas: 1" in scheduler
assert "type: Recreate" in scheduler
assert "- beat" in scheduler
assert "- worker" in worker
assert "- beat" not in worker
def test_ingress_and_optional_rabbitmq_are_explicitly_renderable() -> None:
"""TLS routes and the persistent demo broker remain opt-in values."""
rendered = _render("--set", "rabbitmq.enabled=true")
assert "kind: Ingress" in rendered
assert "secretName: knowledge-platform-api-tls" in rendered
assert "secretName: knowledge-platform-mcp-tls" in rendered
assert "kind: StatefulSet" in rendered
assert "volumeClaimTemplates:" in rendered
assert "name: RABBITMQ_DEFAULT_PASS" in rendered
assert "valueFrom:" in rendered
def test_values_schema_rejects_latest_image_tags() -> None:
"""Cluster releases require a non-latest immutable tag or digest."""
result = _helm(
"lint",
str(CHART),
"--set",
"images.api.tag=latest",
expect_success=False,
)
assert result.returncode != 0
assert "/images/api/tag" in (result.stdout + result.stderr)
def test_cross_field_validation_rejects_unsafe_ingestion_limits() -> None:
"""Rendered settings preserve the application's own configuration rules."""
result = _helm(
"template",
"knowledge-platform",
str(CHART),
"--set",
"config.ingestion.batchMaxTotalBytes=1",
expect_success=False,
)
assert result.returncode != 0
assert "batchMaxTotalBytes must be >= maxUploadBytes" in (result.stdout + result.stderr)
def test_cross_field_validation_rejects_pdb_that_blocks_all_evictions() -> None:
"""A PDB must leave room to replace one of the required replicas."""
result = _helm(
"template",
"knowledge-platform",
str(CHART),
"--set",
"podDisruptionBudget.apiMinAvailable=2",
expect_success=False,
)
assert result.returncode != 0
assert "apiMinAvailable must be < api.replicaCount" in (result.stdout + result.stderr)
def test_cluster_acceptance_requires_explicit_context_and_mutation_confirmation() -> None:
"""The target-cluster harness cannot silently mutate an ambient context."""
cluster_script = (ROOT / "scripts" / "cluster_acceptance.sh").read_text()
worker_script = (ROOT / "scripts" / "worker_recovery_acceptance.sh").read_text()
assert "ACCEPTANCE_KUBE_CONTEXT" in cluster_script
assert "ACCEPTANCE_CONFIRM" in cluster_script
assert 'acceptance_mode="${ACCEPTANCE_MODE:-read-only}"' in cluster_script
assert "--grace-period=0 --force --wait=false" in worker_script
assert "get secret" not in worker_script
def test_deploy_entrypoint_uses_atomic_upgrade_and_never_reads_secret_values() -> None:
"""The one-command wrapper checks references and performs an atomic wait."""
script = (ROOT / "scripts" / "deploy.sh").read_text()
assert "helm upgrade --install" in script
assert "--atomic" in script
assert "--rollback-on-failure" in script
assert "--wait" in script
assert 'kubectl -n "${namespace}" get secret' in script
assert 'awk \'$1 == "runtimeSecret:"' in script
assert "DATABASE_URL}'" not in script