Add managedserver keyword

Author: CarolynRountree

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

@@ -12,6 +12,7 @@
 import oracle.weblogic.deploy.json.JsonException as JsonException
 import oracle.weblogic.deploy.util.VariableException as VariableException
 
+import wlsdeploy.tool.util.variable_injector_functions as variable_injector_functions
 import wlsdeploy.util.model as model_sections
 import wlsdeploy.util.variables as variables
 from wlsdeploy.aliases.aliases import Aliases
@@ -22,6 +23,8 @@
 from wlsdeploy.logging.platform_logger import PlatformLogger
 
 WEBLOGIC_DEPLOY_HOME_TOKEN = '@@WLSDEPLOY@@'
+
+# KWARGS to modify how files are found and loaded on the inject_variables_keyword_file(..) function
 VARIABLE_INJECTOR_FILE_NAME = 'model_variable_injector.json'
 VARIABLE_KEYWORDS_FILE_NAME = 'variable_keywords.json'
 VARIABLE_INJECTOR_PATH_NAME_ARG = 'variable_injector_path_name'
@@ -35,6 +38,8 @@
 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'
@@ -49,6 +54,17 @@
 
 VARIABLE_SEP = '.'
 SUFFIX_SEP = '--'
+
+MANAGED_SERVERS = 'MANAGED_SERVERS'
+ADMIN_SERVER = 'ADMIN_SERVER'
+
+# This could be changed into a loaded file so that others can add their own bits of code to
+# selectively identify which names in an mbean list should be injected with properties
+USER_KEYWORD_DICT = {
+    MANAGED_SERVERS: 'managed_server_list',
+    ADMIN_SERVER: 'admin_server_list'
+}
+# global variables for functions in VariableInjector
 _find_special_names_pattern = re.compile('[\[).+\]]')
 _fake_name_marker = 'fakename'
 _fake_name_replacement = re.compile('.' + _fake_name_marker)
@@ -179,7 +195,7 @@ def __inject_variable(self, location, injector, injector_values):
         def _traverse_variables(model_section, mbean_list):
             if mbean_list:
                 mbean = mbean_list.pop(0)
-                mbean, mbean_name_list = _find_special_name(mbean)
+                mbean, mbean_name_list = self._find_special_name(mbean)
                 _logger.finer('WLSDPLY-19523', mbean, location.get_folder_path(), class_name=_class_name,
                               method_name=_method_name)
                 if mbean in model_section:
@@ -221,7 +237,7 @@ def _traverse_variables(model_section, mbean_list):
         section = self.__model
         if start_mbean_list:
             # Find out in what section is the mbean top folder so can move to that section in the model
-            top_mbean, __ = _find_special_name(start_mbean_list[0])
+            top_mbean, __ = self._find_special_name(start_mbean_list[0])
             for entry in self.__section_keys:
                 if entry in self.__model and top_mbean in self.__model[entry]:
                     section = self.__model[entry]
@@ -442,7 +458,7 @@ def _log_mbean_not_found(self, mbean, replacement, location):
         else:
             _logger.finer('WLSDPLY-19516', mbean, replacement, location.get_folder_path(),
                           class_name=_class_name, method_name=_method_name)
-    
+
     def _get_variable_file_name(self, variables_injector_dictionary, **kwargs):
         _method_name = '_get_variable_file_name'
         if VARIABLE_FILE_NAME_ARG in kwargs:
@@ -475,13 +491,38 @@ def _write_variables_file(self, variables_dictionary, variables_file_name, appen
         _logger.exiting(class_name=_class_name, method_name=_method_name, result=written)
         return written
 
+    def _find_special_name(self, mbean):
+        mbean_name = mbean
+        mbean_name_list = []
+        name_list = _find_special_names_pattern.split(mbean)
+        if name_list and len(name_list) > 1:
+            mbean_name = name_list[0]
+            mbean_name_list = name_list[1].split(',')
+        if mbean_name_list:
+            new_list = []
+            for entry in mbean_name_list:
+                if entry in USER_KEYWORD_DICT:
+                    _logger.fine('WLSDPLY-19538', entry, mbean)
+                    try:
+                        method = getattr(variable_injector_functions, USER_KEYWORD_DICT[entry])
+                        append_list = method(self.__model)
+                        new_list.extend(append_list)
+                    except AttributeError, e:
+                        _logger.warning('WLSDPLY-19539', entry, USER_KEYWORD_DICT[entry], e)
+                        new_list = mbean_name_list
+                        break
+                else:
+                    new_list.append(entry)
+            mbean_name_list = new_list
+        return mbean_name, mbean_name_list
+
 
 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] )
+        _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
@@ -605,8 +646,6 @@ def _get_append_to_variable_file(**kwargs):
     return False
 
 
-
-
 def _format_variable_value(value):
     if type(value) == bool:
         if value:
@@ -667,16 +706,6 @@ def _split_injector(injector_path):
     return ml, attr
 
 
-def _find_special_name(mbean):
-    mbean_name = mbean
-    mbean_name_list = []
-    name_list = _find_special_names_pattern.split(mbean)
-    if name_list and len(name_list) > 1:
-        mbean_name = name_list[0]
-        mbean_name_list = name_list[1].split(',')
-    return mbean_name, mbean_name_list
-
-
 def __temporary_fix(injector_dictionary):
     # this is very dangerous - for now, if you want to escape a backslash, need to do 4 backslash.
     _method_name = '__temporary_fix'

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

@@ -0,0 +1,51 @@
+"""
+Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+The Universal Permissive License (UPL), Version 1.0
+"""
+from wlsdeploy.logging.platform_logger import PlatformLogger
+
+import wlsdeploy.aliases.model_constants as model_constants
+import wlsdeploy.util.model as model_sections
+
+_class_name = 'variable_injector'
+_logger = PlatformLogger('wlsdeploy.tool.util')
+
+
+def managed_server_list(model):
+    """
+    Return a managed server name list from the provided model.
+    :param model: to process for managed server list
+    :return: list of managed server names or empty list if no managed servers
+    """
+    _method_name = 'managed_server_list'
+    _logger.entering(class_name=_class_name, method_name=_method_name)
+    ms_name_list = []
+    topology_constant = model_sections.get_model_topology_key()
+    if topology_constant in model:
+        topology = model[topology_constant]
+        if model_constants.SERVER in topology:
+            ms_name_list = topology[model_constants.SERVER].keys()
+            if model_constants.ADMIN_SERVER_NAME in topology:
+                admin_server = topology[model_constants.ADMIN_SERVER_NAME]
+                if admin_server in ms_name_list:
+                    ms_name_list.remove(admin_server)
+    _logger.exiting(class_name=_class_name, method_name=_method_name, result=ms_name_list)
+    return ms_name_list
+
+
+def admin_server_list(model):
+    """
+    Return the domain admin server in list format
+    :param model: to process for admin server list
+    :return: admin server in list format
+    """
+    _method_name = 'admin_server_list'
+    _logger.entering(class_name=_class_name, method_name=_method_name)
+    as_name_list = []
+    topology_constant = model_sections.get_model_topology_key()
+    if topology_constant in model:
+        topology = model[topology_constant]
+        if topology and model_constants.ADMIN_SERVER_NAME in topology:
+            as_name_list.append(topology[model_constants.ADMIN_SERVER_NAME])
+    _logger.exiting(class_name=_class_name, method_name=_method_name, result=as_name_list)
+    return as_name_list

core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties

@@ -1167,6 +1167,9 @@ 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}
+WLSDPLY-19538=Found name keyword {0} for mbean {1}
+WLSDPLY-19539=Unable to locate and call mbean name keyword {0} method {1} : {2}. Will inject variables using \
+  full mbean name list
 
 # wlsdeploy/tool/variable_inject.py
 WLSDPLY-19600=Use model variable injector file {0} from command line arguments

core/src/test/python/variable_injector_test.py

@@ -210,6 +210,25 @@ def testWithListMBeanName(self):
         actual = self._helper.inject_variables(replacement_dict)
         self._compare_to_expected_dictionary(expected, actual)
 
+    def testWithManagedServerKeyword(self):
+        expected = dict()
+        expected['Server.m1.SSL.Enabled'] = 'True'
+        expected['Server.m2.SSL.Enabled'] = 'True'
+        replacement_dict = dict()
+        replacement_dict['Server[MANAGED_SERVERS].SSL.Enabled'] = dict()
+        actual = self._helper.inject_variables(replacement_dict)
+        self._compare_to_expected_dictionary(expected, actual)
+
+    def testWithMultiKeyword(self):
+        expected = dict()
+        expected['Server.AdminServer.SSL.Enabled'] = 'True'
+        expected['Server.m1.SSL.Enabled'] = 'True'
+        expected['Server.m2.SSL.Enabled'] = 'True'
+        replacement_dict = dict()
+        replacement_dict['Server[MANAGED_SERVERS,ADMIN_SERVER].SSL.Enabled'] = dict()
+        actual = self._helper.inject_variables(replacement_dict)
+        self._compare_to_expected_dictionary(expected, actual)
+
     def testWithVariableHelperKeywords(self):
         expected = dict()
         expected['JMSSystemResource.MyJmsModule.JmsResource.ForeignServer.MyForeignServer.ConnectionURL'] \

installer/src/main/samples/custom_injector.json

@@ -11,5 +11,6 @@
         "suffix": "Host"
       }
     ]
-  }
+  },
+  "Server[MANAGED_SERVERS].SSL.Enabled": {}
 }