LightRAG/tests/test_backward_compatibility.py
Raphael MANSUY fe9b8ec02a
tests: stabilize integration tests + skip external services; fix multi-tenant API behavior and idempotency (#4)
* feat: Implement multi-tenant architecture with tenant and knowledge base models

- Added data models for tenants, knowledge bases, and related configurations.
- Introduced role and permission management for users in the multi-tenant system.
- Created a service layer for managing tenants and knowledge bases, including CRUD operations.
- Developed a tenant-aware instance manager for LightRAG with caching and isolation features.
- Added a migration script to transition existing workspace-based deployments to the new multi-tenant architecture.

* chore: ignore lightrag/api/webui/assets/ directory

* chore: stop tracking lightrag/api/webui/assets (ignore in .gitignore)

* feat: Initialize LightRAG Multi-Tenant Stack with PostgreSQL

- Added README.md for project overview, setup instructions, and architecture details.
- Created docker-compose.yml to define services: PostgreSQL, Redis, LightRAG API, and Web UI.
- Introduced env.example for environment variable configuration.
- Implemented init-postgres.sql for PostgreSQL schema initialization with multi-tenant support.
- Added reproduce_issue.py for testing default tenant access via API.

* feat: Enhance TenantSelector and update related components for improved multi-tenant support

* feat: Enhance testing capabilities and update documentation

- Updated Makefile to include new test commands for various modes (compatibility, isolation, multi-tenant, security, coverage, and dry-run).
- Modified API health check endpoint in Makefile to reflect new port configuration.
- Updated QUICK_START.md and README.md to reflect changes in service URLs and ports.
- Added environment variables for testing modes in env.example.
- Introduced run_all_tests.sh script to automate testing across different modes.
- Created conftest.py for pytest configuration, including database fixtures and mock services.
- Implemented database helper functions for streamlined database operations in tests.
- Added test collection hooks to skip tests based on the current MULTITENANT_MODE.

* feat: Implement multi-tenant support with demo mode enabled by default

- Added multi-tenant configuration to the environment and Docker setup.
- Created pre-configured demo tenants (acme-corp and techstart) for testing.
- Updated API endpoints to support tenant-specific data access.
- Enhanced Makefile commands for better service management and database operations.
- Introduced user-tenant membership system with role-based access control.
- Added comprehensive documentation for multi-tenant setup and usage.
- Fixed issues with document visibility in multi-tenant environments.
- Implemented necessary database migrations for user memberships and legacy support.

* feat(audit): Add final audit report for multi-tenant implementation

- Documented overall assessment, architecture overview, test results, security findings, and recommendations.
- Included detailed findings on critical security issues and architectural concerns.

fix(security): Implement security fixes based on audit findings

- Removed global RAG fallback and enforced strict tenant context.
- Configured super-admin access and required user authentication for tenant access.
- Cleared localStorage on logout and improved error handling in WebUI.

chore(logs): Create task logs for audit and security fixes implementation

- Documented actions, decisions, and next steps for both audit and security fixes.
- Summarized test results and remaining recommendations.

chore(scripts): Enhance development stack management scripts

- Added scripts for cleaning, starting, and stopping the development stack.
- Improved output messages and ensured graceful shutdown of services.

feat(starter): Initialize PostgreSQL with AGE extension support

- Created initialization scripts for PostgreSQL extensions including uuid-ossp, vector, and AGE.
- Ensured successful installation and verification of extensions.

* feat: Implement auto-select for first tenant and KB on initial load in WebUI

- Removed WEBUI_INITIAL_STATE_FIX.md as the issue is resolved.
- Added useTenantInitialization hook to automatically select the first available tenant and KB on app load.
- Integrated the new hook into the Root component of the WebUI.
- Updated RetrievalTesting component to ensure a KB is selected before allowing user interaction.
- Created end-to-end tests for multi-tenant isolation and real service interactions.
- Added scripts for starting, stopping, and cleaning the development stack.
- Enhanced API and tenant routes to support tenant-specific pipeline status initialization.
- Updated constants for backend URL to reflect the correct port.
- Improved error handling and logging in various components.

* feat: Add multi-tenant support with enhanced E2E testing scripts and client functionality

* update client

* Add integration and unit tests for multi-tenant API, models, security, and storage

- Implement integration tests for tenant and knowledge base management endpoints in `test_tenant_api_routes.py`.
- Create unit tests for tenant isolation, model validation, and role permissions in `test_tenant_models.py`.
- Add security tests to enforce role-based permissions and context validation in `test_tenant_security.py`.
- Develop tests for tenant-aware storage operations and context isolation in `test_tenant_storage_phase3.py`.

* feat(e2e): Implement OpenAI model support and database reset functionality

* Add comprehensive test suite for gpt-5-nano compatibility

- Introduced tests for parameter normalization, embeddings, and entity extraction.
- Implemented direct API testing for gpt-5-nano.
- Validated .env configuration loading and OpenAI API connectivity.
- Analyzed reasoning token overhead with various token limits.
- Documented test procedures and expected outcomes in README files.
- Ensured all tests pass for production readiness.

* kg(postgres_impl): ensure AGE extension is loaded in session and configure graph initialization

* dev: add hybrid dev helper scripts, Makefile, docker-compose.dev-db and local development docs

* feat(dev): add dev helper scripts and local development documentation for hybrid setup

* feat(multi-tenant): add detailed specifications and logs for multi-tenant improvements, including UX, backend handling, and ingestion pipeline

* feat(migration): add generated tenant/kb columns, indexes, triggers; drop unused tables; update schema and docs

* test(backward-compat): adapt tests to new StorageNameSpace/TenantService APIs (use concrete dummy storages)

* chore: multi-tenant and UX updates — docs, webui, storage, tenant service adjustments

* tests: stabilize integration tests + skip external services; fix multi-tenant API behavior and idempotency

- gpt5_nano_compatibility: add pytest-asyncio markers, skip when OPENAI key missing, prevent module-level asyncio.run collection, add conftest
- Ollama tests: add server availability check and skip markers; avoid pytest collection warnings by renaming helper classes
- Graph storage tests: rename interactive test functions to avoid pytest collection
- Document & Tenant routes: support external_ids for idempotency; ensure HTTPExceptions are re-raised
- LightRAG core: support external_ids in apipeline_enqueue_documents and idempotent logic
- Tests updated to match API changes (tenant routes & document routes)
- Add logs and scripts for inspection and audit
2025-12-04 16:04:21 +08:00

286 lines
10 KiB
Python

"""Tests to verify backward compatibility with single-tenant deployments.
These tests ensure that the multi-tenant updates don't break existing
single-tenant functionality.
"""
import pytest
from lightrag.models.tenant import TenantContext
class TestQueryRoutesBackwardCompatibility:
"""Test that query routes work without tenant context."""
def test_tenant_context_optional_return_type(self):
"""Test that optional tenant context can return None."""
# In single-tenant mode, this should work without raising errors
# The actual test validates the TenantContext model
assert TenantContext is not None
class TestDocumentRoutesBackwardCompatibility:
"""Test that document routes work without tenant context."""
def test_upload_endpoint_accepts_none_tenant_context(self):
"""Test that upload endpoint handles None tenant context."""
# Verify that optional TenantContext parameter doesn't break non-tenant requests
# This is handled by the Depends(get_tenant_context_optional) dependency
assert TenantContext is not None
def test_scan_endpoint_accepts_none_tenant_context(self):
"""Test that scan endpoint handles None tenant context."""
# Verify that optional TenantContext parameter doesn't break non-tenant requests
assert TenantContext is not None
class TestStorageLayerBackwardCompatibility:
"""Test that storage operations work without tenant context."""
def test_storage_namespace_without_tenant_id(self):
"""Test that StorageNameSpace works without tenant_id field."""
from lightrag.base import StorageNameSpace
# Create a minimal concrete subclass for testing purposes
class DummyStorage(StorageNameSpace):
async def index_done_callback(self) -> None:
return None
async def drop(self) -> dict[str, str]:
return {"status": "success", "message": "dropped"}
# Create instance without tenant_id (legacy-like behavior)
namespace = DummyStorage(namespace="test", workspace="ws", global_config={})
# Should have workspace set
assert hasattr(namespace, 'workspace')
# tenant_id should be optional (getattr should return None)
tenant_id = getattr(namespace, 'tenant_id', None)
assert tenant_id is None
def test_storage_namespace_backward_compat_workspace_only(self):
"""Test StorageNameSpace works with workspace-only configuration."""
from lightrag.base import StorageNameSpace
class DummyStorage(StorageNameSpace):
async def index_done_callback(self) -> None:
return None
async def drop(self) -> dict[str, str]:
return {"status": "success", "message": "dropped"}
# Legacy usage: creating namespace with just workspace (using dummy concrete class)
namespace = DummyStorage(namespace="test", workspace="test-workspace", global_config={})
# Should work without errors
assert namespace.workspace == "test-workspace"
# tenant_id and kb_id should not be required
assert getattr(namespace, 'tenant_id', None) is None
assert getattr(namespace, 'kb_id', None) is None
class TestAuthenticationBackwardCompatibility:
"""Test that authentication works without multi-tenant awareness."""
def test_auth_handler_works_without_tenant_metadata(self):
"""Test that JWT tokens work without tenant metadata."""
from lightrag.api.auth import auth_handler
# Create a token without tenant metadata (legacy mode)
token = auth_handler.create_token(
username="test_user",
role="admin",
metadata={} # No tenant info
)
# Token should be valid
assert token is not None
assert isinstance(token, str)
def test_auth_handler_works_with_tenant_metadata(self):
"""Test that JWT tokens work WITH tenant metadata (new mode)."""
from lightrag.api.auth import auth_handler
# Create a token with tenant metadata (multi-tenant mode)
token = auth_handler.create_token(
username="test_user",
role="admin",
metadata={
"tenant_id": "tenant-123",
"kb_id": "kb-456"
}
)
# Token should be valid
assert token is not None
assert isinstance(token, str)
class TestTenantServiceOptionalUsage:
"""Test that TenantService is optional and doesn't break existing flows."""
@pytest.mark.asyncio
async def test_tenant_service_initialization(self):
"""Test that TenantService initializes without errors."""
from lightrag.services.tenant_service import TenantService
from lightrag.base import BaseKVStorage
# Provide a minimal in-memory KV storage implementation for tests
class FakeKV(BaseKVStorage):
async def index_done_callback(self) -> None:
return None
async def drop(self) -> dict[str, str]:
return {"status": "success", "message": "dropped"}
async def get_by_id(self, id: str):
return None
async def get_by_ids(self, ids: list[str]):
return []
async def filter_keys(self, keys: set[str]) -> set[str]:
return set()
async def upsert(self, data: dict[str, dict]):
return None
async def delete(self, ids: list[str]) -> None:
return None
# Should initialize with a KV storage instance
service = TenantService(FakeKV(namespace="kv", workspace="kv", global_config={}))
assert service is not None
@pytest.mark.asyncio
async def test_tenant_service_crud_operations(self):
"""Test basic CRUD operations on TenantService."""
from lightrag.services.tenant_service import TenantService
from lightrag.base import BaseKVStorage
class FakeKV(BaseKVStorage):
def __init__(self, namespace, workspace, global_config):
super().__init__(namespace=namespace, workspace=workspace, global_config=global_config)
self.store: dict[str, dict] = {}
async def index_done_callback(self) -> None:
return None
async def drop(self) -> dict[str, str]:
self.store.clear()
return {"status": "success", "message": "dropped"}
async def get_by_id(self, id: str):
return self.store.get(id)
async def get_by_ids(self, ids: list[str]):
return [self.store.get(i) for i in ids if i in self.store]
async def filter_keys(self, keys: set[str]) -> set[str]:
return {k for k in keys if k in self.store}
async def upsert(self, data: dict[str, dict]):
for k, v in data.items():
self.store[k] = v
async def delete(self, ids: list[str]) -> None:
for i in ids:
self.store.pop(i, None)
service = TenantService(FakeKV(namespace="kv", workspace="kv", global_config={}))
# Create a tenant
tenant = await service.create_tenant(
tenant_name="Test Tenant",
description="Test Description",
metadata={}
)
assert tenant is not None
assert tenant.tenant_name == "Test Tenant"
assert tenant.tenant_id is not None
# Get the tenant
retrieved = await service.get_tenant(tenant.tenant_id)
assert retrieved is not None
assert retrieved.tenant_id == tenant.tenant_id
# Update the tenant
updated = await service.update_tenant(
tenant.tenant_id,
tenant_name="Updated Name"
)
assert updated is not None
assert updated.tenant_name == "Updated Name"
# Delete the tenant
deleted = await service.delete_tenant(tenant.tenant_id)
assert deleted is True
class TestMultiTenantOptionalness:
"""Test that multi-tenant features are truly optional."""
def test_dependency_injection_works_without_tenant_context(self):
"""Test that query routes work when TenantContext is None."""
# The dependency injection should gracefully handle None tenant context
pass
def test_tenant_routes_are_isolated(self):
"""Test that tenant routes don't interfere with existing routes."""
from lightrag.api.routers.tenant_routes import create_tenant_routes
from lightrag.services.tenant_service import TenantService
from fastapi import FastAPI
from fastapi.testclient import TestClient
app = FastAPI()
from lightrag.base import BaseKVStorage
class FakeKV(BaseKVStorage):
async def index_done_callback(self) -> None:
return None
async def drop(self) -> dict[str, str]:
return {"status": "success", "message": "dropped"}
async def get_by_id(self, id: str):
return None
async def get_by_ids(self, ids: list[str]):
return []
async def filter_keys(self, keys: set[str]) -> set[str]:
return set()
async def upsert(self, data: dict[str, dict]):
return None
async def delete(self, ids: list[str]) -> None:
return None
service = TenantService(FakeKV(namespace="kv", workspace="kv", global_config={}))
# Register tenant routes
router = create_tenant_routes(service)
app.include_router(router)
# App should initialize without errors
client = TestClient(app)
# Tenant endpoints should exist
response = client.options("/api/v1/tenants")
# Should return some response (method not allowed or similar)
assert response.status_code in [200, 405, 404] # 405 = method not allowed
class TestFeatureToggling:
"""Test that multi-tenant can be toggled on/off without code changes."""
def test_single_tenant_deployment_config(self):
"""Test configuration for single-tenant deployment."""
# In single-tenant mode, TenantContext would be None
# All endpoints should work with optional context
pass
def test_multi_tenant_deployment_config(self):
"""Test configuration for multi-tenant deployment."""
# In multi-tenant mode, TenantContext would be required
# All endpoints should validate tenant isolation
pass