Adrian Vladu 493e57c195 Add support for jinja as userdata template engine
If the userdata starts with the text '## template:jinja',
Jinja2 templating engine will be used to render that
userdata.

This feature leverages the get_instance_data metadata
service implementation and tries to be as close as possible
with the cloud-init's implementation.

Change-Id: I79cb0066f7d65ae27867ac01b443e9be432b4dc3
2020-01-21 14:36:16 +02:00

51 lines
1.8 KiB
Python

# Copyright 2019 Cloudbase Solutions Srl
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import jinja2
from cloudbaseinit.utils.template_engine import base_template
from jinja2 import runtime
MISSING_JINJA_VARIABLE = u'CI_MISSING_JINJA_VAR/'
@runtime.implements_to_string
class MissingJinjaVariable(jinja2.DebugUndefined):
"""Missing Jinja2 variable class."""
def __str__(self):
return u'%s%s' % (MISSING_JINJA_VARIABLE, self._undefined_name)
class Jinja2TemplateEngine(base_template.BaseTemplateEngine):
def get_template_type(self):
return 'jinja'
def render(self, data, raw_template):
"""Renders the template using Jinja2 template engine
The data variable is a dict which contains the key-values
that will be used to render the template.
The template is an encoded string which can contain special
constructions that will be used by the template engine.
The return value will be an encoded string.
"""
template = self.remove_template_definition(raw_template).decode()
jinja_template = jinja2.Template(template,
trim_blocks=True,
undefined=MissingJinjaVariable,)
return jinja_template.render(**data).encode()