Skip to content

πŸ™Œ OpenHands: AI-Driven Development

APP-1197 Migrate secrets endpoints to V1 API (#13770)

Tim O'Farrell732a1c19911a
diff --git a/openhands/app_server/secrets/secrets_router.py b/openhands/app_server/secrets/secrets_router.py
new file mode 100644
index 0000000000..75d14fd587
--- /dev/null
+++ b/openhands/app_server/secrets/secrets_router.py
@@ -0,0 +1,329 @@
+"""Secrets router for OpenHands App Server.
+
+This module provides the V1 API routes for secrets under /api/v1/secrets.
+"""
+
+from fastapi import APIRouter, Depends, HTTPException, status
+
+from openhands.app_server.errors import AuthError
+from openhands.app_server.utils.dependencies import get_dependencies
+from openhands.app_server.utils.models import EditResponse
+from openhands.integrations.provider import (
+ PROVIDER_TOKEN_TYPE,
+ CustomSecret,
+ ProviderType,
+)
+from openhands.integrations.utils import validate_provider_token
+from openhands.server.settings import (
+ CustomSecretModel,
+ CustomSecretWithoutValueModel,
+ GETCustomSecrets,
+ POSTProviderModel,
+)
+from openhands.server.user_auth import (
+ get_provider_tokens,
+ get_secrets,
+ get_secrets_store,
+)
+from openhands.storage.data_models.secrets import Secrets
+from openhands.storage.secrets.secrets_store import SecretsStore
+
+# Create router with /api/v1/secrets prefix
+router = APIRouter(
+ prefix='/secrets',
+ tags=['Secrets'],
+ dependencies=get_dependencies(),
+)
+
+
+# =================================================
+# SECTION: Helper functions for git providers
+# =================================================
+
+
+def _check_token_type(
+ confirmed_token_type: ProviderType | None, token_type: ProviderType
+) -> None:
+ """Returns error message if token type doesn't match, None otherwise."""
+ if not confirmed_token_type or confirmed_token_type != token_type:
+ raise AuthError(
+ f'Invalid token. Please make sure it is a valid {token_type.value} token.'
+ )
+
+
+async def check_provider_tokens(
+ incoming_provider_tokens: POSTProviderModel,
+ existing_provider_tokens: PROVIDER_TOKEN_TYPE | None,
+) -> None:
+ if incoming_provider_tokens.provider_tokens:
+ # Determine whether tokens are valid
+ for token_type, token_value in incoming_provider_tokens.provider_tokens.items():
+ if token_value.token:
+ confirmed_token_type = await validate_provider_token(
+ token_value.token, token_value.host
+ ) # FE always sends latest host
+ _check_token_type(confirmed_token_type, token_type)
+
+ existing_token = (
+ existing_provider_tokens.get(token_type, None)
+ if existing_provider_tokens
+ else None
+ )
+ if (
+ existing_token
+ and (existing_token.host != token_value.host)
+ and existing_token.token
+ ):
+ confirmed_token_type = await validate_provider_token(
+ existing_token.token, token_value.host
+ )
+ # Host has changed, check it against existing token
+ _check_token_type(confirmed_token_type, token_type)
+
+
+# =================================================
+# SECTION: Git Provider Token Endpoints
+# =================================================
+
+
+ '/git-providers',
+ tags=['Git Providers'],
+)
+async def store_provider_tokens(
+ provider_info: POSTProviderModel,
+ secrets_store: SecretsStore = Depends(get_secrets_store),
+ provider_tokens: PROVIDER_TOKEN_TYPE | None = Depends(get_provider_tokens),
+) -> EditResponse:
+ """Store git provider tokens.
+
+ Saves the git provider tokens (GitHub, GitLab, Bitbucket, etc.) for the authenticated user.
+
+ Returns:
+ 200: Git providers stored successfully
+ 401: Invalid token
+ 500: Error storing git providers
+ """
+ await check_provider_tokens(provider_info, provider_tokens)
+
+ user_secrets = await secrets_store.load()
+ if not user_secrets:
+ user_secrets = Secrets()
+
+ if provider_info.provider_tokens:
+ existing_providers = [provider for provider in user_secrets.provider_tokens]
+
+ # Merge incoming settings store with the existing one
+ for provider, token_value in list(provider_info.provider_tokens.items()):
+ if provider in existing_providers and not token_value.token:
+ existing_token = user_secrets.provider_tokens.get(provider)
+ if existing_token and existing_token.token:
+ provider_info.provider_tokens[provider] = existing_token
+
+ provider_info.provider_tokens[provider] = provider_info.provider_tokens[
+ provider
+ ].model_copy(update={'host': token_value.host})
+
+ updated_secrets = user_secrets.model_copy(
+ update={'provider_tokens': provider_info.provider_tokens}
+ )
+ await secrets_store.store(updated_secrets)
+
+ return EditResponse(
+ message='Git providers stored',
+ )
+
+
+ '/git-providers',
+ tags=['Git Providers'],
+)
+async def unset_provider_tokens(
+ secrets_store: SecretsStore = Depends(get_secrets_store),
+) -> EditResponse:
+ """Unset (delete) all git provider tokens.
+
+ Removes all git provider tokens for the authenticated user.
+
+ Returns:
+ 200: Git provider tokens unset successfully
+ 500: Error unsetting git provider tokens
+ """
+ user_secrets = await secrets_store.load()
+ if user_secrets:
+ updated_secrets = user_secrets.model_copy(update={'provider_tokens': {}})
+ await secrets_store.store(updated_secrets)
+
+ return EditResponse(message='Unset Git provider tokens')
+
+
+# =================================================
+# SECTION: Custom Secrets Endpoints
+# =================================================
+
+
[email protected]('', response_model=GETCustomSecrets)
+async def load_custom_secrets_names(
+ user_secrets: Secrets | None = Depends(get_secrets),
+) -> GETCustomSecrets:
+ """Load custom secret names.
+
+ Retrieves the names and descriptions of all custom secrets for the authenticated user.
+
+ Returns:
+ GETCustomSecrets: List of custom secrets (without values)
+ """
+ if not user_secrets:
+ return GETCustomSecrets(custom_secrets=[])
+
+ custom_secrets: list[CustomSecretWithoutValueModel] = []
+ if user_secrets.custom_secrets:
+ for secret_name, secret_value in user_secrets.custom_secrets.items():
+ custom_secret = CustomSecretWithoutValueModel(
+ name=secret_name,
+ description=secret_value.description,
+ )
+ custom_secrets.append(custom_secret)
+
+ return GETCustomSecrets(custom_secrets=custom_secrets)
+
+
[email protected]('', status_code=status.HTTP_201_CREATED)
+async def create_custom_secret(
+ incoming_secret: CustomSecretModel,
+ secrets_store: SecretsStore = Depends(get_secrets_store),
+) -> EditResponse:
+ """Create a custom secret.
+
+ Creates a new custom secret for the authenticated user.
+
+ Returns:
+ 201: Secret created successfully
+ 400: Secret already exists
+ 500: Error creating secret
+ """
+ existing_secrets = await secrets_store.load()
+ custom_secrets = dict(existing_secrets.custom_secrets) if existing_secrets else {}
+
+ secret_name = incoming_secret.name
+ secret_value = incoming_secret.value
+ secret_description = incoming_secret.description
+
+ if secret_name in custom_secrets:
+ raise HTTPException(
+ status_code=status.HTTP_400_BAD_REQUEST,
+ detail=f'Secret {secret_name} already exists',
+ )
+
+ custom_secrets[secret_name] = CustomSecret(
+ secret=secret_value,
+ description=secret_description or '',
+ )
+
+ # Create a new Secrets that preserves provider tokens
+ updated_user_secrets = Secrets(
+ custom_secrets=custom_secrets, # type: ignore[arg-type]
+ provider_tokens=existing_secrets.provider_tokens if existing_secrets else {}, # type: ignore[arg-type]
+ )
+
+ await secrets_store.store(updated_user_secrets)
+
+ return EditResponse(
+ message='Secret created successfully',
+ )
+
+
[email protected]('/{secret_id}')
+async def update_custom_secret(
+ secret_id: str,
+ incoming_secret: CustomSecretWithoutValueModel,
+ secrets_store: SecretsStore = Depends(get_secrets_store),
+) -> EditResponse:
+ """Update a custom secret.
+
+ Updates the name and/or description of an existing custom secret.
+
+ Returns:
+ 200: Secret updated successfully
+ 400: Secret name already exists
+ 404: Secret not found
+ 500: Error updating secret
+ """
+ existing_secrets = await secrets_store.load()
+ if existing_secrets:
+ # Check if the secret to update exists
+ if secret_id not in existing_secrets.custom_secrets:
+ return HTTPException(
+ status_code=status.HTTP_404_NOT_FOUND,
+ detail=f'Secret with ID {secret_id} not found',
+ )
+
+ secret_name = incoming_secret.name
+ secret_description = incoming_secret.description
+
+ custom_secrets = dict(existing_secrets.custom_secrets)
+ existing_secret = custom_secrets.pop(secret_id)
+
+ if secret_name != secret_id and secret_name in custom_secrets:
+ raise HTTPException(
+ status_code=status.HTTP_400_BAD_REQUEST,
+ detail=f'Secret {secret_name} already exists',
+ )
+
+ custom_secrets[secret_name] = CustomSecret(
+ secret=existing_secret.secret,
+ description=secret_description or '',
+ )
+
+ updated_secrets = Secrets(
+ custom_secrets=custom_secrets, # type: ignore[arg-type]
+ provider_tokens=existing_secrets.provider_tokens,
+ )
+
+ await secrets_store.store(updated_secrets)
+
+ return EditResponse(
+ message='Secret updated successfully',
+ )
+
+
[email protected]('/{secret_id}')
+async def delete_custom_secret(
+ secret_id: str,
+ secrets_store: SecretsStore = Depends(get_secrets_store),
+) -> EditResponse:
+ """Delete a custom secret.
+
+ Removes a custom secret for the authenticated user.
+
+ Returns:
+ 200: Secret deleted successfully
+ 404: Secret not found
+ 500: Error deleting secret
+ """
+ existing_secrets = await secrets_store.load()
+ if existing_secrets:
+ # Get existing custom secrets
+ custom_secrets = dict(existing_secrets.custom_secrets)
+
+ # Check if the secret to delete exists
+ if secret_id not in custom_secrets:
+ raise HTTPException(
+ status_code=status.HTTP_404_NOT_FOUND,
+ detail=f'Secret with ID {secret_id} not found',
+ )
+
+ # Remove the secret
+ custom_secrets.pop(secret_id)
+
+ # Create a new Secrets that preserves provider tokens and remaining secrets
+ updated_secrets = Secrets(
+ custom_secrets=custom_secrets, # type: ignore[arg-type]
+ provider_tokens=existing_secrets.provider_tokens,
+ )
+
+ await secrets_store.store(updated_secrets)
+
+ return EditResponse(
+ message='Secret deleted successfully',
+ )
diff --git a/openhands/app_server/utils/models.py b/openhands/app_server/utils/models.py
new file mode 100644
index 0000000000..ab8042fc18
--- /dev/null
+++ b/openhands/app_server/utils/models.py
@@ -0,0 +1,7 @@
+from pydantic import BaseModel
+
+
+class EditResponse(BaseModel):
+ """General response to an edit operation"""
+
+ message: str
diff --git a/openhands/app_server/v1_router.py b/openhands/app_server/v1_router.py
index 4cda2d9214..8d1681173b 100644
--- a/openhands/app_server/v1_router.py
+++ b/openhands/app_server/v1_router.py
@@ -9,6 +9,9 @@ from openhands.app_server.pending_messages.pending_message_router import (
router as pending_message_router,
)
from openhands.app_server.sandbox import sandbox_router, sandbox_spec_router
+from openhands.app_server.secrets.secrets_router import (
+ router as secrets_router,
+)
from openhands.app_server.settings.settings_router import (
router as settings_router,
)
@@ -23,6 +26,7 @@ router.include_router(pending_message_router)
router.include_router(sandbox_router.router)
router.include_router(sandbox_spec_router.router)
router.include_router(settings_router)
+router.include_router(secrets_router)
router.include_router(user_router.router)
router.include_router(skills_router.router)
router.include_router(webhook_router.router)
diff --git a/openhands/server/routes/secrets.py b/openhands/server/routes/secrets.py
index 936ff9cf31..a2cc0a34d8 100644
--- a/openhands/server/routes/secrets.py
+++ b/openhands/server/routes/secrets.py
@@ -7,13 +7,28 @@
# Tag: Legacy-V0
# This module belongs to the old V0 web server. The V1 application server lives under openhands/app_server/.
from fastapi import APIRouter, Depends, status
-from fastapi.responses import JSONResponse
+from openhands.app_server.secrets.secrets_router import (
+ create_custom_secret as v1_create_custom_secret,
+)
+from openhands.app_server.secrets.secrets_router import (
+ delete_custom_secret as v1_delete_custom_secret,
+)
+from openhands.app_server.secrets.secrets_router import (
+ load_custom_secrets_names as v1_load_custom_secrets_names,
+)
+from openhands.app_server.secrets.secrets_router import (
+ store_provider_tokens as v1_store_provider_tokens,
+)
+from openhands.app_server.secrets.secrets_router import (
+ unset_provider_tokens as v1_unset_provider_tokens,
+)
+from openhands.app_server.secrets.secrets_router import (
+ update_custom_secret as v1_update_custom_secret,
+)
from openhands.app_server.utils.dependencies import get_dependencies
-from openhands.core.logger import openhands_logger as logger
-from openhands.integrations.provider import PROVIDER_TOKEN_TYPE, CustomSecret
-from openhands.integrations.service_types import ProviderType
-from openhands.integrations.utils import validate_provider_token
+from openhands.app_server.utils.models import EditResponse
+from openhands.integrations.provider import PROVIDER_TOKEN_TYPE
from openhands.server.settings import (
CustomSecretModel,
CustomSecretWithoutValueModel,
@@ -60,126 +75,20 @@ async def invalidate_legacy_secrets_store(
return None
-def process_token_validation_result(
- confirmed_token_type: ProviderType | None, token_type: ProviderType
-) -> str:
- if not confirmed_token_type or confirmed_token_type != token_type:
- return (
- f'Invalid token. Please make sure it is a valid {token_type.value} token.'
- )
-
- return ''
-
-
-async def check_provider_tokens(
- incoming_provider_tokens: POSTProviderModel,
- existing_provider_tokens: PROVIDER_TOKEN_TYPE | None,
-) -> str:
- msg = ''
- if incoming_provider_tokens.provider_tokens:
- # Determine whether tokens are valid
- for token_type, token_value in incoming_provider_tokens.provider_tokens.items():
- if token_value.token:
- confirmed_token_type = await validate_provider_token(
- token_value.token, token_value.host
- ) # FE always sends latest host
- msg = process_token_validation_result(confirmed_token_type, token_type)
-
- existing_token = (
- existing_provider_tokens.get(token_type, None)
- if existing_provider_tokens
- else None
- )
- if (
- existing_token
- and (existing_token.host != token_value.host)
- and existing_token.token
- ):
- confirmed_token_type = await validate_provider_token(
- existing_token.token, token_value.host
- ) # Host has changed, check it against existing token
- if not confirmed_token_type or confirmed_token_type != token_type:
- msg = process_token_validation_result(
- confirmed_token_type, token_type
- )
-
- return msg
-
-
[email protected]('/add-git-providers')
[email protected]('/add-git-providers', deprecated=True)
async def store_provider_tokens(
provider_info: POSTProviderModel,
secrets_store: SecretsStore = Depends(get_secrets_store),
provider_tokens: PROVIDER_TOKEN_TYPE | None = Depends(get_provider_tokens),
-) -> JSONResponse:
- provider_err_msg = await check_provider_tokens(provider_info, provider_tokens)
- if provider_err_msg:
- # We don't have direct access to user_id here, but we can log the provider info
- logger.info(
- f'Returning 401 Unauthorized - Provider token error: {provider_err_msg}'
- )
- return JSONResponse(
- status_code=status.HTTP_401_UNAUTHORIZED,
- content={'error': provider_err_msg},
- )
-
- try:
- user_secrets = await secrets_store.load()
- if not user_secrets:
- user_secrets = Secrets()
-
- if provider_info.provider_tokens:
- existing_providers = [provider for provider in user_secrets.provider_tokens]
-
- # Merge incoming settings store with the existing one
- for provider, token_value in list(provider_info.provider_tokens.items()):
- if provider in existing_providers and not token_value.token:
- existing_token = user_secrets.provider_tokens.get(provider)
- if existing_token and existing_token.token:
- provider_info.provider_tokens[provider] = existing_token
+) -> EditResponse:
+ return await v1_store_provider_tokens(provider_info, secrets_store, provider_tokens)
- provider_info.provider_tokens[provider] = provider_info.provider_tokens[
- provider
- ].model_copy(update={'host': token_value.host})
- updated_secrets = user_secrets.model_copy(
- update={'provider_tokens': provider_info.provider_tokens}
- )
- await secrets_store.store(updated_secrets)
-
- return JSONResponse(
- status_code=status.HTTP_200_OK,
- content={'message': 'Git providers stored'},
- )
- except Exception as e:
- logger.warning(f'Something went wrong storing git providers: {e}')
- return JSONResponse(
- status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
- content={'error': 'Something went wrong storing git providers'},
- )
-
-
[email protected]('/unset-provider-tokens', response_model=dict[str, str])
[email protected]('/unset-provider-tokens', deprecated=True)
async def unset_provider_tokens(
secrets_store: SecretsStore = Depends(get_secrets_store),
-) -> JSONResponse:
- try:
- user_secrets = await secrets_store.load()
- if user_secrets:
- updated_secrets = user_secrets.model_copy(update={'provider_tokens': {}})
- await secrets_store.store(updated_secrets)
-
- return JSONResponse(
- status_code=status.HTTP_200_OK,
- content={'message': 'Unset Git provider tokens'},
- )
-
- except Exception as e:
- logger.warning(f'Something went wrong unsetting tokens: {e}')
- return JSONResponse(
- status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
- content={'error': 'Something went wrong unsetting tokens'},
- )
+) -> EditResponse:
+ return await v1_unset_provider_tokens(secrets_store)
# =================================================
@@ -187,170 +96,33 @@ async def unset_provider_tokens(
# =================================================
[email protected]('/secrets', response_model=GETCustomSecrets)
[email protected]('/secrets', response_model=GETCustomSecrets, deprecated=True)
async def load_custom_secrets_names(
user_secrets: Secrets | None = Depends(get_secrets),
-) -> GETCustomSecrets | JSONResponse:
- try:
- if not user_secrets:
- return GETCustomSecrets(custom_secrets=[])
-
- custom_secrets: list[CustomSecretWithoutValueModel] = []
- if user_secrets.custom_secrets:
- for secret_name, secret_value in user_secrets.custom_secrets.items():
- custom_secret = CustomSecretWithoutValueModel(
- name=secret_name,
- description=secret_value.description,
- )
- custom_secrets.append(custom_secret)
+) -> GETCustomSecrets:
+ return await v1_load_custom_secrets_names(user_secrets)
- return GETCustomSecrets(custom_secrets=custom_secrets)
- except Exception as e:
- logger.warning(f'Failed to load secret names: {e}')
- logger.info('Returning 401 Unauthorized - Failed to get secret names')
- return JSONResponse(
- status_code=status.HTTP_401_UNAUTHORIZED,
- content={'error': 'Failed to get secret names'},
- )
-
-
[email protected]('/secrets', response_model=dict[str, str])
[email protected]('/secrets', status_code=status.HTTP_201_CREATED, deprecated=True)
async def create_custom_secret(
incoming_secret: CustomSecretModel,
secrets_store: SecretsStore = Depends(get_secrets_store),
-) -> JSONResponse:
- try:
- existing_secrets = await secrets_store.load()
- custom_secrets = (
- dict(existing_secrets.custom_secrets) if existing_secrets else {}
- )
+) -> EditResponse:
+ return await v1_create_custom_secret(incoming_secret, secrets_store)
- secret_name = incoming_secret.name
- secret_value = incoming_secret.value
- secret_description = incoming_secret.description
- if secret_name in custom_secrets:
- return JSONResponse(
- status_code=status.HTTP_400_BAD_REQUEST,
- content={'message': f'Secret {secret_name} already exists'},
- )
-
- custom_secrets[secret_name] = CustomSecret(
- secret=secret_value,
- description=secret_description or '',
- )
-
- # Create a new Secrets that preserves provider tokens
- updated_user_secrets = Secrets(
- custom_secrets=custom_secrets, # type: ignore[arg-type]
- provider_tokens=existing_secrets.provider_tokens
- if existing_secrets
- else {}, # type: ignore[arg-type]
- )
-
- await secrets_store.store(updated_user_secrets)
-
- return JSONResponse(
- status_code=status.HTTP_201_CREATED,
- content={'message': 'Secret created successfully'},
- )
- except Exception as e:
- logger.warning(f'Something went wrong creating secret: {e}')
- return JSONResponse(
- status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
- content={'error': 'Something went wrong creating secret'},
- )
-
-
[email protected]('/secrets/{secret_id}', response_model=dict[str, str])
[email protected]('/secrets/{secret_id}', deprecated=True)
async def update_custom_secret(
secret_id: str,
incoming_secret: CustomSecretWithoutValueModel,
secrets_store: SecretsStore = Depends(get_secrets_store),
-) -> JSONResponse:
- try:
- existing_secrets = await secrets_store.load()
- if existing_secrets:
- # Check if the secret to update exists
- if secret_id not in existing_secrets.custom_secrets:
- return JSONResponse(
- status_code=status.HTTP_404_NOT_FOUND,
- content={'error': f'Secret with ID {secret_id} not found'},
- )
-
- secret_name = incoming_secret.name
- secret_description = incoming_secret.description
+) -> EditResponse:
+ return await v1_update_custom_secret(secret_id, incoming_secret, secrets_store)
- custom_secrets = dict(existing_secrets.custom_secrets)
- existing_secret = custom_secrets.pop(secret_id)
- if secret_name != secret_id and secret_name in custom_secrets:
- return JSONResponse(
- status_code=status.HTTP_400_BAD_REQUEST,
- content={'message': f'Secret {secret_name} already exists'},
- )
-
- custom_secrets[secret_name] = CustomSecret(
- secret=existing_secret.secret,
- description=secret_description or '',
- )
-
- updated_secrets = Secrets(
- custom_secrets=custom_secrets, # type: ignore[arg-type]
- provider_tokens=existing_secrets.provider_tokens,
- )
-
- await secrets_store.store(updated_secrets)
-
- return JSONResponse(
- status_code=status.HTTP_200_OK,
- content={'message': 'Secret updated successfully'},
- )
- except Exception as e:
- logger.warning(f'Something went wrong updating secret: {e}')
- return JSONResponse(
- status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
- content={'error': 'Something went wrong updating secret'},
- )
-
-
[email protected]('/secrets/{secret_id}')
[email protected]('/secrets/{secret_id}', deprecated=True)
async def delete_custom_secret(
secret_id: str,
secrets_store: SecretsStore = Depends(get_secrets_store),
-) -> JSONResponse:
- try:
- existing_secrets = await secrets_store.load()
- if existing_secrets:
- # Get existing custom secrets
- custom_secrets = dict(existing_secrets.custom_secrets)
-
- # Check if the secret to delete exists
- if secret_id not in custom_secrets:
- return JSONResponse(
- status_code=status.HTTP_404_NOT_FOUND,
- content={'error': f'Secret with ID {secret_id} not found'},
- )
-
- # Remove the secret
- custom_secrets.pop(secret_id)
-
- # Create a new Secrets that preserves provider tokens and remaining secrets
- updated_secrets = Secrets(
- custom_secrets=custom_secrets, # type: ignore[arg-type]
- provider_tokens=existing_secrets.provider_tokens,
- )
-
- await secrets_store.store(updated_secrets)
-
- return JSONResponse(
- status_code=status.HTTP_200_OK,
- content={'message': 'Secret deleted successfully'},
- )
- except Exception as e:
- logger.warning(f'Something went wrong deleting secret: {e}')
- return JSONResponse(
- status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
- content={'error': 'Something went wrong deleting secret'},
- )
+) -> EditResponse:
+ return await v1_delete_custom_secret(secret_id, secrets_store)
diff --git a/tests/unit/server/routes/test_secrets_api.py b/tests/unit/app_server/test_secrets_api.py
similarity index 93%
rename from tests/unit/server/routes/test_secrets_api.py
rename to tests/unit/app_server/test_secrets_api.py
index b8f8688f6d..40e5800cf3 100644
--- a/tests/unit/server/routes/test_secrets_api.py
+++ b/tests/unit/app_server/test_secrets_api.py
@@ -9,14 +9,14 @@ from fastapi import FastAPI
from fastapi.testclient import TestClient
from pydantic import SecretStr
+from openhands.app_server.secrets.secrets_router import (
+ router as secrets_router,
+)
from openhands.integrations.provider import (
CustomSecret,
ProviderToken,
ProviderType,
)
-from openhands.server.routes.secrets import (
- app as secrets_app,
-)
from openhands.storage import get_file_store
from openhands.storage.data_models.secrets import Secrets
from openhands.storage.secrets.file_secrets_store import FileSecretsStore
@@ -26,7 +26,7 @@ from openhands.storage.secrets.file_secrets_store import FileSecretsStore
def test_client():
"""Create a test client for the settings API."""
app = FastAPI()
- app.include_router(secrets_app)
+ app.include_router(secrets_router)
# Mock SESSION_API_KEY to None to disable authentication in tests
with patch.dict(os.environ, {'SESSION_API_KEY': ''}, clear=False):
@@ -70,7 +70,7 @@ async def test_load_custom_secrets_names(test_client, file_secrets_store):
await file_secrets_store.store(user_secrets)
# Make the GET request
- response = test_client.get('/api/secrets')
+ response = test_client.get('/secrets')
print(response)
assert response.status_code == 200
@@ -107,7 +107,7 @@ async def test_load_custom_secrets_names_empty(test_client, file_secrets_store):
await file_secrets_store.store(user_secrets)
# Make the GET request
- response = test_client.get('/api/secrets')
+ response = test_client.get('/secrets')
assert response.status_code == 200
# Check the response
@@ -130,7 +130,7 @@ async def test_add_custom_secret(test_client, file_secrets_store):
# Make the POST request to add a custom secret
add_secret_data = {'name': 'API_KEY', 'value': 'api-key-value', 'description': None}
- response = test_client.post('/api/secrets', json=add_secret_data)
+ response = test_client.post('/secrets', json=add_secret_data)
assert response.status_code == 201
# Verify that the settings were stored with the new secret
@@ -158,7 +158,7 @@ async def test_create_custom_secret_with_no_existing_secrets(
'value': 'new-api-key-value',
'description': 'Test API Key',
}
- response = test_client.post('/api/secrets', json=add_secret_data)
+ response = test_client.post('/secrets', json=add_secret_data)
assert response.status_code == 201
# Verify that the settings were stored with the new secret
@@ -196,7 +196,7 @@ async def test_update_existing_custom_secret(test_client, file_secrets_store):
'name': 'API_KEY',
'description': None,
}
- response = test_client.put('/api/secrets/API_KEY', json=update_secret_data)
+ response = test_client.put('/secrets/API_KEY', json=update_secret_data)
assert response.status_code == 200
# Verify that the settings were stored with the updated secret
@@ -236,7 +236,7 @@ async def test_add_multiple_custom_secrets(test_client, file_secrets_store):
'value': 'api-key-value',
'description': None,
}
- response1 = test_client.post('/api/secrets', json=add_secret_data1)
+ response1 = test_client.post('/secrets', json=add_secret_data1)
assert response1.status_code == 201
# Make the POST request to add second custom secret
@@ -245,7 +245,7 @@ async def test_add_multiple_custom_secrets(test_client, file_secrets_store):
'value': 'db-password-value',
'description': None,
}
- response = test_client.post('/api/secrets', json=add_secret_data2)
+ response = test_client.post('/secrets', json=add_secret_data2)
assert response.status_code == 201
# Verify that the settings were stored with the new secrets
@@ -293,7 +293,7 @@ async def test_delete_custom_secret(test_client, file_secrets_store):
await file_secrets_store.store(user_secrets)
# Make the DELETE request to delete a custom secret
- response = test_client.delete('/api/secrets/API_KEY')
+ response = test_client.delete('/secrets/API_KEY')
assert response.status_code == 200
# Verify that the settings were stored without the deleted secret
@@ -331,7 +331,7 @@ async def test_delete_nonexistent_custom_secret(test_client, file_secrets_store)
await file_secrets_store.store(user_secrets)
# Make the DELETE request to delete a nonexistent custom secret
- response = test_client.delete('/api/secrets/NONEXISTENT_KEY')
+ response = test_client.delete('/secrets/NONEXISTENT_KEY')
assert response.status_code == 404
# Verify that the settings were stored without changes to existing secrets
@@ -360,7 +360,7 @@ async def test_add_git_providers_with_host(test_client, file_secrets_store):
# Mock check_provider_tokens to return empty string (no error)
with patch(
- 'openhands.server.routes.secrets.check_provider_tokens',
+ 'openhands.app_server.secrets.secrets_router.check_provider_tokens',
AsyncMock(return_value=''),
):
# Add a GitHub provider with a host
@@ -369,7 +369,7 @@ async def test_add_git_providers_with_host(test_client, file_secrets_store):
'github': {'token': 'new-github-token', 'host': 'github.enterprise.com'}
}
}
- response = test_client.post('/api/add-git-providers', json=add_provider_data)
+ response = test_client.post('/secrets/git-providers', json=add_provider_data)
assert response.status_code == 200
# Verify that the settings were stored with the new provider token and host
@@ -399,7 +399,7 @@ async def test_add_git_providers_update_host_only(test_client, file_secrets_stor
# Mock check_provider_tokens to return empty string (no error)
with patch(
- 'openhands.server.routes.secrets.check_provider_tokens',
+ 'openhands.app_server.secrets.secrets_router.check_provider_tokens',
AsyncMock(return_value=''),
):
# Update only the host
@@ -411,7 +411,7 @@ async def test_add_git_providers_update_host_only(test_client, file_secrets_stor
}
}
}
- response = test_client.post('/api/add-git-providers', json=update_host_data)
+ response = test_client.post('/secrets/git-providers', json=update_host_data)
assert response.status_code == 200
# Verify that the host was updated but the token remains the same
@@ -447,9 +447,9 @@ async def test_add_git_providers_invalid_token_with_host(
'github': {'token': 'invalid-token', 'host': 'github.enterprise.com'}
}
}
- response = test_client.post('/api/add-git-providers', json=add_provider_data)
+ response = test_client.post('/secrets/git-providers', json=add_provider_data)
assert response.status_code == 401
- assert 'Invalid token' in response.json()['error']
+ assert 'Invalid token' in response.json()['detail']
@pytest.mark.asyncio
@@ -461,7 +461,7 @@ async def test_add_multiple_git_providers_with_hosts(test_client, file_secrets_s
# Mock check_provider_tokens to return empty string (no error)
with patch(
- 'openhands.server.routes.secrets.check_provider_tokens',
+ 'openhands.app_server.secrets.secrets_router.check_provider_tokens',
AsyncMock(return_value=''),
):
# Add multiple providers with hosts
@@ -471,7 +471,7 @@ async def test_add_multiple_git_providers_with_hosts(test_client, file_secrets_s
'gitlab': {'token': 'gitlab-token', 'host': 'gitlab.enterprise.com'},
}
}
- response = test_client.post('/api/add-git-providers', json=add_providers_data)
+ response = test_client.post('/secrets/git-providers', json=add_providers_data)
assert response.status_code == 200
# Verify that both providers were stored with their respective hosts
diff --git a/tests/unit/app_server/test_settings_api.py b/tests/unit/app_server/test_settings_api.py
index 7c9b91ac19..e3c82ecd28 100644
--- a/tests/unit/app_server/test_settings_api.py
+++ b/tests/unit/app_server/test_settings_api.py
@@ -116,7 +116,7 @@ async def test_settings_api_endpoints(test_client):
assert response.status_code == 200
# Test the unset-provider-tokens endpoint
- response = test_client.post('/api/unset-provider-tokens')
+ response = test_client.delete('/api/v1/secrets/git-providers')
assert response.status_code == 200
diff --git a/tests/unit/integrations/bitbucket/test_bitbucket.py b/tests/unit/integrations/bitbucket/test_bitbucket.py
index 86a72b9c36..a205ed31e5 100644
--- a/tests/unit/integrations/bitbucket/test_bitbucket.py
+++ b/tests/unit/integrations/bitbucket/test_bitbucket.py
@@ -7,6 +7,7 @@ from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from pydantic import SecretStr
+from openhands.app_server.secrets.secrets_router import check_provider_tokens
from openhands.integrations.bitbucket.bitbucket_service import BitBucketService
from openhands.integrations.provider import ProviderToken, ProviderType
from openhands.integrations.service_types import OwnerType, Repository
@@ -17,7 +18,6 @@ from openhands.resolver.interfaces.issue import Issue
from openhands.resolver.interfaces.issue_definitions import ServiceContextIssue
from openhands.resolver.send_pull_request import PR_SIGNATURE, send_pull_request
from openhands.runtime.base import Runtime
-from openhands.server.routes.secrets import check_provider_tokens
from openhands.server.settings import POSTProviderModel
from openhands.server.types import AppMode
@@ -412,9 +412,10 @@ async def test_check_provider_tokens_with_only_bitbucket():
# Call check_provider_tokens with the patched validate_provider_token
with patch(
- 'openhands.server.routes.secrets.validate_provider_token', mock_validate
+ 'openhands.app_server.secrets.secrets_router.validate_provider_token',
+ mock_validate,
):
- result = await check_provider_tokens(post_model, None)
+ await check_provider_tokens(post_model, None)
# Verify that validate_provider_token was called only once (for Bitbucket)
assert mock_validate.call_count == 1
@@ -423,9 +424,6 @@ async def test_check_provider_tokens_with_only_bitbucket():
args, kwargs = mock_validate.call_args
assert args[0].get_secret_value() == 'username:app_password'
- # Verify that no error message was returned
- assert result == ''
-
@pytest.mark.asyncio
async def test_bitbucket_sort_parameter_mapping():
diff --git a/tests/unit/server/routes/test_settings_store_functions.py b/tests/unit/server/routes/test_settings_store_functions.py
index dedee12faf..563ae6fad5 100644
--- a/tests/unit/server/routes/test_settings_store_functions.py
+++ b/tests/unit/server/routes/test_settings_store_functions.py
@@ -6,6 +6,10 @@ from fastapi import FastAPI
from fastapi.testclient import TestClient
from pydantic import SecretStr
+from openhands.app_server.errors import AuthError
+from openhands.app_server.secrets.secrets_router import (
+ check_provider_tokens,
+)
from openhands.app_server.settings.settings_router import store_llm_settings
from openhands.core.config.mcp_config import MCPConfig, MCPStdioServerConfig
from openhands.integrations.provider import ProviderToken
@@ -13,9 +17,6 @@ from openhands.integrations.service_types import ProviderType
from openhands.server.routes.secrets import (
app as secrets_router,
)
-from openhands.server.routes.secrets import (
- check_provider_tokens,
-)
from openhands.server.settings import POSTProviderModel
from openhands.storage import get_file_store
from openhands.storage.data_models.secrets import Secrets
@@ -41,8 +42,8 @@ def test_client():
patch.dict(os.environ, {'SESSION_API_KEY': ''}, clear=False),
patch('openhands.app_server.utils.dependencies._SESSION_API_KEY', None),
patch(
- 'openhands.server.routes.secrets.check_provider_tokens',
- AsyncMock(return_value=''),
+ 'openhands.app_server.secrets.secrets_router.check_provider_tokens',
+ AsyncMock(return_value=None),
),
):
client = TestClient(test_app)
@@ -77,14 +78,10 @@ async def test_check_provider_tokens_valid():
# Mock the validate_provider_token function to return GITHUB for valid tokens
with patch(
- 'openhands.server.routes.secrets.validate_provider_token'
+ 'openhands.app_server.secrets.secrets_router.validate_provider_token'
) as mock_validate:
mock_validate.return_value = ProviderType.GITHUB
-
- result = await check_provider_tokens(providers, existing_provider_tokens)
-
- # Should return empty string for valid token
- assert result == ''
+ await check_provider_tokens(providers, existing_provider_tokens)
mock_validate.assert_called_once()
@@ -99,14 +96,14 @@ async def test_check_provider_tokens_invalid():
# Mock the validate_provider_token function to return None for invalid tokens
with patch(
- 'openhands.server.routes.secrets.validate_provider_token'
+ 'openhands.app_server.secrets.secrets_router.validate_provider_token'
) as mock_validate:
mock_validate.return_value = None
- result = await check_provider_tokens(providers, existing_provider_tokens)
+ # Should raise error for invalid token
+ with pytest.raises(AuthError):
+ await check_provider_tokens(providers, existing_provider_tokens)
- # Should return error message for invalid token
- assert 'Invalid token' in result
mock_validate.assert_called_once()
@@ -120,10 +117,7 @@ async def test_check_provider_tokens_wrong_type():
# Empty existing provider tokens
existing_provider_tokens = {}
- result = await check_provider_tokens(providers, existing_provider_tokens)
-
- # Should return empty string for no providers
- assert result == ''
+ await check_provider_tokens(providers, existing_provider_tokens)
@pytest.mark.asyncio
@@ -134,10 +128,7 @@ async def test_check_provider_tokens_no_tokens():
# Empty existing provider tokens
existing_provider_tokens = {}
- result = await check_provider_tokens(providers, existing_provider_tokens)
-
- # Should return empty string when no tokens provided
- assert result == ''
+ await check_provider_tokens(providers, existing_provider_tokens)
# Tests for store_llm_settings