mirror of
https://github.com/isc-projects/bind9.git
synced 2026-03-13 06:02:37 -04:00
60e118c4fb
Configuration files in system tests which require some variables (e.g. port numbers) filled in during test setup, can now use jinja2 templates when `jinja2` python package is available. Any `*.j2` file found within the system test directory will be automatically rendered with the environment variables into a file without the `.j2` extension by the pytest runner. E.g. `ns1/named.conf.j2` will become `ns1/named.conf` during test setup. To avoid automatic rendering, use `.j2.manual` extension and render the files manually at test time. New `templates` pytest fixture has been added. Its `render()` function can be used to render a template with custom test variables. This can be useful to fill in different config options during the test. With advanced jinja2 template syntax, it can also be used to include/omit entire sections of the config file rather than using `named1.conf.in`, `named2.conf.in` etc.
97 lines
3.2 KiB
Python
97 lines
3.2 KiB
Python
#!/usr/bin/python3
|
|
|
|
# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
#
|
|
# SPDX-License-Identifier: MPL-2.0
|
|
#
|
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
# file, you can obtain one at https://mozilla.org/MPL/2.0/.
|
|
#
|
|
# See the COPYRIGHT file distributed with this work for additional
|
|
# information regarding copyright ownership.
|
|
|
|
from pathlib import Path
|
|
from typing import Any, Dict, Optional, Union
|
|
|
|
import pytest
|
|
|
|
from .log import debug
|
|
from .vars import ALL
|
|
|
|
|
|
class TemplateEngine:
|
|
"""
|
|
Engine for rendering jinja2 templates in system test directories.
|
|
"""
|
|
|
|
def __init__(self, directory: Union[str, Path], env_vars=ALL):
|
|
"""
|
|
Initialize the template engine for `directory`, optionally overriding
|
|
the `env_vars` that will be used when rendering the templates (defaults
|
|
to the environment variables set by the pytest runner).
|
|
"""
|
|
self.directory = Path(directory)
|
|
self._j2env = None
|
|
self.env_vars = dict(env_vars)
|
|
|
|
@property
|
|
def j2env(self):
|
|
"""
|
|
Jinja2 engine that is initialized when first requested. In case the
|
|
jinja2 package in unavailable, the current test will be skipped.
|
|
"""
|
|
if self._j2env is None:
|
|
try:
|
|
import jinja2 # pylint: disable=import-outside-toplevel
|
|
except ImportError:
|
|
pytest.skip("jinja2 not found")
|
|
|
|
loader = jinja2.FileSystemLoader(str(self.directory))
|
|
return jinja2.Environment(
|
|
loader=loader,
|
|
undefined=jinja2.StrictUndefined,
|
|
variable_start_string="@",
|
|
variable_end_string="@",
|
|
)
|
|
return self._j2env
|
|
|
|
def render(
|
|
self,
|
|
output: str,
|
|
data: Optional[Dict[str, Any]] = None,
|
|
template: Optional[str] = None,
|
|
) -> None:
|
|
"""
|
|
Render `output` file from jinja `template` and fill in the `data`. The
|
|
`template` defaults to *.j2.manual or *.j2 file. The environment
|
|
variables which the engine was initialized with are also filled in. In
|
|
case of a variable name clash, `data` has precedence.
|
|
"""
|
|
if template is None:
|
|
template = f"{output}.j2.manual"
|
|
if not Path(template).is_file():
|
|
template = f"{output}.j2"
|
|
if not Path(template).is_file():
|
|
raise RuntimeError('No jinja2 template found for "{output}"')
|
|
|
|
if data is None:
|
|
data = self.env_vars
|
|
else:
|
|
data = {**self.env_vars, **data}
|
|
|
|
debug("rendering template `%s` to file `%s`", template, output)
|
|
stream = self.j2env.get_template(template).stream(data)
|
|
stream.dump(output, encoding="utf-8")
|
|
|
|
def render_auto(self):
|
|
"""
|
|
Render all *.j2 templates with default values and write the output to
|
|
files without the .j2 extensions.
|
|
"""
|
|
templates = [
|
|
str(filepath.relative_to(self.directory))
|
|
for filepath in self.directory.rglob("*.j2")
|
|
]
|
|
for template in templates:
|
|
self.render(template[:-3])
|