dify
This commit is contained in:
1
dify/api/tests/unit_tests/services/auth/__init__.py
Normal file
1
dify/api/tests/unit_tests/services/auth/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
# API authentication service test module
|
||||
@@ -0,0 +1,49 @@
|
||||
import pytest
|
||||
|
||||
from services.auth.api_key_auth_base import ApiKeyAuthBase
|
||||
|
||||
|
||||
class ConcreteApiKeyAuth(ApiKeyAuthBase):
|
||||
"""Concrete implementation for testing abstract base class"""
|
||||
|
||||
def validate_credentials(self):
|
||||
return True
|
||||
|
||||
|
||||
class TestApiKeyAuthBase:
|
||||
def test_should_store_credentials_on_init(self):
|
||||
"""Test that credentials are properly stored during initialization"""
|
||||
credentials = {"api_key": "test_key", "auth_type": "bearer"}
|
||||
auth = ConcreteApiKeyAuth(credentials)
|
||||
assert auth.credentials == credentials
|
||||
|
||||
def test_should_not_instantiate_abstract_class(self):
|
||||
"""Test that ApiKeyAuthBase cannot be instantiated directly"""
|
||||
credentials = {"api_key": "test_key"}
|
||||
|
||||
with pytest.raises(TypeError) as exc_info:
|
||||
ApiKeyAuthBase(credentials)
|
||||
|
||||
assert "Can't instantiate abstract class" in str(exc_info.value)
|
||||
assert "validate_credentials" in str(exc_info.value)
|
||||
|
||||
def test_should_allow_subclass_implementation(self):
|
||||
"""Test that subclasses can properly implement the abstract method"""
|
||||
credentials = {"api_key": "test_key", "auth_type": "bearer"}
|
||||
auth = ConcreteApiKeyAuth(credentials)
|
||||
|
||||
# Should not raise any exception
|
||||
result = auth.validate_credentials()
|
||||
assert result is True
|
||||
|
||||
def test_should_handle_empty_credentials(self):
|
||||
"""Test initialization with empty credentials"""
|
||||
credentials = {}
|
||||
auth = ConcreteApiKeyAuth(credentials)
|
||||
assert auth.credentials == {}
|
||||
|
||||
def test_should_handle_none_credentials(self):
|
||||
"""Test initialization with None credentials"""
|
||||
credentials = None
|
||||
auth = ConcreteApiKeyAuth(credentials)
|
||||
assert auth.credentials is None
|
||||
@@ -0,0 +1,81 @@
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
from services.auth.api_key_auth_factory import ApiKeyAuthFactory
|
||||
from services.auth.auth_type import AuthType
|
||||
|
||||
|
||||
class TestApiKeyAuthFactory:
|
||||
"""Test cases for ApiKeyAuthFactory"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("provider", "auth_class_path"),
|
||||
[
|
||||
(AuthType.FIRECRAWL, "services.auth.firecrawl.firecrawl.FirecrawlAuth"),
|
||||
(AuthType.WATERCRAWL, "services.auth.watercrawl.watercrawl.WatercrawlAuth"),
|
||||
(AuthType.JINA, "services.auth.jina.jina.JinaAuth"),
|
||||
],
|
||||
)
|
||||
def test_get_apikey_auth_factory_valid_providers(self, provider, auth_class_path):
|
||||
"""Test getting auth factory for all valid providers"""
|
||||
with patch(auth_class_path) as mock_auth:
|
||||
auth_class = ApiKeyAuthFactory.get_apikey_auth_factory(provider)
|
||||
assert auth_class == mock_auth
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"invalid_provider",
|
||||
[
|
||||
"invalid_provider",
|
||||
"",
|
||||
None,
|
||||
123,
|
||||
"UNSUPPORTED",
|
||||
],
|
||||
)
|
||||
def test_get_apikey_auth_factory_invalid_providers(self, invalid_provider):
|
||||
"""Test getting auth factory with various invalid providers"""
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
ApiKeyAuthFactory.get_apikey_auth_factory(invalid_provider)
|
||||
assert str(exc_info.value) == "Invalid provider"
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("credentials_return_value", "expected_result"),
|
||||
[
|
||||
(True, True),
|
||||
(False, False),
|
||||
],
|
||||
)
|
||||
@patch("services.auth.api_key_auth_factory.ApiKeyAuthFactory.get_apikey_auth_factory")
|
||||
def test_validate_credentials_delegates_to_auth_instance(
|
||||
self, mock_get_factory, credentials_return_value, expected_result
|
||||
):
|
||||
"""Test that validate_credentials delegates to auth instance correctly"""
|
||||
# Arrange
|
||||
mock_auth_instance = MagicMock()
|
||||
mock_auth_instance.validate_credentials.return_value = credentials_return_value
|
||||
mock_auth_class = MagicMock(return_value=mock_auth_instance)
|
||||
mock_get_factory.return_value = mock_auth_class
|
||||
|
||||
# Act
|
||||
factory = ApiKeyAuthFactory(AuthType.FIRECRAWL, {"api_key": "test_key"})
|
||||
result = factory.validate_credentials()
|
||||
|
||||
# Assert
|
||||
assert result is expected_result
|
||||
mock_auth_instance.validate_credentials.assert_called_once()
|
||||
|
||||
@patch("services.auth.api_key_auth_factory.ApiKeyAuthFactory.get_apikey_auth_factory")
|
||||
def test_validate_credentials_propagates_exceptions(self, mock_get_factory):
|
||||
"""Test that exceptions from auth instance are propagated"""
|
||||
# Arrange
|
||||
mock_auth_instance = MagicMock()
|
||||
mock_auth_instance.validate_credentials.side_effect = Exception("Authentication error")
|
||||
mock_auth_class = MagicMock(return_value=mock_auth_instance)
|
||||
mock_get_factory.return_value = mock_auth_class
|
||||
|
||||
# Act & Assert
|
||||
factory = ApiKeyAuthFactory(AuthType.FIRECRAWL, {"api_key": "test_key"})
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
factory.validate_credentials()
|
||||
assert str(exc_info.value) == "Authentication error"
|
||||
@@ -0,0 +1,387 @@
|
||||
import json
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
from models.source import DataSourceApiKeyAuthBinding
|
||||
from services.auth.api_key_auth_service import ApiKeyAuthService
|
||||
|
||||
|
||||
class TestApiKeyAuthService:
|
||||
"""API key authentication service security tests"""
|
||||
|
||||
def setup_method(self):
|
||||
"""Setup test fixtures"""
|
||||
self.tenant_id = "test_tenant_123"
|
||||
self.category = "search"
|
||||
self.provider = "google"
|
||||
self.binding_id = "binding_123"
|
||||
self.mock_credentials = {"auth_type": "api_key", "config": {"api_key": "test_secret_key_123"}}
|
||||
self.mock_args = {"category": self.category, "provider": self.provider, "credentials": self.mock_credentials}
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_get_provider_auth_list_success(self, mock_session):
|
||||
"""Test get provider auth list - success scenario"""
|
||||
# Mock database query result
|
||||
mock_binding = Mock()
|
||||
mock_binding.tenant_id = self.tenant_id
|
||||
mock_binding.provider = self.provider
|
||||
mock_binding.disabled = False
|
||||
|
||||
mock_session.scalars.return_value.all.return_value = [mock_binding]
|
||||
|
||||
result = ApiKeyAuthService.get_provider_auth_list(self.tenant_id)
|
||||
|
||||
assert len(result) == 1
|
||||
assert result[0].tenant_id == self.tenant_id
|
||||
assert mock_session.scalars.call_count == 1
|
||||
select_arg = mock_session.scalars.call_args[0][0]
|
||||
assert "data_source_api_key_auth_binding" in str(select_arg).lower()
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_get_provider_auth_list_empty(self, mock_session):
|
||||
"""Test get provider auth list - empty result"""
|
||||
mock_session.scalars.return_value.all.return_value = []
|
||||
|
||||
result = ApiKeyAuthService.get_provider_auth_list(self.tenant_id)
|
||||
|
||||
assert result == []
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_get_provider_auth_list_filters_disabled(self, mock_session):
|
||||
"""Test get provider auth list - filters disabled items"""
|
||||
mock_session.scalars.return_value.all.return_value = []
|
||||
|
||||
ApiKeyAuthService.get_provider_auth_list(self.tenant_id)
|
||||
select_stmt = mock_session.scalars.call_args[0][0]
|
||||
where_clauses = list(getattr(select_stmt, "_where_criteria", []) or [])
|
||||
# Ensure both tenant filter and disabled filter exist
|
||||
where_strs = [str(c).lower() for c in where_clauses]
|
||||
assert any("tenant_id" in s for s in where_strs)
|
||||
assert any("disabled" in s for s in where_strs)
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
@patch("services.auth.api_key_auth_service.ApiKeyAuthFactory")
|
||||
@patch("services.auth.api_key_auth_service.encrypter")
|
||||
def test_create_provider_auth_success(self, mock_encrypter, mock_factory, mock_session):
|
||||
"""Test create provider auth - success scenario"""
|
||||
# Mock successful auth validation
|
||||
mock_auth_instance = Mock()
|
||||
mock_auth_instance.validate_credentials.return_value = True
|
||||
mock_factory.return_value = mock_auth_instance
|
||||
|
||||
# Mock encryption
|
||||
encrypted_key = "encrypted_test_key_123"
|
||||
mock_encrypter.encrypt_token.return_value = encrypted_key
|
||||
|
||||
# Mock database operations
|
||||
mock_session.add = Mock()
|
||||
mock_session.commit = Mock()
|
||||
|
||||
ApiKeyAuthService.create_provider_auth(self.tenant_id, self.mock_args)
|
||||
|
||||
# Verify factory class calls
|
||||
mock_factory.assert_called_once_with(self.provider, self.mock_credentials)
|
||||
mock_auth_instance.validate_credentials.assert_called_once()
|
||||
|
||||
# Verify encryption calls
|
||||
mock_encrypter.encrypt_token.assert_called_once_with(self.tenant_id, "test_secret_key_123")
|
||||
|
||||
# Verify database operations
|
||||
mock_session.add.assert_called_once()
|
||||
mock_session.commit.assert_called_once()
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
@patch("services.auth.api_key_auth_service.ApiKeyAuthFactory")
|
||||
def test_create_provider_auth_validation_failed(self, mock_factory, mock_session):
|
||||
"""Test create provider auth - validation failed"""
|
||||
# Mock failed auth validation
|
||||
mock_auth_instance = Mock()
|
||||
mock_auth_instance.validate_credentials.return_value = False
|
||||
mock_factory.return_value = mock_auth_instance
|
||||
|
||||
ApiKeyAuthService.create_provider_auth(self.tenant_id, self.mock_args)
|
||||
|
||||
# Verify no database operations when validation fails
|
||||
mock_session.add.assert_not_called()
|
||||
mock_session.commit.assert_not_called()
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
@patch("services.auth.api_key_auth_service.ApiKeyAuthFactory")
|
||||
@patch("services.auth.api_key_auth_service.encrypter")
|
||||
def test_create_provider_auth_encrypts_api_key(self, mock_encrypter, mock_factory, mock_session):
|
||||
"""Test create provider auth - ensures API key is encrypted"""
|
||||
# Mock successful auth validation
|
||||
mock_auth_instance = Mock()
|
||||
mock_auth_instance.validate_credentials.return_value = True
|
||||
mock_factory.return_value = mock_auth_instance
|
||||
|
||||
# Mock encryption
|
||||
encrypted_key = "encrypted_test_key_123"
|
||||
mock_encrypter.encrypt_token.return_value = encrypted_key
|
||||
|
||||
# Mock database operations
|
||||
mock_session.add = Mock()
|
||||
mock_session.commit = Mock()
|
||||
|
||||
args_copy = self.mock_args.copy()
|
||||
original_key = args_copy["credentials"]["config"]["api_key"]
|
||||
|
||||
ApiKeyAuthService.create_provider_auth(self.tenant_id, args_copy)
|
||||
|
||||
# Verify original key is replaced with encrypted key
|
||||
assert args_copy["credentials"]["config"]["api_key"] == encrypted_key
|
||||
assert args_copy["credentials"]["config"]["api_key"] != original_key
|
||||
|
||||
# Verify encryption function is called correctly
|
||||
mock_encrypter.encrypt_token.assert_called_once_with(self.tenant_id, original_key)
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_get_auth_credentials_success(self, mock_session):
|
||||
"""Test get auth credentials - success scenario"""
|
||||
# Mock database query result
|
||||
mock_binding = Mock()
|
||||
mock_binding.credentials = json.dumps(self.mock_credentials)
|
||||
mock_session.query.return_value.where.return_value.first.return_value = mock_binding
|
||||
mock_session.query.return_value.where.return_value.first.return_value = mock_binding
|
||||
|
||||
result = ApiKeyAuthService.get_auth_credentials(self.tenant_id, self.category, self.provider)
|
||||
|
||||
assert result == self.mock_credentials
|
||||
mock_session.query.assert_called_once_with(DataSourceApiKeyAuthBinding)
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_get_auth_credentials_not_found(self, mock_session):
|
||||
"""Test get auth credentials - not found"""
|
||||
mock_session.query.return_value.where.return_value.first.return_value = None
|
||||
|
||||
result = ApiKeyAuthService.get_auth_credentials(self.tenant_id, self.category, self.provider)
|
||||
|
||||
assert result is None
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_get_auth_credentials_filters_correctly(self, mock_session):
|
||||
"""Test get auth credentials - applies correct filters"""
|
||||
mock_session.query.return_value.where.return_value.first.return_value = None
|
||||
|
||||
ApiKeyAuthService.get_auth_credentials(self.tenant_id, self.category, self.provider)
|
||||
|
||||
# Verify where conditions are correct
|
||||
where_call = mock_session.query.return_value.where.call_args[0]
|
||||
assert len(where_call) == 4 # tenant_id, category, provider, disabled
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_get_auth_credentials_json_parsing(self, mock_session):
|
||||
"""Test get auth credentials - JSON parsing"""
|
||||
# Mock credentials with special characters
|
||||
special_credentials = {"auth_type": "api_key", "config": {"api_key": "key_with_中文_and_special_chars_!@#$%"}}
|
||||
|
||||
mock_binding = Mock()
|
||||
mock_binding.credentials = json.dumps(special_credentials, ensure_ascii=False)
|
||||
mock_session.query.return_value.where.return_value.first.return_value = mock_binding
|
||||
|
||||
result = ApiKeyAuthService.get_auth_credentials(self.tenant_id, self.category, self.provider)
|
||||
|
||||
assert result == special_credentials
|
||||
assert result["config"]["api_key"] == "key_with_中文_and_special_chars_!@#$%"
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_delete_provider_auth_success(self, mock_session):
|
||||
"""Test delete provider auth - success scenario"""
|
||||
# Mock database query result
|
||||
mock_binding = Mock()
|
||||
mock_session.query.return_value.where.return_value.first.return_value = mock_binding
|
||||
|
||||
ApiKeyAuthService.delete_provider_auth(self.tenant_id, self.binding_id)
|
||||
|
||||
# Verify delete operations
|
||||
mock_session.delete.assert_called_once_with(mock_binding)
|
||||
mock_session.commit.assert_called_once()
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_delete_provider_auth_not_found(self, mock_session):
|
||||
"""Test delete provider auth - not found"""
|
||||
mock_session.query.return_value.where.return_value.first.return_value = None
|
||||
|
||||
ApiKeyAuthService.delete_provider_auth(self.tenant_id, self.binding_id)
|
||||
|
||||
# Verify no delete operations when not found
|
||||
mock_session.delete.assert_not_called()
|
||||
mock_session.commit.assert_not_called()
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_delete_provider_auth_filters_by_tenant(self, mock_session):
|
||||
"""Test delete provider auth - filters by tenant"""
|
||||
mock_session.query.return_value.where.return_value.first.return_value = None
|
||||
|
||||
ApiKeyAuthService.delete_provider_auth(self.tenant_id, self.binding_id)
|
||||
|
||||
# Verify where conditions include tenant_id and binding_id
|
||||
where_call = mock_session.query.return_value.where.call_args[0]
|
||||
assert len(where_call) == 2
|
||||
|
||||
def test_validate_api_key_auth_args_success(self):
|
||||
"""Test API key auth args validation - success scenario"""
|
||||
# Should not raise any exception
|
||||
ApiKeyAuthService.validate_api_key_auth_args(self.mock_args)
|
||||
|
||||
def test_validate_api_key_auth_args_missing_category(self):
|
||||
"""Test API key auth args validation - missing category"""
|
||||
args = self.mock_args.copy()
|
||||
del args["category"]
|
||||
|
||||
with pytest.raises(ValueError, match="category is required"):
|
||||
ApiKeyAuthService.validate_api_key_auth_args(args)
|
||||
|
||||
def test_validate_api_key_auth_args_empty_category(self):
|
||||
"""Test API key auth args validation - empty category"""
|
||||
args = self.mock_args.copy()
|
||||
args["category"] = ""
|
||||
|
||||
with pytest.raises(ValueError, match="category is required"):
|
||||
ApiKeyAuthService.validate_api_key_auth_args(args)
|
||||
|
||||
def test_validate_api_key_auth_args_missing_provider(self):
|
||||
"""Test API key auth args validation - missing provider"""
|
||||
args = self.mock_args.copy()
|
||||
del args["provider"]
|
||||
|
||||
with pytest.raises(ValueError, match="provider is required"):
|
||||
ApiKeyAuthService.validate_api_key_auth_args(args)
|
||||
|
||||
def test_validate_api_key_auth_args_empty_provider(self):
|
||||
"""Test API key auth args validation - empty provider"""
|
||||
args = self.mock_args.copy()
|
||||
args["provider"] = ""
|
||||
|
||||
with pytest.raises(ValueError, match="provider is required"):
|
||||
ApiKeyAuthService.validate_api_key_auth_args(args)
|
||||
|
||||
def test_validate_api_key_auth_args_missing_credentials(self):
|
||||
"""Test API key auth args validation - missing credentials"""
|
||||
args = self.mock_args.copy()
|
||||
del args["credentials"]
|
||||
|
||||
with pytest.raises(ValueError, match="credentials is required"):
|
||||
ApiKeyAuthService.validate_api_key_auth_args(args)
|
||||
|
||||
def test_validate_api_key_auth_args_empty_credentials(self):
|
||||
"""Test API key auth args validation - empty credentials"""
|
||||
args = self.mock_args.copy()
|
||||
args["credentials"] = None
|
||||
|
||||
with pytest.raises(ValueError, match="credentials is required"):
|
||||
ApiKeyAuthService.validate_api_key_auth_args(args)
|
||||
|
||||
def test_validate_api_key_auth_args_invalid_credentials_type(self):
|
||||
"""Test API key auth args validation - invalid credentials type"""
|
||||
args = self.mock_args.copy()
|
||||
args["credentials"] = "not_a_dict"
|
||||
|
||||
with pytest.raises(ValueError, match="credentials must be a dictionary"):
|
||||
ApiKeyAuthService.validate_api_key_auth_args(args)
|
||||
|
||||
def test_validate_api_key_auth_args_missing_auth_type(self):
|
||||
"""Test API key auth args validation - missing auth_type"""
|
||||
args = self.mock_args.copy()
|
||||
del args["credentials"]["auth_type"]
|
||||
|
||||
with pytest.raises(ValueError, match="auth_type is required"):
|
||||
ApiKeyAuthService.validate_api_key_auth_args(args)
|
||||
|
||||
def test_validate_api_key_auth_args_empty_auth_type(self):
|
||||
"""Test API key auth args validation - empty auth_type"""
|
||||
args = self.mock_args.copy()
|
||||
args["credentials"]["auth_type"] = ""
|
||||
|
||||
with pytest.raises(ValueError, match="auth_type is required"):
|
||||
ApiKeyAuthService.validate_api_key_auth_args(args)
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"malicious_input",
|
||||
[
|
||||
"<script>alert('xss')</script>",
|
||||
"'; DROP TABLE users; --",
|
||||
"../../../etc/passwd",
|
||||
"\\x00\\x00", # null bytes
|
||||
"A" * 10000, # very long input
|
||||
],
|
||||
)
|
||||
def test_validate_api_key_auth_args_malicious_input(self, malicious_input):
|
||||
"""Test API key auth args validation - malicious input"""
|
||||
args = self.mock_args.copy()
|
||||
args["category"] = malicious_input
|
||||
|
||||
# Verify parameter validator doesn't crash on malicious input
|
||||
# Should validate normally rather than raising security-related exceptions
|
||||
ApiKeyAuthService.validate_api_key_auth_args(args)
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
@patch("services.auth.api_key_auth_service.ApiKeyAuthFactory")
|
||||
@patch("services.auth.api_key_auth_service.encrypter")
|
||||
def test_create_provider_auth_database_error_handling(self, mock_encrypter, mock_factory, mock_session):
|
||||
"""Test create provider auth - database error handling"""
|
||||
# Mock successful auth validation
|
||||
mock_auth_instance = Mock()
|
||||
mock_auth_instance.validate_credentials.return_value = True
|
||||
mock_factory.return_value = mock_auth_instance
|
||||
|
||||
# Mock encryption
|
||||
mock_encrypter.encrypt_token.return_value = "encrypted_key"
|
||||
|
||||
# Mock database error
|
||||
mock_session.commit.side_effect = Exception("Database error")
|
||||
|
||||
with pytest.raises(Exception, match="Database error"):
|
||||
ApiKeyAuthService.create_provider_auth(self.tenant_id, self.mock_args)
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_get_auth_credentials_invalid_json(self, mock_session):
|
||||
"""Test get auth credentials - invalid JSON"""
|
||||
# Mock database returning invalid JSON
|
||||
mock_binding = Mock()
|
||||
mock_binding.credentials = "invalid json content"
|
||||
mock_session.query.return_value.where.return_value.first.return_value = mock_binding
|
||||
|
||||
with pytest.raises(json.JSONDecodeError):
|
||||
ApiKeyAuthService.get_auth_credentials(self.tenant_id, self.category, self.provider)
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
@patch("services.auth.api_key_auth_service.ApiKeyAuthFactory")
|
||||
def test_create_provider_auth_factory_exception(self, mock_factory, mock_session):
|
||||
"""Test create provider auth - factory exception"""
|
||||
# Mock factory raising exception
|
||||
mock_factory.side_effect = Exception("Factory error")
|
||||
|
||||
with pytest.raises(Exception, match="Factory error"):
|
||||
ApiKeyAuthService.create_provider_auth(self.tenant_id, self.mock_args)
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
@patch("services.auth.api_key_auth_service.ApiKeyAuthFactory")
|
||||
@patch("services.auth.api_key_auth_service.encrypter")
|
||||
def test_create_provider_auth_encryption_exception(self, mock_encrypter, mock_factory, mock_session):
|
||||
"""Test create provider auth - encryption exception"""
|
||||
# Mock successful auth validation
|
||||
mock_auth_instance = Mock()
|
||||
mock_auth_instance.validate_credentials.return_value = True
|
||||
mock_factory.return_value = mock_auth_instance
|
||||
|
||||
# Mock encryption exception
|
||||
mock_encrypter.encrypt_token.side_effect = Exception("Encryption error")
|
||||
|
||||
with pytest.raises(Exception, match="Encryption error"):
|
||||
ApiKeyAuthService.create_provider_auth(self.tenant_id, self.mock_args)
|
||||
|
||||
def test_validate_api_key_auth_args_none_input(self):
|
||||
"""Test API key auth args validation - None input"""
|
||||
with pytest.raises(TypeError):
|
||||
ApiKeyAuthService.validate_api_key_auth_args(None)
|
||||
|
||||
def test_validate_api_key_auth_args_dict_credentials_with_list_auth_type(self):
|
||||
"""Test API key auth args validation - dict credentials with list auth_type"""
|
||||
args = self.mock_args.copy()
|
||||
args["credentials"]["auth_type"] = ["api_key"]
|
||||
|
||||
# Current implementation checks if auth_type exists and is truthy, list ["api_key"] is truthy
|
||||
# So this should not raise exception, this test should pass
|
||||
ApiKeyAuthService.validate_api_key_auth_args(args)
|
||||
231
dify/api/tests/unit_tests/services/auth/test_auth_integration.py
Normal file
231
dify/api/tests/unit_tests/services/auth/test_auth_integration.py
Normal file
@@ -0,0 +1,231 @@
|
||||
"""
|
||||
API Key Authentication System Integration Tests
|
||||
"""
|
||||
|
||||
import json
|
||||
from concurrent.futures import ThreadPoolExecutor
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
import httpx
|
||||
import pytest
|
||||
|
||||
from services.auth.api_key_auth_factory import ApiKeyAuthFactory
|
||||
from services.auth.api_key_auth_service import ApiKeyAuthService
|
||||
from services.auth.auth_type import AuthType
|
||||
|
||||
|
||||
class TestAuthIntegration:
|
||||
def setup_method(self):
|
||||
self.tenant_id_1 = "tenant_123"
|
||||
self.tenant_id_2 = "tenant_456" # For multi-tenant isolation testing
|
||||
self.category = "search"
|
||||
|
||||
# Realistic authentication configurations
|
||||
self.firecrawl_credentials = {"auth_type": "bearer", "config": {"api_key": "fc_test_key_123"}}
|
||||
self.jina_credentials = {"auth_type": "bearer", "config": {"api_key": "jina_test_key_456"}}
|
||||
self.watercrawl_credentials = {"auth_type": "x-api-key", "config": {"api_key": "wc_test_key_789"}}
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
@patch("services.auth.firecrawl.firecrawl.httpx.post")
|
||||
@patch("services.auth.api_key_auth_service.encrypter.encrypt_token")
|
||||
def test_end_to_end_auth_flow(self, mock_encrypt, mock_http, mock_session):
|
||||
"""Test complete authentication flow: request → validation → encryption → storage"""
|
||||
mock_http.return_value = self._create_success_response()
|
||||
mock_encrypt.return_value = "encrypted_fc_test_key_123"
|
||||
mock_session.add = Mock()
|
||||
mock_session.commit = Mock()
|
||||
|
||||
args = {"category": self.category, "provider": AuthType.FIRECRAWL, "credentials": self.firecrawl_credentials}
|
||||
ApiKeyAuthService.create_provider_auth(self.tenant_id_1, args)
|
||||
|
||||
mock_http.assert_called_once()
|
||||
call_args = mock_http.call_args
|
||||
assert "https://api.firecrawl.dev/v1/crawl" in call_args[0][0]
|
||||
assert call_args[1]["headers"]["Authorization"] == "Bearer fc_test_key_123"
|
||||
|
||||
mock_encrypt.assert_called_once_with(self.tenant_id_1, "fc_test_key_123")
|
||||
mock_session.add.assert_called_once()
|
||||
mock_session.commit.assert_called_once()
|
||||
|
||||
@patch("services.auth.firecrawl.firecrawl.httpx.post")
|
||||
def test_cross_component_integration(self, mock_http):
|
||||
"""Test factory → provider → HTTP call integration"""
|
||||
mock_http.return_value = self._create_success_response()
|
||||
factory = ApiKeyAuthFactory(AuthType.FIRECRAWL, self.firecrawl_credentials)
|
||||
result = factory.validate_credentials()
|
||||
|
||||
assert result is True
|
||||
mock_http.assert_called_once()
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_multi_tenant_isolation(self, mock_session):
|
||||
"""Ensure complete tenant data isolation"""
|
||||
tenant1_binding = self._create_mock_binding(self.tenant_id_1, AuthType.FIRECRAWL, self.firecrawl_credentials)
|
||||
tenant2_binding = self._create_mock_binding(self.tenant_id_2, AuthType.JINA, self.jina_credentials)
|
||||
|
||||
mock_session.scalars.return_value.all.return_value = [tenant1_binding]
|
||||
result1 = ApiKeyAuthService.get_provider_auth_list(self.tenant_id_1)
|
||||
|
||||
mock_session.scalars.return_value.all.return_value = [tenant2_binding]
|
||||
result2 = ApiKeyAuthService.get_provider_auth_list(self.tenant_id_2)
|
||||
|
||||
assert len(result1) == 1
|
||||
assert result1[0].tenant_id == self.tenant_id_1
|
||||
assert len(result2) == 1
|
||||
assert result2[0].tenant_id == self.tenant_id_2
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
def test_cross_tenant_access_prevention(self, mock_session):
|
||||
"""Test prevention of cross-tenant credential access"""
|
||||
mock_session.query.return_value.where.return_value.first.return_value = None
|
||||
|
||||
result = ApiKeyAuthService.get_auth_credentials(self.tenant_id_2, self.category, AuthType.FIRECRAWL)
|
||||
|
||||
assert result is None
|
||||
|
||||
def test_sensitive_data_protection(self):
|
||||
"""Ensure API keys don't leak to logs"""
|
||||
credentials_with_secrets = {
|
||||
"auth_type": "bearer",
|
||||
"config": {"api_key": "super_secret_key_do_not_log", "secret": "another_secret"},
|
||||
}
|
||||
|
||||
factory = ApiKeyAuthFactory(AuthType.FIRECRAWL, credentials_with_secrets)
|
||||
factory_str = str(factory)
|
||||
|
||||
assert "super_secret_key_do_not_log" not in factory_str
|
||||
assert "another_secret" not in factory_str
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
@patch("services.auth.firecrawl.firecrawl.httpx.post")
|
||||
@patch("services.auth.api_key_auth_service.encrypter.encrypt_token")
|
||||
def test_concurrent_creation_safety(self, mock_encrypt, mock_http, mock_session):
|
||||
"""Test concurrent authentication creation safety"""
|
||||
mock_http.return_value = self._create_success_response()
|
||||
mock_encrypt.return_value = "encrypted_key"
|
||||
mock_session.add = Mock()
|
||||
mock_session.commit = Mock()
|
||||
|
||||
args = {"category": self.category, "provider": AuthType.FIRECRAWL, "credentials": self.firecrawl_credentials}
|
||||
|
||||
results = []
|
||||
exceptions = []
|
||||
|
||||
def create_auth():
|
||||
try:
|
||||
ApiKeyAuthService.create_provider_auth(self.tenant_id_1, args)
|
||||
results.append("success")
|
||||
except Exception as e:
|
||||
exceptions.append(e)
|
||||
|
||||
with ThreadPoolExecutor(max_workers=5) as executor:
|
||||
futures = [executor.submit(create_auth) for _ in range(5)]
|
||||
for future in futures:
|
||||
future.result()
|
||||
|
||||
assert len(results) == 5
|
||||
assert len(exceptions) == 0
|
||||
assert mock_session.add.call_count == 5
|
||||
assert mock_session.commit.call_count == 5
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"invalid_input",
|
||||
[
|
||||
None, # Null input
|
||||
{}, # Empty dictionary - missing required fields
|
||||
{"auth_type": "bearer"}, # Missing config section
|
||||
{"auth_type": "bearer", "config": {}}, # Missing api_key
|
||||
],
|
||||
)
|
||||
def test_invalid_input_boundary(self, invalid_input):
|
||||
"""Test boundary handling for invalid inputs"""
|
||||
with pytest.raises((ValueError, KeyError, TypeError, AttributeError)):
|
||||
ApiKeyAuthFactory(AuthType.FIRECRAWL, invalid_input)
|
||||
|
||||
@patch("services.auth.firecrawl.firecrawl.httpx.post")
|
||||
def test_http_error_handling(self, mock_http):
|
||||
"""Test proper HTTP error handling"""
|
||||
mock_response = Mock()
|
||||
mock_response.status_code = 401
|
||||
mock_response.text = '{"error": "Unauthorized"}'
|
||||
mock_response.raise_for_status.side_effect = httpx.HTTPError("Unauthorized")
|
||||
mock_http.return_value = mock_response
|
||||
|
||||
# PT012: Split into single statement for pytest.raises
|
||||
factory = ApiKeyAuthFactory(AuthType.FIRECRAWL, self.firecrawl_credentials)
|
||||
with pytest.raises((httpx.HTTPError, Exception)):
|
||||
factory.validate_credentials()
|
||||
|
||||
@patch("services.auth.api_key_auth_service.db.session")
|
||||
@patch("services.auth.firecrawl.firecrawl.httpx.post")
|
||||
def test_network_failure_recovery(self, mock_http, mock_session):
|
||||
"""Test system recovery from network failures"""
|
||||
mock_http.side_effect = httpx.RequestError("Network timeout")
|
||||
mock_session.add = Mock()
|
||||
mock_session.commit = Mock()
|
||||
|
||||
args = {"category": self.category, "provider": AuthType.FIRECRAWL, "credentials": self.firecrawl_credentials}
|
||||
|
||||
with pytest.raises(httpx.RequestError):
|
||||
ApiKeyAuthService.create_provider_auth(self.tenant_id_1, args)
|
||||
|
||||
mock_session.commit.assert_not_called()
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("provider", "credentials"),
|
||||
[
|
||||
(AuthType.FIRECRAWL, {"auth_type": "bearer", "config": {"api_key": "fc_key"}}),
|
||||
(AuthType.JINA, {"auth_type": "bearer", "config": {"api_key": "jina_key"}}),
|
||||
(AuthType.WATERCRAWL, {"auth_type": "x-api-key", "config": {"api_key": "wc_key"}}),
|
||||
],
|
||||
)
|
||||
def test_all_providers_factory_creation(self, provider, credentials):
|
||||
"""Test factory creation for all supported providers"""
|
||||
auth_class = ApiKeyAuthFactory.get_apikey_auth_factory(provider)
|
||||
assert auth_class is not None
|
||||
|
||||
factory = ApiKeyAuthFactory(provider, credentials)
|
||||
assert factory.auth is not None
|
||||
|
||||
def _create_success_response(self, status_code=200):
|
||||
"""Create successful HTTP response mock"""
|
||||
mock_response = Mock()
|
||||
mock_response.status_code = status_code
|
||||
mock_response.json.return_value = {"status": "success"}
|
||||
mock_response.raise_for_status.return_value = None
|
||||
return mock_response
|
||||
|
||||
def _create_mock_binding(self, tenant_id: str, provider: str, credentials: dict) -> Mock:
|
||||
"""Create realistic database binding mock"""
|
||||
mock_binding = Mock()
|
||||
mock_binding.id = f"binding_{provider}_{tenant_id}"
|
||||
mock_binding.tenant_id = tenant_id
|
||||
mock_binding.category = self.category
|
||||
mock_binding.provider = provider
|
||||
mock_binding.credentials = json.dumps(credentials, ensure_ascii=False)
|
||||
mock_binding.disabled = False
|
||||
|
||||
mock_binding.created_at = Mock()
|
||||
mock_binding.created_at.timestamp.return_value = 1640995200
|
||||
mock_binding.updated_at = Mock()
|
||||
mock_binding.updated_at.timestamp.return_value = 1640995200
|
||||
|
||||
return mock_binding
|
||||
|
||||
def test_integration_coverage_validation(self):
|
||||
"""Validate integration test coverage meets quality standards"""
|
||||
core_scenarios = {
|
||||
"business_logic": ["end_to_end_auth_flow", "cross_component_integration"],
|
||||
"security": ["multi_tenant_isolation", "cross_tenant_access_prevention", "sensitive_data_protection"],
|
||||
"reliability": ["concurrent_creation_safety", "network_failure_recovery"],
|
||||
"compatibility": ["all_providers_factory_creation"],
|
||||
"boundaries": ["invalid_input_boundary", "http_error_handling"],
|
||||
}
|
||||
|
||||
total_scenarios = sum(len(scenarios) for scenarios in core_scenarios.values())
|
||||
assert total_scenarios >= 10
|
||||
|
||||
security_tests = core_scenarios["security"]
|
||||
assert "multi_tenant_isolation" in security_tests
|
||||
assert "sensitive_data_protection" in security_tests
|
||||
assert True
|
||||
150
dify/api/tests/unit_tests/services/auth/test_auth_type.py
Normal file
150
dify/api/tests/unit_tests/services/auth/test_auth_type.py
Normal file
@@ -0,0 +1,150 @@
|
||||
import pytest
|
||||
|
||||
from services.auth.auth_type import AuthType
|
||||
|
||||
|
||||
class TestAuthType:
|
||||
"""Test cases for AuthType enum"""
|
||||
|
||||
def test_auth_type_is_str_enum(self):
|
||||
"""Test that AuthType is properly a StrEnum"""
|
||||
assert issubclass(AuthType, str)
|
||||
assert hasattr(AuthType, "__members__")
|
||||
|
||||
def test_auth_type_has_expected_values(self):
|
||||
"""Test that all expected auth types exist with correct values"""
|
||||
expected_values = {
|
||||
"FIRECRAWL": "firecrawl",
|
||||
"WATERCRAWL": "watercrawl",
|
||||
"JINA": "jinareader",
|
||||
}
|
||||
|
||||
# Verify all expected members exist
|
||||
for member_name, expected_value in expected_values.items():
|
||||
assert hasattr(AuthType, member_name)
|
||||
assert getattr(AuthType, member_name).value == expected_value
|
||||
|
||||
# Verify no extra members exist
|
||||
assert len(AuthType) == len(expected_values)
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("auth_type", "expected_string"),
|
||||
[
|
||||
(AuthType.FIRECRAWL, "firecrawl"),
|
||||
(AuthType.WATERCRAWL, "watercrawl"),
|
||||
(AuthType.JINA, "jinareader"),
|
||||
],
|
||||
)
|
||||
def test_auth_type_string_representation(self, auth_type, expected_string):
|
||||
"""Test string representation of auth types"""
|
||||
assert str(auth_type) == expected_string
|
||||
assert auth_type.value == expected_string
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("auth_type", "compare_value", "expected_result"),
|
||||
[
|
||||
(AuthType.FIRECRAWL, "firecrawl", True),
|
||||
(AuthType.WATERCRAWL, "watercrawl", True),
|
||||
(AuthType.JINA, "jinareader", True),
|
||||
(AuthType.FIRECRAWL, "FIRECRAWL", False), # Case sensitive
|
||||
(AuthType.FIRECRAWL, "watercrawl", False),
|
||||
(AuthType.JINA, "jina", False), # Full value mismatch
|
||||
],
|
||||
)
|
||||
def test_auth_type_comparison(self, auth_type, compare_value, expected_result):
|
||||
"""Test auth type comparison with strings"""
|
||||
assert (auth_type == compare_value) is expected_result
|
||||
|
||||
def test_auth_type_iteration(self):
|
||||
"""Test that AuthType can be iterated over"""
|
||||
auth_types = list(AuthType)
|
||||
assert len(auth_types) == 3
|
||||
assert AuthType.FIRECRAWL in auth_types
|
||||
assert AuthType.WATERCRAWL in auth_types
|
||||
assert AuthType.JINA in auth_types
|
||||
|
||||
def test_auth_type_membership(self):
|
||||
"""Test membership checking for AuthType"""
|
||||
assert "firecrawl" in [auth.value for auth in AuthType]
|
||||
assert "watercrawl" in [auth.value for auth in AuthType]
|
||||
assert "jinareader" in [auth.value for auth in AuthType]
|
||||
assert "invalid" not in [auth.value for auth in AuthType]
|
||||
|
||||
def test_auth_type_invalid_attribute_access(self):
|
||||
"""Test accessing non-existent auth type raises AttributeError"""
|
||||
with pytest.raises(AttributeError):
|
||||
_ = AuthType.INVALID_TYPE
|
||||
|
||||
def test_auth_type_immutability(self):
|
||||
"""Test that enum values cannot be modified"""
|
||||
# In Python 3.11+, enum members are read-only
|
||||
with pytest.raises(AttributeError):
|
||||
AuthType.FIRECRAWL = "modified"
|
||||
|
||||
def test_auth_type_from_value(self):
|
||||
"""Test creating AuthType from string value"""
|
||||
assert AuthType("firecrawl") == AuthType.FIRECRAWL
|
||||
assert AuthType("watercrawl") == AuthType.WATERCRAWL
|
||||
assert AuthType("jinareader") == AuthType.JINA
|
||||
|
||||
# Test invalid value
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
AuthType("invalid_auth_type")
|
||||
assert "invalid_auth_type" in str(exc_info.value)
|
||||
|
||||
def test_auth_type_name_property(self):
|
||||
"""Test the name property of enum members"""
|
||||
assert AuthType.FIRECRAWL.name == "FIRECRAWL"
|
||||
assert AuthType.WATERCRAWL.name == "WATERCRAWL"
|
||||
assert AuthType.JINA.name == "JINA"
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"auth_type",
|
||||
[AuthType.FIRECRAWL, AuthType.WATERCRAWL, AuthType.JINA],
|
||||
)
|
||||
def test_auth_type_isinstance_checks(self, auth_type):
|
||||
"""Test isinstance checks for auth types"""
|
||||
assert isinstance(auth_type, AuthType)
|
||||
assert isinstance(auth_type, str)
|
||||
assert isinstance(auth_type.value, str)
|
||||
|
||||
def test_auth_type_hash(self):
|
||||
"""Test that auth types are hashable and can be used in sets/dicts"""
|
||||
auth_set = {AuthType.FIRECRAWL, AuthType.WATERCRAWL, AuthType.JINA}
|
||||
assert len(auth_set) == 3
|
||||
|
||||
auth_dict = {
|
||||
AuthType.FIRECRAWL: "firecrawl_handler",
|
||||
AuthType.WATERCRAWL: "watercrawl_handler",
|
||||
AuthType.JINA: "jina_handler",
|
||||
}
|
||||
assert auth_dict[AuthType.FIRECRAWL] == "firecrawl_handler"
|
||||
|
||||
def test_auth_type_json_serializable(self):
|
||||
"""Test that auth types can be JSON serialized"""
|
||||
import json
|
||||
|
||||
auth_data = {
|
||||
"provider": AuthType.FIRECRAWL,
|
||||
"enabled": True,
|
||||
}
|
||||
|
||||
# Should serialize to string value
|
||||
json_str = json.dumps(auth_data, default=str)
|
||||
assert '"provider": "firecrawl"' in json_str
|
||||
|
||||
def test_auth_type_matches_factory_usage(self):
|
||||
"""Test that all AuthType values are handled by ApiKeyAuthFactory"""
|
||||
# This test verifies that the enum values match what's expected
|
||||
# by the factory implementation
|
||||
from services.auth.api_key_auth_factory import ApiKeyAuthFactory
|
||||
|
||||
for auth_type in AuthType:
|
||||
# Should not raise ValueError for valid auth types
|
||||
try:
|
||||
auth_class = ApiKeyAuthFactory.get_apikey_auth_factory(auth_type)
|
||||
assert auth_class is not None
|
||||
except ImportError:
|
||||
# It's OK if the actual auth implementation doesn't exist
|
||||
# We're just testing that the enum value is recognized
|
||||
pass
|
||||
191
dify/api/tests/unit_tests/services/auth/test_firecrawl_auth.py
Normal file
191
dify/api/tests/unit_tests/services/auth/test_firecrawl_auth.py
Normal file
@@ -0,0 +1,191 @@
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import httpx
|
||||
import pytest
|
||||
|
||||
from services.auth.firecrawl.firecrawl import FirecrawlAuth
|
||||
|
||||
|
||||
class TestFirecrawlAuth:
|
||||
@pytest.fixture
|
||||
def valid_credentials(self):
|
||||
"""Fixture for valid bearer credentials"""
|
||||
return {"auth_type": "bearer", "config": {"api_key": "test_api_key_123"}}
|
||||
|
||||
@pytest.fixture
|
||||
def auth_instance(self, valid_credentials):
|
||||
"""Fixture for FirecrawlAuth instance with valid credentials"""
|
||||
return FirecrawlAuth(valid_credentials)
|
||||
|
||||
def test_should_initialize_with_valid_bearer_credentials(self, valid_credentials):
|
||||
"""Test successful initialization with valid bearer credentials"""
|
||||
auth = FirecrawlAuth(valid_credentials)
|
||||
assert auth.api_key == "test_api_key_123"
|
||||
assert auth.base_url == "https://api.firecrawl.dev"
|
||||
assert auth.credentials == valid_credentials
|
||||
|
||||
def test_should_initialize_with_custom_base_url(self):
|
||||
"""Test initialization with custom base URL"""
|
||||
credentials = {
|
||||
"auth_type": "bearer",
|
||||
"config": {"api_key": "test_api_key_123", "base_url": "https://custom.firecrawl.dev"},
|
||||
}
|
||||
auth = FirecrawlAuth(credentials)
|
||||
assert auth.api_key == "test_api_key_123"
|
||||
assert auth.base_url == "https://custom.firecrawl.dev"
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("auth_type", "expected_error"),
|
||||
[
|
||||
("basic", "Invalid auth type, Firecrawl auth type must be Bearer"),
|
||||
("x-api-key", "Invalid auth type, Firecrawl auth type must be Bearer"),
|
||||
("", "Invalid auth type, Firecrawl auth type must be Bearer"),
|
||||
],
|
||||
)
|
||||
def test_should_raise_error_for_invalid_auth_type(self, auth_type, expected_error):
|
||||
"""Test that non-bearer auth types raise ValueError"""
|
||||
credentials = {"auth_type": auth_type, "config": {"api_key": "test_api_key_123"}}
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
FirecrawlAuth(credentials)
|
||||
assert str(exc_info.value) == expected_error
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("credentials", "expected_error"),
|
||||
[
|
||||
({"auth_type": "bearer", "config": {}}, "No API key provided"),
|
||||
({"auth_type": "bearer"}, "No API key provided"),
|
||||
({"auth_type": "bearer", "config": {"api_key": ""}}, "No API key provided"),
|
||||
({"auth_type": "bearer", "config": {"api_key": None}}, "No API key provided"),
|
||||
],
|
||||
)
|
||||
def test_should_raise_error_for_missing_api_key(self, credentials, expected_error):
|
||||
"""Test that missing or empty API key raises ValueError"""
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
FirecrawlAuth(credentials)
|
||||
assert str(exc_info.value) == expected_error
|
||||
|
||||
@patch("services.auth.firecrawl.firecrawl.httpx.post")
|
||||
def test_should_validate_valid_credentials_successfully(self, mock_post, auth_instance):
|
||||
"""Test successful credential validation"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = 200
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
result = auth_instance.validate_credentials()
|
||||
|
||||
assert result is True
|
||||
expected_data = {
|
||||
"url": "https://example.com",
|
||||
"includePaths": [],
|
||||
"excludePaths": [],
|
||||
"limit": 1,
|
||||
"scrapeOptions": {"onlyMainContent": True},
|
||||
}
|
||||
mock_post.assert_called_once_with(
|
||||
"https://api.firecrawl.dev/v1/crawl",
|
||||
headers={"Content-Type": "application/json", "Authorization": "Bearer test_api_key_123"},
|
||||
json=expected_data,
|
||||
)
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("status_code", "error_message"),
|
||||
[
|
||||
(402, "Payment required"),
|
||||
(409, "Conflict error"),
|
||||
(500, "Internal server error"),
|
||||
],
|
||||
)
|
||||
@patch("services.auth.firecrawl.firecrawl.httpx.post")
|
||||
def test_should_handle_http_errors(self, mock_post, status_code, error_message, auth_instance):
|
||||
"""Test handling of various HTTP error codes"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = status_code
|
||||
mock_response.json.return_value = {"error": error_message}
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
auth_instance.validate_credentials()
|
||||
assert str(exc_info.value) == f"Failed to authorize. Status code: {status_code}. Error: {error_message}"
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("status_code", "response_text", "has_json_error", "expected_error_contains"),
|
||||
[
|
||||
(403, '{"error": "Forbidden"}', True, "Failed to authorize. Status code: 403. Error: Forbidden"),
|
||||
(404, "", True, "Unexpected error occurred while trying to authorize. Status code: 404"),
|
||||
(401, "Not JSON", True, "Expecting value"), # JSON decode error
|
||||
],
|
||||
)
|
||||
@patch("services.auth.firecrawl.firecrawl.httpx.post")
|
||||
def test_should_handle_unexpected_errors(
|
||||
self, mock_post, status_code, response_text, has_json_error, expected_error_contains, auth_instance
|
||||
):
|
||||
"""Test handling of unexpected errors with various response formats"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = status_code
|
||||
mock_response.text = response_text
|
||||
if has_json_error:
|
||||
mock_response.json.side_effect = Exception("Not JSON")
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
auth_instance.validate_credentials()
|
||||
assert expected_error_contains in str(exc_info.value)
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("exception_type", "exception_message"),
|
||||
[
|
||||
(httpx.ConnectError, "Network error"),
|
||||
(httpx.TimeoutException, "Request timeout"),
|
||||
(httpx.ReadTimeout, "Read timeout"),
|
||||
(httpx.ConnectTimeout, "Connection timeout"),
|
||||
],
|
||||
)
|
||||
@patch("services.auth.firecrawl.firecrawl.httpx.post")
|
||||
def test_should_handle_network_errors(self, mock_post, exception_type, exception_message, auth_instance):
|
||||
"""Test handling of various network-related errors including timeouts"""
|
||||
mock_post.side_effect = exception_type(exception_message)
|
||||
|
||||
with pytest.raises(exception_type) as exc_info:
|
||||
auth_instance.validate_credentials()
|
||||
assert exception_message in str(exc_info.value)
|
||||
|
||||
def test_should_not_expose_api_key_in_error_messages(self):
|
||||
"""Test that API key is not exposed in error messages"""
|
||||
credentials = {"auth_type": "bearer", "config": {"api_key": "super_secret_key_12345"}}
|
||||
auth = FirecrawlAuth(credentials)
|
||||
|
||||
# Verify API key is stored but not in any error message
|
||||
assert auth.api_key == "super_secret_key_12345"
|
||||
|
||||
# Test various error scenarios don't expose the key
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
FirecrawlAuth({"auth_type": "basic", "config": {"api_key": "super_secret_key_12345"}})
|
||||
assert "super_secret_key_12345" not in str(exc_info.value)
|
||||
|
||||
@patch("services.auth.firecrawl.firecrawl.httpx.post")
|
||||
def test_should_use_custom_base_url_in_validation(self, mock_post):
|
||||
"""Test that custom base URL is used in validation"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = 200
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
credentials = {
|
||||
"auth_type": "bearer",
|
||||
"config": {"api_key": "test_api_key_123", "base_url": "https://custom.firecrawl.dev"},
|
||||
}
|
||||
auth = FirecrawlAuth(credentials)
|
||||
result = auth.validate_credentials()
|
||||
|
||||
assert result is True
|
||||
assert mock_post.call_args[0][0] == "https://custom.firecrawl.dev/v1/crawl"
|
||||
|
||||
@patch("services.auth.firecrawl.firecrawl.httpx.post")
|
||||
def test_should_handle_timeout_with_retry_suggestion(self, mock_post, auth_instance):
|
||||
"""Test that timeout errors are handled gracefully with appropriate error message"""
|
||||
mock_post.side_effect = httpx.TimeoutException("The request timed out after 30 seconds")
|
||||
|
||||
with pytest.raises(httpx.TimeoutException) as exc_info:
|
||||
auth_instance.validate_credentials()
|
||||
|
||||
# Verify the timeout exception is raised with original message
|
||||
assert "timed out" in str(exc_info.value)
|
||||
155
dify/api/tests/unit_tests/services/auth/test_jina_auth.py
Normal file
155
dify/api/tests/unit_tests/services/auth/test_jina_auth.py
Normal file
@@ -0,0 +1,155 @@
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import httpx
|
||||
import pytest
|
||||
|
||||
from services.auth.jina.jina import JinaAuth
|
||||
|
||||
|
||||
class TestJinaAuth:
|
||||
def test_should_initialize_with_valid_bearer_credentials(self):
|
||||
"""Test successful initialization with valid bearer credentials"""
|
||||
credentials = {"auth_type": "bearer", "config": {"api_key": "test_api_key_123"}}
|
||||
auth = JinaAuth(credentials)
|
||||
assert auth.api_key == "test_api_key_123"
|
||||
assert auth.credentials == credentials
|
||||
|
||||
def test_should_raise_error_for_invalid_auth_type(self):
|
||||
"""Test that non-bearer auth type raises ValueError"""
|
||||
credentials = {"auth_type": "basic", "config": {"api_key": "test_api_key_123"}}
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
JinaAuth(credentials)
|
||||
assert str(exc_info.value) == "Invalid auth type, Jina Reader auth type must be Bearer"
|
||||
|
||||
def test_should_raise_error_for_missing_api_key(self):
|
||||
"""Test that missing API key raises ValueError"""
|
||||
credentials = {"auth_type": "bearer", "config": {}}
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
JinaAuth(credentials)
|
||||
assert str(exc_info.value) == "No API key provided"
|
||||
|
||||
def test_should_raise_error_for_missing_config(self):
|
||||
"""Test that missing config section raises ValueError"""
|
||||
credentials = {"auth_type": "bearer"}
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
JinaAuth(credentials)
|
||||
assert str(exc_info.value) == "No API key provided"
|
||||
|
||||
@patch("services.auth.jina.jina.httpx.post")
|
||||
def test_should_validate_valid_credentials_successfully(self, mock_post):
|
||||
"""Test successful credential validation"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = 200
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
credentials = {"auth_type": "bearer", "config": {"api_key": "test_api_key_123"}}
|
||||
auth = JinaAuth(credentials)
|
||||
result = auth.validate_credentials()
|
||||
|
||||
assert result is True
|
||||
mock_post.assert_called_once_with(
|
||||
"https://r.jina.ai",
|
||||
headers={"Content-Type": "application/json", "Authorization": "Bearer test_api_key_123"},
|
||||
json={"url": "https://example.com"},
|
||||
)
|
||||
|
||||
@patch("services.auth.jina.jina.httpx.post")
|
||||
def test_should_handle_http_402_error(self, mock_post):
|
||||
"""Test handling of 402 Payment Required error"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = 402
|
||||
mock_response.json.return_value = {"error": "Payment required"}
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
credentials = {"auth_type": "bearer", "config": {"api_key": "test_api_key_123"}}
|
||||
auth = JinaAuth(credentials)
|
||||
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
auth.validate_credentials()
|
||||
assert str(exc_info.value) == "Failed to authorize. Status code: 402. Error: Payment required"
|
||||
|
||||
@patch("services.auth.jina.jina.httpx.post")
|
||||
def test_should_handle_http_409_error(self, mock_post):
|
||||
"""Test handling of 409 Conflict error"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = 409
|
||||
mock_response.json.return_value = {"error": "Conflict error"}
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
credentials = {"auth_type": "bearer", "config": {"api_key": "test_api_key_123"}}
|
||||
auth = JinaAuth(credentials)
|
||||
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
auth.validate_credentials()
|
||||
assert str(exc_info.value) == "Failed to authorize. Status code: 409. Error: Conflict error"
|
||||
|
||||
@patch("services.auth.jina.jina.httpx.post")
|
||||
def test_should_handle_http_500_error(self, mock_post):
|
||||
"""Test handling of 500 Internal Server Error"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = 500
|
||||
mock_response.json.return_value = {"error": "Internal server error"}
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
credentials = {"auth_type": "bearer", "config": {"api_key": "test_api_key_123"}}
|
||||
auth = JinaAuth(credentials)
|
||||
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
auth.validate_credentials()
|
||||
assert str(exc_info.value) == "Failed to authorize. Status code: 500. Error: Internal server error"
|
||||
|
||||
@patch("services.auth.jina.jina.httpx.post")
|
||||
def test_should_handle_unexpected_error_with_text_response(self, mock_post):
|
||||
"""Test handling of unexpected errors with text response"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = 403
|
||||
mock_response.text = '{"error": "Forbidden"}'
|
||||
mock_response.json.side_effect = Exception("Not JSON")
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
credentials = {"auth_type": "bearer", "config": {"api_key": "test_api_key_123"}}
|
||||
auth = JinaAuth(credentials)
|
||||
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
auth.validate_credentials()
|
||||
assert str(exc_info.value) == "Failed to authorize. Status code: 403. Error: Forbidden"
|
||||
|
||||
@patch("services.auth.jina.jina.httpx.post")
|
||||
def test_should_handle_unexpected_error_without_text(self, mock_post):
|
||||
"""Test handling of unexpected errors without text response"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = 404
|
||||
mock_response.text = ""
|
||||
mock_response.json.side_effect = Exception("Not JSON")
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
credentials = {"auth_type": "bearer", "config": {"api_key": "test_api_key_123"}}
|
||||
auth = JinaAuth(credentials)
|
||||
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
auth.validate_credentials()
|
||||
assert str(exc_info.value) == "Unexpected error occurred while trying to authorize. Status code: 404"
|
||||
|
||||
@patch("services.auth.jina.jina.httpx.post")
|
||||
def test_should_handle_network_errors(self, mock_post):
|
||||
"""Test handling of network connection errors"""
|
||||
mock_post.side_effect = httpx.ConnectError("Network error")
|
||||
|
||||
credentials = {"auth_type": "bearer", "config": {"api_key": "test_api_key_123"}}
|
||||
auth = JinaAuth(credentials)
|
||||
|
||||
with pytest.raises(httpx.ConnectError):
|
||||
auth.validate_credentials()
|
||||
|
||||
def test_should_not_expose_api_key_in_error_messages(self):
|
||||
"""Test that API key is not exposed in error messages"""
|
||||
credentials = {"auth_type": "bearer", "config": {"api_key": "super_secret_key_12345"}}
|
||||
auth = JinaAuth(credentials)
|
||||
|
||||
# Verify API key is stored but not in any error message
|
||||
assert auth.api_key == "super_secret_key_12345"
|
||||
|
||||
# Test various error scenarios don't expose the key
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
JinaAuth({"auth_type": "basic", "config": {"api_key": "super_secret_key_12345"}})
|
||||
assert "super_secret_key_12345" not in str(exc_info.value)
|
||||
205
dify/api/tests/unit_tests/services/auth/test_watercrawl_auth.py
Normal file
205
dify/api/tests/unit_tests/services/auth/test_watercrawl_auth.py
Normal file
@@ -0,0 +1,205 @@
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import httpx
|
||||
import pytest
|
||||
|
||||
from services.auth.watercrawl.watercrawl import WatercrawlAuth
|
||||
|
||||
|
||||
class TestWatercrawlAuth:
|
||||
@pytest.fixture
|
||||
def valid_credentials(self):
|
||||
"""Fixture for valid x-api-key credentials"""
|
||||
return {"auth_type": "x-api-key", "config": {"api_key": "test_api_key_123"}}
|
||||
|
||||
@pytest.fixture
|
||||
def auth_instance(self, valid_credentials):
|
||||
"""Fixture for WatercrawlAuth instance with valid credentials"""
|
||||
return WatercrawlAuth(valid_credentials)
|
||||
|
||||
def test_should_initialize_with_valid_x_api_key_credentials(self, valid_credentials):
|
||||
"""Test successful initialization with valid x-api-key credentials"""
|
||||
auth = WatercrawlAuth(valid_credentials)
|
||||
assert auth.api_key == "test_api_key_123"
|
||||
assert auth.base_url == "https://app.watercrawl.dev"
|
||||
assert auth.credentials == valid_credentials
|
||||
|
||||
def test_should_initialize_with_custom_base_url(self):
|
||||
"""Test initialization with custom base URL"""
|
||||
credentials = {
|
||||
"auth_type": "x-api-key",
|
||||
"config": {"api_key": "test_api_key_123", "base_url": "https://custom.watercrawl.dev"},
|
||||
}
|
||||
auth = WatercrawlAuth(credentials)
|
||||
assert auth.api_key == "test_api_key_123"
|
||||
assert auth.base_url == "https://custom.watercrawl.dev"
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("auth_type", "expected_error"),
|
||||
[
|
||||
("bearer", "Invalid auth type, WaterCrawl auth type must be x-api-key"),
|
||||
("basic", "Invalid auth type, WaterCrawl auth type must be x-api-key"),
|
||||
("", "Invalid auth type, WaterCrawl auth type must be x-api-key"),
|
||||
],
|
||||
)
|
||||
def test_should_raise_error_for_invalid_auth_type(self, auth_type, expected_error):
|
||||
"""Test that non-x-api-key auth types raise ValueError"""
|
||||
credentials = {"auth_type": auth_type, "config": {"api_key": "test_api_key_123"}}
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
WatercrawlAuth(credentials)
|
||||
assert str(exc_info.value) == expected_error
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("credentials", "expected_error"),
|
||||
[
|
||||
({"auth_type": "x-api-key", "config": {}}, "No API key provided"),
|
||||
({"auth_type": "x-api-key"}, "No API key provided"),
|
||||
({"auth_type": "x-api-key", "config": {"api_key": ""}}, "No API key provided"),
|
||||
({"auth_type": "x-api-key", "config": {"api_key": None}}, "No API key provided"),
|
||||
],
|
||||
)
|
||||
def test_should_raise_error_for_missing_api_key(self, credentials, expected_error):
|
||||
"""Test that missing or empty API key raises ValueError"""
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
WatercrawlAuth(credentials)
|
||||
assert str(exc_info.value) == expected_error
|
||||
|
||||
@patch("services.auth.watercrawl.watercrawl.httpx.get")
|
||||
def test_should_validate_valid_credentials_successfully(self, mock_get, auth_instance):
|
||||
"""Test successful credential validation"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = 200
|
||||
mock_get.return_value = mock_response
|
||||
|
||||
result = auth_instance.validate_credentials()
|
||||
|
||||
assert result is True
|
||||
mock_get.assert_called_once_with(
|
||||
"https://app.watercrawl.dev/api/v1/core/crawl-requests/",
|
||||
headers={"Content-Type": "application/json", "X-API-KEY": "test_api_key_123"},
|
||||
)
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("status_code", "error_message"),
|
||||
[
|
||||
(402, "Payment required"),
|
||||
(409, "Conflict error"),
|
||||
(500, "Internal server error"),
|
||||
],
|
||||
)
|
||||
@patch("services.auth.watercrawl.watercrawl.httpx.get")
|
||||
def test_should_handle_http_errors(self, mock_get, status_code, error_message, auth_instance):
|
||||
"""Test handling of various HTTP error codes"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = status_code
|
||||
mock_response.json.return_value = {"error": error_message}
|
||||
mock_get.return_value = mock_response
|
||||
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
auth_instance.validate_credentials()
|
||||
assert str(exc_info.value) == f"Failed to authorize. Status code: {status_code}. Error: {error_message}"
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("status_code", "response_text", "has_json_error", "expected_error_contains"),
|
||||
[
|
||||
(403, '{"error": "Forbidden"}', True, "Failed to authorize. Status code: 403. Error: Forbidden"),
|
||||
(404, "", True, "Unexpected error occurred while trying to authorize. Status code: 404"),
|
||||
(401, "Not JSON", True, "Expecting value"), # JSON decode error
|
||||
],
|
||||
)
|
||||
@patch("services.auth.watercrawl.watercrawl.httpx.get")
|
||||
def test_should_handle_unexpected_errors(
|
||||
self, mock_get, status_code, response_text, has_json_error, expected_error_contains, auth_instance
|
||||
):
|
||||
"""Test handling of unexpected errors with various response formats"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = status_code
|
||||
mock_response.text = response_text
|
||||
if has_json_error:
|
||||
mock_response.json.side_effect = Exception("Not JSON")
|
||||
mock_get.return_value = mock_response
|
||||
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
auth_instance.validate_credentials()
|
||||
assert expected_error_contains in str(exc_info.value)
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("exception_type", "exception_message"),
|
||||
[
|
||||
(httpx.ConnectError, "Network error"),
|
||||
(httpx.TimeoutException, "Request timeout"),
|
||||
(httpx.ReadTimeout, "Read timeout"),
|
||||
(httpx.ConnectTimeout, "Connection timeout"),
|
||||
],
|
||||
)
|
||||
@patch("services.auth.watercrawl.watercrawl.httpx.get")
|
||||
def test_should_handle_network_errors(self, mock_get, exception_type, exception_message, auth_instance):
|
||||
"""Test handling of various network-related errors including timeouts"""
|
||||
mock_get.side_effect = exception_type(exception_message)
|
||||
|
||||
with pytest.raises(exception_type) as exc_info:
|
||||
auth_instance.validate_credentials()
|
||||
assert exception_message in str(exc_info.value)
|
||||
|
||||
def test_should_not_expose_api_key_in_error_messages(self):
|
||||
"""Test that API key is not exposed in error messages"""
|
||||
credentials = {"auth_type": "x-api-key", "config": {"api_key": "super_secret_key_12345"}}
|
||||
auth = WatercrawlAuth(credentials)
|
||||
|
||||
# Verify API key is stored but not in any error message
|
||||
assert auth.api_key == "super_secret_key_12345"
|
||||
|
||||
# Test various error scenarios don't expose the key
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
WatercrawlAuth({"auth_type": "bearer", "config": {"api_key": "super_secret_key_12345"}})
|
||||
assert "super_secret_key_12345" not in str(exc_info.value)
|
||||
|
||||
@patch("services.auth.watercrawl.watercrawl.httpx.get")
|
||||
def test_should_use_custom_base_url_in_validation(self, mock_get):
|
||||
"""Test that custom base URL is used in validation"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = 200
|
||||
mock_get.return_value = mock_response
|
||||
|
||||
credentials = {
|
||||
"auth_type": "x-api-key",
|
||||
"config": {"api_key": "test_api_key_123", "base_url": "https://custom.watercrawl.dev"},
|
||||
}
|
||||
auth = WatercrawlAuth(credentials)
|
||||
result = auth.validate_credentials()
|
||||
|
||||
assert result is True
|
||||
assert mock_get.call_args[0][0] == "https://custom.watercrawl.dev/api/v1/core/crawl-requests/"
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("base_url", "expected_url"),
|
||||
[
|
||||
("https://app.watercrawl.dev", "https://app.watercrawl.dev/api/v1/core/crawl-requests/"),
|
||||
("https://app.watercrawl.dev/", "https://app.watercrawl.dev/api/v1/core/crawl-requests/"),
|
||||
("https://app.watercrawl.dev//", "https://app.watercrawl.dev/api/v1/core/crawl-requests/"),
|
||||
],
|
||||
)
|
||||
@patch("services.auth.watercrawl.watercrawl.httpx.get")
|
||||
def test_should_use_urljoin_for_url_construction(self, mock_get, base_url, expected_url):
|
||||
"""Test that urljoin is used correctly for URL construction with various base URLs"""
|
||||
mock_response = MagicMock()
|
||||
mock_response.status_code = 200
|
||||
mock_get.return_value = mock_response
|
||||
|
||||
credentials = {"auth_type": "x-api-key", "config": {"api_key": "test_api_key_123", "base_url": base_url}}
|
||||
auth = WatercrawlAuth(credentials)
|
||||
auth.validate_credentials()
|
||||
|
||||
# Verify the correct URL was called
|
||||
assert mock_get.call_args[0][0] == expected_url
|
||||
|
||||
@patch("services.auth.watercrawl.watercrawl.httpx.get")
|
||||
def test_should_handle_timeout_with_retry_suggestion(self, mock_get, auth_instance):
|
||||
"""Test that timeout errors are handled gracefully with appropriate error message"""
|
||||
mock_get.side_effect = httpx.TimeoutException("The request timed out after 30 seconds")
|
||||
|
||||
with pytest.raises(httpx.TimeoutException) as exc_info:
|
||||
auth_instance.validate_credentials()
|
||||
|
||||
# Verify the timeout exception is raised with original message
|
||||
assert "timed out" in str(exc_info.value)
|
||||
Reference in New Issue
Block a user