zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Simplify testing of schema

Browse Source
This commit is contained in:
Jordan Bradford
2025-04-16 13:30:14 -04:00
parent 251099caac
commit 5ff2c8aa6f
1 changed files with 6 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
tests/test_config_schema.py
View File

@@ -2,144 +2,10 @@
Unit test functions to test JSON Schema validation
"""
import pytest
import jsonschema
from tljh.config_schema import config_schema
from tljh import config
@pytest.mark.parametrize(
"valid_config",
[
# Valid configuration with JupyterLab as default app and HTTPS enabled with Let's Encrypt
{
"user_environment": {"default_app": "jupyterlab"},
"https": {
"enabled": True,
"letsencrypt": {
"email": "admin@example.com",
"domains": ["example.com"],
},
},
},
# Valid configuration with classic notebook UI
{"user_environment": {"default_app": "classic"}, "https": {"enabled": False}},
# Valid configuration with culling service enabled
{
"user_environment": {"default_app": "jupyterlab"},
"https": {"enabled": False},
"services": {
"cull": {
"enabled": True,
"timeout": 3600,
"every": 600,
"concurrency": 5,
"users": True,
"max_age": 86400,
"remove_named_servers": False,
}
},
},
# Valid configuration of resource limits
{
"user_environment": {"default_app": "jupyterlab"},
"https": {"enabled": False},
"limits": {"memory": "2G", "cpu": 1.5},
},
# Valid configuration with TLS certificates instead of Let's Encrypt
{
"user_environment": {"default_app": "jupyterlab"},
"https": {
"enabled": True,
"tls": {
"key": "/etc/tljh/tls/private.key",
"cert": "/etc/tljh/tls/certificate.crt",
},
},
},
# Valid configuration with TLS and custom HTTPS address/port
{
"user_environment": {"default_app": "jupyterlab"},
"https": {
"enabled": True,
"address": "192.168.1.1",
"port": 443,
"tls": {
"key": "/etc/tljh/tls/private.key",
"cert": "/etc/tljh/tls/certificate.crt",
},
},
},
],
)
def test_valid_configs(valid_config):
"""Test that known good configs pass validation without errors."""
try:
config.validate_config(valid_config, validate=True)
except Exception as e:
pytest.fail(f"Valid config failed validation: {e}")
@pytest.mark.parametrize(
"invalid_config",
[
# Invalid default_app value
{
"user_environment": {"default_app": "saturnlab"},
"https": {
"enabled": True,
"letsencrypt": {
"email": "admin@example.com",
"domains": ["sub.example.com"],
},
},
},
# Invalid domains type (should be array)
{
"user_environment": {"default_app": "jupyterlab"},
"https": {
"enabled": True,
"letsencrypt": {"email": "not-an-email", "domains": "example.com"},
},
},
# Extra unexpected property
{
"user_environment": {"default_app": "jupyterlab"},
"https": {
"enabled": True,
"letsencrypt": {
"email": "admin@example.com",
"domains": ["example.com"],
"extra_property": "invalid",
},
},
},
# Invalid culling service config (timeout should be an integer)
{
"user_environment": {"default_app": "jupyterlab"},
"https": {"enabled": False},
"services": {
"cull": {
"enabled": True,
"timeout": "one hour",
"every": 600,
"concurrency": 5,
"users": True,
"max_age": 86400,
"remove_named_servers": False,
}
},
},
# Invalid resource limits (negative CPU value)
{
"user_environment": {"default_app": "jupyterlab"},
"https": {"enabled": False},
"limits": {"memory": "2G", "cpu": -1},
},
],
)
def test_invalid_configs(invalid_config):
"""Test that known bad configs raise validation errors."""
with pytest.raises(SystemExit) as exc_info:
config.validate_config(invalid_config, validate=True)
assert exc_info.value.code == 1
def test_valid_config_json_schema():
"""Validate that the JSON schema fits its $schema specification"""
validator_class = jsonschema.validators.validator_for(config_schema)
validator_class.check_schema(config_schema)