JIRA WDT-371 - Use variable map for model merge to find matching names (#455)

Author: rakillen

core/src/main/python/create.py

@@ -385,19 +385,26 @@ def main(args):
         model_context = ModelContext(_program_name, dict())
         tool_exit.end(model_context, exit_code)
 
+    variable_map = {}
+    try:
+        if model_context.get_variable_file():
+            variable_map = variables.load_variables(model_context.get_variable_file())
+    except VariableException, ex:
+        __logger.severe('WLSDPLY-20004', _program_name, ex.getLocalizedMessage(), error=ex,
+                        class_name=_class_name, method_name=_method_name)
+        cla_helper.clean_up_temp_files()
+        tool_exit.end(model_context, CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
+
     model_file_value = model_context.get_model_file()
     try:
-        model = cla_helper.merge_model_files(model_file_value)
+        model = cla_helper.merge_model_files(model_file_value, variable_map)
     except TranslateException, te:
         __logger.severe('WLSDPLY-20009', _program_name, model_file_value, te.getLocalizedMessage(), error=te,
                         class_name=_class_name, method_name=_method_name)
         cla_helper.clean_up_temp_files()
         tool_exit.end(model_context, CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
 
     try:
-        variable_map = {}
-        if model_context.get_variable_file():
-            variable_map = variables.load_variables(model_context.get_variable_file())
         variables.substitute(model, variable_map, model_context)
     except VariableException, ex:
         __logger.severe('WLSDPLY-20004', _program_name, ex.getLocalizedMessage(), error=ex,

core/src/main/python/deploy.py

@@ -409,19 +409,26 @@ def main(args):
         model_context = ModelContext(_program_name, dict())
         tool_exit.end(model_context, exit_code)
 
+    variable_map = {}
+    try:
+        if model_context.get_variable_file():
+            variable_map = variables.load_variables(model_context.get_variable_file())
+    except VariableException, ex:
+        __logger.severe('WLSDPLY-20004', _program_name, ex.getLocalizedMessage(), error=ex,
+                        class_name=_class_name, method_name=_method_name)
+        cla_helper.clean_up_temp_files()
+        tool_exit.end(model_context, CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
+
     model_file_value = model_context.get_model_file()
     try:
-        model_dictionary = cla_helper.merge_model_files(model_file_value)
+        model_dictionary = cla_helper.merge_model_files(model_file_value, variable_map)
     except TranslateException, te:
         __logger.severe('WLSDPLY-09014', _program_name, model_file_value, te.getLocalizedMessage(), error=te,
                         class_name=_class_name, method_name=_method_name)
         cla_helper.clean_up_temp_files()
         tool_exit.end(model_context, CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
 
     try:
-        variable_map = {}
-        if model_context.get_variable_file():
-            variable_map = variables.load_variables(model_context.get_variable_file())
         variables.substitute(model_dictionary, variable_map, model_context)
     except VariableException, ex:
         __logger.severe('WLSDPLY-20004', _program_name, ex.getLocalizedMessage(), error=ex,

core/src/main/python/update.py

@@ -427,19 +427,26 @@ def main(args):
         model_context = ModelContext(_program_name, dict())
         tool_exit.end(model_context, exit_code)
 
+    variable_map = {}
+    try:
+        if model_context.get_variable_file():
+            variable_map = variables.load_variables(model_context.get_variable_file())
+    except VariableException, ex:
+        __logger.severe('WLSDPLY-20004', _program_name, ex.getLocalizedMessage(), error=ex,
+                        class_name=_class_name, method_name=_method_name)
+        cla_helper.clean_up_temp_files()
+        tool_exit.end(model_context, CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
+
     model_file_value = model_context.get_model_file()
     try:
-        model_dictionary = cla_helper.merge_model_files(model_file_value)
+        model_dictionary = cla_helper.merge_model_files(model_file_value, variable_map)
     except TranslateException, te:
         __logger.severe('WLSDPLY-09014', _program_name, model_file_value, te.getLocalizedMessage(), error=te,
                         class_name=_class_name, method_name=_method_name)
         cla_helper.clean_up_temp_files()
         tool_exit.end(model_context, CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
 
     try:
-        variable_map = {}
-        if model_context.get_variable_file():
-            variable_map = variables.load_variables(model_context.get_variable_file())
         variables.substitute(model_dictionary, variable_map, model_context)
     except VariableException, ex:
         __logger.severe('WLSDPLY-20004', _program_name, ex.getLocalizedMessage(), error=ex,

core/src/main/python/validate.py

@@ -175,9 +175,10 @@ def __perform_model_file_validation(model_file_name, model_context):
                       class_name=_class_name, method_name=_method_name)
 
     try:
-        model_dictionary = cla_helper.merge_model_files(model_file_name)
         model_validator = Validator(model_context, logger=__logger)
-        model_validator.validate_in_standalone_mode(model_dictionary, model_context.get_variable_file(),
+        variable_map = model_validator.load_variables(model_context.get_variable_file())
+        model_dictionary = cla_helper.merge_model_files(model_file_name, variable_map)
+        model_validator.validate_in_standalone_mode(model_dictionary, variable_map,
                                                     model_context.get_archive_file_name())
     except TranslateException, te:
         __logger.severe('WLSDPLY-20009', _program_name, model_file_name, te.getLocalizedMessage(),

core/src/main/python/wlsdeploy/tool/validate/validator.py

@@ -96,7 +96,7 @@ def __init__(self, model_context, aliases=None, logger=None, wlst_mode=None, dom
         self._model_file_name = self._model_context.get_model_file()
         return
 
-    def validate_in_standalone_mode(self, model_dict, variables_file_name=None, archive_file_name=None):
+    def validate_in_standalone_mode(self, model_dict, variable_map, archive_file_name=None):
         """
         Performs model file validate and returns a ValidationResults object.
 
@@ -105,8 +105,7 @@ def validate_in_standalone_mode(self, model_dict, variables_file_name=None, arch
         ones, followed by error-related ones.
 
         :param model_dict: A Python dictionary of the model to be validated
-        :param variables_file_name: Path to file containing variable substitution data used with model file.
-        Defaults to None.
+        :param variable_map: Map used for variable substitution
         :param archive_file_name: Path to file containing binaries associated with the model file.
         Defaults to None.
         :raises ValidationException: if an AliasException is raised during an invocation of an aliases API call.
@@ -119,9 +118,9 @@ def validate_in_standalone_mode(self, model_dict, variables_file_name=None, arch
         # actually require changes to be made to the cloned model dictionary
         cloned_model_dict = copy.deepcopy(model_dict)
 
-        self._logger.entering(variables_file_name, archive_file_name, class_name=_class_name, method_name=_method_name)
+        self._logger.entering(archive_file_name, class_name=_class_name, method_name=_method_name)
         self._validation_mode = _ValidationModes.STANDALONE
-        self.__validate_model_file(cloned_model_dict, variables_file_name, archive_file_name)
+        self.__validate_model_file(cloned_model_dict, variable_map, archive_file_name)
 
         self._logger.exiting(class_name=_class_name, method_name=_method_name)
 
@@ -156,7 +155,8 @@ def validate_in_tool_mode(self, model_dict, variables_file_name=None, archive_fi
         self._logger.entering(variables_file_name, archive_file_name, class_name=_class_name, method_name=_method_name)
         return_code = Validator.ReturnCode.STOP
         self._validation_mode = _ValidationModes.TOOL
-        self.__validate_model_file(cloned_model_dict, variables_file_name, archive_file_name)
+        variable_map = self.load_variables(variables_file_name)
+        self.__validate_model_file(cloned_model_dict, variable_map, archive_file_name)
 
         status = Validator.ValidationStatus.VALID
 
@@ -223,23 +223,20 @@ def __get_attribute_log_value(self, attribute_name, attribute_value, attribute_i
                 result = '<masked>'
         return result
 
-    def __validate_model_file(self, model_dict, variables_file_name, archive_file_name):
+    def __validate_model_file(self, model_dict, variables_map, archive_file_name):
         _method_name = '__validate_model_file'
 
         self.__pre_validation_setup(model_dict, archive_file_name)
 
-        self._logger.entering(variables_file_name, archive_file_name, class_name=_class_name, method_name=_method_name)
+        self._logger.entering(archive_file_name, class_name=_class_name, method_name=_method_name)
         self._logger.info('WLSDPLY-05002', _ValidationModes.from_value(self._validation_mode), self._wls_version,
                           WlstModes.from_value(self._wlst_mode), class_name=_class_name, method_name=_method_name)
 
         if self._model_file_name is not None:
             self._logger.info('WLSDPLY-05003', self._model_file_name, class_name=_class_name, method_name=_method_name)
 
         try:
-            if variables_file_name is not None:
-                self._logger.info('WLSDPLY-05004', variables_file_name, class_name=_class_name,
-                                  method_name=_method_name)
-                self._variable_properties = variables.load_variables(variables_file_name)
+            self._variable_properties = variables_map
             variables.substitute(model_dict, self._variable_properties, self._model_context)
         except VariableException, ve:
             ex = exception_helper.create_validate_exception('WLSDPLY-20004', 'validateModel',
@@ -270,6 +267,26 @@ def __validate_model_file(self, model_dict, variables_file_name, archive_file_na
         self._logger.exiting(class_name=_class_name, method_name=_method_name)
         return
 
+    def load_variables(self, variables_file_name):
+        """
+        Load the variables properties from the specified file.
+        :param variables_file_name: the name of the variables file, or None if not specified
+        :return: the variables properties
+        """
+        _method_name = 'load_variables'
+
+        try:
+            if variables_file_name is not None:
+                self._logger.info('WLSDPLY-05004', variables_file_name, class_name=_class_name,
+                                  method_name=_method_name)
+                return variables.load_variables(variables_file_name)
+            return {}
+        except VariableException, ve:
+            ex = exception_helper.create_validate_exception('WLSDPLY-20004', 'validateModel',
+                                                            ve.getLocalizedMessage(), error=ve)
+            self._logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+            raise ex
+
     def __pre_validation_setup(self, model_dict, archive_file_name):
         """
         Performs pre-validation setup activities. These include things like:

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

@@ -10,6 +10,7 @@
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.logging.platform_logger import PlatformLogger
 from wlsdeploy.util import cla_utils
+from wlsdeploy.util import variables
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
 from wlsdeploy.util.model_translator import FileToPython
 
@@ -115,10 +116,11 @@ def clean_up_temp_files():
         __tmp_model_dir = None
 
 
-def merge_model_files(model_file_value):
+def merge_model_files(model_file_value, variable_map=None):
     """
     Merge the model files specified by the model file value.
     It may be a single file, or a comma-separated list of files.
+    :param variable_map: variables to be used for name resolution, or None
     :param model_file_value: the value specified as a command argument
     :return: the merge model dictionary
     """
@@ -127,24 +129,50 @@ def merge_model_files(model_file_value):
 
     for model_file in model_files:
         model = FileToPython(model_file, True).parse()
-        _merge_dictionaries(merged_model, model)
+        _merge_dictionaries(merged_model, model, variable_map)
 
     return merged_model
 
 
-def _merge_dictionaries(dictionary, new_dictionary):
+def _merge_dictionaries(dictionary, new_dictionary, variable_map):
     """
     Merge the values from the new dictionary to the existing one.
+    Use variables to resolve keys.
     :param dictionary: the existing dictionary
     :param new_dictionary: the new dictionary to be merged
+    :param variable_map: variables to be used for name resolution, or None
     """
-    for key in new_dictionary:
-        new_value = new_dictionary[key]
-        if key not in dictionary:
-            dictionary[key] = new_value
+    for new_key in new_dictionary:
+        new_value = new_dictionary[new_key]
+        dictionary_key = _find_dictionary_key(dictionary, new_key, variable_map)
+        if dictionary_key is None:
+            dictionary[new_key] = new_value
         else:
-            value = dictionary[key]
+            value = dictionary[dictionary_key]
             if isinstance(value, dict) and isinstance(new_value, dict):
-                _merge_dictionaries(value, new_value)
+                _merge_dictionaries(value, new_value, variable_map)
             else:
-                dictionary[key] = new_value
+                dictionary[new_key] = new_value
+
+
+def _find_dictionary_key(dictionary, new_key, variable_map):
+    """
+    Find the specified key in the specified dictionary.
+    If a direct match is not found, and a variable map is specified, perform a more thorough check,
+    taking into account variable substitution.
+    :param dictionary: the dictionary to be searched
+    :param new_key: the key being checked
+    :param variable_map: variables to be used for name resolution, or None
+    :return: the corresponding key from the dictionary
+    """
+    if new_key in dictionary:
+        return new_key
+
+    if variable_map is not None:
+        actual_new_key = variables.substitute_key(new_key, variable_map)
+        for key in dictionary.keys():
+            actual_key = variables.substitute_key(key, variable_map)
+            if actual_key == actual_new_key:
+                return key
+
+    return None

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

@@ -266,3 +266,22 @@ def _read_value_from_file(file_path, model_context):
         raise ex
 
     return str(line).strip()
+
+
+def substitute_key(text, variables):
+    """
+    Substitute any @@PROP values in the text and return.
+    If the corresponding variable is not found, leave the @@PROP value in place.
+    The deprecated ${} notation is not resolved.
+    :param text: the text to be evaluated
+    :param variables: the variable map
+    :return: the substituted text value
+    """
+    tokens = _property_pattern.findall(text)
+    if tokens:
+        for token in tokens:
+            key = token[7:-2]
+            if key in variables:
+                value = variables[key]
+                text = text.replace(token, value)
+    return text