add capability to append or update an existing variable file with injector

CarolynRountree · CarolynRountree · commit 6f9f06dfd086 · 2018-05-24T15:54:21.000-05:00
diff --git a/core/src/main/python/discover.py b/core/src/main/python/discover.py
@@ -22,7 +22,6 @@
 from oracle.weblogic.deploy.util import WebLogicDeployToolingVersion
 from oracle.weblogic.deploy.util import WLSDeployArchive
 from oracle.weblogic.deploy.util import WLSDeployArchiveIOException
-from oracle.weblogic.deploy.validate import ValidateException
 
 sys.path.append(os.path.dirname(os.path.realpath(sys.argv[0])))
 
@@ -37,7 +36,6 @@
 from wlsdeploy.tool.discover.multi_tenant_discoverer import MultiTenantDiscoverer
 from wlsdeploy.tool.discover.resources_discoverer import ResourcesDiscoverer
 from wlsdeploy.tool.discover.topology_discoverer import TopologyDiscoverer
-from wlsdeploy.tool.validate.validator import Validator
 from wlsdeploy.tool.util import filter_helper
 from wlsdeploy.util import wlst_helper
 from wlsdeploy.util import model_translator
@@ -369,18 +367,20 @@ def __check_and_customize_model(model, model_context):
     if filter_helper.apply_filters(model.get_model(), "discover"):
         __logger.info('WLSDPLY-06014', _class_name=_class_name, method_name=_method_name)
 
-    inserted, variable_model, variable_file_name = VariableInjector(model.get_model(), model_context, WebLogicHelper(
-        __logger).get_actual_weblogic_version()).inject_variables_keyword_file()
+    inserted, variable_model, variable_file_name = VariableInjector(_program_name, model.get_model(), model_context,
+                                                                    WebLogicHelper(
+                                                                        __logger).get_actual_weblogic_version()).\
+        inject_variables_keyword_file()
     if inserted:
         model = Model(variable_model)
-    try:
-        validator = Validator(model_context, wlst_mode=__wlst_mode)
-
-        # no variables are generated by the discover tool
-        validator.validate_in_tool_mode(model.get_model(), variables_file_name=variable_file_name,
-                                        archive_file_name=model_context.get_archive_file_name())
-    except ValidateException, ex:
-        __logger.warning('WLSDPLY-06015', ex.getLocalizedMessage(), class_name=_class_name, method_name=_method_name)
+    # try:
+    #     validator = Validator(model_context, wlst_mode=__wlst_mode)
+    #
+    #     # no variables are generated by the discover tool
+    #     validator.validate_in_tool_mode(model.get_model(), variables_file_name=variable_file_name,
+    #                                     archive_file_name=model_context.get_archive_file_name())
+    # except ValidateException, ex:
+    #     __logger.warning('WLSDPLY-06015', ex.getLocalizedMessage(), class_name=_class_name, method_name=_method_name)
     return model
 
 
diff --git a/core/src/main/python/encrypt.py b/core/src/main/python/encrypt.py
@@ -190,7 +190,7 @@ def __encrypt_model_and_variables(model_context):
 
     if variable_change_count > 0:
         try:
-            variable_helper.write_variables(variables, variable_file)
+            variable_helper.write_variables(_program_name, variables, variable_file)
             __logger.info('WLSDPLY-04209', _program_name, variable_change_count, variable_file,
                           class_name=_class_name, method_name=_method_name)
         except VariableException, ve:
diff --git a/core/src/main/python/variable_inject.py b/core/src/main/python/variable_inject.py
@@ -177,8 +177,8 @@ def __inject(model, model_context):
     :param model_context: the model context
     :return: True if variables were inserted into model: The updated model
     """
-    __kwargs[variable_injector.VARIABLE_FILE_APPEND_ARG] = True
-    inserted, variable_model, variable_file_name = VariableInjector(model, model_context,
+    __kwargs[variable_injector.VARIABLE_FILE_APPEND_ARG] = variable_injector.VARIABLE_FILE_UPDATE
+    inserted, variable_model, variable_file_name = VariableInjector(_program_name, model, model_context,
                                                                     WebLogicHelper(
                                                                         __logger).get_actual_weblogic_version()). \
         inject_variables_keyword_file(**__kwargs)
diff --git a/core/src/main/python/wlsdeploy/tool/util/variable_injector.py b/core/src/main/python/wlsdeploy/tool/util/variable_injector.py
@@ -10,7 +10,6 @@
 
 import oracle.weblogic.deploy.aliases.AliasException as AliasException
 import oracle.weblogic.deploy.json.JsonException as JsonException
-import oracle.weblogic.deploy.util.PyOrderedDict as PyOrderedDict
 import oracle.weblogic.deploy.util.VariableException as VariableException
 
 import wlsdeploy.util.model as model_sections
@@ -33,6 +32,9 @@
 VARIABLE_FILE_NAME_ARG = 'variable_file_name'
 VARIABLE_FILE_NAME = 'variables.json'
 VARIABLE_FILE_APPEND_ARG = 'append_to_variables'
+VARIABLE_FILE_APPEND = 'append'
+VARIABLE_FILE_UPDATE = 'update'
+VARIABLE_FILE_APPEND_VALS = [VARIABLE_FILE_APPEND, VARIABLE_FILE_UPDATE]
 # custom keyword in model injector file
 CUSTOM_KEYWORD = 'CUSTOM'
 KEYWORD_FILES = 'file-list'
@@ -59,7 +61,15 @@
 
 class VariableInjector(object):
 
-    def __init__(self, model, model_context=None, version=None):
+    def __init__(self, program_name, model, model_context=None, version=None):
+        """
+        Construct an instance of the injector with the model and information used by the injector.
+        :param program_name: name of the calling tool
+        :param model: to be updated with variables
+        :param model_context: context with command line information
+        :param version: of model if model context is not provided
+        """
+        self.__program_name = program_name
         self.__original = copy.deepcopy(model)
         self.__model = model
         self.__model_context = model_context
@@ -86,7 +96,7 @@ def inject_variables_keyword_file(self, **kwargs):
         _logger.entering(class_name=_class_name, method_name=_method_name)
 
         variable_injector_location_file = _get_variable_injector_file_name(**kwargs)
-        variables_injector_dictionary = _load_variables_file(variable_injector_location_file)
+        variables_injector_dictionary = _load_variable_injector_file(variable_injector_location_file)
         variable_keywords_location_file = _get_variable_keywords_file_name(**kwargs)
         keywords_dictionary = _load_keywords_file(variable_keywords_location_file)
 
@@ -101,12 +111,14 @@ def inject_variables_keyword_file(self, **kwargs):
             else:
                 _logger.info('WLSDPLY-19533', variable_injector_location_file, class_name=_class_name,
                              method_name=_method_name)
-                variable_file_location = self._replace_tokens(variable_file_location)
+                append, stage_dictionary = _load_variable_file(variable_file_location, **kwargs)
                 injector_file_list = _create_injector_file_list(variables_injector_dictionary, keywords_dictionary,
                                                                 _get_keyword_files_location(**kwargs))
                 variables_file_dictionary = self.inject_variables_keyword_dictionary(injector_file_list)
-                variables_inserted = _write_variables_file(variables_file_dictionary, variable_file_location,
-                                                           _get_append_to_variable_file(**kwargs))
+                if variables_file_dictionary:
+                    stage_dictionary.update(variables_file_dictionary)
+                    variables_inserted = self._write_variables_file(stage_dictionary, variable_file_location,
+                                                                    append)
                 if variables_inserted:
                     _logger.info('WLSDPLY-19518', variable_file_location, class_name=_class_name,
                                  method_name=_method_name)
@@ -124,20 +136,20 @@ def inject_variables_keyword_file(self, **kwargs):
     def inject_variables_keyword_dictionary(self, injector_file_list):
         """
         Takes a variable keyword dictionary and returns a variables for file in a dictionary
-        :param injector_file_list:
-        :return:
+        :param injector_file_list: list of injector files for processing variable injection
+        :return: variables_dictionary containing the variable properties to persist to the variable file
         """
         _method_name = 'inject_variables_keyword_dictionary'
         _logger.entering(injector_file_list, class_name=_class_name, method_name=_method_name)
-        variables_dictionary = PyOrderedDict()
+        variable_dictionary = dict()
         for filename in injector_file_list:
             injector_dictionary = _load_injector_file(self._replace_tokens(filename))
             entries = self.inject_variables(injector_dictionary)
             if entries:
                 _logger.finer('WLSDPLY-19513', filename, class_name=_class_name, method_name=_method_name)
-                variables_dictionary.update(entries)
-        _logger.exiting(class_name=_class_name, method_name=_method_name, result=variables_dictionary)
-        return variables_dictionary
+                variable_dictionary.update(entries)
+        _logger.exiting(class_name=_class_name, method_name=_method_name, result=variable_dictionary)
+        return variable_dictionary
 
     def inject_variables(self, injector_dictionary):
         """
@@ -422,7 +434,7 @@ def _log_mbean_not_found(self, mbean, replacement, location):
         code = ValidationCodes.INVALID
         try:
             code, __ = self.__aliases.is_valid_model_folder_name(location, mbean)
-        except AliasException, ae:
+        except AliasException:
             pass
         if code == ValidationCodes.INVALID:
             _logger.warning('WLSDPLY-19515', mbean, replacement, location.get_folder_path(),
@@ -444,8 +456,46 @@ def _get_variable_file_name(self, variables_injector_dictionary, **kwargs):
             _logger.finer('WLSDPLY-19521', variable_file_location, class_name=_class_name, method_name=_method_name)
         else:
             variable_file_location = variables.get_default_variable_file_name(self.__model_context)
+        if variable_file_location:
+            variable_file_location = self._replace_tokens(variable_file_location)
         return variable_file_location
 
+    def _write_variables_file(self, variables_dictionary, variables_file_name, append):
+        _method_name = '_write_variables_file'
+        _logger.entering(variables_dictionary, variables_file_name, class_name=_class_name, method_name=_method_name)
+
+        written = False
+        if variables_dictionary:
+            try:
+                variables.write_variables(self.__program_name, variables_dictionary, variables_file_name, append)
+                written = True
+            except VariableException, ve:
+                _logger.warning('WLSDPLY-19507', variables_file_name, ve.getLocalizedMessage(), class_name=_class_name,
+                                method_name=_method_name)
+        _logger.exiting(class_name=_class_name, method_name=_method_name, result=written)
+        return written
+
+
+def _load_variable_file(variable_file_location, **kwargs):
+    _method_name = '_load_variable_file'
+    append = False
+    variable_dictionary = dict()
+    if VARIABLE_FILE_APPEND_ARG in kwargs and kwargs[VARIABLE_FILE_APPEND_ARG] in VARIABLE_FILE_APPEND_VALS:
+        _logger.fine('append argument found {0}', kwargs[VARIABLE_FILE_APPEND_ARG] )
+        if kwargs[VARIABLE_FILE_APPEND_ARG] == VARIABLE_FILE_APPEND:
+            _logger.fine('WLSDPLY-19536', variable_file_location, class_name=_class_name, method_name=_method_name)
+            append = True
+        elif kwargs[VARIABLE_FILE_APPEND_ARG] == VARIABLE_FILE_UPDATE and os.path.isfile(variable_file_location):
+            _logger.fine('WLSDPLY-19534', variable_file_location, class_name=_class_name, method_name=_method_name)
+            try:
+                variable_dictionary = variables.load_variables(variable_file_location)
+            except VariableException, ve:
+                _logger.warning('WLSDPLY-19537', variable_file_location, ve.getLocalizedMessage(),
+                                class_name=_class_name, method_name=_method_name)
+        else:
+            _logger.fine('WLSDPLY-19535', variable_file_location, class_name=_class_name, method_name=_method_name)
+    return append, variable_dictionary
+
 
 def _get_variable_injector_file_name(**kwargs):
     variable_injector_file_name = VARIABLE_INJECTOR_FILE_NAME
@@ -467,7 +517,7 @@ def _get_variable_keywords_file_name(**kwargs):
         return os.path.join(_wlsdeploy_location, DEFAULT_FILE_LOCATION, variable_keywords_file_name)
 
 
-def _load_variables_file(variable_injector_location):
+def _load_variable_injector_file(variable_injector_location):
     _method_name = '_load_variables_file'
     _logger.entering(variable_injector_location, class_name=_class_name, method_name=_method_name)
     variables_dictionary = None
@@ -555,20 +605,6 @@ def _get_append_to_variable_file(**kwargs):
     return False
 
 
-def _write_variables_file(variables_dictionary, variables_file_name, append):
-    _method_name = '_write_variables_file'
-    _logger.entering(variables_dictionary, variables_file_name, class_name=_class_name, method_name=_method_name)
-
-    written = False
-    if variables_dictionary:
-        try:
-            variables.write_variables(variables_dictionary, variables_file_name, append)
-            written = True
-        except VariableException, ve:
-            _logger.warning('WLSDPLY-19507', variables_file_name, ve.getLocalizedMessage(), class_name=_class_name,
-                            method_name=_method_name)
-    _logger.exiting(class_name=_class_name, method_name=_method_name, result=written)
-    return written
 
 
 def _format_variable_value(value):
diff --git a/core/src/main/python/wlsdeploy/util/variables.py b/core/src/main/python/wlsdeploy/util/variables.py
@@ -58,22 +58,23 @@ def load_variables(file_path):
     return variable_map
 
 
-def write_variables(variable_map, file_path, append=False):
+def write_variables(program_name, variable_map, file_path, append=False):
     """
     Write the dictionary of variables to the specified file.
+    :param program_name: name of tool that invoked the method which will be written to the variable properties file
     :param variable_map: the dictionary of variables
     :param file_path: the file to which to write the properties
     :param append: defaults to False. Append properties to the end of file
     :raises VariableException if an error occurs while storing the variables in the file
     """
     _method_name = 'write_variables'
-    _logger.entering(file_path, append, class_name=_class_name, method_name=_method_name)
+    _logger.entering(program_name, file_path, append, class_name=_class_name, method_name=_method_name)
     props = Properties()
     for key in variable_map:
         value = variable_map[key]
         props.setProperty(key, value)
 
-    comment = exception_helper.get_message('WLSDPLY-01731')
+    comment = exception_helper.get_message('WLSDPLY-01731', program_name)
     output_stream = None
     try:
         output_stream = FileOutputStream(File(file_path), Boolean(append))
diff --git a/core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties b/core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties
@@ -247,7 +247,7 @@ WLSDPLY-01720=to_boolean() method called with non-boolean value {0} so returning
 
 # wlsdeploy/util/variables.py
 WLSDPLY-01730=Failed to load variables file {0}: {1}
-WLSDPLY-01731=Variables updated
+WLSDPLY-01731=Variables updated by {0}
 WLSDPLY-01732=Variable {0} is not found in properties file
 WLSDPLY-01733=Variable file {0} cannot be read: {1}
 WLSDPLY-01734=No value in variable file {0}
@@ -1163,6 +1163,10 @@ WLSDPLY-19531=Invalid location {0} for variable injection into attribute {1} : {
 WLSDPLY-19532=No model variable injector file {0}
 WLSDPLY-19533=Will inject variable replacement strings into model using keyword directions found in model \
   variable injector file {0}
+WLSDPLY-19534=Update existing variable file {0} with injected variables
+WLSDPLY-19535=Create new variable file {0} for injected variables
+WLSDPLY-19536=Append existing variable file {0} with injected variables
+WLSDPLY-19537=Unable to load variables from existing file {0} and will overwrite the file : {1}
 
 # wlsdeploy/tool/variable_inject.py
 WLSDPLY-19600=Use model variable injector file {0} from command line arguments
diff --git a/core/src/test/python/variable_injector_test.py b/core/src/test/python/variable_injector_test.py
@@ -2,6 +2,7 @@
 Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
 The Universal Permissive License (UPL), Version 1.0
 """
+import os
 import unittest
 
 import wlsdeploy.util.variables as variables
@@ -12,7 +13,7 @@
 
 class VariableFileHelperTest(unittest.TestCase):
     _resources_dir = '../../test-classes'
-    _variable_file = _resources_dir + '/variables.properties'
+    _variable_file = _resources_dir + '/variable.injector.test.properties'
     _model_file = _resources_dir + '/variable_insertion.yaml'
     _variable_injector_keyword = 'variable_injector_keyword.json'
     _variable_injector_custom = 'variable_injector_custom.json'
@@ -21,7 +22,7 @@ class VariableFileHelperTest(unittest.TestCase):
     def setUp(self):
         self.name = VariableFileHelperTest
         self._model = FileToPython(self._model_file).parse()
-        self._helper = VariableInjector(self._model, None, '12.2.1.3')
+        self._helper = VariableInjector(self.name, self._model, None, '12.2.1.3')
 
     def testSingleVariableReplacement(self):
         replacement_dict = dict()
@@ -223,9 +224,10 @@ def testWithVariableHelperKeywords(self):
             variable_injector_path_name=self._resources_dir,
             variable_injector_file_name=self._variable_injector_keyword,
             variable_keywords_path_name=self._resources_dir, variable_keywords_file_name=self._keywords_file)
-        self.assertEqual(True, inserted)
         self.assertEqual(self._variable_file, variable_file_name)
+        self.assertEqual(True, inserted)
         actual = variables.load_variables(self._variable_file)
+        print actual
         self._compare_to_expected_dictionary(expected, actual)
 
     def _compare_to_expected_dictionary(self, expected, actual):
diff --git a/core/src/test/resources/variable_injector_keyword.json b/core/src/test/resources/variable_injector_keyword.json
@@ -1,5 +1,5 @@
 {
-  "variable_file_name": "../../test-classes/variables.properties",
+  "variable_file_name": "../../test-classes/variable.injector.test.properties",
   "PORT": {},
   "URL": {},
   "CREDENTIALS": {}

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "variable_file_name": "../../test-classes/variables.properties",`
	`2`	`+ "variable_file_name": "../../test-classes/variable.injector.test.properties",`
`3`	`3`	`"PORT": {},`
`4`	`4`	`"URL": {},`
`5`	`5`	`"CREDENTIALS": {}`