Files
ess-helm/tests/manifests/test_synapse.py

182 lines
7.6 KiB
Python

# Copyright 2024-2025 New Vector Ltd
# Copyright 2025 Element Creations Ltd
#
# SPDX-License-Identifier: AGPL-3.0-only
import pytest
import yaml
from . import DeployableDetails, PropertyType
from .utils import (
iterate_deployables_ingress_parts,
iterate_deployables_parts,
template_id,
template_to_deployable_details,
)
@pytest.mark.parametrize("values_file", ["synapse-minimal-values.yaml"])
@pytest.mark.asyncio_cooperative
async def test_appservice_configmaps_are_templated(release_name, values, make_templates):
values["synapse"].setdefault("appservices", []).append(
{"configMap": "as-{{ $.Release.Name }}", "configMapKey": "reg.yaml"}
)
for template in await make_templates(values):
if template["metadata"]["name"].startswith(f"{release_name}-synapse") and template["kind"] == "StatefulSet":
for volume in template["spec"]["template"]["spec"]["volumes"]:
if (
"configMap" in volume
and volume["configMap"]["name"] == f"as-{release_name}"
and volume["name"] == "as-0"
):
break
else:
raise AssertionError(
"The appservice configMap wasn't included in the volumes : "
f"{','.join([volume['name'] for volume in template['spec']['template']['spec']['volumes']])}"
)
for volumeMount in template["spec"]["template"]["spec"]["containers"][0]["volumeMounts"]:
if volumeMount["name"] == "as-0" and volumeMount["mountPath"] == "/as/0/reg.yaml":
break
else:
raise AssertionError("The appservice configMap isn't mounted at the expected location")
@pytest.mark.parametrize("values_file", ["synapse-minimal-values.yaml"])
@pytest.mark.asyncio_cooperative
async def test_appservice_secrets_are_templated(release_name, values, make_templates):
values["synapse"].setdefault("appservices", []).append(
{"secret": "as-{{ $.Release.Name }}", "secretKey": "reg.yaml"}
)
for template in await make_templates(values):
if template["metadata"]["name"].startswith(f"{release_name}-synapse") and template["kind"] == "StatefulSet":
for volume in template["spec"]["template"]["spec"]["volumes"]:
if (
"secret" in volume
and volume["secret"]["secretName"] == f"as-{release_name}"
and volume["name"] == "as-0"
):
break
else:
raise AssertionError(
"The appservice secret wasn't included in the volumes : "
f"{','.join([volume['name'] for volume in template['spec']['template']['spec']['volumes']])}"
)
for volumeMount in template["spec"]["template"]["spec"]["containers"][0]["volumeMounts"]:
if volumeMount["name"] == "as-0" and volumeMount["mountPath"] == "/as/0/reg.yaml":
break
else:
raise AssertionError("The appservice secret isn't mounted at the expected location")
@pytest.mark.parametrize("values_file", ["synapse-minimal-values.yaml"])
@pytest.mark.asyncio_cooperative
async def test_max_upload_size_annotation_global_ingressType(values, make_templates):
for template in await make_templates(values):
if template["kind"] == "Ingress":
assert "nginx.ingress.kubernetes.io/proxy-body-size" not in template["metadata"].get("annotations", {})
values.setdefault("ingress", {})["controllerType"] = "ingress-nginx"
for template in await make_templates(values):
if template["kind"] == "Ingress":
assert "nginx.ingress.kubernetes.io/proxy-body-size" in template["metadata"].get("annotations", {})
@pytest.mark.parametrize("values_file", ["synapse-minimal-values.yaml"])
@pytest.mark.asyncio_cooperative
async def test_max_upload_size_annotation_component_ingressType(values, make_templates):
def set_ingress_type(deployable_details: DeployableDetails):
deployable_details.set_helm_values(values, PropertyType.Ingress, {"controllerType": "ingress-nginx"})
for template in await make_templates(values):
if template["kind"] == "Ingress":
assert "nginx.ingress.kubernetes.io/proxy-body-size" not in template["metadata"].get("annotations", {})
iterate_deployables_ingress_parts(set_ingress_type)
for template in await make_templates(values):
if template["kind"] == "Ingress":
assert "nginx.ingress.kubernetes.io/proxy-body-size" in template["metadata"].get("annotations", {})
@pytest.mark.parametrize("values_file", ["synapse-minimal-values.yaml"])
@pytest.mark.asyncio_cooperative
async def test_log_level_overrides(values, make_templates):
for template in await make_templates(values):
if (
template["kind"] == "ConfigMap"
and "synapse" in template["metadata"]["name"]
and "log_config.yaml" in template["data"]
):
log_yaml = yaml.safe_load(template["data"]["log_config.yaml"])
log_level = log_yaml["root"]["level"]
loggers = log_yaml["loggers"]
assert log_level == "INFO"
assert loggers == {
"synapse.storage.SQL": {"level": "INFO"},
}
break
else:
raise RuntimeError("Could not find log_config.yaml")
values["synapse"]["logging"] = {
"rootLevel": "WARNING",
"levelOverrides": {"synapse.storage.SQL": "DEBUG", "synapse.over.value": "INFO"},
}
for template in await make_templates(values):
if (
template["kind"] == "ConfigMap"
and "synapse" in template["metadata"]["name"]
and "log_config.yaml" in template["data"]
):
log_yaml = yaml.safe_load(template["data"]["log_config.yaml"])
log_level = log_yaml["root"]["level"]
loggers = log_yaml["loggers"]
assert log_level == "WARNING"
assert loggers == {"synapse.storage.SQL": {"level": "DEBUG"}, "synapse.over.value": {"level": "INFO"}}
break
else:
raise RuntimeError("Could not find log_config.yaml")
@pytest.mark.parametrize("values_file", ["synapse-worker-example-values.yaml"])
@pytest.mark.asyncio_cooperative
async def test_synapse_resources_shared_by_default(values, make_templates):
resources = {
"requests": {
"cpu": "1000",
"memory": "2000Mi",
},
"limits": {
"cpu": "3000",
"memory": "4000Mi",
},
}
def set_resources(deployable_details: DeployableDetails):
if deployable_details.name == "synapse":
deployable_details.set_helm_values(values, PropertyType.Resources, resources)
iterate_deployables_parts(set_resources, lambda deployable_details: deployable_details.is_synapse_process)
for template in await make_templates(values):
if template["kind"] in ["Deployment", "StatefulSet", "Job"]:
deployable_details = template_to_deployable_details(template)
if not deployable_details.is_synapse_process:
continue
for container in template["spec"]["template"]["spec"]["containers"]:
assert "resources" in container, (
f"{template_id(template)} has container {container['name']} without resources"
)
assert resources == container["resources"], (
f"{template_id(template)} has container {container['name']} "
"which doesn't have the expected resources"
)