From a027e1100bced326e92b9fe0447f0bf1637095f9 Mon Sep 17 00:00:00 2001 From: DR695H Date: Thu, 23 May 2019 12:01:49 -0400 Subject: move templating engine rename it to the Temaplaitng subcomponent and seperate out the keywords into its own file Change-Id: Id1795be9b8add507226ae8deb7a6f1b4c01cc118 Issue-ID: TEST-158 Signed-off-by: DR695H --- robotframework-onap/ONAPLibrary/Templating.py | 28 +++++++++++++++ .../ONAPLibrary/TemplatingKeywords.py | 41 ++++++++++++++++++++++ robotframework-onap/eteutils/TemplatingEngine.py | 36 ------------------- 3 files changed, 69 insertions(+), 36 deletions(-) create mode 100644 robotframework-onap/ONAPLibrary/Templating.py create mode 100644 robotframework-onap/ONAPLibrary/TemplatingKeywords.py delete mode 100644 robotframework-onap/eteutils/TemplatingEngine.py diff --git a/robotframework-onap/ONAPLibrary/Templating.py b/robotframework-onap/ONAPLibrary/Templating.py new file mode 100644 index 0000000..8975402 --- /dev/null +++ b/robotframework-onap/ONAPLibrary/Templating.py @@ -0,0 +1,28 @@ +# Copyright 2019 AT&T Intellectual Property. All rights reserved. +# +# 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. + +from ONAPLibrary.robotlibcore import HybridCore +from ONAPLibrary.TemplatingKeywords import TemplatingKeywords + + +class Templating(HybridCore): + """Templating is an ONAP resource for templating with strings in robot framework. Under the hood it uses the Jinja2 + templating engine + """ + + def __init__(self): + self.keyword_implementors = [ + TemplatingKeywords() + ] + HybridCore.__init__(self, self.keyword_implementors) diff --git a/robotframework-onap/ONAPLibrary/TemplatingKeywords.py b/robotframework-onap/ONAPLibrary/TemplatingKeywords.py new file mode 100644 index 0000000..4ad959f --- /dev/null +++ b/robotframework-onap/ONAPLibrary/TemplatingKeywords.py @@ -0,0 +1,41 @@ +# Copyright 2019 AT&T Intellectual Property. All rights reserved. +# +# 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. + +from jinja2 import Environment, FileSystemLoader, select_autoescape +from robot import utils +from robot.api.deco import keyword + + +class TemplatingKeywords(object): + """Templating is an ONAP resource for templating with strings in robot framework. Under the hood it uses the Jinja2 + templating engine + """ + + def __init__(self): + self._cache = utils.ConnectionCache('No Jinja Environments created') + + @keyword + def create_environment(self, alias, templates_folder): + """create an environment under an alias for tempalte location""" + jinja_env = Environment( + loader=FileSystemLoader(templates_folder), + autoescape=select_autoescape(['html', 'xml']) + ) + self._cache.register(jinja_env, alias=alias) + + @keyword + def apply_template(self, alias, template_location, values): + """returns a string that is the jinja template in template_location filled in via the dictionary in values """ + template = self._cache.switch(alias).get_template(template_location) + return template.render(values) diff --git a/robotframework-onap/eteutils/TemplatingEngine.py b/robotframework-onap/eteutils/TemplatingEngine.py deleted file mode 100644 index b47cf8e..0000000 --- a/robotframework-onap/eteutils/TemplatingEngine.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2019 AT&T Intellectual Property. All rights reserved. -# -# 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. - - -from jinja2 import Environment, FileSystemLoader, select_autoescape -from robot import utils - - -class TemplatingEngine(object): - """TemplateImporter is common resource for templating with strings.""" - - def __init__(self): - self._cache = utils.ConnectionCache('No Jinja Environments created') - - def create_environment(self, alias, templates_folder): - jinja_env = Environment( - loader=FileSystemLoader(templates_folder), - autoescape=select_autoescape(['html', 'xml']) - ) - self._cache.register(jinja_env, alias=alias) - - def apply_template(self, alias, template_location, values): - """returns a string that is the jinja template in template_location filled in via the dictionary in values """ - template = self._cache.switch(alias).get_template(template_location) - return template.render(values) -- cgit 1.2.3-korg