LightRAG/test_multitenant.sh
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

128 lines
4.9 KiB
Bash
Executable file

#!/bin/bash
# Comprehensive test script for LightRAG multi-tenant functionality
set -e
API_URL="http://localhost:9621"
ADMIN_USER="admin"
ADMIN_PASS="admin123"
echo "🧪 Testing LightRAG Multi-Tenant System"
echo "========================================"
echo ""
# Test 1: Check server is running
echo "✓ Test 1: Server Health Check"
if curl -s "$API_URL/docs" > /dev/null; then
echo " ✅ Server is responding"
else
echo " ❌ Server is not responding"
exit 1
fi
echo ""
# Test 2: Login as Admin
echo "✓ Test 2: Login as Admin"
LOGIN_RESPONSE=$(curl -s -X POST "$API_URL/login" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "username=$ADMIN_USER&password=$ADMIN_PASS")
TOKEN=$(echo "$LOGIN_RESPONSE" | python3 -c "import sys, json; print(json.load(sys.stdin).get('access_token', ''))" 2>/dev/null || echo "")
if [ ! -z "$TOKEN" ]; then
echo " ✅ Login successful, got token"
else
echo " ❌ Login failed"
echo "$LOGIN_RESPONSE"
exit 1
fi
echo ""
# Test 3: Verify Public Tenant List (Now Allowed with Auth)
echo "✓ Test 3: Verify Public Tenant List (Auth Required)"
HTTP_CODE=$(curl -s -o /dev/null -w "%{http_code}" -H "Authorization: Bearer $TOKEN" "$API_URL/api/v1/tenants")
if [ "$HTTP_CODE" == "200" ]; then
echo " ✅ Public tenant list accessible with auth (HTTP $HTTP_CODE)"
else
echo " ❌ Public tenant list failed (HTTP $HTTP_CODE)"
fi
echo ""
# Test 4: List All Tenants (Admin)
echo "✓ Test 4: List All Tenants (Admin)"
TENANTS_RESPONSE=$(curl -s -H "Authorization: Bearer $TOKEN" "$API_URL/api/v1/admin/tenants?page=1&page_size=10")
TENANT_COUNT=$(echo "$TENANTS_RESPONSE" | python3 -c "import sys, json; print(json.load(sys.stdin).get('total', 0))")
echo " Found $TENANT_COUNT tenants"
echo " Response:"
echo "$TENANTS_RESPONSE" | python3 -m json.tool | head -15
echo ""
# Test 5: Get First Tenant Details (using X-Tenant-ID)
echo "✓ Test 5: Get First Tenant Details"
FIRST_TENANT=$(echo "$TENANTS_RESPONSE" | python3 -c "import sys, json; items = json.load(sys.stdin).get('items', []); print(items[0]['tenant_id'] if items else '')")
if [ ! -z "$FIRST_TENANT" ]; then
echo " Found tenant: $FIRST_TENANT"
# Use X-Tenant-ID header to switch context
TENANT_DETAILS=$(curl -s -H "Authorization: Bearer $TOKEN" -H "X-Tenant-ID: $FIRST_TENANT" "$API_URL/api/v1/tenants/me")
echo " Tenant details:"
echo "$TENANT_DETAILS" | python3 -m json.tool | head -10
else
echo " No tenants found, skipping tenant details"
fi
echo ""
# Test 6: List Knowledge Bases for Tenant
echo "✓ Test 6: List Knowledge Bases for Tenant"
if [ ! -z "$FIRST_TENANT" ]; then
KBS_RESPONSE=$(curl -s -H "Authorization: Bearer $TOKEN" -H "X-Tenant-ID: $FIRST_TENANT" "$API_URL/api/v1/knowledge-bases?page=1&page_size=10")
KB_COUNT=$(echo "$KBS_RESPONSE" | python3 -c "import sys, json; print(json.load(sys.stdin).get('total', 0))")
echo " Found $KB_COUNT knowledge bases in tenant $FIRST_TENANT"
echo " Response:"
echo "$KBS_RESPONSE" | python3 -m json.tool | head -15
else
echo " Skipping KB list (no tenants found)"
fi
echo ""
# Test 7: Verify Demo Tenants (Admin Search)
echo "✓ Test 7: Verify Demo Tenants (Finance, Marketing Team, Engineering Team)"
DEMO_TENANTS=("Finance" "Marketing Team" "Engineering Team")
for tenant_name in "${DEMO_TENANTS[@]}"; do
SEARCH=$(curl -s -G -H "Authorization: Bearer $TOKEN" "$API_URL/api/v1/admin/tenants" --data-urlencode "search=$tenant_name" | python3 -c "import sys, json; print(json.load(sys.stdin).get('total', 0))" 2>/dev/null || echo "0")
if [ "$SEARCH" -gt 0 ]; then
echo " ✅ Found '$tenant_name' tenant"
else
echo " ❌ Missing '$tenant_name' tenant"
fi
done
echo ""
# Test 8: Verify Default Tenant Resolution
echo "✓ Test 8: Verify Default Tenant Resolution"
DEFAULT_TENANT_RESPONSE=$(curl -s -H "Authorization: Bearer $TOKEN" -H "X-Tenant-ID: default" "$API_URL/api/v1/tenants/me")
RESOLVED_ID=$(echo "$DEFAULT_TENANT_RESPONSE" | python3 -c "import sys, json; print(json.load(sys.stdin).get('tenant_id', ''))" 2>/dev/null || echo "")
if [ ! -z "$RESOLVED_ID" ]; then
echo " ✅ Resolved 'default' to $RESOLVED_ID"
else
echo " ❌ Failed to resolve 'default' tenant"
echo "$DEFAULT_TENANT_RESPONSE"
fi
echo ""
# Test 9: Verify Legacy KB List Route
echo "✓ Test 9: Verify Legacy KB List Route (/tenants/default/knowledge-bases)"
LEGACY_KB_RESPONSE=$(curl -s -H "Authorization: Bearer $TOKEN" "$API_URL/api/v1/tenants/default/knowledge-bases?page=1&page_size=5")
LEGACY_KB_COUNT=$(echo "$LEGACY_KB_RESPONSE" | python3 -c "import sys, json; print(json.load(sys.stdin).get('total', 0))" 2>/dev/null || echo "-1")
if [ "$LEGACY_KB_COUNT" -ge 0 ]; then
echo " ✅ Legacy KB list route working (Found $LEGACY_KB_COUNT KBs)"
else
echo " ❌ Legacy KB list route failed"
echo "$LEGACY_KB_RESPONSE"
fi
echo ""
echo "========================================"
echo "✅ All tests completed!"