OpenHands/tests/unit/cli/test_cli_settings.py
Xingyao Wang e19b3dd1f0
Add claude-sonnet-4-5 model support (#11179)
Co-authored-by: openhands <openhands@all-hands.dev>
2025-09-30 03:27:19 +00:00

1450 lines
54 KiB
Python

from pathlib import Path
from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from prompt_toolkit.formatted_text import HTML
from pydantic import SecretStr
from openhands.cli.settings import (
display_settings,
modify_llm_settings_advanced,
modify_llm_settings_basic,
modify_search_api_settings,
)
from openhands.cli.tui import UserCancelledError
from openhands.core.config import OpenHandsConfig
from openhands.storage.data_models.settings import Settings
from openhands.storage.settings.file_settings_store import FileSettingsStore
# Mock classes for condensers
class MockLLMSummarizingCondenserConfig:
def __init__(self, llm_config, type, keep_first=4, max_size=120):
self.llm_config = llm_config
self.type = type
self.keep_first = keep_first
self.max_size = max_size
class MockConversationWindowCondenserConfig:
def __init__(self, type):
self.type = type
class MockCondenserPipelineConfig:
def __init__(self, type, condensers):
self.type = type
self.condensers = condensers
class TestDisplaySettings:
@pytest.fixture
def app_config(self):
config = MagicMock(spec=OpenHandsConfig)
llm_config = MagicMock()
llm_config.base_url = None
llm_config.model = 'openai/gpt-4'
llm_config.api_key = SecretStr('test-api-key')
config.get_llm_config.return_value = llm_config
config.default_agent = 'test-agent'
config.file_store_path = '/tmp'
# Set up security as a separate mock
security_mock = MagicMock(spec=OpenHandsConfig)
security_mock.confirmation_mode = True
config.security = security_mock
config.enable_default_condenser = True
config.search_api_key = SecretStr('tvly-test-key')
return config
@pytest.fixture
def advanced_app_config(self):
config = MagicMock()
llm_config = MagicMock()
llm_config.base_url = 'https://custom-api.com'
llm_config.model = 'custom-model'
llm_config.api_key = SecretStr('test-api-key')
config.get_llm_config.return_value = llm_config
config.default_agent = 'test-agent'
config.file_store_path = '/tmp'
# Set up security as a separate mock
security_mock = MagicMock()
security_mock.confirmation_mode = True
config.security = security_mock
config.enable_default_condenser = True
config.search_api_key = SecretStr('tvly-test-key')
return config
@patch('openhands.cli.settings.print_container')
def test_display_settings_standard_config(self, mock_print_container, app_config):
display_settings(app_config)
mock_print_container.assert_called_once()
# Verify the container was created with the correct settings
container = mock_print_container.call_args[0][0]
text_area = container.body
# Check that the text area contains expected labels and values
settings_text = text_area.text
assert 'LLM Provider:' in settings_text
assert 'openai' in settings_text
assert 'LLM Model:' in settings_text
assert 'gpt-4' in settings_text
assert 'API Key:' in settings_text
assert '********' in settings_text
assert 'Agent:' in settings_text
assert 'test-agent' in settings_text
assert 'Confirmation Mode:' in settings_text
assert 'Enabled' in settings_text
assert 'Memory Condensation:' in settings_text
assert 'Enabled' in settings_text
assert 'Search API Key:' in settings_text
assert '********' in settings_text # Search API key should be masked
assert 'Configuration File' in settings_text
assert str(Path(app_config.file_store_path)) in settings_text
@patch('openhands.cli.settings.print_container')
def test_display_settings_advanced_config(
self, mock_print_container, advanced_app_config
):
display_settings(advanced_app_config)
mock_print_container.assert_called_once()
# Verify the container was created with the correct settings
container = mock_print_container.call_args[0][0]
text_area = container.body
# Check that the text area contains expected labels and values
settings_text = text_area.text
assert 'Custom Model:' in settings_text
assert 'custom-model' in settings_text
assert 'Base URL:' in settings_text
assert 'https://custom-api.com' in settings_text
assert 'API Key:' in settings_text
assert '********' in settings_text
assert 'Agent:' in settings_text
assert 'test-agent' in settings_text
class TestModifyLLMSettingsBasic:
@pytest.fixture
def app_config(self):
config = MagicMock(spec=OpenHandsConfig)
llm_config = MagicMock()
llm_config.model = 'openai/gpt-4'
llm_config.api_key = SecretStr('test-api-key')
llm_config.base_url = None
config.get_llm_config.return_value = llm_config
config.set_llm_config = MagicMock()
config.set_agent_config = MagicMock()
agent_config = MagicMock()
config.get_agent_config.return_value = agent_config
# Set up security as a separate mock
security_mock = MagicMock()
security_mock.confirmation_mode = True
config.security = security_mock
return config
@pytest.fixture
def settings_store(self):
store = MagicMock(spec=FileSettingsStore)
store.load = AsyncMock(return_value=Settings())
store.store = AsyncMock()
return store
@pytest.mark.asyncio
@patch('openhands.cli.settings.get_supported_llm_models')
@patch('openhands.cli.settings.organize_models_and_providers')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
async def test_modify_llm_settings_basic_success(
self,
mock_confirm,
mock_session,
mock_organize,
mock_get_models,
app_config,
settings_store,
):
# Setup mocks
mock_get_models.return_value = ['openai/gpt-4', 'anthropic/claude-3-opus']
mock_organize.return_value = {
'openai': {'models': ['gpt-4', 'gpt-3.5-turbo'], 'separator': '/'},
'anthropic': {
'models': ['claude-3-opus', 'claude-3-sonnet'],
'separator': '/',
},
}
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(
side_effect=[
'gpt-4', # Model
'new-api-key', # API Key
]
)
mock_session.return_value = session_instance
# Mock cli_confirm to:
# 1. Select the first provider (openai) from the list
# 2. Select "Select another model" option
# 3. Select "Yes, save" option
mock_confirm.side_effect = [0, 1, 0]
# Call the function
await modify_llm_settings_basic(app_config, settings_store)
# Verify LLM config was updated
app_config.set_llm_config.assert_called_once()
args, kwargs = app_config.set_llm_config.call_args
# The model name might be different based on the default model in the list
# Just check that it contains 'gpt-4' instead of checking for prefix
assert 'gpt-4' in args[0].model
assert args[0].api_key.get_secret_value() == 'new-api-key'
assert args[0].base_url is None
# Verify settings were saved
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
# The model name might be different based on the default model in the list
# Just check that it contains 'gpt-4' instead of checking for prefix
assert 'gpt-4' in settings.llm_model
assert settings.llm_api_key.get_secret_value() == 'new-api-key'
assert settings.llm_base_url is None
@pytest.mark.asyncio
@patch('openhands.cli.settings.get_supported_llm_models')
@patch('openhands.cli.settings.organize_models_and_providers')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
async def test_modify_llm_settings_basic_user_cancels(
self,
mock_confirm,
mock_session,
mock_organize,
mock_get_models,
app_config,
settings_store,
):
# Setup mocks
mock_get_models.return_value = ['openai/gpt-4', 'anthropic/claude-3-opus']
mock_organize.return_value = {
'openai': {'models': ['gpt-4', 'gpt-3.5-turbo'], 'separator': '/'}
}
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(side_effect=UserCancelledError())
mock_session.return_value = session_instance
# Call the function
await modify_llm_settings_basic(app_config, settings_store)
# Verify settings were not changed
app_config.set_llm_config.assert_not_called()
settings_store.store.assert_not_called()
@pytest.mark.asyncio
@patch('openhands.cli.settings.get_supported_llm_models')
@patch('openhands.cli.settings.organize_models_and_providers')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch('openhands.cli.settings.print_formatted_text')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
async def test_modify_llm_settings_basic_invalid_provider_input(
self,
mock_print,
mock_confirm,
mock_session,
mock_organize,
mock_get_models,
app_config,
settings_store,
):
# Setup mocks
mock_get_models.return_value = ['openai/gpt-4', 'anthropic/claude-3-opus']
mock_organize.return_value = {
'openai': {'models': ['gpt-4', 'gpt-3.5-turbo'], 'separator': '/'}
}
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(
side_effect=[
'invalid-provider', # First invalid provider
'openai', # Valid provider
'custom-model', # Custom model (now allowed with warning)
'new-api-key', # API key
]
)
mock_session.return_value = session_instance
# Mock cli_confirm to select the second option (change provider/model) for the first two calls
# and then select the first option (save settings) for the last call
mock_confirm.side_effect = [1, 1, 0]
# Call the function
await modify_llm_settings_basic(app_config, settings_store)
# Verify error message was shown for invalid provider and warning for custom model
assert mock_print.call_count >= 2 # At least two messages should be printed
# Check for invalid provider error and custom model warning
provider_error_found = False
model_warning_found = False
for call in mock_print.call_args_list:
args, _ = call
if args and isinstance(args[0], HTML):
if 'Invalid provider selected' in args[0].value:
provider_error_found = True
if 'Warning:' in args[0].value and 'custom-model' in args[0].value:
model_warning_found = True
assert provider_error_found, 'No error message for invalid provider'
assert model_warning_found, 'No warning message for custom model'
# Verify LLM config was updated with the custom model
app_config.set_llm_config.assert_called_once()
# Verify settings were saved with the custom model
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
assert 'custom-model' in settings.llm_model
assert settings.llm_api_key.get_secret_value() == 'new-api-key'
assert settings.llm_base_url is None
def test_default_model_selection(self):
"""Test that the default model selection uses the first model in the list."""
# This is a simple test to verify that the default model selection uses the first model in the list
# We're directly checking the code in settings.py where the default model is set
import inspect
import openhands.cli.settings as settings_module
source_lines = inspect.getsource(
settings_module.modify_llm_settings_basic
).splitlines()
# Look for the block that sets the default model
default_model_block = []
in_default_model_block = False
for line in source_lines:
if (
'# Set default model to the best verified model for the provider'
in line
):
in_default_model_block = True
default_model_block.append(line)
elif in_default_model_block:
default_model_block.append(line)
if '# Show the default model' in line:
break
# Assert that we found the default model selection logic
assert default_model_block, (
'Could not find the block that sets the default model'
)
# Print the actual lines for debugging
print('Default model block found:')
for line in default_model_block:
print(f' {line.strip()}')
# Check that the logic uses the first model in the list
first_model_check = any(
'provider_models[0]' in line for line in default_model_block
)
assert first_model_check, (
'Default model selection should use the first model in the list'
)
@pytest.mark.asyncio
@patch(
'openhands.cli.settings.VERIFIED_PROVIDERS',
['openhands', 'anthropic', 'openai'],
)
@patch('openhands.cli.settings.VERIFIED_ANTHROPIC_MODELS', ['claude-3-opus'])
@patch('openhands.cli.settings.get_supported_llm_models')
@patch('openhands.cli.settings.organize_models_and_providers')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch('openhands.cli.settings.print_formatted_text')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
async def test_default_provider_print_and_initial_selection(
self,
mock_print,
mock_confirm,
mock_session,
mock_organize,
mock_get_models,
app_config,
settings_store,
):
"""Verify default provider printing and initial provider selection index."""
mock_get_models.return_value = [
'openhands/o3',
'anthropic/claude-3-opus',
'openai/gpt-4',
]
mock_organize.return_value = {
'openhands': {'models': ['o3'], 'separator': '/'},
'anthropic': {'models': ['claude-3-opus'], 'separator': '/'},
'openai': {'models': ['gpt-4'], 'separator': '/'},
}
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(side_effect=['api-key-123'])
mock_session.return_value = session_instance
mock_confirm.side_effect = [1, 0, 0]
await modify_llm_settings_basic(app_config, settings_store)
# Assert printing of default provider
default_print_calls = [
c
for c in mock_print.call_args_list
if c
and c[0]
and isinstance(c[0][0], HTML)
and 'Default provider:' in c[0][0].value
]
assert default_print_calls, 'Default provider line was not printed'
printed_html = default_print_calls[0][0][0].value
assert 'anthropic' in printed_html
# Assert initial_selection for provider prompt
provider_confirm_call = mock_confirm.call_args_list[0]
# initial_selection prefers current_provider (openai) over default_provider (anthropic)
# VERIFIED_PROVIDERS = ['openhands', 'anthropic', 'openai'] → index of 'openai' is 2
assert provider_confirm_call[1]['initial_selection'] == 2
@pytest.fixture
def app_config_with_existing(self):
config = MagicMock(spec=OpenHandsConfig)
llm_config = MagicMock()
# Set existing configuration
llm_config.model = 'anthropic/claude-3-opus'
llm_config.api_key = SecretStr('existing-api-key')
llm_config.base_url = None
config.get_llm_config.return_value = llm_config
config.set_llm_config = MagicMock()
config.set_agent_config = MagicMock()
agent_config = MagicMock()
config.get_agent_config.return_value = agent_config
# Set up security as a separate mock
security_mock = MagicMock()
security_mock.confirmation_mode = True
config.security = security_mock
return config
@pytest.mark.asyncio
@patch(
'openhands.cli.settings.VERIFIED_PROVIDERS',
['openhands', 'anthropic'],
)
@patch(
'openhands.cli.settings.VERIFIED_ANTHROPIC_MODELS',
['claude-3-opus', 'claude-3-sonnet'],
)
@patch('openhands.cli.settings.get_supported_llm_models')
@patch('openhands.cli.settings.organize_models_and_providers')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
async def test_modify_llm_settings_basic_keep_existing_values(
self,
mock_confirm,
mock_session,
mock_organize,
mock_get_models,
app_config_with_existing,
settings_store,
):
"""Test keeping existing configuration values by pressing Enter/selecting defaults."""
# Setup mocks
mock_get_models.return_value = ['anthropic/claude-3-opus', 'openai/gpt-4']
mock_organize.return_value = {
'openhands': {'models': [], 'separator': '/'},
'anthropic': {
'models': ['claude-3-opus', 'claude-3-sonnet'],
'separator': '/',
},
}
session_instance = MagicMock()
# Simulate user pressing Enter to keep existing values
session_instance.prompt_async = AsyncMock(
side_effect=[
'',
]
)
mock_session.return_value = session_instance
# Mock cli_confirm to select existing provider and model (keeping current values)
mock_confirm.side_effect = [
1, # Select anthropic (matches initial_selection position)
0, # Select first model option (use default)
0, # Save settings
]
await modify_llm_settings_basic(app_config_with_existing, settings_store)
# Check that initial_selection was used for provider selection
provider_confirm_call = mock_confirm.call_args_list[0]
# anthropic is at index 1 in VERIFIED_PROVIDERS ['openhands', 'anthropic']
assert provider_confirm_call[1]['initial_selection'] == 1
# Check that initial_selection was used for model selection
model_confirm_call = mock_confirm.call_args_list[1]
# claude-3-opus should be at index 0 in our mocked VERIFIED_OPENHANDS_MODELS
assert 'initial_selection' in model_confirm_call[1]
assert (
model_confirm_call[1]['initial_selection'] == 0
) # claude-3-opus is at index 0
# Verify API key prompt shows existing key indicator
api_key_prompt_call = session_instance.prompt_async.call_args_list[0]
prompt_text = api_key_prompt_call[0][0]
assert 'exis***-key' in prompt_text
assert 'ENTER to keep current' in prompt_text
# Verify settings were saved with existing values (no changes)
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
assert settings.llm_model == 'anthropic/claude-3-opus'
assert settings.llm_api_key.get_secret_value() == 'existing-api-key'
@pytest.mark.asyncio
@patch(
'openhands.cli.settings.VERIFIED_PROVIDERS',
['openhands', 'anthropic'],
)
@patch(
'openhands.cli.settings.VERIFIED_ANTHROPIC_MODELS',
['claude-3-opus', 'claude-3-sonnet'],
)
@patch('openhands.cli.settings.get_supported_llm_models')
@patch('openhands.cli.settings.organize_models_and_providers')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
async def test_modify_llm_settings_basic_change_only_api_key(
self,
mock_confirm,
mock_session,
mock_organize,
mock_get_models,
app_config_with_existing,
settings_store,
):
"""Test changing only the API key while keeping provider and model."""
# Setup mocks
mock_get_models.return_value = ['anthropic/claude-3-opus']
mock_organize.return_value = {
'openhands': {'models': [], 'separator': '/'},
'anthropic': {
'models': ['claude-3-opus', 'claude-3-sonnet'],
'separator': '/',
},
}
session_instance = MagicMock()
# User enters a new API key
session_instance.prompt_async = AsyncMock(
side_effect=[
'new-api-key-12345',
]
)
mock_session.return_value = session_instance
# Keep existing provider and model
mock_confirm.side_effect = [
1, # Select anthropic (matches initial_selection position)
0, # Select first model option (use default)
0, # Save settings
]
await modify_llm_settings_basic(app_config_with_existing, settings_store)
# Verify settings were saved with only API key changed
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
# Model should remain the same
assert settings.llm_model == 'anthropic/claude-3-opus'
# API key should be the new one
assert settings.llm_api_key.get_secret_value() == 'new-api-key-12345'
@pytest.mark.asyncio
@patch(
'openhands.cli.settings.VERIFIED_PROVIDERS',
['openhands', 'anthropic'],
)
@patch(
'openhands.cli.settings.VERIFIED_OPENHANDS_MODELS',
[
'claude-sonnet-4-20250514',
'claude-sonnet-4-5-20250929',
'claude-opus-4-20250514',
'o3',
],
)
@patch('openhands.cli.settings.get_supported_llm_models')
@patch('openhands.cli.settings.organize_models_and_providers')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
async def test_modify_llm_settings_basic_change_provider_and_model(
self,
mock_confirm,
mock_session,
mock_organize,
mock_get_models,
app_config_with_existing,
settings_store,
):
"""Test changing provider and model requires re-entering API key when provider changes."""
# Setup mocks
mock_get_models.return_value = [
'openhands/claude-sonnet-4-20250514',
'openhands/claude-sonnet-4-5-20250929',
'openhands/claude-opus-4-20250514',
'openhands/o3',
]
mock_organize.return_value = {
'openhands': {
'models': [
'claude-sonnet-4-20250514',
'claude-sonnet-4-5-20250929',
'claude-opus-4-20250514',
'o3',
],
'separator': '/',
},
'anthropic': {
'models': ['claude-3-opus', 'claude-3-sonnet'],
'separator': '/',
},
}
session_instance = MagicMock()
# Must enter a new API key because provider changed (current key cleared)
session_instance.prompt_async = AsyncMock(
side_effect=[
'new-api-key-after-provider-change',
]
)
mock_session.return_value = session_instance
# Change provider and model
mock_confirm.side_effect = [
0, # Select openhands (index 0 in ['openhands', 'anthropic'])
3, # Select o3 (index 3 in ['claude-sonnet-4-20250514', 'claude-sonnet-4-5-20250929', 'claude-opus-4-20250514', 'o3'])
0, # Save settings
]
await modify_llm_settings_basic(app_config_with_existing, settings_store)
# Verify API key prompt does NOT show existing key indicator after provider change
api_key_prompt_call = session_instance.prompt_async.call_args_list[0]
prompt_text = api_key_prompt_call[0][0]
assert '***' not in prompt_text
assert 'ENTER to keep current' not in prompt_text
# Verify settings were saved with new provider/model and new API key
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
assert settings.llm_model == 'openhands/o3'
# API key should be the newly entered one
assert (
settings.llm_api_key.get_secret_value()
== 'new-api-key-after-provider-change'
)
@pytest.mark.asyncio
@patch(
'openhands.cli.settings.VERIFIED_PROVIDERS',
['openhands', 'anthropic'],
)
@patch(
'openhands.cli.settings.VERIFIED_OPENHANDS_MODELS',
['anthropic/claude-3-opus', 'anthropic/claude-3-sonnet'],
)
@patch(
'openhands.cli.settings.VERIFIED_ANTHROPIC_MODELS',
['claude-sonnet-4-20250514', 'claude-sonnet-4-5-20250929', 'claude-3-opus'],
)
@patch('openhands.cli.settings.get_supported_llm_models')
@patch('openhands.cli.settings.organize_models_and_providers')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
async def test_modify_llm_settings_basic_from_scratch(
self,
mock_confirm,
mock_session,
mock_organize,
mock_get_models,
settings_store,
):
"""Test setting up LLM configuration from scratch (no existing settings)."""
# Create a fresh config with no existing LLM settings
config = MagicMock(spec=OpenHandsConfig)
llm_config = MagicMock()
llm_config.model = None # No existing model
llm_config.api_key = None # No existing API key
llm_config.base_url = None
config.get_llm_config.return_value = llm_config
config.set_llm_config = MagicMock()
config.set_agent_config = MagicMock()
agent_config = MagicMock()
config.get_agent_config.return_value = agent_config
# Set up security as a separate mock
security_mock = MagicMock()
security_mock.confirmation_mode = True
config.security = security_mock
config.enable_default_condenser = True
config.default_agent = 'test-agent'
config.file_store_path = '/tmp'
# Setup mocks
mock_get_models.return_value = [
'anthropic/claude-sonnet-4-20250514',
'anthropic/claude-3-opus',
]
mock_organize.return_value = {
'openhands': {'models': [], 'separator': '/'},
'anthropic': {
'models': ['claude-sonnet-4-20250514', 'claude-3-opus'],
'separator': '/',
},
}
session_instance = MagicMock()
# User enters a new API key (no existing key to keep)
session_instance.prompt_async = AsyncMock(
side_effect=[
'new-api-key-12345',
]
)
mock_session.return_value = session_instance
# Mock cli_confirm to select anthropic provider and use default model
mock_confirm.side_effect = [
1, # Select anthropic (index 1 in ['openhands', 'anthropic'])
0, # Use default model (claude-sonnet-4-20250514)
0, # Save settings
]
await modify_llm_settings_basic(config, settings_store)
# Check that initial_selection was used for provider selection
provider_confirm_call = mock_confirm.call_args_list[0]
# Since there's no existing provider, it defaults to 'anthropic' which is at index 1
assert provider_confirm_call[1]['initial_selection'] == 1
# Check that initial_selection was used for model selection
model_confirm_call = mock_confirm.call_args_list[1]
# Since there's no existing model, it should default to using the first option (default model)
assert 'initial_selection' in model_confirm_call[1]
assert model_confirm_call[1]['initial_selection'] == 0
# Verify API key prompt does NOT show existing key indicator
api_key_prompt_call = session_instance.prompt_async.call_args_list[0]
prompt_text = api_key_prompt_call[0][0]
assert '***' not in prompt_text
assert 'ENTER to keep current' not in prompt_text
# Verify settings were saved with new values
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
assert settings.llm_model == 'anthropic/claude-sonnet-4-20250514'
assert settings.llm_api_key.get_secret_value() == 'new-api-key-12345'
class TestModifyLLMSettingsAdvanced:
@pytest.fixture
def app_config(self):
config = MagicMock(spec=OpenHandsConfig)
llm_config = MagicMock()
llm_config.model = 'custom-model'
llm_config.api_key = SecretStr('test-api-key')
llm_config.base_url = 'https://custom-api.com'
config.get_llm_config.return_value = llm_config
config.set_llm_config = MagicMock()
config.set_agent_config = MagicMock()
config.default_agent = 'test-agent'
config.enable_default_condenser = True
agent_config = MagicMock()
config.get_agent_config.return_value = agent_config
# Set up security as a separate mock
security_mock = MagicMock()
security_mock.confirmation_mode = True
config.security = security_mock
return config
@pytest.fixture
def settings_store(self):
store = MagicMock(spec=FileSettingsStore)
store.load = AsyncMock(return_value=Settings())
store.store = AsyncMock()
return store
@pytest.mark.asyncio
@patch('openhands.cli.settings.Agent.list_agents')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
@patch(
'openhands.cli.settings.ConversationWindowCondenserConfig',
MockConversationWindowCondenserConfig,
)
@patch(
'openhands.cli.settings.CondenserPipelineConfig', MockCondenserPipelineConfig
)
async def test_modify_llm_settings_advanced_success(
self, mock_confirm, mock_session, mock_list_agents, app_config, settings_store
):
# Setup mocks
mock_list_agents.return_value = ['default', 'test-agent']
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(
side_effect=[
'new-model', # Custom model
'https://new-url', # Base URL
'new-api-key', # API key
'default', # Agent
]
)
mock_session.return_value = session_instance
# Mock user confirmations
mock_confirm.side_effect = [
0, # Enable confirmation mode
0, # Enable memory condensation
0, # Save settings
]
# Call the function
await modify_llm_settings_advanced(app_config, settings_store)
# Verify LLM config was updated
app_config.set_llm_config.assert_called_once()
args, kwargs = app_config.set_llm_config.call_args
assert args[0].model == 'new-model'
assert args[0].api_key.get_secret_value() == 'new-api-key'
assert args[0].base_url == 'https://new-url'
# Verify settings were saved
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
assert settings.llm_model == 'new-model'
assert settings.llm_api_key.get_secret_value() == 'new-api-key'
assert settings.llm_base_url == 'https://new-url'
assert settings.agent == 'default'
assert settings.confirmation_mode is True
assert settings.enable_default_condenser is True
@pytest.mark.asyncio
@patch('openhands.cli.settings.Agent.list_agents')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
@patch(
'openhands.cli.settings.ConversationWindowCondenserConfig',
MockConversationWindowCondenserConfig,
)
async def test_modify_llm_settings_advanced_user_cancels(
self, mock_confirm, mock_session, mock_list_agents, app_config, settings_store
):
# Setup mocks
mock_list_agents.return_value = ['default', 'test-agent']
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(side_effect=UserCancelledError())
mock_session.return_value = session_instance
# Call the function
await modify_llm_settings_advanced(app_config, settings_store)
# Verify settings were not changed
app_config.set_llm_config.assert_not_called()
settings_store.store.assert_not_called()
@pytest.mark.asyncio
@patch('openhands.cli.settings.Agent.list_agents')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch('openhands.cli.settings.print_formatted_text')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
@patch(
'openhands.cli.settings.ConversationWindowCondenserConfig',
MockConversationWindowCondenserConfig,
)
async def test_modify_llm_settings_advanced_invalid_agent(
self,
mock_print,
mock_confirm,
mock_session,
mock_list_agents,
app_config,
settings_store,
):
# Setup mocks
mock_list_agents.return_value = ['default', 'test-agent']
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(
side_effect=[
'new-model', # Custom model
'https://new-url', # Base URL
'new-api-key', # API key
'invalid-agent', # Invalid agent
'default', # Valid agent on retry
]
)
mock_session.return_value = session_instance
# Call the function
await modify_llm_settings_advanced(app_config, settings_store)
# Verify error message was shown
assert (
mock_print.call_count == 3
) # Called 3 times: empty line, error message, empty line
error_message_call = mock_print.call_args_list[
1
] # The second call contains the error message
args, kwargs = error_message_call
assert isinstance(args[0], HTML)
assert 'Invalid agent' in args[0].value
# Verify settings were not changed
app_config.set_llm_config.assert_not_called()
settings_store.store.assert_not_called()
@pytest.mark.asyncio
@patch('openhands.cli.settings.Agent.list_agents')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
@patch(
'openhands.cli.settings.ConversationWindowCondenserConfig',
MockConversationWindowCondenserConfig,
)
async def test_modify_llm_settings_advanced_user_rejects_save(
self, mock_confirm, mock_session, mock_list_agents, app_config, settings_store
):
# Setup mocks
mock_list_agents.return_value = ['default', 'test-agent']
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(
side_effect=[
'new-model', # Custom model
'https://new-url', # Base URL
'new-api-key', # API key
'default', # Agent
]
)
mock_session.return_value = session_instance
# Mock user confirmations
mock_confirm.side_effect = [
0, # Enable confirmation mode
0, # Enable memory condensation
1, # Reject saving settings
]
# Call the function
await modify_llm_settings_advanced(app_config, settings_store)
# Verify settings were not changed
app_config.set_llm_config.assert_not_called()
settings_store.store.assert_not_called()
@pytest.fixture
def app_config_with_existing(self):
config = MagicMock(spec=OpenHandsConfig)
llm_config = MagicMock()
llm_config.model = 'custom-existing-model'
llm_config.api_key = SecretStr('existing-advanced-key')
llm_config.base_url = 'https://existing-api.com'
config.get_llm_config.return_value = llm_config
config.set_llm_config = MagicMock()
config.set_agent_config = MagicMock()
config.default_agent = 'existing-agent'
config.enable_default_condenser = False
agent_config = MagicMock()
config.get_agent_config.return_value = agent_config
# Set up security as a separate mock
security_mock = MagicMock()
security_mock.confirmation_mode = False
config.security = security_mock
return config
@pytest.mark.asyncio
@patch('openhands.cli.settings.Agent.list_agents')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
@patch(
'openhands.cli.settings.ConversationWindowCondenserConfig',
MockConversationWindowCondenserConfig,
)
@patch(
'openhands.cli.settings.CondenserPipelineConfig', MockCondenserPipelineConfig
)
async def test_modify_llm_settings_advanced_keep_existing_values(
self,
mock_confirm,
mock_session,
mock_list_agents,
app_config_with_existing,
settings_store,
):
"""Test keeping all existing values in advanced settings by pressing Enter."""
# Setup mocks
mock_list_agents.return_value = ['default', 'existing-agent', 'test-agent']
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(
side_effect=[
'custom-existing-model', # Keep existing model (simulating prefill behavior)
'https://existing-api.com', # Keep existing base URL (simulating prefill behavior)
'', # Keep existing API key (press Enter)
'existing-agent', # Keep existing agent (simulating prefill behavior)
]
)
mock_session.return_value = session_instance
# Mock user confirmations
mock_confirm.side_effect = [
1, # Disable confirmation mode (current is False)
1, # Disable memory condensation (current is False)
0, # Save settings
]
await modify_llm_settings_advanced(app_config_with_existing, settings_store)
# Verify all prompts were called with prefill=True and current values
prompt_calls = session_instance.prompt_async.call_args_list
# Check model prompt
assert prompt_calls[0][1]['default'] == 'custom-existing-model'
# Check base URL prompt
assert prompt_calls[1][1]['default'] == 'https://existing-api.com'
# Check API key prompt (should not prefill but show indicator)
api_key_prompt = prompt_calls[2][0][0]
assert 'exis***-key' in api_key_prompt
assert 'ENTER to keep current' in api_key_prompt
assert prompt_calls[2][1]['default'] == '' # Not prefilled for security
# Check agent prompt
assert prompt_calls[3][1]['default'] == 'existing-agent'
# Verify initial selections for confirmation mode and condenser
confirm_calls = mock_confirm.call_args_list
assert confirm_calls[0][1]['initial_selection'] == 1 # Disable (current)
assert confirm_calls[1][1]['initial_selection'] == 1 # Disable (current)
# Verify settings were saved with existing values
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
assert settings.llm_model == 'custom-existing-model'
assert settings.llm_api_key.get_secret_value() == 'existing-advanced-key'
assert settings.llm_base_url == 'https://existing-api.com'
assert settings.agent == 'existing-agent'
assert settings.confirmation_mode is False
assert settings.enable_default_condenser is False
@pytest.mark.asyncio
@patch('openhands.cli.settings.Agent.list_agents')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
@patch(
'openhands.cli.settings.ConversationWindowCondenserConfig',
MockConversationWindowCondenserConfig,
)
@patch(
'openhands.cli.settings.CondenserPipelineConfig', MockCondenserPipelineConfig
)
async def test_modify_llm_settings_advanced_partial_change(
self,
mock_confirm,
mock_session,
mock_list_agents,
app_config_with_existing,
settings_store,
):
"""Test changing only some values in advanced settings while keeping others."""
# Setup mocks
mock_list_agents.return_value = ['default', 'existing-agent', 'test-agent']
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(
side_effect=[
'new-custom-model', # Change model
'https://existing-api.com', # Keep existing base URL (simulating prefill behavior)
'new-api-key-123', # Change API key
'test-agent', # Change agent
]
)
mock_session.return_value = session_instance
# Mock user confirmations - change some settings
mock_confirm.side_effect = [
0, # Enable confirmation mode (change from current False)
1, # Disable memory condensation (keep current False)
0, # Save settings
]
await modify_llm_settings_advanced(app_config_with_existing, settings_store)
# Verify settings were saved with mixed changes
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
assert settings.llm_model == 'new-custom-model' # Changed
assert settings.llm_api_key.get_secret_value() == 'new-api-key-123' # Changed
assert settings.llm_base_url == 'https://existing-api.com' # Kept same
assert settings.agent == 'test-agent' # Changed
assert settings.confirmation_mode is True # Changed
assert settings.enable_default_condenser is False # Kept same
@pytest.mark.asyncio
@patch('openhands.cli.settings.Agent.list_agents')
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch(
'openhands.cli.settings.LLMSummarizingCondenserConfig',
MockLLMSummarizingCondenserConfig,
)
@patch(
'openhands.cli.settings.ConversationWindowCondenserConfig',
MockConversationWindowCondenserConfig,
)
@patch(
'openhands.cli.settings.CondenserPipelineConfig', MockCondenserPipelineConfig
)
async def test_modify_llm_settings_advanced_from_scratch(
self, mock_confirm, mock_session, mock_list_agents, settings_store
):
"""Test setting up advanced configuration from scratch (no existing settings)."""
# Create a fresh config with no existing settings
config = MagicMock(spec=OpenHandsConfig)
llm_config = MagicMock()
llm_config.model = None # No existing model
llm_config.api_key = None # No existing API key
llm_config.base_url = None # No existing base URL
config.get_llm_config.return_value = llm_config
config.set_llm_config = MagicMock()
config.set_agent_config = MagicMock()
config.default_agent = None # No existing agent
config.enable_default_condenser = True # Default value
agent_config = MagicMock()
config.get_agent_config.return_value = agent_config
# Set up security as a separate mock
security_mock = MagicMock()
security_mock.confirmation_mode = True # Default value
config.security = security_mock
# Setup mocks
mock_list_agents.return_value = ['default', 'test-agent', 'advanced-agent']
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(
side_effect=[
'from-scratch-model', # New custom model
'https://new-api-endpoint.com', # New base URL
'brand-new-api-key', # New API key
'advanced-agent', # New agent
]
)
mock_session.return_value = session_instance
# Mock user confirmations - set up from scratch
mock_confirm.side_effect = [
1, # Disable confirmation mode (change from default True)
0, # Enable memory condensation (keep default True)
0, # Save settings
]
await modify_llm_settings_advanced(config, settings_store)
# Check that prompts don't show prefilled values since nothing exists
prompt_calls = session_instance.prompt_async.call_args_list
# Check model prompt - no prefill for empty model
assert prompt_calls[0][1]['default'] == ''
# Check base URL prompt - no prefill for empty base_url
assert prompt_calls[1][1]['default'] == ''
# Check API key prompt - should not show existing key indicator
api_key_prompt = prompt_calls[2][0][0]
assert '***' not in api_key_prompt
assert 'ENTER to keep current' not in api_key_prompt
assert prompt_calls[2][1]['default'] == '' # Not prefilled
# Check agent prompt - no prefill for empty agent
assert prompt_calls[3][1]['default'] == ''
# Verify initial selections for confirmation mode and condenser
confirm_calls = mock_confirm.call_args_list
assert confirm_calls[0][1]['initial_selection'] == 0 # Enable (default)
assert confirm_calls[1][1]['initial_selection'] == 0 # Enable (default)
# Verify settings were saved with new values
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
assert settings.llm_model == 'from-scratch-model'
assert settings.llm_api_key.get_secret_value() == 'brand-new-api-key'
assert settings.llm_base_url == 'https://new-api-endpoint.com'
assert settings.agent == 'advanced-agent'
assert settings.confirmation_mode is False # Changed from default
assert settings.enable_default_condenser is True # Kept default
class TestGetValidatedInput:
@pytest.mark.asyncio
@patch('openhands.cli.settings.PromptSession')
async def test_get_validated_input_with_prefill(self, mock_session):
"""Test get_validated_input with default_value prefilled."""
from openhands.cli.settings import get_validated_input
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(return_value='modified-value')
result = await get_validated_input(
session_instance,
'Enter value: ',
default_value='existing-value',
)
# Verify prompt was called with default parameter
session_instance.prompt_async.assert_called_once_with(
'Enter value: ', default='existing-value'
)
assert result == 'modified-value'
@pytest.mark.asyncio
@patch('openhands.cli.settings.PromptSession')
async def test_get_validated_input_empty_returns_current(self, mock_session):
"""Test that pressing Enter with empty input returns enter_keeps_value."""
from openhands.cli.settings import get_validated_input
session_instance = MagicMock()
# Simulate user pressing Enter (empty input)
session_instance.prompt_async = AsyncMock(return_value=' ')
result = await get_validated_input(
session_instance,
'Enter value: ',
default_value='',
enter_keeps_value='existing-value',
)
# Verify prompt was called with empty default
session_instance.prompt_async.assert_called_once_with(
'Enter value: ', default=''
)
# Empty input should return enter_keeps_value
assert result == 'existing-value'
@pytest.mark.asyncio
@patch('openhands.cli.settings.PromptSession')
async def test_get_validated_input_with_validator(self, mock_session):
"""Test get_validated_input with validator and error message."""
from openhands.cli.settings import get_validated_input
session_instance = MagicMock()
# First attempt fails validation, second succeeds
session_instance.prompt_async = AsyncMock(
side_effect=['invalid', 'valid-input']
)
# Mock print_formatted_text to verify error message
with patch('openhands.cli.settings.print_formatted_text') as mock_print:
result = await get_validated_input(
session_instance,
'Enter value: ',
validator=lambda x: x.startswith('valid'),
error_message='Input must start with "valid"',
)
# Verify error message was shown
assert mock_print.call_count == 3
# The second call contains the error message
error_message_call = mock_print.call_args_list[1]
args, kwargs = error_message_call
assert isinstance(args[0], HTML)
assert 'Input must start with "valid"' in args[0].value
assert result == 'valid-input'
class TestModifySearchApiSettings:
@pytest.fixture
def app_config(self):
config = MagicMock(spec=OpenHandsConfig)
config.search_api_key = SecretStr('tvly-existing-key')
return config
@pytest.fixture
def settings_store(self):
store = MagicMock(spec=FileSettingsStore)
store.load = AsyncMock(return_value=Settings())
store.store = AsyncMock()
return store
@pytest.mark.asyncio
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch('openhands.cli.settings.print_formatted_text')
async def test_modify_search_api_settings_set_new_key(
self, mock_print, mock_confirm, mock_session, app_config, settings_store
):
# Setup mocks
session_instance = MagicMock()
session_instance.prompt_async = AsyncMock(return_value='tvly-new-key')
mock_session.return_value = session_instance
# Mock user confirmations: Set/Update API Key, then Save
mock_confirm.side_effect = [0, 0]
# Call the function
await modify_search_api_settings(app_config, settings_store)
# Verify config was updated
assert app_config.search_api_key.get_secret_value() == 'tvly-new-key'
# Verify settings were saved
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
assert settings.search_api_key.get_secret_value() == 'tvly-new-key'
@pytest.mark.asyncio
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch('openhands.cli.settings.print_formatted_text')
async def test_modify_search_api_settings_remove_key(
self, mock_print, mock_confirm, mock_session, app_config, settings_store
):
# Setup mocks
session_instance = MagicMock()
mock_session.return_value = session_instance
# Mock user confirmations: Remove API Key, then Save
mock_confirm.side_effect = [1, 0]
# Call the function
await modify_search_api_settings(app_config, settings_store)
# Verify config was updated to None
assert app_config.search_api_key is None
# Verify settings were saved
settings_store.store.assert_called_once()
args, kwargs = settings_store.store.call_args
settings = args[0]
assert settings.search_api_key is None
@pytest.mark.asyncio
@patch('openhands.cli.settings.PromptSession')
@patch('openhands.cli.settings.cli_confirm')
@patch('openhands.cli.settings.print_formatted_text')
async def test_modify_search_api_settings_keep_current(
self, mock_print, mock_confirm, mock_session, app_config, settings_store
):
# Setup mocks
session_instance = MagicMock()
mock_session.return_value = session_instance
# Mock user confirmation: Keep current setting
mock_confirm.return_value = 2
# Call the function
await modify_search_api_settings(app_config, settings_store)
# Verify settings were not changed
settings_store.store.assert_not_called()