* 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
236 lines
7.3 KiB
Python
236 lines
7.3 KiB
Python
"""
|
|
Tests for tenant isolation in multi-tenant LightRAG.
|
|
|
|
These tests verify that:
|
|
1. Tenants can be created and managed
|
|
2. Knowledge bases are properly isolated per tenant
|
|
3. Cross-tenant data access is denied
|
|
4. Storage operations respect tenant/KB boundaries
|
|
"""
|
|
|
|
import pytest
|
|
from lightrag.models.tenant import (
|
|
Tenant, TenantConfig, TenantContext,
|
|
KnowledgeBase, KBConfig, ResourceQuota
|
|
)
|
|
|
|
|
|
class TestTenantModels:
|
|
"""Test tenant data models."""
|
|
|
|
def test_tenant_creation(self):
|
|
"""Test creating a tenant with default values."""
|
|
tenant = Tenant(
|
|
tenant_name="Test Tenant"
|
|
)
|
|
assert tenant.tenant_name == "Test Tenant"
|
|
assert tenant.is_active is True
|
|
assert tenant.tenant_id is not None
|
|
assert len(tenant.tenant_id) > 0
|
|
assert tenant.kb_count == 0
|
|
|
|
def test_tenant_with_custom_config(self):
|
|
"""Test creating a tenant with custom configuration."""
|
|
config = TenantConfig(
|
|
llm_model="custom-llm",
|
|
embedding_model="custom-embedding",
|
|
chunk_size=2000,
|
|
top_k=50
|
|
)
|
|
tenant = Tenant(
|
|
tenant_name="Test",
|
|
config=config
|
|
)
|
|
assert tenant.config.llm_model == "custom-llm"
|
|
assert tenant.config.chunk_size == 2000
|
|
assert tenant.config.top_k == 50
|
|
|
|
def test_tenant_to_dict(self):
|
|
"""Test tenant serialization to dictionary."""
|
|
tenant = Tenant(
|
|
tenant_id="test-123",
|
|
tenant_name="Test",
|
|
description="Test tenant"
|
|
)
|
|
data = tenant.to_dict()
|
|
assert data["tenant_id"] == "test-123"
|
|
assert data["tenant_name"] == "Test"
|
|
assert data["description"] == "Test tenant"
|
|
assert "config" in data
|
|
assert "quota" in data
|
|
assert data["is_active"] is True
|
|
|
|
|
|
class TestKnowledgeBase:
|
|
"""Test knowledge base models."""
|
|
|
|
def test_kb_creation(self):
|
|
"""Test creating a knowledge base."""
|
|
kb = KnowledgeBase(
|
|
tenant_id="tenant-1",
|
|
kb_name="Test KB"
|
|
)
|
|
assert kb.kb_name == "Test KB"
|
|
assert kb.tenant_id == "tenant-1"
|
|
assert kb.is_active is True
|
|
assert kb.status == "ready"
|
|
assert kb.document_count == 0
|
|
|
|
def test_kb_to_dict(self):
|
|
"""Test KB serialization."""
|
|
kb = KnowledgeBase(
|
|
kb_id="kb-123",
|
|
tenant_id="tenant-1",
|
|
kb_name="Test KB"
|
|
)
|
|
data = kb.to_dict()
|
|
assert data["kb_id"] == "kb-123"
|
|
assert data["tenant_id"] == "tenant-1"
|
|
assert data["kb_name"] == "Test KB"
|
|
|
|
def test_kb_with_override_config(self):
|
|
"""Test KB with configuration override."""
|
|
config = KBConfig(
|
|
top_k=30,
|
|
chunk_size=1500
|
|
)
|
|
kb = KnowledgeBase(
|
|
tenant_id="tenant-1",
|
|
kb_name="Test",
|
|
config=config
|
|
)
|
|
assert kb.config.top_k == 30
|
|
assert kb.config.chunk_size == 1500
|
|
|
|
|
|
class TestTenantContext:
|
|
"""Test tenant context for requests."""
|
|
|
|
def test_context_creation(self):
|
|
"""Test creating a tenant context."""
|
|
context = TenantContext(
|
|
tenant_id="tenant-1",
|
|
kb_id="kb-1",
|
|
user_id="user-1",
|
|
role="admin"
|
|
)
|
|
assert context.tenant_id == "tenant-1"
|
|
assert context.kb_id == "kb-1"
|
|
assert context.user_id == "user-1"
|
|
assert context.role == "admin"
|
|
|
|
def test_workspace_namespace(self):
|
|
"""Test backward-compatible workspace namespace."""
|
|
context = TenantContext(
|
|
tenant_id="acme",
|
|
kb_id="docs",
|
|
user_id="user-1",
|
|
role="editor"
|
|
)
|
|
assert context.workspace_namespace == "acme_docs"
|
|
|
|
def test_kb_access_control(self):
|
|
"""Test KB access control in context."""
|
|
context = TenantContext(
|
|
tenant_id="tenant-1",
|
|
kb_id="kb-1",
|
|
user_id="user-1",
|
|
role="viewer",
|
|
knowledge_base_ids=["kb-1", "kb-2"]
|
|
)
|
|
assert context.can_access_kb("kb-1") is True
|
|
assert context.can_access_kb("kb-2") is True
|
|
assert context.can_access_kb("kb-3") is False
|
|
|
|
def test_kb_access_all(self):
|
|
"""Test KB access with wildcard."""
|
|
context = TenantContext(
|
|
tenant_id="tenant-1",
|
|
kb_id="kb-1",
|
|
user_id="user-1",
|
|
role="admin",
|
|
knowledge_base_ids=["*"] # Admin has access to all
|
|
)
|
|
assert context.can_access_kb("kb-1") is True
|
|
assert context.can_access_kb("kb-2") is True
|
|
assert context.can_access_kb("kb-999") is True
|
|
|
|
def test_permission_checking(self):
|
|
"""Test permission checking."""
|
|
context = TenantContext(
|
|
tenant_id="tenant-1",
|
|
kb_id="kb-1",
|
|
user_id="user-1",
|
|
role="viewer",
|
|
permissions={
|
|
"query:run": True,
|
|
"document:create": False
|
|
}
|
|
)
|
|
assert context.has_permission("query:run") is True
|
|
assert context.has_permission("document:create") is False
|
|
|
|
def test_context_to_dict(self):
|
|
"""Test context serialization."""
|
|
context = TenantContext(
|
|
tenant_id="tenant-1",
|
|
kb_id="kb-1",
|
|
user_id="user-1",
|
|
role="editor"
|
|
)
|
|
data = context.to_dict()
|
|
assert data["tenant_id"] == "tenant-1"
|
|
assert data["kb_id"] == "kb-1"
|
|
assert data["user_id"] == "user-1"
|
|
assert data["workspace_namespace"] == "tenant-1_kb-1"
|
|
|
|
|
|
class TestResourceQuota:
|
|
"""Test resource quota limits."""
|
|
|
|
def test_quota_defaults(self):
|
|
"""Test quota has reasonable defaults."""
|
|
quota = ResourceQuota()
|
|
assert quota.max_documents == 10000
|
|
assert quota.max_storage_gb == 100.0
|
|
assert quota.max_concurrent_queries == 10
|
|
assert quota.max_monthly_api_calls == 100000
|
|
|
|
def test_quota_custom(self):
|
|
"""Test custom quota settings."""
|
|
quota = ResourceQuota(
|
|
max_documents=5000,
|
|
max_storage_gb=50.0,
|
|
max_concurrent_queries=5
|
|
)
|
|
assert quota.max_documents == 5000
|
|
assert quota.max_storage_gb == 50.0
|
|
assert quota.max_concurrent_queries == 5
|
|
|
|
|
|
class TestRoles:
|
|
"""Test role and permission definitions."""
|
|
|
|
def test_role_enum_values(self):
|
|
"""Test role enum has expected values."""
|
|
from lightrag.models.tenant import Role
|
|
assert Role.ADMIN.value == "admin"
|
|
assert Role.EDITOR.value == "editor"
|
|
assert Role.VIEWER.value == "viewer"
|
|
assert Role.VIEWER_READONLY.value == "viewer:read-only"
|
|
|
|
def test_role_permissions(self):
|
|
"""Test role-to-permissions mapping."""
|
|
from lightrag.models.tenant import ROLE_PERMISSIONS, Role, Permission
|
|
|
|
admin_perms = ROLE_PERMISSIONS[Role.ADMIN]
|
|
assert len(admin_perms) > 0
|
|
assert "query:run" in admin_perms
|
|
|
|
viewer_perms = ROLE_PERMISSIONS[Role.VIEWER]
|
|
assert "query:run" in viewer_perms
|
|
assert "document:delete" not in viewer_perms
|
|
|
|
|
|
if __name__ == "__main__":
|
|
pytest.main([__file__, "-v"])
|