主要变更: - 将 templates_dir 参数改为 template_file,支持单个模板库 YAML 文件 - 添加模板库 YAML 验证功能 - 为模板添加 base_dir 支持,正确解析相对路径资源 - 内联模板与外部模板同名时改为警告(内联优先) - 移除模板缓存机制,直接使用模板库字典 - 更新所有相关测试以适配新的模板加载方式 此重构简化了模板管理,使模板资源的路径解析更加清晰明确。
238 lines
9.5 KiB
Python
238 lines
9.5 KiB
Python
"""
|
|
资源验证器单元测试
|
|
|
|
测试 ResourceValidator 的图片和模板文件验证功能
|
|
"""
|
|
|
|
import pytest
|
|
from pathlib import Path
|
|
from validators.resource import ResourceValidator
|
|
|
|
|
|
class TestResourceValidator:
|
|
"""ResourceValidator 测试类"""
|
|
|
|
def test_init(self, temp_dir):
|
|
"""测试初始化"""
|
|
validator = ResourceValidator(yaml_dir=temp_dir)
|
|
assert validator.yaml_dir == temp_dir
|
|
assert validator.template_file is None
|
|
|
|
def test_init_with_template_dir(self, temp_dir, sample_template):
|
|
"""测试带模板文件初始化"""
|
|
validator = ResourceValidator(yaml_dir=temp_dir, template_file=sample_template)
|
|
assert validator.template_file == sample_template
|
|
|
|
|
|
class TestValidateImage:
|
|
"""validate_image 方法测试"""
|
|
|
|
def test_existing_image(self, temp_dir, sample_image):
|
|
"""测试存在的图片文件"""
|
|
validator = ResourceValidator(yaml_dir=temp_dir)
|
|
elem = type("Element", (), {"src": sample_image.name})()
|
|
issues = validator.validate_image(elem, 1, 1)
|
|
assert len(issues) == 0
|
|
|
|
def test_nonexistent_image(self, temp_dir):
|
|
"""测试不存在的图片文件"""
|
|
validator = ResourceValidator(yaml_dir=temp_dir)
|
|
elem = type("Element", (), {"src": "nonexistent.png"})()
|
|
issues = validator.validate_image(elem, 1, 1)
|
|
assert len(issues) == 1
|
|
assert issues[0].level == "ERROR"
|
|
assert issues[0].code == "IMAGE_FILE_NOT_FOUND"
|
|
|
|
def test_image_with_absolute_path(self, temp_dir, sample_image):
|
|
"""测试绝对路径图片"""
|
|
validator = ResourceValidator(yaml_dir=temp_dir)
|
|
elem = type("Element", (), {"src": str(sample_image)})()
|
|
issues = validator.validate_image(elem, 1, 1)
|
|
assert len(issues) == 0
|
|
|
|
def test_image_without_src_attribute(self, temp_dir):
|
|
"""测试没有 src 属性的元素"""
|
|
validator = ResourceValidator(yaml_dir=temp_dir)
|
|
elem = type("Element", (), {})() # 没有 src 属性
|
|
issues = validator.validate_image(elem, 1, 1)
|
|
assert len(issues) == 0
|
|
|
|
def test_image_with_empty_src(self, temp_dir):
|
|
"""测试空 src 字符串"""
|
|
validator = ResourceValidator(yaml_dir=temp_dir)
|
|
elem = type("Element", (), {"src": ""})()
|
|
issues = validator.validate_image(elem, 1, 1)
|
|
assert len(issues) == 0
|
|
|
|
|
|
class TestValidateTemplate:
|
|
"""validate_template 方法测试"""
|
|
|
|
def test_slide_without_template(self, temp_dir):
|
|
"""测试不使用模板的幻灯片"""
|
|
validator = ResourceValidator(yaml_dir=temp_dir)
|
|
slide_data = {} # 没有 template 字段
|
|
issues = validator.validate_template(slide_data, 1)
|
|
assert len(issues) == 0
|
|
|
|
def test_template_with_file_not_specified(self, temp_dir):
|
|
"""测试使用模板但未指定模板文件"""
|
|
validator = ResourceValidator(yaml_dir=temp_dir, template_file=None)
|
|
slide_data = {"template": "title-slide"}
|
|
issues = validator.validate_template(slide_data, 1)
|
|
assert len(issues) == 1
|
|
assert issues[0].level == "ERROR"
|
|
assert issues[0].code == "TEMPLATE_FILE_NOT_SPECIFIED"
|
|
|
|
def test_nonexistent_template_file(self, temp_dir):
|
|
"""测试模板库文件不存在"""
|
|
template_file = temp_dir / "nonexistent.yaml"
|
|
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
|
|
slide_data = {"template": "title-slide"}
|
|
issues = validator.validate_template(slide_data, 1)
|
|
assert len(issues) == 1
|
|
assert issues[0].level == "ERROR"
|
|
assert issues[0].code == "TEMPLATE_LIBRARY_FILE_NOT_FOUND"
|
|
|
|
def test_valid_template_file(self, sample_template):
|
|
"""测试有效的模板文件"""
|
|
validator = ResourceValidator(
|
|
yaml_dir=sample_template.parent, template_file=sample_template
|
|
)
|
|
slide_data = {"template": "title-slide"}
|
|
issues = validator.validate_template(slide_data, 1)
|
|
assert len(issues) == 0
|
|
|
|
def test_template_with_yaml_extension(self, temp_dir):
|
|
"""测试模板名称在模板库中不存在"""
|
|
template_file = temp_dir / "templates.yaml"
|
|
template_file.write_text("templates:\n test-template:\n vars: []\n elements: []")
|
|
|
|
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
|
|
slide_data = {"template": "nonexistent"}
|
|
issues = validator.validate_template(slide_data, 1)
|
|
assert len(issues) == 1
|
|
assert issues[0].level == "ERROR"
|
|
assert issues[0].code == "TEMPLATE_NOT_FOUND_IN_LIBRARY"
|
|
|
|
def test_invalid_template_structure(self, temp_dir):
|
|
"""测试模板库文件格式错误(缺少 templates 字段)"""
|
|
template_file = temp_dir / "invalid.yaml"
|
|
template_file.write_text("vars: []") # 缺少 templates 字段
|
|
|
|
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
|
|
slide_data = {"template": "test"}
|
|
issues = validator.validate_template(slide_data, 1)
|
|
# 模板库加载失败,会报 TEMPLATE_LIBRARY_FILE_NOT_FOUND 或其他错误
|
|
assert len(issues) >= 1
|
|
assert issues[0].level == "ERROR"
|
|
|
|
|
|
class TestValidateTemplateVars:
|
|
"""validate_template_vars 方法测试"""
|
|
|
|
def test_slide_without_template(self, temp_dir):
|
|
"""测试不使用模板的幻灯片"""
|
|
validator = ResourceValidator(yaml_dir=temp_dir)
|
|
slide_data = {}
|
|
issues = validator.validate_template_vars(slide_data, 1)
|
|
assert len(issues) == 0
|
|
|
|
def test_template_with_file_not_specified(self, temp_dir):
|
|
"""测试使用模板但未指定模板文件"""
|
|
validator = ResourceValidator(yaml_dir=temp_dir, template_file=None)
|
|
slide_data = {"template": "title-slide"}
|
|
issues = validator.validate_template_vars(slide_data, 1)
|
|
assert len(issues) == 0
|
|
|
|
def test_provide_all_required_vars(self, sample_template):
|
|
"""测试提供所有必需变量时验证通过"""
|
|
validator = ResourceValidator(
|
|
yaml_dir=sample_template.parent, template_file=sample_template
|
|
)
|
|
slide_data = {
|
|
"template": "title-slide",
|
|
"vars": {"title": "Hello", "subtitle": "World"},
|
|
}
|
|
issues = validator.validate_template_vars(slide_data, 1)
|
|
assert len(issues) == 0
|
|
|
|
def test_missing_required_var(self, sample_template):
|
|
"""测试缺少必需变量时验证失败"""
|
|
validator = ResourceValidator(
|
|
yaml_dir=sample_template.parent, template_file=sample_template
|
|
)
|
|
slide_data = {"template": "title-slide", "vars": {"subtitle": "World"}}
|
|
issues = validator.validate_template_vars(slide_data, 1)
|
|
assert len(issues) == 1
|
|
assert issues[0].level == "ERROR"
|
|
assert issues[0].code == "MISSING_TEMPLATE_REQUIRED_VARS"
|
|
assert "title" in issues[0].message
|
|
|
|
def test_multiple_required_vars_partial_missing(self, temp_dir):
|
|
"""测试多个必需变量部分缺失"""
|
|
template_file = temp_dir / "templates.yaml"
|
|
template_content = """templates:
|
|
multi-var:
|
|
vars:
|
|
- name: title
|
|
required: true
|
|
- name: subtitle
|
|
required: true
|
|
- name: author
|
|
required: false
|
|
elements: []
|
|
"""
|
|
template_file.write_text(template_content)
|
|
|
|
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
|
|
slide_data = {"template": "multi-var", "vars": {"title": "Hello"}}
|
|
issues = validator.validate_template_vars(slide_data, 1)
|
|
assert len(issues) == 1
|
|
assert issues[0].level == "ERROR"
|
|
assert "subtitle" in issues[0].message
|
|
|
|
def test_optional_var_missing(self, sample_template):
|
|
"""测试可选变量缺失时验证通过"""
|
|
validator = ResourceValidator(
|
|
yaml_dir=sample_template.parent, template_file=sample_template
|
|
)
|
|
slide_data = {"template": "title-slide", "vars": {"title": "Hello"}}
|
|
issues = validator.validate_template_vars(slide_data, 1)
|
|
assert len(issues) == 0
|
|
|
|
def test_template_with_no_required_vars(self, temp_dir):
|
|
"""测试模板没有必需变量时"""
|
|
template_file = temp_dir / "templates.yaml"
|
|
template_content = """templates:
|
|
optional-only:
|
|
vars:
|
|
- name: subtitle
|
|
required: false
|
|
elements: []
|
|
"""
|
|
template_file.write_text(template_content)
|
|
|
|
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
|
|
slide_data = {"template": "optional-only", "vars": {}}
|
|
issues = validator.validate_template_vars(slide_data, 1)
|
|
assert len(issues) == 0
|
|
|
|
def test_nonexistent_template_file(self, temp_dir):
|
|
"""测试模板文件不存在时不报错(由 validate_template 处理)"""
|
|
template_file = temp_dir / "nonexistent.yaml"
|
|
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
|
|
slide_data = {"template": "nonexistent"}
|
|
issues = validator.validate_template_vars(slide_data, 1)
|
|
assert len(issues) == 0
|
|
|
|
def test_error_location_contains_slide_number(self, sample_template):
|
|
"""测试错误信息包含幻灯片位置"""
|
|
validator = ResourceValidator(
|
|
yaml_dir=sample_template.parent, template_file=sample_template
|
|
)
|
|
slide_data = {"template": "title-slide", "vars": {}}
|
|
issues = validator.validate_template_vars(slide_data, 5)
|
|
assert len(issues) == 1
|
|
assert "幻灯片 5" in issues[0].location
|