robotframework-onap/ONAPLibrary/TemplatingKeywords.py

   1 # Copyright 2019 AT&T Intellectual Property. All rights reserved.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #         http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 from jinja2 import Environment, FileSystemLoader, select_autoescape
  16 from robot import utils
  17 from robot.api.deco import keyword
  18
  19
  20 class TemplatingKeywords(object):
  21     """Templating is an ONAP resource for templating with strings in robot framework. Under the hood it uses the Jinja2
  22     templating engine
  23     """
  24
  25     def __init__(self):
  26         self._cache = utils.ConnectionCache('No Jinja Environments created')
  27
  28     @keyword
  29     def create_environment(self, alias, templates_folder):
  30         """create an environment under an alias for tempalte location"""
  31         jinja_env = Environment(
  32             loader=FileSystemLoader(templates_folder),
  33             autoescape=select_autoescape(['html', 'xml'])
  34         )
  35         self._cache.register(jinja_env, alias=alias)
  36
  37     @keyword
  38     def apply_template(self, alias, template_location, values):
  39         """returns a string that is the jinja template in template_location filled in via the dictionary in values """
  40         template = self._cache.switch(alias).get_template(template_location)
  41         return template.render(values)