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
  16 from robot import utils
  17 from robot.api.deco import keyword
  18 from string import Template
  19
  20
  21 class TemplatingKeywords(object):
  22     """Templating is an ONAP resource for templating with strings in robot framework. Under the hood it uses the Jinja2
  23     templating engine
  24     """
  25
  26     def __init__(self):
  27         self._cache = utils.ConnectionCache('No Jinja Environments created')
  28
  29     @keyword
  30     def create_environment(self, alias, templates_folder):
  31         """create an environment under an alias for tempalte location"""
  32         jinja_env = Environment(
  33             loader=FileSystemLoader(templates_folder)
  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)
  42
  43     @keyword
  44     def template_string(self, template, values):
  45         """Template String takes in a string and its values and converts it using the string.Template class"""
  46         return Template(template).substitute(values)