mirror of
https://github.com/tiennm99/DocsGPT.git
synced 2026-10-04 16:13:23 +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.
321 lines
11 KiB
Python
321 lines
11 KiB
Python
"""Tests for docsgpt/api/internal/routes.py.
|
|
|
|
Uses the ephemeral ``pg_conn`` fixture so the sources repository writes
|
|
happen against a real Postgres schema.
|
|
"""
|
|
|
|
import io
|
|
from contextlib import contextmanager
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
from flask import Flask
|
|
|
|
|
|
_TEST_KEY = "test-internal-key"
|
|
_AUTH = {"X-Internal-Key": _TEST_KEY}
|
|
|
|
|
|
@contextmanager
|
|
def _patch_db(conn):
|
|
@contextmanager
|
|
def _yield():
|
|
yield conn
|
|
|
|
with patch(
|
|
"docsgpt.api.internal.routes.db_session", _yield
|
|
):
|
|
yield
|
|
|
|
|
|
def _make_app():
|
|
from docsgpt.api.internal.routes import internal
|
|
|
|
app = Flask(__name__)
|
|
app.register_blueprint(internal)
|
|
app.config["TESTING"] = True
|
|
return app
|
|
|
|
|
|
class TestVerifyInternalKey:
|
|
def test_rejects_when_internal_key_not_configured(self):
|
|
app = _make_app()
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", ""
|
|
):
|
|
with app.test_client() as c:
|
|
r = c.get("/api/download")
|
|
assert r.status_code == 401
|
|
|
|
def test_rejects_when_key_missing(self):
|
|
app = _make_app()
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
):
|
|
with app.test_client() as c:
|
|
r = c.get("/api/download")
|
|
assert r.status_code == 401
|
|
|
|
def test_rejects_when_key_mismatch(self):
|
|
app = _make_app()
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
):
|
|
with app.test_client() as c:
|
|
r = c.get("/api/download", headers={"X-Internal-Key": "wrong"})
|
|
assert r.status_code == 401
|
|
|
|
|
|
class TestDownloadFile:
|
|
def test_returns_404_for_missing_file(self, tmp_path):
|
|
app = _make_app()
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.UPLOAD_FOLDER",
|
|
str(tmp_path),
|
|
), patch(
|
|
"docsgpt.api.internal.routes.current_dir", ""
|
|
):
|
|
with app.test_client() as c:
|
|
r = c.get(
|
|
"/api/download?user=alice&name=job1&file=missing.txt",
|
|
headers=_AUTH,
|
|
)
|
|
assert r.status_code == 404
|
|
|
|
def test_returns_file_when_present(self, tmp_path):
|
|
app = _make_app()
|
|
user_dir = tmp_path / "bob" / "job1"
|
|
user_dir.mkdir(parents=True)
|
|
(user_dir / "hello.txt").write_text("hi there")
|
|
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.UPLOAD_FOLDER",
|
|
str(tmp_path),
|
|
), patch(
|
|
"docsgpt.api.internal.routes.current_dir", ""
|
|
):
|
|
with app.test_client() as c:
|
|
r = c.get(
|
|
"/api/download?user=bob&name=job1&file=hello.txt",
|
|
headers=_AUTH,
|
|
)
|
|
assert r.status_code == 200
|
|
assert r.data == b"hi there"
|
|
|
|
|
|
class TestUploadIndex:
|
|
def _base_form(self, *, source_id="source-1"):
|
|
return {
|
|
"user": "alice",
|
|
"name": "Job A",
|
|
"tokens": "100",
|
|
"retriever": "classic",
|
|
"id": source_id,
|
|
"type": "file",
|
|
}
|
|
|
|
def test_rejects_without_auth(self):
|
|
app = _make_app()
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
):
|
|
with app.test_client() as c:
|
|
r = c.post("/api/upload_index")
|
|
assert r.status_code == 401
|
|
|
|
def test_rejects_missing_user(self):
|
|
app = _make_app()
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
):
|
|
with app.test_client() as c:
|
|
r = c.post("/api/upload_index", headers=_AUTH, data={})
|
|
assert r.status_code == 200
|
|
assert r.json == {"status": "no user"}
|
|
|
|
def test_rejects_missing_name(self):
|
|
app = _make_app()
|
|
form = {"user": "alice"}
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
):
|
|
with app.test_client() as c:
|
|
r = c.post("/api/upload_index", headers=_AUTH, data=form)
|
|
assert r.status_code == 200
|
|
assert r.json == {"status": "no name"}
|
|
|
|
def test_creates_new_source_for_non_faiss_store(self, pg_conn):
|
|
"""For non-faiss VECTOR_STORE the route skips file uploads entirely."""
|
|
from docsgpt.storage.db.repositories.sources import SourcesRepository
|
|
|
|
app = _make_app()
|
|
form = {**self._base_form(source_id="legacy-source-1")}
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.VECTOR_STORE", "milvus"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.EMBEDDINGS_NAME", "emb"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.StorageCreator.get_storage",
|
|
return_value=MagicMock(),
|
|
), _patch_db(pg_conn):
|
|
with app.test_client() as c:
|
|
r = c.post("/api/upload_index", headers=_AUTH, data=form)
|
|
|
|
assert r.status_code == 200
|
|
assert r.json == {"status": "ok"}
|
|
repo = SourcesRepository(pg_conn)
|
|
found = repo.get_by_legacy_id("legacy-source-1", "alice")
|
|
assert found is not None
|
|
|
|
def test_updates_existing_source(self, pg_conn):
|
|
from docsgpt.storage.db.repositories.sources import SourcesRepository
|
|
|
|
repo = SourcesRepository(pg_conn)
|
|
created = repo.create(
|
|
"initial",
|
|
user_id="alice",
|
|
legacy_mongo_id="legacy-src-2",
|
|
tokens="0",
|
|
)
|
|
app = _make_app()
|
|
form = {**self._base_form(source_id="legacy-src-2"), "tokens": "999"}
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.VECTOR_STORE", "milvus"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.EMBEDDINGS_NAME", "emb"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.StorageCreator.get_storage",
|
|
return_value=MagicMock(),
|
|
), _patch_db(pg_conn):
|
|
with app.test_client() as c:
|
|
r = c.post("/api/upload_index", headers=_AUTH, data=form)
|
|
assert r.status_code == 200
|
|
|
|
updated = repo.get(str(created["id"]), "alice")
|
|
assert updated["tokens"] == "999"
|
|
|
|
def test_handles_directory_structure_and_file_name_map(self, pg_conn):
|
|
import json
|
|
|
|
app = _make_app()
|
|
form = {
|
|
**self._base_form(source_id="legacy-src-3"),
|
|
"directory_structure": json.dumps({"root": {"a.txt": None}}),
|
|
"file_name_map": json.dumps({"a.txt": "Original A.txt"}),
|
|
}
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.VECTOR_STORE", "milvus"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.EMBEDDINGS_NAME", "emb"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.StorageCreator.get_storage",
|
|
return_value=MagicMock(),
|
|
), _patch_db(pg_conn):
|
|
with app.test_client() as c:
|
|
r = c.post("/api/upload_index", headers=_AUTH, data=form)
|
|
assert r.status_code == 200
|
|
|
|
def test_invalid_json_falls_back_to_empty(self, pg_conn):
|
|
app = _make_app()
|
|
form = {
|
|
**self._base_form(source_id="legacy-src-4"),
|
|
"directory_structure": "not-json",
|
|
"file_name_map": "also-not-json",
|
|
}
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.VECTOR_STORE", "milvus"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.EMBEDDINGS_NAME", "emb"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.StorageCreator.get_storage",
|
|
return_value=MagicMock(),
|
|
), _patch_db(pg_conn):
|
|
with app.test_client() as c:
|
|
r = c.post("/api/upload_index", headers=_AUTH, data=form)
|
|
assert r.status_code == 200
|
|
|
|
def test_faiss_missing_file_faiss(self, pg_conn):
|
|
app = _make_app()
|
|
form = self._base_form(source_id="legacy-src-5")
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.VECTOR_STORE", "faiss"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.StorageCreator.get_storage",
|
|
return_value=MagicMock(),
|
|
):
|
|
with app.test_client() as c:
|
|
r = c.post(
|
|
"/api/upload_index",
|
|
headers=_AUTH,
|
|
data=form,
|
|
content_type="multipart/form-data",
|
|
)
|
|
assert r.status_code == 200
|
|
assert r.json == {"status": "no file"}
|
|
|
|
def test_faiss_missing_file_pkl(self, pg_conn):
|
|
app = _make_app()
|
|
data = {
|
|
**self._base_form(source_id="legacy-src-6"),
|
|
"file_faiss": (io.BytesIO(b"faiss-data"), "index.faiss"),
|
|
}
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.VECTOR_STORE", "faiss"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.StorageCreator.get_storage",
|
|
return_value=MagicMock(),
|
|
):
|
|
with app.test_client() as c:
|
|
r = c.post(
|
|
"/api/upload_index",
|
|
headers=_AUTH,
|
|
data=data,
|
|
content_type="multipart/form-data",
|
|
)
|
|
assert r.status_code == 200
|
|
assert r.json == {"status": "no file"}
|
|
|
|
def test_faiss_saves_both_files(self, pg_conn):
|
|
app = _make_app()
|
|
fake_storage = MagicMock()
|
|
data = {
|
|
**self._base_form(source_id="legacy-src-7"),
|
|
"file_faiss": (io.BytesIO(b"faiss-data"), "index.faiss"),
|
|
"file_pkl": (io.BytesIO(b"pkl-data"), "index.pkl"),
|
|
}
|
|
with patch(
|
|
"docsgpt.api.internal.routes.settings.INTERNAL_KEY", _TEST_KEY
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.VECTOR_STORE", "faiss"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.settings.EMBEDDINGS_NAME", "emb"
|
|
), patch(
|
|
"docsgpt.api.internal.routes.StorageCreator.get_storage",
|
|
return_value=fake_storage,
|
|
), _patch_db(pg_conn):
|
|
with app.test_client() as c:
|
|
r = c.post(
|
|
"/api/upload_index",
|
|
headers=_AUTH,
|
|
data=data,
|
|
content_type="multipart/form-data",
|
|
)
|
|
assert r.status_code == 200
|
|
assert r.json == {"status": "ok"}
|
|
assert fake_storage.save_file.call_count == 2
|