Correct variable tokens at discover time (#720)

* Issue #708 - Remove illegal characters from variable name during discovery

* Issue #708 - Corrected test

* Issue #708 - Use cleaned resource name to find a user match

Author: rakillen

core/src/main/python/wlsdeploy/tool/util/variable_injector_functions.py

@@ -17,6 +17,9 @@
 _fake_name_replacement = re.compile('.' + _fake_name_marker)
 _white_space_replacement = re.compile('\s')
 
+# bad characters for a property name - anything that isn't a good character
+_bad_chars_replacement = re.compile('[^\\w.-]')
+
 
 def managed_server_list(model):
     """
@@ -76,11 +79,20 @@ def format_variable_name(location, attribute, aliases):
         if node is not None and len(node) > 0:
             short_name += node + '.'
     short_name += attribute
+    return clean_property_name(short_name)
+
 
-    short_name = short_name.replace('/', '.')
-    short_name = _white_space_replacement.sub('-', short_name)
-    short_name = _fake_name_replacement.sub('', short_name)
-    return short_name
+def clean_property_name(name):
+    """
+    Remove or replace invalid characters in the variable name for use as a property name.
+    :param name: the name to be cleaned
+    :return: the revised name
+    """
+    name = name.replace('/', '.')
+    name = _white_space_replacement.sub('-', name)
+    name = _bad_chars_replacement.sub('-', name)
+    name = _fake_name_replacement.sub('', name)
+    return name
 
 
 def __traverse_location(iterate_location, attribute, name_list, aliases, last_folder=None, last_folder_short=None):

core/src/main/python/wlsdeploy/util/target_configuration_helper.py

@@ -230,7 +230,14 @@ def find_user_name(property_name, model_dictionary):
         name = matches[0]
         resources = dictionary_utils.get_dictionary_element(model_dictionary, RESOURCES)
         system_resources = dictionary_utils.get_dictionary_element(resources, JDBC_SYSTEM_RESOURCE)
-        datasource = dictionary_utils.get_dictionary_element(system_resources, name)
+
+        # the property name has already been "cleaned", so clean resource name to find a match
+        datasource = {}
+        for resource_name in system_resources:
+            resource_property_name = variable_injector_functions.clean_property_name(resource_name)
+            if name == resource_property_name:
+                datasource = dictionary_utils.get_dictionary_element(system_resources, resource_name)
+
         jdbc_resources = dictionary_utils.get_dictionary_element(datasource, JDBC_RESOURCE)
         driver_params = dictionary_utils.get_dictionary_element(jdbc_resources, JDBC_DRIVER_PARAMS)
         properties = dictionary_utils.get_dictionary_element(driver_params, PROPERTIES)

core/src/test/python/wlsdeploy/tool/util/variable_injector_functions_test.py

@@ -0,0 +1,66 @@
+"""
+Copyright (c) 2020, Oracle Corporation and/or its affiliates.  All rights reserved.
+The Universal Permissive License (UPL), Version 1.0
+"""
+
+import unittest
+
+from wlsdeploy.aliases.aliases import Aliases
+from wlsdeploy.aliases.location_context import LocationContext
+from wlsdeploy.aliases.model_constants import MACHINE
+from wlsdeploy.tool.util import variable_injector_functions
+from wlsdeploy.util import variables
+from wlsdeploy.util.model_context import ModelContext
+
+
+class VariableInjectorFunctionsTests(unittest.TestCase):
+    """
+    Test the variable injector functions methods.
+    """
+    wls_version = '12.2.1.3'
+    attribute_name = 'Notes'
+
+    def setUp(self):
+        model_context = ModelContext("test", {})
+        self.aliases = Aliases(model_context)
+        self.location = LocationContext().append_location(MACHINE)
+        self.name_token = self.aliases.get_name_token(self.location)
+        self.short_name = self.aliases.get_folder_short_name(self.location)
+
+    def testFormatVariableName(self):
+        """
+        Verify that names from location are converted to valid variable names.
+        """
+        # spaces in model name
+        self._check_name('My Machine', 'My-Machine')
+
+        # parenthesis can be in model name
+        self._check_name('ohMy-(datasource)', 'ohMy--datasource-')
+
+        # versioned library names may be model names
+        self._check_name('Lib.oracle.wsm.idmrest.sharedlib#1.0@12.2.1.3.Target',
+                         'Lib.oracle.wsm.idmrest.sharedlib-1.0-12.2.1.3.Target')
+
+    def _check_name(self, name, expected_key):
+        """
+        Verify that the specified name is converted to match the expected key.
+        A machine location is created with the supplied name and converted to a variable name.
+        An expected value is constructed using the expected key and known parameters.
+        :param name: the name to be converted
+        :param expected_key: the expected variable key
+        """
+        self.location.add_name_token(self.name_token, name)
+        variable_name = variable_injector_functions.format_variable_name(self.location, self.attribute_name,
+                                                                         self.aliases)
+
+        # verify that a property built with this value will parse correctly
+        property_text = '@@PROP:%s@@' % variable_name
+        matches = variables._property_pattern.findall(property_text)
+        self.assertEqual(1, len(matches), "Property %s should parse correctly" % property_text)
+
+        expected_name = "%s.%s.%s" % (self.short_name, expected_key, self.attribute_name)
+        self.assertEqual(expected_name, variable_name)
+
+
+if __name__ == '__main__':
+    unittest.main()