feat(FN-003): add tool manifest registry with FastAPI CRUD and built-in manifests
- Add ToolManifest Pydantic models with validators for ports, mounts, health checks, and traefik config - Implement in-memory ToolRegistry with YAML loading and built-in manifest scanning - Add FastAPI CRUD routes for listing, retrieving, and creating tool manifests - Include built-in manifests for runfusion and code-server - Harden web Dockerfile with unprivileged nginx and port 8080 - Add tool manifest specification documentation and architecture updates Fusion-Task-Id: FN-003
This commit is contained in:
Fusion
@@ -0,0 +1,243 @@
|
||||
"""Tests for the tool manifest Pydantic models."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import pytest
|
||||
from pydantic import ValidationError
|
||||
|
||||
from app.tools.models import (
|
||||
ExecutableConfig,
|
||||
HealthCheckConfig,
|
||||
MountConfig,
|
||||
PortConfig,
|
||||
ResourceLimits,
|
||||
SecretRef,
|
||||
ToolManifest,
|
||||
TraefikConfig,
|
||||
)
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _minimal_manifest(**overrides: object) -> ToolManifest:
|
||||
defaults: dict[str, object] = {
|
||||
"id": "test-tool",
|
||||
"name": "Test Tool",
|
||||
"image": "test:latest",
|
||||
"ports": [PortConfig(container_port=8080, primary=True)],
|
||||
"traefik": TraefikConfig(enabled=False),
|
||||
}
|
||||
defaults.update(overrides)
|
||||
return ToolManifest.model_validate(defaults)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Valid construction
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_valid_runfusion_shape() -> None:
|
||||
manifest = ToolManifest(
|
||||
id="runfusion",
|
||||
name="RunFusion",
|
||||
description="Executable Node.js environment.",
|
||||
image="node:22-slim",
|
||||
runtime_working_dir="/workspace",
|
||||
ports=[PortConfig(container_port=8080, name="http", primary=True)],
|
||||
workspace_mounts=[
|
||||
MountConfig(source_pattern="{project_repo}", target="/workspace")
|
||||
],
|
||||
config_mounts=[
|
||||
MountConfig(
|
||||
source_pattern="{user_config}/runfusion", target="/home/node/.config"
|
||||
)
|
||||
],
|
||||
env={"NODE_ENV": "development"},
|
||||
health_check=HealthCheckConfig(
|
||||
type="http", path="/", port=8080, start_period_seconds=10
|
||||
),
|
||||
resource_limits=ResourceLimits(cpus=2.0, memory_mb=2048),
|
||||
executable=ExecutableConfig(node_version="22", package_manager="npm"),
|
||||
traefik=TraefikConfig(
|
||||
enabled=True, subdomain_prefix="runfusion", port=8080
|
||||
),
|
||||
)
|
||||
assert manifest.id == "runfusion"
|
||||
assert manifest.ports[0].primary is True
|
||||
assert manifest.traefik is not None
|
||||
assert manifest.traefik.enabled is True
|
||||
|
||||
|
||||
def test_valid_code_server_shape() -> None:
|
||||
manifest = ToolManifest(
|
||||
id="code-server",
|
||||
name="code-server",
|
||||
description="VS Code in the browser.",
|
||||
image="codercom/code-server:latest",
|
||||
runtime_working_dir="/workspace",
|
||||
ports=[PortConfig(container_port=8080, name="http", primary=True)],
|
||||
workspace_mounts=[
|
||||
MountConfig(source_pattern="{project_repo}", target="/workspace")
|
||||
],
|
||||
config_mounts=[
|
||||
MountConfig(
|
||||
source_pattern="{user_config}/code-server",
|
||||
target="/home/coder/.config/code-server",
|
||||
)
|
||||
],
|
||||
health_check=HealthCheckConfig(type="http", path="/healthz", port=8080),
|
||||
resource_limits=ResourceLimits(cpus=2.0, memory_mb=4096),
|
||||
traefik=TraefikConfig(enabled=True, subdomain_prefix="code", port=8080),
|
||||
secrets=[
|
||||
SecretRef(name="code-server-password", env_var="PASSWORD", required=False)
|
||||
],
|
||||
)
|
||||
assert manifest.id == "code-server"
|
||||
assert manifest.secrets[0].env_var == "PASSWORD"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Invalid id values
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_invalid_id_uppercase() -> None:
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
_minimal_manifest(id="RunFusion")
|
||||
assert "id" in str(exc_info.value)
|
||||
|
||||
|
||||
def test_invalid_id_spaces() -> None:
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
_minimal_manifest(id="run fusion")
|
||||
assert "id" in str(exc_info.value)
|
||||
|
||||
|
||||
def test_invalid_id_empty_string() -> None:
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
_minimal_manifest(id="")
|
||||
assert "id" in str(exc_info.value)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Port validation
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_invalid_container_port_zero() -> None:
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
PortConfig(container_port=0)
|
||||
assert "container_port" in str(exc_info.value)
|
||||
|
||||
|
||||
def test_invalid_container_port_too_high() -> None:
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
PortConfig(container_port=70000)
|
||||
assert "container_port" in str(exc_info.value)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Mount target validation
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_mount_target_not_absolute() -> None:
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
MountConfig(source_pattern="{project_repo}", target="workspace")
|
||||
assert "absolute" in str(exc_info.value).lower()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# HealthCheck validation
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_health_check_http_missing_path() -> None:
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
HealthCheckConfig(type="http")
|
||||
assert "path" in str(exc_info.value)
|
||||
|
||||
|
||||
def test_health_check_command_missing_command() -> None:
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
HealthCheckConfig(type="command")
|
||||
assert "command" in str(exc_info.value)
|
||||
|
||||
|
||||
def test_health_check_tcp_allows_missing_path() -> None:
|
||||
hc = HealthCheckConfig(type="tcp")
|
||||
assert hc.type == "tcp"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Traefik + primary port validation
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_missing_primary_port_when_traefik_enabled() -> None:
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
ToolManifest(
|
||||
id="bad-tool",
|
||||
name="Bad Tool",
|
||||
image="test:latest",
|
||||
ports=[PortConfig(container_port=8080, primary=False)],
|
||||
traefik=TraefikConfig(enabled=True),
|
||||
)
|
||||
assert "primary" in str(exc_info.value).lower()
|
||||
|
||||
|
||||
def test_traefik_disabled_allows_no_primary_port() -> None:
|
||||
manifest = ToolManifest(
|
||||
id="no-route",
|
||||
name="No Route",
|
||||
image="test:latest",
|
||||
ports=[PortConfig(container_port=8080, primary=False)],
|
||||
traefik=TraefikConfig(enabled=False),
|
||||
)
|
||||
assert manifest.traefik is not None
|
||||
assert manifest.traefik.enabled is False
|
||||
|
||||
|
||||
def test_no_traefik_allows_no_primary_port() -> None:
|
||||
manifest = ToolManifest(
|
||||
id="no-route",
|
||||
name="No Route",
|
||||
image="test:latest",
|
||||
ports=[PortConfig(container_port=8080, primary=False)],
|
||||
)
|
||||
assert manifest.traefik is None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Resource limits validation
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_resource_limits_cpus_too_low() -> None:
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
ResourceLimits(cpus=0.001)
|
||||
assert "cpus" in str(exc_info.value)
|
||||
|
||||
|
||||
def test_resource_limits_memory_mb_too_low() -> None:
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
ResourceLimits(memory_mb=8)
|
||||
assert "memory_mb" in str(exc_info.value)
|
||||
|
||||
|
||||
def test_resource_limits_memory_swap_negative_one_ok() -> None:
|
||||
rl = ResourceLimits(memory_swap_mb=-1)
|
||||
assert rl.memory_swap_mb == -1
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Serialization round-trip
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_serialization_roundtrip() -> None:
|
||||
original = _minimal_manifest(
|
||||
id="roundtrip",
|
||||
name="Roundtrip Tool",
|
||||
ports=[PortConfig(container_port=3000, name="http", primary=True)],
|
||||
traefik=TraefikConfig(enabled=True, subdomain_prefix="rt"),
|
||||
)
|
||||
dumped = original.model_dump(mode="json")
|
||||
restored = ToolManifest.model_validate(dumped)
|
||||
assert restored.id == original.id
|
||||
assert restored.ports[0].container_port == original.ports[0].container_port
|
||||
assert restored.traefik is not None
|
||||
assert restored.traefik.subdomain_prefix == "rt"
|
||||
@@ -0,0 +1,159 @@
|
||||
"""Tests for the in-memory tool manifest registry."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
from pydantic import ValidationError
|
||||
|
||||
from app.tools.models import PortConfig, ToolManifest, TraefikConfig
|
||||
from app.tools.registry import ToolRegistry
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.fixture
|
||||
def registry() -> ToolRegistry:
|
||||
return ToolRegistry()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def sample_manifest() -> ToolManifest:
|
||||
return ToolManifest(
|
||||
id="test-tool",
|
||||
name="Test Tool",
|
||||
image="test:latest",
|
||||
ports=[PortConfig(container_port=8080, primary=True)],
|
||||
traefik=TraefikConfig(enabled=False),
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Register / get round-trip
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_register_and_get(registry: ToolRegistry, sample_manifest: ToolManifest) -> None:
|
||||
registry.register(sample_manifest)
|
||||
retrieved = registry.get("test-tool")
|
||||
assert retrieved is not None
|
||||
assert retrieved.id == "test-tool"
|
||||
|
||||
|
||||
def test_get_missing_returns_none(registry: ToolRegistry) -> None:
|
||||
assert registry.get("missing") is None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# List
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_list_returns_all(registry: ToolRegistry) -> None:
|
||||
m1 = ToolManifest(
|
||||
id="tool-a",
|
||||
name="Tool A",
|
||||
image="a:latest",
|
||||
ports=[PortConfig(container_port=8080, primary=True)],
|
||||
traefik=TraefikConfig(enabled=False),
|
||||
)
|
||||
m2 = ToolManifest(
|
||||
id="tool-b",
|
||||
name="Tool B",
|
||||
image="b:latest",
|
||||
ports=[PortConfig(container_port=3000, primary=True)],
|
||||
traefik=TraefikConfig(enabled=False),
|
||||
)
|
||||
registry.register(m1)
|
||||
registry.register(m2)
|
||||
assert len(registry.list()) == 2
|
||||
ids = {m.id for m in registry.list()}
|
||||
assert ids == {"tool-a", "tool-b"}
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Overwrite behavior
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_register_overwrites_existing(
|
||||
registry: ToolRegistry,
|
||||
sample_manifest: ToolManifest,
|
||||
) -> None:
|
||||
registry.register(sample_manifest)
|
||||
updated = ToolManifest(
|
||||
id="test-tool",
|
||||
name="Updated Tool",
|
||||
image="updated:latest",
|
||||
ports=[PortConfig(container_port=8080, primary=True)],
|
||||
traefik=TraefikConfig(enabled=False),
|
||||
)
|
||||
registry.register(updated)
|
||||
retrieved = registry.get("test-tool")
|
||||
assert retrieved is not None
|
||||
assert retrieved.name == "Updated Tool"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Remove
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_remove_returns_manifest(registry: ToolRegistry, sample_manifest: ToolManifest) -> None:
|
||||
registry.register(sample_manifest)
|
||||
removed = registry.remove("test-tool")
|
||||
assert removed is not None
|
||||
assert removed.id == "test-tool"
|
||||
assert registry.get("test-tool") is None
|
||||
|
||||
|
||||
def test_remove_missing_returns_none(registry: ToolRegistry) -> None:
|
||||
assert registry.remove("missing") is None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Load file
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_load_valid_yaml_file(registry: ToolRegistry, tmp_path: Path) -> None:
|
||||
yaml_path = tmp_path / "my-tool.yml"
|
||||
yaml_path.write_text(
|
||||
"""
|
||||
id: my-tool
|
||||
name: My Tool
|
||||
image: my-tool:latest
|
||||
ports:
|
||||
- container_port: 8080
|
||||
primary: true
|
||||
traefik:
|
||||
enabled: false
|
||||
""",
|
||||
encoding="utf-8",
|
||||
)
|
||||
manifest = registry.load_file(yaml_path)
|
||||
assert manifest.id == "my-tool"
|
||||
assert manifest.name == "My Tool"
|
||||
assert manifest.ports[0].container_port == 8080
|
||||
|
||||
|
||||
def test_load_invalid_yaml_raises(registry: ToolRegistry, tmp_path: Path) -> None:
|
||||
yaml_path = tmp_path / "bad-tool.yml"
|
||||
yaml_path.write_text(
|
||||
"""
|
||||
id: BAD ID
|
||||
name: Bad Tool
|
||||
image: bad:latest
|
||||
""",
|
||||
encoding="utf-8",
|
||||
)
|
||||
with pytest.raises(ValidationError):
|
||||
registry.load_file(yaml_path)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Load builtin manifests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_load_builtin_manifests(registry: ToolRegistry) -> None:
|
||||
registry.load_builtin_manifests()
|
||||
# Built-in manifests from Step 4 may not exist yet in isolation,
|
||||
# but the method should not raise regardless of directory contents.
|
||||
assert isinstance(registry.list(), list)
|
||||
@@ -0,0 +1,93 @@
|
||||
"""Tests for the FastAPI tool manifest router."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
from app.main import app
|
||||
from app.tools.registry import registry
|
||||
|
||||
client = TestClient(app)
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def _reset_registry() -> None:
|
||||
registry._manifests.clear()
|
||||
registry.load_builtin_manifests()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# GET /api/v1/tools
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def test_list_tools_includes_builtins() -> None:
|
||||
response = client.get("/api/v1/tools")
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
ids = {item["id"] for item in data}
|
||||
assert "runfusion" in ids
|
||||
assert "code-server" in ids
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# GET /api/v1/tools/{tool_id}
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def test_get_tool_runfusion() -> None:
|
||||
response = client.get("/api/v1/tools/runfusion")
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert data["id"] == "runfusion"
|
||||
assert data["name"] == "RunFusion"
|
||||
|
||||
|
||||
def test_get_tool_not_found() -> None:
|
||||
response = client.get("/api/v1/tools/nonexistent")
|
||||
assert response.status_code == 404
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# POST /api/v1/tools
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def test_create_tool_success() -> None:
|
||||
payload = {
|
||||
"id": "new-tool",
|
||||
"name": "New Tool",
|
||||
"image": "new-tool:latest",
|
||||
"ports": [{"container_port": 3000, "primary": True}],
|
||||
"traefik": {"enabled": False},
|
||||
}
|
||||
response = client.post("/api/v1/tools", json=payload)
|
||||
assert response.status_code == 201
|
||||
data = response.json()
|
||||
assert data["id"] == "new-tool"
|
||||
assert data["name"] == "New Tool"
|
||||
|
||||
|
||||
def test_create_tool_duplicate() -> None:
|
||||
payload = {
|
||||
"id": "runfusion",
|
||||
"name": "Duplicate",
|
||||
"image": "dup:latest",
|
||||
"ports": [{"container_port": 3000, "primary": True}],
|
||||
"traefik": {"enabled": False},
|
||||
}
|
||||
response = client.post("/api/v1/tools", json=payload)
|
||||
assert response.status_code == 409
|
||||
|
||||
|
||||
def test_create_tool_invalid_id() -> None:
|
||||
payload = {
|
||||
"id": "Bad ID",
|
||||
"name": "Bad Tool",
|
||||
"image": "bad:latest",
|
||||
"ports": [{"container_port": 3000, "primary": True}],
|
||||
"traefik": {"enabled": False},
|
||||
}
|
||||
response = client.post("/api/v1/tools", json=payload)
|
||||
assert response.status_code == 422
|
||||
Reference in New Issue
Block a user