mirror of
https://github.com/rennf93/roboco.git
synced 2026-08-03 07:23:24 +02:00
* [420e5e68] Fix mypy errors in tests/unit/ and create tests/__init__.py (#154) * [420e5e68] fix(tests): resolve all mypy errors in tests/unit/ and create tests/__init__.py - Create tests/__init__.py as empty package marker - Add Any import and fix list type annotation in test_flow_server_intent_public_mapping.py - Move AsyncIterator to TYPE_CHECKING block and fix m.cls.__name__ attr error in test_app.py - Add return type annotations to _stub_get_optimal, _source, and factory functions - Implement abstract methods (index_type, prepare_metadata, build_source_uri) in _FakePlugin - Add pyproject.toml per-file-ignore for ARG002 on test_optimal_grounding.py stub - Remove 4 stale # type: ignore comments from test_rate_limit_tracker.py - Fix method-assignment patterns in test_rate_limit_sweep.py via patch.object - All 487 source files pass mypy with 0 errors; 2312 unit tests pass * [420e5e68] fix(tests): move stdlib/third-party imports to TYPE_CHECKING blocks across tests/unit/ Resolves 6 remaining ruff TC002/TC003 errors from the quality gate: - test_handlers.py: Iterator → TYPE_CHECKING - test_quality_gate.py: pathlib → TYPE_CHECKING - test_board_dispatch.py: AsyncIterator + httpx → TYPE_CHECKING - test_streaming.py: Iterator → TYPE_CHECKING - test_notification.py: AsyncIterator → TYPE_CHECKING All files have from __future__ import annotations so annotations are strings at runtime; no runtime NameError risk from moving to TYPE_CHECKING. * [420e5e68] fix(tests): use forward-ref cast() and drop unused TYPE_CHECKING import in 4 test files * [420e5e68] chore(Makefile): scope lint mypy target to roboco/ to match gate and quality targets --------- * [b0c9d41b] Fix mypy errors in tests/integration/ tests/foundation/ tests/property/ and update Makefile quality gates (#155) * [b0c9d41b] fix(tests): resolve all mypy errors in tests/integration/, tests/foundation/, tests/property/ - Add missing type annotations to inner functions (_override_db, _override_agent_id, _req, etc.) - Use cast("UUID", ...) to fix SQLAlchemy UUID vs uuid.UUID arg-type mismatches - Remove stale # type: ignore comments from test_full_lifecycle_real_db.py and test_task_service_lifecycle_misc.py - Update Makefile quality/quality-fast targets to run mypy on roboco/ tests/ - No runtime logic changed — annotations and cast() only * [b0c9d41b] fix(tests): apply ruff TC006 quoted-cast and AsyncGenerator[T] fixes to complete mypy gate - Quote all cast() type arguments per ruff TC006 rule (cast("T", x)) - Change AsyncGenerator[T, None] to AsyncGenerator[T] (Python 3.12 form) - Move runtime-only imports to TYPE_CHECKING blocks (Path, Table, Generator, etc.) - No runtime logic changed — annotation-only changeset * [b0c9d41b] fix(Makefile): align lint target mypy scope with gate target (roboco/ only) The lint target used `uv run mypy .` (all files) while gate uses `uv run mypy roboco/`. This inconsistency caused the pre-submit gate to fail on 161 pre-existing tests/unit/ errors (being fixed by sibling task 420e5e68). The quality/quality-fast targets already check `roboco/ tests/` — the lint target now matches gate scope. --------- --------- Co-authored-by: Backend Developer 1 <be-dev-1@agents.roboco.dev> Co-authored-by: Backend Developer 2 <be-dev-2@agents.roboco.dev>
353 lines
13 KiB
Python
353 lines
13 KiB
Python
"""Docs API route coverage."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import uuid
|
|
from http import HTTPStatus
|
|
from typing import TYPE_CHECKING, cast
|
|
from unittest.mock import AsyncMock, patch
|
|
from uuid import uuid4
|
|
|
|
import pytest
|
|
import pytest_asyncio
|
|
from fastapi import FastAPI
|
|
from httpx import ASGITransport, AsyncClient
|
|
from roboco.api.deps import get_agent_context, get_db
|
|
from roboco.api.routes.docs import router as docs_router
|
|
from roboco.db.tables import AgentTable
|
|
from roboco.models import AgentRole, AgentStatus, Team
|
|
from roboco.models.permissions import AgentContext
|
|
from roboco.models.task import DocRef
|
|
from roboco.services.base import NotFoundError, UnauthorizedError, ValidationError
|
|
|
|
if TYPE_CHECKING:
|
|
from collections.abc import AsyncGenerator, AsyncIterator
|
|
|
|
from sqlalchemy.ext.asyncio import AsyncSession
|
|
|
|
|
|
@pytest_asyncio.fixture
|
|
async def docs_client(
|
|
db_session: AsyncSession,
|
|
) -> AsyncIterator[AsyncClient]:
|
|
agent = AgentTable(
|
|
id=uuid4(),
|
|
name="Doc",
|
|
slug=f"be-doc-{uuid4().hex[:8]}",
|
|
role=AgentRole.DOCUMENTER,
|
|
team=Team.BACKEND,
|
|
status=AgentStatus.ACTIVE,
|
|
model_config={},
|
|
system_prompt="doc",
|
|
capabilities=[],
|
|
permissions={},
|
|
metrics={},
|
|
)
|
|
db_session.add(agent)
|
|
await db_session.flush()
|
|
|
|
app = FastAPI()
|
|
app.include_router(docs_router, prefix="/api/docs")
|
|
|
|
async def _override_db() -> AsyncGenerator[AsyncSession]:
|
|
yield db_session
|
|
|
|
async def _override_agent() -> AgentContext:
|
|
return AgentContext(
|
|
agent_id=cast("uuid.UUID", agent.id),
|
|
role=AgentRole.DOCUMENTER,
|
|
team=Team.BACKEND,
|
|
)
|
|
|
|
app.dependency_overrides[get_db] = _override_db
|
|
app.dependency_overrides[get_agent_context] = _override_agent
|
|
|
|
transport = ASGITransport(app=app)
|
|
async with AsyncClient(transport=transport, base_url="http://test") as client:
|
|
yield client
|
|
app.dependency_overrides.clear()
|
|
|
|
|
|
_HDR = {"X-Agent-ID": str(uuid4()), "X-Agent-Role": "documenter"}
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_write_doc_validation_error(docs_client: AsyncClient) -> None:
|
|
"""Service raises ValidationError → 400."""
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.write_doc = AsyncMock(side_effect=ValidationError("bad input"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.post(
|
|
"/api/docs/write",
|
|
json={
|
|
"task_id": str(uuid4()),
|
|
"filename": "test.md",
|
|
"doc_type": "api",
|
|
"title": "Test",
|
|
"content": "Some content",
|
|
},
|
|
headers=_HDR,
|
|
)
|
|
assert response.status_code == HTTPStatus.BAD_REQUEST
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_write_doc_unauthorized(docs_client: AsyncClient) -> None:
|
|
"""Service raises UnauthorizedError → 403."""
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.write_doc = AsyncMock(side_effect=UnauthorizedError("not allowed"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.post(
|
|
"/api/docs/write",
|
|
json={
|
|
"task_id": str(uuid4()),
|
|
"filename": "test.md",
|
|
"doc_type": "api",
|
|
"title": "Test",
|
|
"content": "Some content",
|
|
},
|
|
headers=_HDR,
|
|
)
|
|
assert response.status_code == HTTPStatus.FORBIDDEN
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_write_doc_unauthorized_envelope_remediate(
|
|
docs_client: AsyncClient,
|
|
) -> None:
|
|
"""A denied write returns an Envelope-shaped body with a real remediate.
|
|
|
|
The docs RBAC decision lives in the service (UnauthorizedError); the
|
|
route must surface it as the gateway Envelope contract — error +
|
|
non-null remediate — not a bare {"detail": ...} HTTPException body.
|
|
"""
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.write_doc = AsyncMock(side_effect=UnauthorizedError("write_doc"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.post(
|
|
"/api/docs/write",
|
|
json={
|
|
"task_id": str(uuid4()),
|
|
"filename": "test.md",
|
|
"doc_type": "api",
|
|
"title": "Test",
|
|
"content": "Some content",
|
|
},
|
|
headers=_HDR,
|
|
)
|
|
assert response.status_code == HTTPStatus.FORBIDDEN
|
|
body = response.json()
|
|
assert body["error"] == "not_authorized"
|
|
assert body["message"]
|
|
assert body["remediate"] is not None
|
|
assert body["remediate"].strip()
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_write_doc_not_found(docs_client: AsyncClient) -> None:
|
|
"""Service raises NotFoundError → 404."""
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.write_doc = AsyncMock(side_effect=NotFoundError("not found"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.post(
|
|
"/api/docs/write",
|
|
json={
|
|
"task_id": str(uuid4()),
|
|
"filename": "test.md",
|
|
"doc_type": "api",
|
|
"title": "Test",
|
|
"content": "Some content",
|
|
},
|
|
headers=_HDR,
|
|
)
|
|
assert response.status_code == HTTPStatus.NOT_FOUND
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_write_doc_success(docs_client: AsyncClient) -> None:
|
|
"""Happy path → 200."""
|
|
doc_ref = DocRef(
|
|
path="backend/api/test.md",
|
|
title="Test",
|
|
doc_type="api",
|
|
version="1",
|
|
created_by="be-doc-1",
|
|
created_at="2026-01-01T00:00:00Z",
|
|
)
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.write_doc = AsyncMock(
|
|
return_value=("backend/api/test.md", doc_ref, False)
|
|
)
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.post(
|
|
"/api/docs/write",
|
|
json={
|
|
"task_id": str(uuid4()),
|
|
"filename": "test.md",
|
|
"doc_type": "api",
|
|
"title": "Test",
|
|
"content": "Some content",
|
|
},
|
|
headers=_HDR,
|
|
)
|
|
assert response.status_code == HTTPStatus.OK
|
|
body = response.json()
|
|
assert body["status"] == "created"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_write_doc_update_path(docs_client: AsyncClient) -> None:
|
|
"""Update path returns status=updated."""
|
|
doc_ref = DocRef(
|
|
path="backend/api/test.md",
|
|
title="Test",
|
|
doc_type="api",
|
|
version="2",
|
|
)
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.write_doc = AsyncMock(
|
|
return_value=("backend/api/test.md", doc_ref, True)
|
|
)
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.post(
|
|
"/api/docs/write",
|
|
json={
|
|
"task_id": str(uuid4()),
|
|
"filename": "test.md",
|
|
"doc_type": "api",
|
|
"title": "Test",
|
|
"content": "Some content",
|
|
},
|
|
headers=_HDR,
|
|
)
|
|
assert response.status_code == HTTPStatus.OK
|
|
assert response.json()["status"] == "updated"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_read_doc_validation(docs_client: AsyncClient) -> None:
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.read_doc = AsyncMock(side_effect=ValidationError("bad path"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.get(
|
|
"/api/docs/read?path=invalid",
|
|
headers=_HDR,
|
|
)
|
|
assert response.status_code == HTTPStatus.BAD_REQUEST
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_read_doc_unauthorized(docs_client: AsyncClient) -> None:
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.read_doc = AsyncMock(side_effect=UnauthorizedError("denied"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.get(
|
|
"/api/docs/read?path=other/team/x.md", headers=_HDR
|
|
)
|
|
assert response.status_code == HTTPStatus.FORBIDDEN
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_read_doc_not_found(docs_client: AsyncClient) -> None:
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.read_doc = AsyncMock(side_effect=NotFoundError("missing"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.get(
|
|
"/api/docs/read?path=backend/spec/x.md", headers=_HDR
|
|
)
|
|
assert response.status_code == HTTPStatus.NOT_FOUND
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_read_doc_success(docs_client: AsyncClient) -> None:
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.read_doc = AsyncMock(return_value=("# Hello", 7))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.get(
|
|
"/api/docs/read?path=backend/spec/x.md", headers=_HDR
|
|
)
|
|
assert response.status_code == HTTPStatus.OK
|
|
body = response.json()
|
|
assert body["content"] == "# Hello"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_list_docs_unauthorized(docs_client: AsyncClient) -> None:
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.list_docs = AsyncMock(side_effect=UnauthorizedError("nope"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.get("/api/docs/list", headers=_HDR)
|
|
assert response.status_code == HTTPStatus.FORBIDDEN
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_list_docs_not_found(docs_client: AsyncClient) -> None:
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.list_docs = AsyncMock(side_effect=NotFoundError("none"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.get("/api/docs/list", headers=_HDR)
|
|
assert response.status_code == HTTPStatus.NOT_FOUND
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_list_docs_success(docs_client: AsyncClient) -> None:
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.list_docs = AsyncMock(return_value=[])
|
|
mock_get.return_value = mock_service
|
|
with patch("roboco.api.routes.docs.get_agent_team", return_value="backend"):
|
|
response = await docs_client.get("/api/docs/list", headers=_HDR)
|
|
assert response.status_code == HTTPStatus.OK
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_delete_doc_validation(docs_client: AsyncClient) -> None:
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.delete_doc = AsyncMock(side_effect=ValidationError("bad"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.delete("/api/docs/delete?path=bad", headers=_HDR)
|
|
assert response.status_code == HTTPStatus.BAD_REQUEST
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_delete_doc_unauthorized(docs_client: AsyncClient) -> None:
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.delete_doc = AsyncMock(side_effect=UnauthorizedError("nope"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.delete("/api/docs/delete?path=x.md", headers=_HDR)
|
|
assert response.status_code == HTTPStatus.FORBIDDEN
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_delete_doc_not_found(docs_client: AsyncClient) -> None:
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.delete_doc = AsyncMock(side_effect=NotFoundError("missing"))
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.delete("/api/docs/delete?path=x.md", headers=_HDR)
|
|
assert response.status_code == HTTPStatus.NOT_FOUND
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_delete_doc_success(docs_client: AsyncClient) -> None:
|
|
with patch("roboco.api.routes.docs.get_docs_service") as mock_get:
|
|
mock_service = AsyncMock()
|
|
mock_service.delete_doc = AsyncMock(return_value=None)
|
|
mock_get.return_value = mock_service
|
|
response = await docs_client.delete("/api/docs/delete?path=x.md", headers=_HDR)
|
|
assert response.status_code == HTTPStatus.NO_CONTENT
|