mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-01-28 14:16:34 +08:00
## Summary Implement a flexible sandbox provider system supporting both self-managed (Docker) and SaaS (Aliyun Code Interpreter) backends for secure code execution in agent workflows. **Key Changes:** - ✅ Aliyun Code Interpreter provider using official `agentrun-sdk>=0.0.16` - ✅ Self-managed provider with gVisor (runsc) security - ✅ Arguments parameter support for dynamic code execution - ✅ Database-only configuration (removed fallback logic) - ✅ Configuration scripts for quick setup Issue #12479 ## Features ### 🔌 Provider Abstraction Layer **1. Self-Managed Provider** (`agent/sandbox/providers/self_managed.py`) - Wraps existing executor_manager HTTP API - gVisor (runsc) for secure container isolation - Configurable pool size, timeout, retry logic - Languages: Python, Node.js, JavaScript - ⚠️ **Requires**: gVisor installation, Docker, base images **2. Aliyun Code Interpreter** (`agent/sandbox/providers/aliyun_codeinterpreter.py`) - SaaS integration using official agentrun-sdk - Serverless microVM execution with auto-authentication - Hard timeout: 30 seconds max - Credentials: `AGENTRUN_ACCESS_KEY_ID`, `AGENTRUN_ACCESS_KEY_SECRET`, `AGENTRUN_ACCOUNT_ID`, `AGENTRUN_REGION` - Automatically wraps code to call `main()` function **3. E2B Provider** (`agent/sandbox/providers/e2b.py`) - Placeholder for future integration ### ⚙️ Configuration System - `conf/system_settings.json`: Default provider = `aliyun_codeinterpreter` - `agent/sandbox/client.py`: Enforces database-only configuration - Admin UI: `/admin/sandbox-settings` - Configuration validation via `validate_config()` method - Health checks for all providers ### 🎯 Key Capabilities **Arguments Parameter Support:** All providers support passing arguments to `main()` function: ```python # User code def main(name: str, count: int) -> dict: return {"message": f"Hello {name}!" * count} # Executed with: arguments={"name": "World", "count": 3} # Result: {"message": "Hello World!Hello World!Hello World!"} ``` **Self-Describing Providers:** Each provider implements `get_config_schema()` returning form configuration for Admin UI **Error Handling:** Structured `ExecutionResult` with stdout, stderr, exit_code, execution_time ## Configuration Scripts Two scripts for quick Aliyun sandbox setup: **Shell Script (requires jq):** ```bash source scripts/configure_aliyun_sandbox.sh ``` **Python Script (interactive):** ```bash python3 scripts/configure_aliyun_sandbox.py ``` ## Testing ```bash # Unit tests uv run pytest agent/sandbox/tests/test_providers.py -v # Aliyun provider tests uv run pytest agent/sandbox/tests/test_aliyun_codeinterpreter.py -v # Integration tests (requires credentials) uv run pytest agent/sandbox/tests/test_aliyun_codeinterpreter_integration.py -v # Quick SDK validation python3 agent/sandbox/tests/verify_sdk.py ``` **Test Coverage:** - 30 unit tests for provider abstraction - Provider-specific tests for Aliyun - Integration tests with real API - Security tests for executor_manager ## Documentation - `docs/develop/sandbox_spec.md` - Complete architecture specification - `agent/sandbox/tests/MIGRATION_GUIDE.md` - Migration from legacy sandbox - `agent/sandbox/tests/QUICKSTART.md` - Quick start guide - `agent/sandbox/tests/README.md` - Testing documentation ## Breaking Changes ⚠️ **Migration Required:** 1. **Directory Move**: `sandbox/` → `agent/sandbox/` - Update imports: `from sandbox.` → `from agent.sandbox.` 2. **Mandatory Configuration**: - SystemSettings must have `sandbox.provider_type` configured - Removed fallback default values - Configuration must exist in database (from `conf/system_settings.json`) 3. **Aliyun Credentials**: - Requires `AGENTRUN_*` environment variables (not `ALIYUN_*`) - `AGENTRUN_ACCOUNT_ID` is now required (Aliyun primary account ID) 4. **Self-Managed Provider**: - gVisor (runsc) must be installed for security - Install: `go install gvisor.dev/gvisor/runsc@latest` ## Database Schema Changes ```python # SystemSettings.value: CharField → TextField api/db/db_models.py: Changed for unlimited config length # SystemSettingsService.get_by_name(): Fixed query precision api/db/services/system_settings_service.py: startswith → exact match ``` ## Files Changed ### Backend (Python) - `agent/sandbox/providers/base.py` - SandboxProvider ABC interface - `agent/sandbox/providers/manager.py` - ProviderManager - `agent/sandbox/providers/self_managed.py` - Self-managed provider - `agent/sandbox/providers/aliyun_codeinterpreter.py` - Aliyun provider - `agent/sandbox/providers/e2b.py` - E2B provider (placeholder) - `agent/sandbox/client.py` - Unified client (enforces DB-only config) - `agent/tools/code_exec.py` - Updated to use provider system - `admin/server/services.py` - SandboxMgr with registry & validation - `admin/server/routes.py` - 5 sandbox API endpoints - `conf/system_settings.json` - Default: aliyun_codeinterpreter - `api/db/db_models.py` - TextField for SystemSettings.value - `api/db/services/system_settings_service.py` - Exact match query ### Frontend (TypeScript/React) - `web/src/pages/admin/sandbox-settings.tsx` - Settings UI - `web/src/services/admin-service.ts` - Sandbox service functions - `web/src/services/admin.service.d.ts` - Type definitions - `web/src/utils/api.ts` - Sandbox API endpoints ### Documentation - `docs/develop/sandbox_spec.md` - Architecture spec - `agent/sandbox/tests/MIGRATION_GUIDE.md` - Migration guide - `agent/sandbox/tests/QUICKSTART.md` - Quick start - `agent/sandbox/tests/README.md` - Testing guide ### Configuration Scripts - `scripts/configure_aliyun_sandbox.sh` - Shell script (jq) - `scripts/configure_aliyun_sandbox.py` - Python script ### Tests - `agent/sandbox/tests/test_providers.py` - 30 unit tests - `agent/sandbox/tests/test_aliyun_codeinterpreter.py` - Provider tests - `agent/sandbox/tests/test_aliyun_codeinterpreter_integration.py` - Integration tests - `agent/sandbox/tests/verify_sdk.py` - SDK validation ## Architecture ``` Admin UI → Admin API → SandboxMgr → ProviderManager → [SelfManaged|Aliyun|E2B] ↓ SystemSettings ``` ## Usage ### 1. Configure Provider **Via Admin UI:** 1. Navigate to `/admin/sandbox-settings` 2. Select provider (Aliyun Code Interpreter / Self-Managed) 3. Fill in configuration 4. Click "Test Connection" to verify 5. Click "Save" to apply **Via Configuration Scripts:** ```bash # Aliyun provider export AGENTRUN_ACCESS_KEY_ID="xxx" export AGENTRUN_ACCESS_KEY_SECRET="yyy" export AGENTRUN_ACCOUNT_ID="zzz" export AGENTRUN_REGION="cn-shanghai" source scripts/configure_aliyun_sandbox.sh ``` ### 2. Restart Service ```bash cd docker docker compose restart ragflow-server ``` ### 3. Execute Code in Agent ```python from agent.sandbox.client import execute_code result = execute_code( code='def main(name: str) -> dict: return {"message": f"Hello {name}!"}', language="python", timeout=30, arguments={"name": "World"} ) print(result.stdout) # {"message": "Hello World!"} ``` ## Troubleshooting ### "Container pool is busy" (Self-Managed) - **Cause**: Pool exhausted (default: 1 container in `.env`) - **Fix**: Increase `SANDBOX_EXECUTOR_MANAGER_POOL_SIZE` to 5+ ### "Sandbox provider type not configured" - **Cause**: Database missing configuration - **Fix**: Run config script or set via Admin UI ### "gVisor not found" - **Cause**: runsc not installed - **Fix**: `go install gvisor.dev/gvisor/runsc@latest && sudo cp ~/go/bin/runsc /usr/local/bin/` ### Aliyun authentication errors - **Cause**: Wrong environment variable names - **Fix**: Use `AGENTRUN_*` prefix (not `ALIYUN_*`) ## Checklist - [x] All tests passing (30 unit tests + integration tests) - [x] Documentation updated (spec, migration guide, quickstart) - [x] Type definitions added (TypeScript) - [x] Admin UI implemented - [x] Configuration validation - [x] Health checks implemented - [x] Error handling with structured results - [x] Breaking changes documented - [x] Configuration scripts created - [x] gVisor requirements documented Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
330 lines
13 KiB
Python
330 lines
13 KiB
Python
#
|
|
# Copyright 2025 The InfiniFlow Authors. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
|
|
"""
|
|
Unit tests for Aliyun Code Interpreter provider.
|
|
|
|
These tests use mocks and don't require real Aliyun credentials.
|
|
|
|
Official Documentation: https://help.aliyun.com/zh/functioncompute/fc/sandbox-sandbox-code-interepreter
|
|
Official SDK: https://github.com/Serverless-Devs/agentrun-sdk-python
|
|
"""
|
|
|
|
import pytest
|
|
from unittest.mock import patch, MagicMock
|
|
|
|
from agent.sandbox.providers.base import SandboxProvider
|
|
from agent.sandbox.providers.aliyun_codeinterpreter import AliyunCodeInterpreterProvider
|
|
|
|
|
|
class TestAliyunCodeInterpreterProvider:
|
|
"""Test AliyunCodeInterpreterProvider implementation."""
|
|
|
|
def test_provider_initialization(self):
|
|
"""Test provider initialization."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
assert provider.access_key_id == ""
|
|
assert provider.access_key_secret == ""
|
|
assert provider.account_id == ""
|
|
assert provider.region == "cn-hangzhou"
|
|
assert provider.template_name == ""
|
|
assert provider.timeout == 30
|
|
assert not provider._initialized
|
|
|
|
@patch("agent.sandbox.providers.aliyun_codeinterpreter.Template")
|
|
def test_initialize_success(self, mock_template):
|
|
"""Test successful initialization."""
|
|
# Mock health check response
|
|
mock_template.list.return_value = []
|
|
|
|
provider = AliyunCodeInterpreterProvider()
|
|
result = provider.initialize(
|
|
{
|
|
"access_key_id": "LTAI5tXXXXXXXXXX",
|
|
"access_key_secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
|
|
"account_id": "1234567890123456",
|
|
"region": "cn-hangzhou",
|
|
"template_name": "python-sandbox",
|
|
"timeout": 20,
|
|
}
|
|
)
|
|
|
|
assert result is True
|
|
assert provider.access_key_id == "LTAI5tXXXXXXXXXX"
|
|
assert provider.access_key_secret == "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
|
|
assert provider.account_id == "1234567890123456"
|
|
assert provider.region == "cn-hangzhou"
|
|
assert provider.template_name == "python-sandbox"
|
|
assert provider.timeout == 20
|
|
assert provider._initialized
|
|
|
|
def test_initialize_missing_credentials(self):
|
|
"""Test initialization with missing credentials."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
# Missing access_key_id
|
|
result = provider.initialize({"access_key_secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"})
|
|
assert result is False
|
|
|
|
# Missing access_key_secret
|
|
result = provider.initialize({"access_key_id": "LTAI5tXXXXXXXXXX"})
|
|
assert result is False
|
|
|
|
# Missing account_id
|
|
provider2 = AliyunCodeInterpreterProvider()
|
|
result = provider2.initialize({"access_key_id": "LTAI5tXXXXXXXXXX", "access_key_secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"})
|
|
assert result is False
|
|
|
|
@patch("agent.sandbox.providers.aliyun_codeinterpreter.Template")
|
|
def test_initialize_default_config(self, mock_template):
|
|
"""Test initialization with default config."""
|
|
mock_template.list.return_value = []
|
|
|
|
provider = AliyunCodeInterpreterProvider()
|
|
result = provider.initialize({"access_key_id": "LTAI5tXXXXXXXXXX", "access_key_secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "account_id": "1234567890123456"})
|
|
|
|
assert result is True
|
|
assert provider.region == "cn-hangzhou"
|
|
assert provider.template_name == ""
|
|
|
|
@patch("agent.sandbox.providers.aliyun_codeinterpreter.CodeInterpreterSandbox")
|
|
def test_create_instance_python(self, mock_sandbox_class):
|
|
"""Test creating a Python instance."""
|
|
# Mock successful instance creation
|
|
mock_sandbox = MagicMock()
|
|
mock_sandbox.sandbox_id = "01JCED8Z9Y6XQVK8M2NRST5WXY"
|
|
mock_sandbox_class.return_value = mock_sandbox
|
|
|
|
provider = AliyunCodeInterpreterProvider()
|
|
provider._initialized = True
|
|
provider._config = MagicMock()
|
|
|
|
instance = provider.create_instance("python")
|
|
|
|
assert instance.provider == "aliyun_codeinterpreter"
|
|
assert instance.status == "READY"
|
|
assert instance.metadata["language"] == "python"
|
|
|
|
@patch("agent.sandbox.providers.aliyun_codeinterpreter.CodeInterpreterSandbox")
|
|
def test_create_instance_javascript(self, mock_sandbox_class):
|
|
"""Test creating a JavaScript instance."""
|
|
mock_sandbox = MagicMock()
|
|
mock_sandbox.sandbox_id = "01JCED8Z9Y6XQVK8M2NRST5WXY"
|
|
mock_sandbox_class.return_value = mock_sandbox
|
|
|
|
provider = AliyunCodeInterpreterProvider()
|
|
provider._initialized = True
|
|
provider._config = MagicMock()
|
|
|
|
instance = provider.create_instance("javascript")
|
|
|
|
assert instance.metadata["language"] == "javascript"
|
|
|
|
def test_create_instance_not_initialized(self):
|
|
"""Test creating instance when provider not initialized."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
with pytest.raises(RuntimeError, match="Provider not initialized"):
|
|
provider.create_instance("python")
|
|
|
|
@patch("agent.sandbox.providers.aliyun_codeinterpreter.CodeInterpreterSandbox")
|
|
def test_execute_code_success(self, mock_sandbox_class):
|
|
"""Test successful code execution."""
|
|
# Mock sandbox instance
|
|
mock_sandbox = MagicMock()
|
|
mock_sandbox.context.execute.return_value = {
|
|
"results": [{"type": "stdout", "text": "Hello, World!"}, {"type": "result", "text": "None"}, {"type": "endOfExecution", "status": "ok"}],
|
|
"contextId": "kernel-12345-67890",
|
|
}
|
|
mock_sandbox_class.return_value = mock_sandbox
|
|
|
|
provider = AliyunCodeInterpreterProvider()
|
|
provider._initialized = True
|
|
provider._config = MagicMock()
|
|
|
|
result = provider.execute_code(instance_id="01JCED8Z9Y6XQVK8M2NRST5WXY", code="print('Hello, World!')", language="python", timeout=10)
|
|
|
|
assert result.stdout == "Hello, World!"
|
|
assert result.stderr == ""
|
|
assert result.exit_code == 0
|
|
assert result.execution_time > 0
|
|
|
|
@patch("agent.sandbox.providers.aliyun_codeinterpreter.CodeInterpreterSandbox")
|
|
def test_execute_code_timeout(self, mock_sandbox_class):
|
|
"""Test code execution timeout."""
|
|
from agentrun.utils.exception import ServerError
|
|
|
|
mock_sandbox = MagicMock()
|
|
mock_sandbox.context.execute.side_effect = ServerError(408, "Request timeout")
|
|
mock_sandbox_class.return_value = mock_sandbox
|
|
|
|
provider = AliyunCodeInterpreterProvider()
|
|
provider._initialized = True
|
|
provider._config = MagicMock()
|
|
|
|
with pytest.raises(TimeoutError, match="Execution timed out"):
|
|
provider.execute_code(instance_id="01JCED8Z9Y6XQVK8M2NRST5WXY", code="while True: pass", language="python", timeout=5)
|
|
|
|
@patch("agent.sandbox.providers.aliyun_codeinterpreter.CodeInterpreterSandbox")
|
|
def test_execute_code_with_error(self, mock_sandbox_class):
|
|
"""Test code execution with error."""
|
|
mock_sandbox = MagicMock()
|
|
mock_sandbox.context.execute.return_value = {
|
|
"results": [{"type": "stderr", "text": "Traceback..."}, {"type": "error", "text": "NameError: name 'x' is not defined"}, {"type": "endOfExecution", "status": "error"}]
|
|
}
|
|
mock_sandbox_class.return_value = mock_sandbox
|
|
|
|
provider = AliyunCodeInterpreterProvider()
|
|
provider._initialized = True
|
|
provider._config = MagicMock()
|
|
|
|
result = provider.execute_code(instance_id="01JCED8Z9Y6XQVK8M2NRST5WXY", code="print(x)", language="python")
|
|
|
|
assert result.exit_code != 0
|
|
assert len(result.stderr) > 0
|
|
|
|
def test_get_supported_languages(self):
|
|
"""Test getting supported languages."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
languages = provider.get_supported_languages()
|
|
|
|
assert "python" in languages
|
|
assert "javascript" in languages
|
|
|
|
def test_get_config_schema(self):
|
|
"""Test getting configuration schema."""
|
|
schema = AliyunCodeInterpreterProvider.get_config_schema()
|
|
|
|
assert "access_key_id" in schema
|
|
assert schema["access_key_id"]["required"] is True
|
|
|
|
assert "access_key_secret" in schema
|
|
assert schema["access_key_secret"]["required"] is True
|
|
|
|
assert "account_id" in schema
|
|
assert schema["account_id"]["required"] is True
|
|
|
|
assert "region" in schema
|
|
assert "template_name" in schema
|
|
assert "timeout" in schema
|
|
|
|
def test_validate_config_success(self):
|
|
"""Test successful configuration validation."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
is_valid, error_msg = provider.validate_config({"access_key_id": "LTAI5tXXXXXXXXXX", "account_id": "1234567890123456", "region": "cn-hangzhou"})
|
|
|
|
assert is_valid is True
|
|
assert error_msg is None
|
|
|
|
def test_validate_config_invalid_access_key(self):
|
|
"""Test validation with invalid access key format."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
is_valid, error_msg = provider.validate_config({"access_key_id": "INVALID_KEY"})
|
|
|
|
assert is_valid is False
|
|
assert "AccessKey ID format" in error_msg
|
|
|
|
def test_validate_config_missing_account_id(self):
|
|
"""Test validation with missing account ID."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
is_valid, error_msg = provider.validate_config({})
|
|
|
|
assert is_valid is False
|
|
assert "Account ID" in error_msg
|
|
|
|
def test_validate_config_invalid_region(self):
|
|
"""Test validation with invalid region."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
is_valid, error_msg = provider.validate_config(
|
|
{
|
|
"access_key_id": "LTAI5tXXXXXXXXXX",
|
|
"account_id": "1234567890123456", # Provide required field
|
|
"region": "us-west-1",
|
|
}
|
|
)
|
|
|
|
assert is_valid is False
|
|
assert "Invalid region" in error_msg
|
|
|
|
def test_validate_config_invalid_timeout(self):
|
|
"""Test validation with invalid timeout (> 30 seconds)."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
is_valid, error_msg = provider.validate_config(
|
|
{
|
|
"access_key_id": "LTAI5tXXXXXXXXXX",
|
|
"account_id": "1234567890123456", # Provide required field
|
|
"timeout": 60,
|
|
}
|
|
)
|
|
|
|
assert is_valid is False
|
|
assert "Timeout must be between 1 and 30 seconds" in error_msg
|
|
|
|
def test_normalize_language_python(self):
|
|
"""Test normalizing Python language identifier."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
assert provider._normalize_language("python") == "python"
|
|
assert provider._normalize_language("python3") == "python"
|
|
assert provider._normalize_language("PYTHON") == "python"
|
|
|
|
def test_normalize_language_javascript(self):
|
|
"""Test normalizing JavaScript language identifier."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
assert provider._normalize_language("javascript") == "javascript"
|
|
assert provider._normalize_language("nodejs") == "javascript"
|
|
assert provider._normalize_language("JavaScript") == "javascript"
|
|
|
|
|
|
class TestAliyunCodeInterpreterInterface:
|
|
"""Test that Aliyun provider correctly implements the interface."""
|
|
|
|
def test_aliyun_provider_is_abstract(self):
|
|
"""Test that AliyunCodeInterpreterProvider is a SandboxProvider."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
assert isinstance(provider, SandboxProvider)
|
|
|
|
def test_aliyun_provider_has_abstract_methods(self):
|
|
"""Test that AliyunCodeInterpreterProvider implements all abstract methods."""
|
|
provider = AliyunCodeInterpreterProvider()
|
|
|
|
assert hasattr(provider, "initialize")
|
|
assert callable(provider.initialize)
|
|
|
|
assert hasattr(provider, "create_instance")
|
|
assert callable(provider.create_instance)
|
|
|
|
assert hasattr(provider, "execute_code")
|
|
assert callable(provider.execute_code)
|
|
|
|
assert hasattr(provider, "destroy_instance")
|
|
assert callable(provider.destroy_instance)
|
|
|
|
assert hasattr(provider, "health_check")
|
|
assert callable(provider.health_check)
|
|
|
|
assert hasattr(provider, "get_supported_languages")
|
|
assert callable(provider.get_supported_languages)
|