Files
ess-helm/scripts/migration/tests/test_config_value_tracker.py
T

405 lines
13 KiB
Python

# Copyright 2026 Element Creations Ltd
#
# SPDX-License-Identifier: AGPL-3.0-only
"""Tests for the ConfigValueTransformer class."""
import logging
from pathlib import Path
from ..extra_files import ExtraFilesDiscovery
from ..interfaces import ExtraFilesDiscoveryStrategy, SecretDiscoveryStrategy
from ..migration import ConfigValueTransformer, TransformationSpec
from ..models import DiscoveredPath
def test_config_value_tracker_basic():
"""Test basic ConfigValueTransformer functionality with dict-based transformations."""
transformer = ConfigValueTransformer(logging.Logger(__name__), ess_config={"unchanged": "value"})
# Create a test config
config = {
"database": {
"host": "postgres",
"port": 5432,
},
"server_name": "example.com",
}
# Transform some values using TransformationSpec
transformer.transform_from_config(
config,
[
TransformationSpec(src_key="database.host", target_key="postgres.host"),
TransformationSpec(src_key="database.port", target_key="postgres.port"),
TransformationSpec(src_key="server_name", target_key="serverName"),
],
)
# Check tracked values
tracked_values = transformer.tracked_values
assert "database.host" in tracked_values
assert "database.port" in tracked_values
assert "server_name" in tracked_values
assert len(tracked_values) == 3
# Check transformations
transformations = transformer.results
assert len(transformations) == 3
# Check ESS config
ess_config = transformer.ess_config
assert ess_config["unchanged"] == "value"
assert ess_config["postgres"]["host"] == "postgres"
assert ess_config["postgres"]["port"] == 5432
assert ess_config["serverName"] == "example.com"
def test_config_value_tracker_filter_config():
"""Test ConfigValueTransformer filter_config functionality."""
transformer = ConfigValueTransformer(logging.Logger(__name__), ess_config={})
# Create a test config
config = {
"database": {
"host": "postgres",
"port": 5432,
},
"server_name": "example.com",
}
# Transform some values
transformer.transform_from_config(
config,
[
TransformationSpec(src_key="database.host", target_key="postgres.host"),
TransformationSpec(src_key="database.port", target_key="postgres.port"),
TransformationSpec(src_key="server_name", target_key="serverName"),
],
)
# Create a config to filter
config = {
"database": {
"host": "postgres",
"port": 5432,
"name": "synapse", # Not tracked
},
"server_name": "example.com",
"other_setting": "preserved",
}
# Filter the config
filtered_config = transformer.filter_config(config)
# Check that tracked values are removed
assert "database" in filtered_config
assert "host" not in filtered_config["database"]
assert "port" not in filtered_config["database"]
assert "name" in filtered_config["database"] # Not tracked, should be preserved
assert "server_name" not in filtered_config
assert "other_setting" in filtered_config # Not tracked, should be preserved
def test_config_value_tracker_nested_dict():
"""Test ConfigValueTransformer with nested dictionaries."""
transformer = ConfigValueTransformer(logging.Logger(__name__), ess_config={})
# Create a nested config
config = {
"database": {
"connection": {
"host": "postgres",
"port": 5432,
},
"credentials": {
"user": "synapse",
"password": "secret",
},
},
"server": {
"name": "example.com",
},
}
# Transform values from the nested dict using explicit TransformationSpecs
transformer.transform_from_config(
config,
[
TransformationSpec(src_key="database.connection.host", target_key="database.connection.host"),
TransformationSpec(src_key="database.connection.port", target_key="database.connection.port"),
TransformationSpec(src_key="database.credentials.user", target_key="database.credentials.user"),
TransformationSpec(src_key="server.name", target_key="server.name"),
],
)
# Check tracked values
tracked_values = transformer.tracked_values
assert "database.connection.host" in tracked_values
assert "database.connection.port" in tracked_values
assert "database.credentials.user" in tracked_values
assert "server.name" in tracked_values
assert len(tracked_values) == 4
# Check ESS config
ess_config = transformer.ess_config
assert ess_config["database"]["connection"]["host"] == "postgres"
assert ess_config["database"]["connection"]["port"] == 5432
assert ess_config["database"]["credentials"]["user"] == "synapse"
assert ess_config["server"]["name"] == "example.com"
def test_config_value_tracker_empty():
"""Test ConfigValueTransformer with no tracked values."""
transformer = ConfigValueTransformer(logging.Logger(__name__), ess_config={})
# Create a config to filter
config = {
"database": {
"host": "postgres",
"port": 5432,
},
"server_name": "example.com",
}
# Filter the config (no values tracked)
filtered_config = transformer.filter_config(config)
# Should be unchanged
assert filtered_config == config
# ESS config should be empty
assert transformer.ess_config == {}
def test_update_paths_in_config_basic():
"""Test update_paths_in_config with basic file path updates."""
transformer = ConfigValueTransformer(logging.Logger(__name__), ess_config={})
# Create a mock ExtraFilesDiscovery with discovered file paths
class MockStrategy(ExtraFilesDiscoveryStrategy):
@property
def ignored_config_keys(self):
return []
class MockSecretStrategy(SecretDiscoveryStrategy):
@property
def ess_secret_schema(self):
return {}
# Create test source config with file paths
source_config = {
"templates": {
"password_reset": "/path/to/password_reset.html",
"registration": "/path/to/registration.html",
},
"other_setting": "preserved",
}
# Create discovered paths
discovered_paths = [
DiscoveredPath(
config_key="templates.password_reset",
source_file="test.yaml",
source_path=Path("password_reset.html"),
is_dir=False,
skipped_reason=None,
),
DiscoveredPath(
config_key="templates.registration",
source_file="test.yaml",
source_path=Path("registration.html"),
is_dir=False,
skipped_reason=None,
),
]
# Create ExtraFilesDiscovery instance
extra_files_discovery = ExtraFilesDiscovery(
strategy=MockStrategy(),
pretty_logger=logging.Logger(__name__),
secrets_strategy=MockSecretStrategy(),
source_file="test.yaml",
discovered_file_paths=discovered_paths,
)
# Test the update_paths_in_config method
updated_config = transformer.update_paths_in_config(source_config, extra_files_discovery, "synapse")
# Verify paths are updated correctly
assert updated_config["templates"]["password_reset"] == "/etc/synapse/extra/password_reset.html"
assert updated_config["templates"]["registration"] == "/etc/synapse/extra/registration.html"
assert updated_config["other_setting"] == "preserved" # Non-file setting should be unchanged
# Verify tracked values (only skipped paths are tracked)
assert len(transformer.tracked_values) == 0 # No skipped paths in this test
def test_update_paths_in_config_with_skipped_paths():
"""Test update_paths_in_config with skipped file paths."""
transformer = ConfigValueTransformer(logging.Logger(__name__), ess_config={})
class MockStrategy(ExtraFilesDiscoveryStrategy):
@property
def ignored_config_keys(self):
return []
class MockSecretStrategy(SecretDiscoveryStrategy):
@property
def ess_secret_schema(self):
return {}
# Create test source config
source_config = {
"templates": {
"password_reset": "/path/to/password_reset.html",
"registration": "/path/to/registration.html",
},
}
# Create discovered paths with one skipped
discovered_paths = [
DiscoveredPath(
config_key="templates.password_reset",
source_file="test.yaml",
source_path=Path("password_reset.html"),
is_dir=False,
skipped_reason="File too large",
),
DiscoveredPath(
config_key="templates.registration",
source_file="test.yaml",
source_path=Path("registration.html"),
is_dir=False,
skipped_reason=None,
),
]
extra_files_discovery = ExtraFilesDiscovery(
strategy=MockStrategy(),
pretty_logger=logging.Logger(__name__),
secrets_strategy=MockSecretStrategy(),
source_file="test.yaml",
discovered_file_paths=discovered_paths,
)
# Test the update_paths_in_config method
updated_config = transformer.update_paths_in_config(source_config, extra_files_discovery, "synapse")
# Verify skipped path is not updated but is tracked
assert updated_config["templates"]["password_reset"] == "/path/to/password_reset.html" # Unchanged
assert updated_config["templates"]["registration"] == "/etc/synapse/extra/registration.html" # Updated
# Verify tracked values (only skipped paths are tracked)
assert "templates.password_reset" in transformer.tracked_values
assert "templates.registration" not in transformer.tracked_values
assert len(transformer.tracked_values) == 1
def test_update_paths_in_config_empty_discovery():
"""Test update_paths_in_config with no discovered files."""
transformer = ConfigValueTransformer(logging.Logger(__name__), ess_config={})
class MockStrategy(ExtraFilesDiscoveryStrategy):
@property
def ignored_config_keys(self):
return []
class MockSecretStrategy(SecretDiscoveryStrategy):
@property
def ess_secret_schema(self):
return {}
# Create test source config
source_config = {
"templates": {
"password_reset": "/path/to/password_reset.html",
},
"other_setting": "preserved",
}
# Create ExtraFilesDiscovery with no discovered paths
extra_files_discovery = ExtraFilesDiscovery(
strategy=MockStrategy(),
pretty_logger=logging.Logger(__name__),
secrets_strategy=MockSecretStrategy(),
source_file="test.yaml",
discovered_file_paths=[],
)
# Test the update_paths_in_config method
updated_config = transformer.update_paths_in_config(source_config, extra_files_discovery, "synapse")
# Verify config is unchanged
assert updated_config == source_config
assert len(transformer.tracked_values) == 0
def test_update_paths_in_config_nested_config():
"""Test update_paths_in_config with nested configuration structures."""
transformer = ConfigValueTransformer(logging.Logger(__name__), ess_config={})
class MockStrategy(ExtraFilesDiscoveryStrategy):
@property
def ignored_config_keys(self):
return []
class MockSecretStrategy(SecretDiscoveryStrategy):
@property
def ess_secret_schema(self):
return {}
# Create test source config with nested structure
source_config = {
"email": {
"smtp_host": "smtp.example.com",
"template_dir": "/path/to/email/templates",
"config": {
"tls_cert": "/path/to/cert.pem",
"tls_key": "/path/to/key.pem",
},
},
"other_setting": "preserved",
}
# Create discovered paths
discovered_paths = [
DiscoveredPath(
config_key="email.template_dir",
source_file="test.yaml",
source_path=Path("email/templates"),
is_dir=True,
skipped_reason=None,
),
DiscoveredPath(
config_key="email.config.tls_cert",
source_file="test.yaml",
source_path=Path("cert.pem"),
is_dir=False,
skipped_reason=None,
),
]
extra_files_discovery = ExtraFilesDiscovery(
strategy=MockStrategy(),
pretty_logger=logging.Logger(__name__),
secrets_strategy=MockSecretStrategy(),
source_file="test.yaml",
discovered_file_paths=discovered_paths,
)
# Test the update_paths_in_config method
updated_config = transformer.update_paths_in_config(
source_config, extra_files_discovery, "matrix-authentication-service"
)
# Verify paths are updated correctly
assert updated_config["email"]["template_dir"] == "/etc/matrix-authentication-service/extra/templates"
assert updated_config["email"]["config"]["tls_cert"] == "/etc/matrix-authentication-service/extra/cert.pem"
assert updated_config["email"]["smtp_host"] == "smtp.example.com" # Unchanged
assert updated_config["other_setting"] == "preserved" # Unchanged
# Verify tracked values (only skipped paths are tracked)
assert len(transformer.tracked_values) == 0 # No skipped paths in this test