mirror of
https://github.com/tiennm99/DocsGPT.git
synced 2026-10-04 20:13:04 +00:00
Alex
574f96341e
The backend import package is now docsgpt, the name it will carry on PyPI; application was far too generic to install into anyone's site-packages. git mv plus a mechanical rewrite of every import, dotted string and path reference: 734 Python files, the compose files, Dockerfile, workflows, docs, setup scripts, devcontainer, k8s manifests, vscode config, pytest and coverage config, .gitignore. Behaviour is unchanged. Kept for one release: - A top-level application package whose meta-path finder resolves application.x.y to the already-imported docsgpt.x.y object, so old imports and entry points (celery -A application.app.celery, uvicorn application.asgi:asgi_app) keep working with a FutureWarning. - Celery registers every application.* task name as an alias of its docsgpt.* task on start-up, so messages queued by the previous release still run. The redbeat key prefix moves to redbeat:docsgpt:v2: so schedule entries the previous release wrote are left unread instead of firing twice. The backend image builds from the repository root (docker build -f docsgpt/Dockerfile .) so it can ship the alias package; a root .dockerignore allow-lists docsgpt/ and application/ and keeps caches, local data, .env files, the sample index files and the Dockerfile out. Compose and the image workflows point at the new context.
135 lines
4.4 KiB
Python
135 lines
4.4 KiB
Python
"""Tests for docsgpt/mcp_server.py.
|
|
|
|
The server module exposes one FastMCP tool, ``search_docs``, that reads
|
|
the caller's ``Authorization: Bearer <key>`` header via
|
|
``get_http_headers()`` and delegates to
|
|
``docsgpt.services.search_service.search``. These tests exercise
|
|
the tool directly by patching ``get_http_headers`` and ``search``; the
|
|
full HTTP-layer plumbing (mount, lifespan, session handshake) is
|
|
covered by ``tests/test_asgi.py``.
|
|
"""
|
|
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestSearchDocsTool:
|
|
@pytest.mark.asyncio
|
|
async def test_missing_bearer_raises_permission_error(self):
|
|
from docsgpt.mcp_server import search_docs
|
|
|
|
with patch(
|
|
"docsgpt.mcp_server.get_http_headers", return_value={}
|
|
):
|
|
with pytest.raises(PermissionError):
|
|
await search_docs(query="hi")
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_non_bearer_header_raises_permission_error(self):
|
|
from docsgpt.mcp_server import search_docs
|
|
|
|
with patch(
|
|
"docsgpt.mcp_server.get_http_headers",
|
|
return_value={"authorization": "Basic dXNlcjpwYXNz"},
|
|
):
|
|
with pytest.raises(PermissionError):
|
|
await search_docs(query="hi")
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_blank_bearer_token_raises_permission_error(self):
|
|
from docsgpt.mcp_server import search_docs
|
|
|
|
with patch(
|
|
"docsgpt.mcp_server.get_http_headers",
|
|
return_value={"authorization": "Bearer "},
|
|
):
|
|
with pytest.raises(PermissionError):
|
|
await search_docs(query="hi")
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_invalid_api_key_raises_permission_error(self):
|
|
from docsgpt.mcp_server import search_docs
|
|
from docsgpt.services.search_service import InvalidAPIKey
|
|
|
|
with (
|
|
patch(
|
|
"docsgpt.mcp_server.get_http_headers",
|
|
return_value={"authorization": "Bearer bogus"},
|
|
),
|
|
patch(
|
|
"docsgpt.mcp_server.search", side_effect=InvalidAPIKey()
|
|
),
|
|
):
|
|
with pytest.raises(PermissionError):
|
|
await search_docs(query="hi")
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_search_failed_bubbles_up(self):
|
|
from docsgpt.mcp_server import search_docs
|
|
from docsgpt.services.search_service import SearchFailed
|
|
|
|
with (
|
|
patch(
|
|
"docsgpt.mcp_server.get_http_headers",
|
|
return_value={"authorization": "Bearer k"},
|
|
),
|
|
patch(
|
|
"docsgpt.mcp_server.search",
|
|
side_effect=SearchFailed("boom"),
|
|
),
|
|
):
|
|
with pytest.raises(SearchFailed):
|
|
await search_docs(query="hi")
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_happy_path_passes_args_and_returns_hits(self):
|
|
from docsgpt.mcp_server import search_docs
|
|
|
|
hits = [{"text": "t", "title": "T", "source": "s"}]
|
|
with (
|
|
patch(
|
|
"docsgpt.mcp_server.get_http_headers",
|
|
return_value={"authorization": "Bearer the-key"},
|
|
),
|
|
patch(
|
|
"docsgpt.mcp_server.search", return_value=hits
|
|
) as mock_search,
|
|
):
|
|
out = await search_docs(query="q", chunks=7)
|
|
assert out == hits
|
|
mock_search.assert_called_once_with("the-key", "q", 7)
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_default_chunks_is_5(self):
|
|
from docsgpt.mcp_server import search_docs
|
|
|
|
with (
|
|
patch(
|
|
"docsgpt.mcp_server.get_http_headers",
|
|
return_value={"authorization": "Bearer k"},
|
|
),
|
|
patch(
|
|
"docsgpt.mcp_server.search", return_value=[]
|
|
) as mock_search,
|
|
):
|
|
await search_docs(query="q")
|
|
mock_search.assert_called_once_with("k", "q", 5)
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_bearer_scheme_case_insensitive(self):
|
|
from docsgpt.mcp_server import search_docs
|
|
|
|
with (
|
|
patch(
|
|
"docsgpt.mcp_server.get_http_headers",
|
|
return_value={"authorization": "bearer lowercase-scheme"},
|
|
),
|
|
patch(
|
|
"docsgpt.mcp_server.search", return_value=[]
|
|
) as mock_search,
|
|
):
|
|
await search_docs(query="q")
|
|
mock_search.assert_called_once_with("lowercase-scheme", "q", 5)
|