mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-06-29 23:41:12 +08:00
d78013964a
### What problem does this PR solve? ### Summary PR #14222 consolidated KB (web) API endpoints into RESTful Dataset (HTTP) API endpoints and deleted the web API test suite under `test_web_api/test_kb_app/` and `test_web_api/test_document_app/`. While most test coverage was migrated to the HTTP API test suite, some tests were not ported over. This PR adds back the missing coverage. ### Route migration reference | Old Web API | New HTTP API | Missing tests | |---|---|---| | `POST /v1/kb/update_metadata_setting` | `PUT /api/v1/datasets/<id>/metadata/config` | auth & error paths | | `GET /api/v1/datasets/<id>/auto_metadata` | `GET /api/v1/datasets/<id>/metadata/config` | auth & CRUD | | `PUT /api/v1/datasets/<id>/auto_metadata` | `PUT /api/v1/datasets/<id>/metadata/config` | auth & CRUD | | `GET /v1/kb/<kb_id>/basic_info` | `GET /api/v1/datasets/<id>/ingestions/summary` | covered | | `POST /v1/kb/list_pipeline_logs` | `GET /api/v1/datasets/<id>/ingestions` | edge cases missing | ### Changes #### `test_file_management_within_dataset/test_metadata_config.py` (new, 10 tests) Covers `GET/PUT /datasets/<id>/metadata/config` (migrated from `test_kb_tags_meta.py`'s `test_update_metadata_setting` and `test_document_metadata.py`'s negative tests): - Authorization for dataset metadata config GET/PUT - Authorization for document metadata config PUT - Success, invalid dataset, missing payload, not found scenarios #### `test_dataset_management/test_ingestion_logs.py` (extended, +2 tests) Covers `GET /datasets/<id>/ingestions` edge cases (migrated from `test_kb_pipeline_tasks.py`): - Missing dataset ID - Abnormal date filter ### Type of change - [x] Other: Test coverage improvement --------- Signed-off-by: noob <yixiao121314@outlook.com>
(1). Deploy RAGFlow services and images
https://ragflow.io/docs/build_docker_image
(2). Configure the required environment for testing
Install Python dependencies (including test dependencies):
uv sync --python 3.12 --only-group test --no-default-groups --frozen
Activate the environment:
source .venv/bin/activate
Install SDK:
uv pip install sdk/python
Modify the .env file: Add the following code:
COMPOSE_PROFILES=${COMPOSE_PROFILES},tei-cpu
TEI_MODEL=BAAI/bge-small-en-v1.5
RAGFLOW_IMAGE=infiniflow/ragflow:v0.25.0 #Replace with the image you are using
Start the container（wait two minutes）:
docker compose -f docker/docker-compose.yml up -d
(3). Test Elasticsearch
a) Run sdk tests against Elasticsearch:
export HTTP_API_TEST_LEVEL=p2
export HOST_ADDRESS=http://127.0.0.1:9380 # Ensure that this port is the API port mapped to your localhost
pytest -s --tb=short --level=${HTTP_API_TEST_LEVEL} test/testcases/test_sdk_api
b) Run http api tests against Elasticsearch:
pytest -s --tb=short --level=${HTTP_API_TEST_LEVEL} test/testcases/test_http_api
(4). Test Infinity
Modify the .env file:
DOC_ENGINE=${DOC_ENGINE:-infinity}
Start the container:
docker compose -f docker/docker-compose.yml down -v
docker compose -f docker/docker-compose.yml up -d
a) Run sdk tests against Infinity:
DOC_ENGINE=infinity pytest -s --tb=short --level=${HTTP_API_TEST_LEVEL} test/testcases/test_sdk_api
b) Run http api tests against Infinity:
DOC_ENGINE=infinity pytest -s --tb=short --level=${HTTP_API_TEST_LEVEL} test/testcases/test_http_api