move templating engine 86/88386/1
authorDR695H <dr695h@att.com>
Thu, 23 May 2019 16:01:49 +0000 (12:01 -0400)
committerDR695H <dr695h@att.com>
Thu, 23 May 2019 16:02:27 +0000 (12:02 -0400)
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 <dr695h@att.com>
robotframework-onap/ONAPLibrary/Templating.py [new file with mode: 0644]
robotframework-onap/ONAPLibrary/TemplatingKeywords.py [moved from robotframework-onap/eteutils/TemplatingEngine.py with 81% similarity]

diff --git a/robotframework-onap/ONAPLibrary/Templating.py b/robotframework-onap/ONAPLibrary/Templating.py
new file mode 100644 (file)
index 0000000..8975402
--- /dev/null
@@ -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)
 # 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 TemplatingEngine(object):
-    """TemplateImporter is common resource for templating with strings."""
+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)