copilot-swe-agent[bot]
58c9b5d7f0
- Create app/templates/email/default.html (fixes 'default.html not found' error) - Add DEST_EMAIL_* settings to app/config.py (decoupled from shared EMAIL_* settings) - Update upload_to_email task to use dest_email_* settings exclusively - Update _should_upload_to_email() to check dest_email_* settings - Update config validator, providers, and settings_service for dest_email_* - Update .env.demo and docs/ConfigurationGuide.md - Update all tests to use dest_email_* settings where appropriate" Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
471 lines
21 KiB
Python
471 lines
21 KiB
Python
"""Tests for app/utils/config_validator/validators.py module."""
|
|
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
from app.utils.config_validator.validators import (
|
|
check_all_configs,
|
|
validate_auth_config,
|
|
validate_email_config,
|
|
validate_notification_config,
|
|
validate_storage_configs,
|
|
)
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestValidateStorageConfigs:
|
|
"""Tests for validate_storage_configs function."""
|
|
|
|
def test_returns_dict(self):
|
|
"""Test returns a dictionary."""
|
|
result = validate_storage_configs()
|
|
assert isinstance(result, dict)
|
|
|
|
def test_has_expected_keys(self):
|
|
"""Test has expected provider keys."""
|
|
result = validate_storage_configs()
|
|
expected_keys = [
|
|
"dropbox",
|
|
"nextcloud",
|
|
"sftp",
|
|
"s3",
|
|
"ftp",
|
|
"webdav",
|
|
"google_drive",
|
|
"onedrive",
|
|
"email",
|
|
"paperless",
|
|
"uptime_kuma",
|
|
]
|
|
for key in expected_keys:
|
|
assert key in result
|
|
|
|
def test_values_are_lists(self):
|
|
"""Test that values are lists of issues."""
|
|
result = validate_storage_configs()
|
|
for key, issues in result.items():
|
|
assert isinstance(issues, list)
|
|
|
|
def test_sftp_missing_host(self):
|
|
"""Test validation when SFTP_HOST is missing."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.sftp_host = None
|
|
mock_settings.sftp_private_key = None
|
|
mock_settings.sftp_password = None
|
|
result = validate_storage_configs()
|
|
assert "SFTP_HOST is not configured" in result["sftp"]
|
|
|
|
def test_sftp_invalid_key_path(self):
|
|
"""Test validation when SFTP_KEY_PATH file doesn't exist."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.sftp_host = "sftp.example.com"
|
|
mock_settings.sftp_private_key = "/nonexistent/key.pem"
|
|
mock_settings.sftp_password = None
|
|
result = validate_storage_configs()
|
|
assert any("SFTP_KEY_PATH file not found" in issue for issue in result["sftp"])
|
|
|
|
def test_sftp_missing_credentials(self):
|
|
"""Test validation when neither SFTP key nor password is configured."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.sftp_host = "sftp.example.com"
|
|
mock_settings.sftp_private_key = None
|
|
mock_settings.sftp_password = None
|
|
result = validate_storage_configs()
|
|
assert "Neither SFTP_KEY_PATH nor SFTP_PASSWORD is configured" in result["sftp"]
|
|
|
|
def test_email_storage_missing_config(self):
|
|
"""Test validation when email destination storage config is missing."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.dest_email_host = None
|
|
mock_settings.dest_email_default_recipient = None
|
|
result = validate_storage_configs()
|
|
assert "DEST_EMAIL_HOST is not configured" in result["email"]
|
|
assert "DEST_EMAIL_DEFAULT_RECIPIENT is not configured" in result["email"]
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestValidateEmailConfig:
|
|
"""Tests for validate_email_config function."""
|
|
|
|
def test_returns_list(self):
|
|
"""Test returns a list."""
|
|
result = validate_email_config()
|
|
assert isinstance(result, list)
|
|
|
|
def test_missing_email_host(self):
|
|
"""Test validation when EMAIL_HOST is missing."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.email_host = None
|
|
mock_settings.email_port = 587
|
|
mock_settings.email_username = "user"
|
|
mock_settings.email_password = "pass"
|
|
result = validate_email_config()
|
|
assert "EMAIL_HOST is not configured" in result
|
|
|
|
def test_missing_email_port(self):
|
|
"""Test validation when EMAIL_PORT is missing."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.email_host = "smtp.example.com"
|
|
mock_settings.email_port = None
|
|
mock_settings.email_username = "user"
|
|
mock_settings.email_password = "pass"
|
|
result = validate_email_config()
|
|
assert "EMAIL_PORT is not configured" in result
|
|
|
|
def test_missing_email_username(self):
|
|
"""Test validation when EMAIL_USERNAME is missing."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.email_host = "smtp.example.com"
|
|
mock_settings.email_port = 587
|
|
mock_settings.email_username = None
|
|
mock_settings.email_password = "pass"
|
|
result = validate_email_config()
|
|
assert "EMAIL_USERNAME is not configured" in result
|
|
|
|
def test_missing_email_password(self):
|
|
"""Test validation when EMAIL_PASSWORD is missing."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.email_host = "smtp.example.com"
|
|
mock_settings.email_port = 587
|
|
mock_settings.email_username = "user"
|
|
mock_settings.email_password = None
|
|
result = validate_email_config()
|
|
assert "EMAIL_PASSWORD is not configured" in result
|
|
|
|
@patch("app.utils.config_validator.validators.socket.gethostbyname")
|
|
def test_invalid_email_host(self, mock_gethostbyname):
|
|
"""Test validation when email host cannot be resolved."""
|
|
import socket
|
|
|
|
mock_gethostbyname.side_effect = socket.gaierror("Cannot resolve")
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.email_host = "invalid.example.com"
|
|
mock_settings.email_port = 587
|
|
mock_settings.email_username = "user"
|
|
mock_settings.email_password = "pass"
|
|
result = validate_email_config()
|
|
assert any("Cannot resolve email host" in issue for issue in result)
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestValidateAuthConfig:
|
|
"""Tests for validate_auth_config function."""
|
|
|
|
def test_auth_disabled_returns_empty(self):
|
|
"""Test returns empty list when auth is disabled."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.auth_enabled = False
|
|
result = validate_auth_config()
|
|
assert isinstance(result, list)
|
|
assert len(result) == 0
|
|
|
|
def test_auth_enabled_missing_session_secret(self):
|
|
"""Test validation when SESSION_SECRET is missing."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.auth_enabled = True
|
|
mock_settings.session_secret = None
|
|
mock_settings.admin_username = None
|
|
mock_settings.admin_password = None
|
|
mock_settings.authentik_client_id = None
|
|
mock_settings.authentik_client_secret = None
|
|
mock_settings.authentik_config_url = None
|
|
result = validate_auth_config()
|
|
assert "SESSION_SECRET is not configured but AUTH_ENABLED is True" in result
|
|
|
|
def test_auth_enabled_short_session_secret(self):
|
|
"""Test validation when SESSION_SECRET is too short."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.auth_enabled = True
|
|
mock_settings.session_secret = "tooshort"
|
|
mock_settings.admin_username = None
|
|
mock_settings.admin_password = None
|
|
mock_settings.authentik_client_id = None
|
|
mock_settings.authentik_client_secret = None
|
|
mock_settings.authentik_config_url = None
|
|
result = validate_auth_config()
|
|
assert "SESSION_SECRET must be at least 32 characters long" in result
|
|
|
|
def test_auth_enabled_neither_simple_nor_oidc(self):
|
|
"""Test validation when neither simple auth nor OIDC is configured."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.auth_enabled = True
|
|
mock_settings.session_secret = "a" * 32
|
|
mock_settings.admin_username = None
|
|
mock_settings.admin_password = None
|
|
mock_settings.authentik_client_id = None
|
|
mock_settings.authentik_client_secret = None
|
|
mock_settings.authentik_config_url = None
|
|
result = validate_auth_config()
|
|
assert "Neither simple authentication nor OIDC are properly configured" in result
|
|
|
|
def test_auth_enabled_oidc_missing_provider_name(self):
|
|
"""Test validation when OIDC is configured but provider name is missing."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.auth_enabled = True
|
|
mock_settings.session_secret = "a" * 32
|
|
mock_settings.admin_username = None
|
|
mock_settings.admin_password = None
|
|
mock_settings.authentik_client_id = "client_id"
|
|
mock_settings.authentik_client_secret = "client_secret"
|
|
mock_settings.authentik_config_url = "https://example.com"
|
|
mock_settings.oauth_provider_name = None
|
|
result = validate_auth_config()
|
|
assert "OAUTH_PROVIDER_NAME is not configured but OIDC is enabled" in result
|
|
|
|
def test_auth_enabled_simple_auth_valid(self):
|
|
"""Test validation when simple auth is properly configured."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.auth_enabled = True
|
|
mock_settings.session_secret = "a" * 32
|
|
mock_settings.admin_username = "admin"
|
|
mock_settings.admin_password = "password"
|
|
mock_settings.authentik_client_id = None
|
|
mock_settings.authentik_client_secret = None
|
|
mock_settings.authentik_config_url = None
|
|
result = validate_auth_config()
|
|
assert len(result) == 0
|
|
|
|
def test_auth_enabled_oidc_valid(self):
|
|
"""Test validation when OIDC is properly configured."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.auth_enabled = True
|
|
mock_settings.session_secret = "a" * 32
|
|
mock_settings.admin_username = None
|
|
mock_settings.admin_password = None
|
|
mock_settings.authentik_client_id = "client_id"
|
|
mock_settings.authentik_client_secret = "client_secret"
|
|
mock_settings.authentik_config_url = "https://example.com"
|
|
mock_settings.oauth_provider_name = "Authentik"
|
|
result = validate_auth_config()
|
|
assert len(result) == 0
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestValidateNotificationConfig:
|
|
"""Tests for validate_notification_config function."""
|
|
|
|
def test_returns_list(self):
|
|
"""Test returns a list."""
|
|
result = validate_notification_config()
|
|
assert isinstance(result, list)
|
|
|
|
def test_no_notification_urls_configured(self):
|
|
"""Test validation when no notification URLs are configured."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.notification_urls = None
|
|
result = validate_notification_config()
|
|
assert "No notification URLs configured" in result
|
|
|
|
def test_invalid_notification_url_format(self):
|
|
"""Test validation when notification URL format is invalid."""
|
|
# This test would require actually having apprise installed and testing
|
|
# with it, or complex mocking. Since the coverage report shows lines 189-203
|
|
# aren't covered, we'll skip detailed apprise testing as it requires the module.
|
|
pass
|
|
|
|
def test_notification_url_exception(self):
|
|
"""Test validation when adding notification URL raises exception."""
|
|
# This test would require actually having apprise installed and testing
|
|
# with it, or complex mocking. Skipping for now.
|
|
pass
|
|
|
|
def test_apprise_not_installed(self):
|
|
"""Test validation when Apprise module is not available."""
|
|
# The ImportError path is tested indirectly when apprise is not installed
|
|
# We can't easily test this without manipulating sys.modules in a complex way
|
|
pass
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestCheckAllConfigs:
|
|
"""Tests for check_all_configs function."""
|
|
|
|
def test_returns_dict(self):
|
|
"""Test returns a dictionary."""
|
|
result = check_all_configs()
|
|
assert isinstance(result, dict)
|
|
|
|
def test_has_expected_keys(self):
|
|
"""Test has expected keys."""
|
|
result = check_all_configs()
|
|
assert "storage" in result
|
|
assert "email" in result
|
|
assert "notification" in result
|
|
assert "auth" in result
|
|
|
|
@patch("app.utils.config_validator.settings_display.dump_all_settings")
|
|
def test_debug_mode_enabled(self, mock_dump):
|
|
"""Test that settings are dumped when debug mode is enabled."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.debug = True
|
|
mock_settings.auth_enabled = False
|
|
mock_settings.email_host = "smtp.example.com"
|
|
mock_settings.email_port = 587
|
|
mock_settings.email_username = "user"
|
|
mock_settings.email_password = "pass"
|
|
mock_settings.notification_urls = ["mailto://test@example.com"]
|
|
check_all_configs()
|
|
mock_dump.assert_called_once()
|
|
|
|
@patch("app.utils.config_validator.settings_display.dump_all_settings")
|
|
def test_debug_mode_disabled(self, mock_dump):
|
|
"""Test that settings are not dumped when debug mode is disabled."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.debug = False
|
|
mock_settings.auth_enabled = False
|
|
mock_settings.email_host = "smtp.example.com"
|
|
mock_settings.email_port = 587
|
|
mock_settings.email_username = "user"
|
|
mock_settings.email_password = "pass"
|
|
mock_settings.notification_urls = ["mailto://test@example.com"]
|
|
check_all_configs()
|
|
mock_dump.assert_not_called()
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestValidateAuthConfigEdgeCases:
|
|
"""Test edge cases in auth configuration validation."""
|
|
|
|
def test_session_secret_exactly_32_chars(self):
|
|
"""Test validation with session secret exactly 32 characters."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.auth_enabled = True
|
|
mock_settings.session_secret = "a" * 32 # Exactly 32 characters
|
|
mock_settings.admin_username = "admin"
|
|
mock_settings.admin_password = "pass"
|
|
|
|
issues = validate_auth_config()
|
|
# Should not have issue about length
|
|
assert not any("32 characters" in issue for issue in issues)
|
|
|
|
def test_auth_disabled_no_validation(self):
|
|
"""Test that auth validation is skipped when auth is disabled."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.auth_enabled = False
|
|
|
|
issues = validate_auth_config()
|
|
# Should have no issues when auth is disabled
|
|
assert len(issues) == 0
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestValidateEmailConfigEdgeCases:
|
|
"""Test edge cases in email configuration validation."""
|
|
|
|
@patch("app.utils.config_validator.validators.socket.gethostbyname")
|
|
def test_email_host_resolution_success(self, mock_gethostbyname):
|
|
"""Test email host resolution success."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.email_host = "smtp.example.com"
|
|
mock_settings.email_port = 587
|
|
mock_settings.email_username = "user"
|
|
mock_settings.email_password = "pass"
|
|
|
|
mock_gethostbyname.return_value = "192.0.2.1"
|
|
|
|
issues = validate_email_config()
|
|
# Should not have DNS resolution issue
|
|
assert not any("Cannot resolve" in issue for issue in issues)
|
|
|
|
@patch("app.utils.config_validator.validators.socket.gethostbyname")
|
|
def test_email_host_resolution_failure(self, mock_gethostbyname):
|
|
"""Test email host resolution failure."""
|
|
import socket
|
|
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.email_host = "nonexistent.example.com"
|
|
mock_settings.email_port = 587
|
|
mock_settings.email_username = "user"
|
|
mock_settings.email_password = "pass"
|
|
|
|
mock_gethostbyname.side_effect = socket.gaierror()
|
|
|
|
issues = validate_email_config()
|
|
# Should have DNS resolution issue
|
|
assert any("Cannot resolve" in issue for issue in issues)
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestValidateNotificationConfigEdgeCases:
|
|
"""Test edge cases in notification configuration validation."""
|
|
|
|
@patch("builtins.__import__", side_effect=ImportError("No module named 'apprise'"))
|
|
def test_apprise_not_installed(self, mock_import):
|
|
"""Test handling when apprise module is not available."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.notification_urls = ["https://example.com/notify"]
|
|
|
|
# Should handle gracefully
|
|
issues = validate_notification_config()
|
|
assert isinstance(issues, list)
|
|
assert any("Apprise module not installed" in issue for issue in issues)
|
|
|
|
def test_invalid_apprise_url_format(self):
|
|
"""Test validation with invalid notification URL format."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
with patch("apprise.Apprise") as mock_apprise_class:
|
|
mock_settings.notification_urls = ["invalid-url-format"]
|
|
|
|
mock_apprise = mock_apprise_class.return_value
|
|
mock_apprise.add.return_value = False # Invalid URL
|
|
|
|
issues = validate_notification_config()
|
|
assert any("Invalid notification URL format" in issue for issue in issues)
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestValidateStorageConfigsEdgeCases:
|
|
"""Test edge cases for storage configuration validation."""
|
|
|
|
def test_sftp_with_valid_key_path(self, tmp_path):
|
|
"""Test SFTP validation with valid key file path."""
|
|
key_file = tmp_path / "key.pem"
|
|
key_file.write_text("fake key")
|
|
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
mock_settings.sftp_host = "sftp.example.com"
|
|
mock_settings.sftp_private_key = str(key_file)
|
|
mock_settings.sftp_password = None
|
|
|
|
result = validate_storage_configs()
|
|
# Should not have key file not found issue
|
|
assert not any("file not found" in issue.lower() for issue in result["sftp"])
|
|
|
|
def test_all_services_fully_configured(self):
|
|
"""Test validation when all services are fully configured."""
|
|
with patch("app.utils.config_validator.validators.settings") as mock_settings:
|
|
# Configure all services
|
|
mock_settings.sftp_host = "sftp.example.com"
|
|
mock_settings.sftp_password = "pass"
|
|
mock_settings.dest_email_host = "smtp.example.com"
|
|
mock_settings.dest_email_default_recipient = "test@example.com"
|
|
mock_settings.s3_bucket_name = "my-bucket"
|
|
mock_settings.aws_access_key_id = "key"
|
|
mock_settings.aws_secret_access_key = "secret"
|
|
mock_settings.ftp_host = "ftp.example.com"
|
|
mock_settings.ftp_username = "user"
|
|
mock_settings.ftp_password = "pass"
|
|
mock_settings.webdav_url = "https://webdav.example.com"
|
|
mock_settings.webdav_username = "user"
|
|
mock_settings.webdav_password = "pass"
|
|
mock_settings.google_drive_credentials_json = "{}"
|
|
mock_settings.google_drive_folder_id = "folder_id"
|
|
mock_settings.paperless_host = "https://paperless.example.com"
|
|
mock_settings.paperless_ngx_api_token = "token"
|
|
mock_settings.onedrive_client_id = "id"
|
|
mock_settings.onedrive_client_secret = "secret"
|
|
mock_settings.onedrive_refresh_token = "token"
|
|
mock_settings.dropbox_app_key = "key"
|
|
mock_settings.dropbox_app_secret = "secret"
|
|
mock_settings.dropbox_refresh_token = "token"
|
|
mock_settings.nextcloud_upload_url = "https://nextcloud.example.com"
|
|
mock_settings.nextcloud_username = "user"
|
|
mock_settings.nextcloud_password = "pass"
|
|
mock_settings.uptime_kuma_url = "https://kuma.example.com"
|
|
|
|
result = validate_storage_configs()
|
|
# Check that all providers have empty issue lists
|
|
for provider, issues in result.items():
|
|
assert len(issues) == 0, f"{provider} should have no issues"
|