Remove templar use and replace with regex (#169)

Remove templar use and replace with regex

Signed-off-by: Stewart Francis <[email protected]>

Author: stewartfrancis

changelogs/fragments/169-remove-templar.yaml

@@ -0,0 +1,2 @@
+minor_changes:
+  - Remove usage of templar, and replace with simple pattern matching (https://github.com/ansible-collections/ibm_zos_cics/pull/169).

plugins/action/csd.py

@@ -19,8 +19,8 @@ def run(self, tmp=None, task_vars=None):
             task_vars=task_vars,
         )
 
-    def _process_module_args(self, module_args, _templar, ds_name, task_vars, cics_data_sets_required):
-        super(ActionModule, self)._process_module_args(module_args, _templar, ds_name, task_vars, cics_data_sets_required)
+    def _process_module_args(self, module_args, ds_name, cics_data_sets_required):
+        super(ActionModule, self)._process_module_args(module_args, ds_name, cics_data_sets_required)
         if module_args.get(INPUT_LOCATION):
             module_args[INPUT_LOCATION] = module_args[INPUT_LOCATION].lower()
             if module_args[INPUT_LOCATION] == LOCAL and module_args.get(INPUT_SOURCE):

plugins/action/region_jcl.py

@@ -37,7 +37,7 @@ def run(self, tmp=None, task_vars=None):
         }
 
         try:
-            _process_module_args(self.module_args, self._templar, task_vars)
+            _process_module_args(self.module_args)
         except (KeyError, ValueError) as e:
             return_structure.update({
                 "failed": True,
@@ -55,26 +55,26 @@ def run(self, tmp=None, task_vars=None):
         return return_structure
 
 
-def _process_module_args(module_args, _templar, task_vars):
+def _process_module_args(module_args):
     for library_key in LIBRARY_KEYS:
         _set_top_libraries_key(module_args, library_key)
         _validate_list_of_data_set_lengths(module_args[library_key]["top_data_sets"])
         _validate_list_of_data_set_lengths(module_args[library_key].get("data_sets", []))
 
     for cics_lib in CICS_DS_KEYS:
-        _process_libraries_args(module_args, _templar, task_vars, "cics_data_sets", cics_lib)
+        _process_libraries_args(module_args, "cics_data_sets", cics_lib)
 
     for region_ds in REGION_DS_KEYS:
-        _process_region_data_set_args(module_args, _templar, region_ds, task_vars)
+        _process_region_data_set_args(module_args, region_ds)
     # Template field in region_data_sets needs to be removed before module execution
     if module_args["region_data_sets"].get("template"):
         del module_args["region_data_sets"]["template"]
 
     for le_lib in LE_DS_KEYS:
-        _process_libraries_args(module_args, _templar, task_vars, "le_data_sets", le_lib)
+        _process_libraries_args(module_args, "le_data_sets", le_lib)
 
     # Optional argument
     if module_args.get("cpsm_data_sets"):
         for cpsm_lib in CPSM_DS_KEYS:
-            _process_libraries_args(module_args, _templar, task_vars, "cpsm_data_sets", cpsm_lib)
+            _process_libraries_args(module_args, "cpsm_data_sets", cpsm_lib)
     _process_data_set_unit_args(module_args)

plugins/plugin_utils/_module_action_plugin.py

@@ -8,6 +8,7 @@
 __metaclass__ = type
 
 from ansible.plugins.action import ActionBase
+import re
 
 REGION_DS_KEYS = ["dfhgcd", "dfhlcd", "dfhintra", "dfhlrq", "dfhtemp", "dfhauxt", "dfhbuxt", "dfhdmpa", "dfhdmpb", "dfhcsd", "dfhstart"]
 CICS_DS_KEYS = ["sdfhload", "sdfhauth", "sdfhlic"]
@@ -33,9 +34,7 @@ def _run(self, ds_name, module_name, cics_data_sets_required, tmp=None, task_var
         try:
             self._process_module_args(
                 self.module_args,
-                self._templar,
                 ds_name,
-                task_vars,
                 cics_data_sets_required,
             )
         except (KeyError, ValueError) as e:
@@ -56,17 +55,17 @@ def _run(self, ds_name, module_name, cics_data_sets_required, tmp=None, task_var
 
         return return_structure
 
-    def _process_module_args(self, module_args, _templar, ds_name, task_vars, cics_data_sets_required):
-        _process_module_args(module_args, _templar, ds_name, task_vars, cics_data_sets_required)
+    def _process_module_args(self, module_args, ds_name, cics_data_sets_required):
+        _process_module_args(module_args, ds_name, cics_data_sets_required)
 
 
-def _process_module_args(module_args, _templar, ds_name, task_vars, cics_data_sets_required):
-    _process_region_data_set_args(module_args, _templar, ds_name, task_vars)
+def _process_module_args(module_args, ds_name, cics_data_sets_required):
+    _process_region_data_set_args(module_args, ds_name)
     _process_data_set_unit_args(module_args)
     _remove_region_data_set_args(module_args, ds_name)
 
     if cics_data_sets_required:
-        _process_libraries_args(module_args, _templar, task_vars, "cics_data_sets", "sdfhload")
+        _process_libraries_args(module_args, "cics_data_sets", "sdfhload")
         _remove_cics_data_set_args(module_args, "sdfhload")
     else:
         if module_args.get("cics_data_sets"):
@@ -102,7 +101,7 @@ def _remove_cics_data_set_args(module_args, ds_name):
             del module_args["cics_data_sets"][cics_key]
 
 
-def _process_region_data_set_args(module_args, _templar, ds_name, task_vars):
+def _process_region_data_set_args(module_args, ds_name):
     if not module_args.get("region_data_sets"):
         raise KeyError("Required argument region_data_sets not found")
 
@@ -111,8 +110,6 @@ def _process_region_data_set_args(module_args, _templar, ds_name, task_vars):
             module_args["region_data_sets"].update({
                 ds_name: {
                     "dsn": _template_dsn(
-                        _templar=_templar,
-                        task_vars=task_vars,
                         var_name="data_set_name",
                         replace_val=ds_name.upper(),
                         template=module_args["region_data_sets"]["template"],
@@ -140,12 +137,10 @@ def _validate_data_set_length(data_set):
         raise ValueError("Data set: {0} is longer than 44 characters.".format(data_set))
 
 
-def _process_libraries_args(module_args, _templar, task_vars, lib_type, lib_ds_name):
+def _process_libraries_args(module_args, lib_type, lib_ds_name):
     if not _check_library_override(module_args, lib_type, lib_ds_name):
         if _check_template(module_args, lib_type):
             module_args[lib_type][lib_ds_name] = _template_dsn(
-                _templar=_templar,
-                task_vars=task_vars,
                 var_name="lib_name",
                 replace_val=lib_ds_name.upper(),
                 template=module_args[lib_type]["template"],
@@ -155,14 +150,8 @@ def _process_libraries_args(module_args, _templar, task_vars, lib_type, lib_ds_n
     return _validate_data_set_length(module_args[lib_type][lib_ds_name])
 
 
-def _template_dsn(_templar, task_vars, var_name, replace_val, template):
-    cpy = task_vars.copy()
-    cpy.update({var_name: replace_val})
-    return _templar.copy_with_new_env(
-        variable_start_string="<<",
-        variable_end_string=">>",
-        available_variables=cpy,
-    ).do_template(template, overrides=dict(variable_start_string="<<", variable_end_string=">>"))
+def _template_dsn(var_name, replace_val, template):
+    return re.sub(f"<<\\s*{var_name}\\s*>>", replace_val, template)
 
 
 def _check_template(module_args, arg_dict):

tests/unit/action/test_data_set.py

@@ -6,19 +6,11 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-from ansible.parsing.dataloader import DataLoader
-from ansible.template import Templar
 from ansible_collections.ibm.ibm_zos_cics.plugins.plugin_utils._module_action_plugin import (
     _process_module_args
 )
 
 
-def get_templar(module_args):
-    loader = DataLoader()
-    templar = Templar(loader=loader, variables=module_args)
-    return templar
-
-
 def test_data_set_with_template():
     args_with_template = {
         "region_data_sets": {"template": "data.set.template.<< data_set_name >>"},
@@ -27,10 +19,8 @@ def test_data_set_with_template():
         "space_type": "m",
         "state": "initial"
     }
-    templar = get_templar(args_with_template)
-    task_vars = args_with_template
 
-    _process_module_args(args_with_template, templar, "dfhlrq", task_vars, False)
+    _process_module_args(args_with_template, "dfhlrq", False)
 
     assert args_with_template == {
         "region_data_sets": {
@@ -51,10 +41,8 @@ def test_data_set_with_override():
         "space_type": "m",
         "state": "initial"
     }
-    templar = get_templar(args_with_override)
-    task_vars = args_with_override
 
-    _process_module_args(args_with_override, templar, "dfhlrq", task_vars, False)
+    _process_module_args(args_with_override, "dfhlrq", False)
 
     assert args_with_override == {
         "region_data_sets": {
@@ -73,11 +61,9 @@ def test_data_set_with_override_but_no_dsn_key():
         "space_type": "m",
         "state": "initial"
     }
-    templar = get_templar(args_with_override)
-    task_vars = args_with_override
 
     try:
-        _process_module_args(args_with_override, templar, "dfhlrq", task_vars, False)
+        _process_module_args(args_with_override, "dfhlrq", False)
     except KeyError as e:
         assert e.args[0] == "No template or data set override found for dfhlrq"
     else:
@@ -91,11 +77,9 @@ def test_data_set_with_override_but_no_dsn_value():
         "space_type": "m",
         "state": "initial"
     }
-    templar = get_templar(args_with_override)
-    task_vars = args_with_override
 
     try:
-        _process_module_args(args_with_override, templar, "dfhlrq", task_vars, False)
+        _process_module_args(args_with_override, "dfhlrq", False)
     except KeyError as e:
         assert e.args[0] == "No template or data set override found for dfhlrq"
     else:
@@ -109,11 +93,9 @@ def test_data_set_without_override_or_template():
         "space_type": "m",
         "state": "initial"
     }
-    templar = get_templar(args_with_garbage)
-    task_vars = args_with_garbage
 
     try:
-        _process_module_args(args_with_garbage, templar, "dfhlrq", task_vars, False)
+        _process_module_args(args_with_garbage, "dfhlrq", False)
     except KeyError as e:
         assert e.args[0] == "No template or data set override found for dfhlrq"
     else:
@@ -128,10 +110,8 @@ def test_data_set_with_unnecessary_cics_data_sets_arg():
         "space_type": "m",
         "state": "initial"
     }
-    templar = get_templar(args_with_template)
-    task_vars = args_with_template
 
-    _process_module_args(args_with_template, templar, "dfhlrq", task_vars, False)
+    _process_module_args(args_with_template, "dfhlrq", False)
 
     assert args_with_template == {
         "region_data_sets": {
@@ -152,10 +132,8 @@ def test_data_set_with_le_data_sets_arg():
         "space_type": "m",
         "state": "initial"
     }
-    templar = get_templar(args_with_template)
-    task_vars = args_with_template
 
-    _process_module_args(args_with_template, templar, "dfhlrq", task_vars, False)
+    _process_module_args(args_with_template, "dfhlrq", False)
 
     assert args_with_template == {
         "region_data_sets": {
@@ -176,10 +154,8 @@ def test_data_set_with_cpsm_data_sets_arg():
         "space_type": "m",
         "state": "initial"
     }
-    templar = get_templar(args_with_template)
-    task_vars = args_with_template
 
-    _process_module_args(args_with_template, templar, "dfhlrq", task_vars, False)
+    _process_module_args(args_with_template, "dfhlrq", False)
 
     assert args_with_template == {
         "region_data_sets": {
@@ -200,10 +176,8 @@ def test_data_set_with_required_cics_data_sets_templated():
         "space_type": "m",
         "state": "initial"
     }
-    templar = get_templar(args_with_template)
-    task_vars = args_with_template
 
-    _process_module_args(args_with_template, templar, "dfhgcd", task_vars, True)
+    _process_module_args(args_with_template, "dfhgcd", True)
 
     assert args_with_template == {
         "region_data_sets": {