Wdt automate tokenize credentials (#473)

* tokenize credentials in the model

* special cases handled. updated discoverDomain scripts

* Update discover.md

* change variable file INFO message

* Update discover.md

* validate variable file is different in create,update,deploy and discover

* shorten token names. correct variable file default used

* put short name in alias definition

* use common short name

Author: CarolynRountree

core/src/main/python/create.py

@@ -16,7 +16,6 @@
 from oracle.weblogic.deploy.util import FileUtils
 from oracle.weblogic.deploy.util import TranslateException
 from oracle.weblogic.deploy.util import VariableException
-from oracle.weblogic.deploy.util import WLSDeployArchive
 from oracle.weblogic.deploy.util import WLSDeployArchiveIOException
 from oracle.weblogic.deploy.util import WebLogicDeployToolingVersion
 from oracle.weblogic.deploy.validate import ValidateException
@@ -191,6 +190,7 @@ def __process_model_args(optional_arg_map):
     # this requirement is specific to create, other tools will verify it.
 
     cla_helper.validate_model_present(_program_name, optional_arg_map)
+    cla_helper.validate_variable_file_exists(_program_name, optional_arg_map)
     return
 
 

core/src/main/python/deploy.py

@@ -126,6 +126,7 @@ def __process_model_args(optional_arg_map):
     """
     cla_helper.validate_optional_archive(_program_name, optional_arg_map)
     cla_helper.validate_model_present(_program_name, optional_arg_map)
+    cla_helper.validate_variable_file_exists(_program_name, optional_arg_map)
     return
 
 

core/src/main/python/discover.py

@@ -71,7 +71,7 @@
     # Used by shell script to locate WLST
     CommandLineArgUtil.MODEL_FILE_SWITCH,
     CommandLineArgUtil.DOMAIN_TYPE_SWITCH,
-    CommandLineArgUtil.VARIABLE_PROPERTIES_FILE_SWITCH,
+    CommandLineArgUtil.VARIABLE_FILE_SWITCH,
     CommandLineArgUtil.ADMIN_URL_SWITCH,
     CommandLineArgUtil.ADMIN_USER_SWITCH,
     CommandLineArgUtil.ADMIN_PASS_SWITCH,
@@ -189,20 +189,20 @@ def __process_variable_filename_arg(optional_arg_map):
     """
     _method_name = '__process_variable_filename_arg'
 
-    if CommandLineArgUtil.VARIABLE_PROPERTIES_FILE_SWITCH in optional_arg_map:
-        variable_injector_file_name = variable_injector.get_default_variable_injector_file_name()
+    if CommandLineArgUtil.VARIABLE_FILE_SWITCH in optional_arg_map:
+        variable_injector_file_name = optional_arg_map[CommandLineArgUtil.VARIABLE_FILE_SWITCH]
         try:
-            FileUtils.validateExistingFile(variable_injector_file_name)
+            FileUtils.validateWritableFile(variable_injector_file_name)
         except IllegalArgumentException, ie:
             ex = exception_helper.create_cla_exception('WLSDPLY-06021', optional_arg_map[
-                CommandLineArgUtil.VARIABLE_PROPERTIES_FILE_SWITCH], variable_injector_file_name,
+                CommandLineArgUtil.VARIABLE_FILE_SWITCH], variable_injector_file_name,
                                                        ie.getLocalizedMessage(), error=ie)
             __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
             raise ex
     return
 
 
-def __discover(model_context, aliases):
+def __discover(model_context, aliases, injector):
     """
     Populate the model from the domain.
     :param model_context: the model context
@@ -216,14 +216,14 @@ def __discover(model_context, aliases):
     try:
         _add_domain_name(base_location, aliases)
         DomainInfoDiscoverer(model_context, model.get_model_domain_info(), base_location, wlst_mode=__wlst_mode,
-                             aliases=aliases).discover()
+                             aliases=aliases, variable_injector=injector).discover()
         TopologyDiscoverer(model_context, model.get_model_topology(), base_location, wlst_mode=__wlst_mode,
-                           aliases=aliases).discover()
+                           aliases=aliases, variable_injector=injector).discover()
         ResourcesDiscoverer(model_context, model.get_model_resources(), base_location, wlst_mode=__wlst_mode,
-                            aliases=aliases).discover()
+                            aliases=aliases, variable_injector=injector).discover()
         DeploymentsDiscoverer(model_context, model.get_model_app_deployments(), base_location, wlst_mode=__wlst_mode,
-                              aliases=aliases).discover()
-        __discover_multi_tenant(model, model_context, base_location, aliases)
+                              aliases=aliases, variable_injector=injector).discover()
+        __discover_multi_tenant(model, model_context, base_location, aliases, injector)
     except AliasException, ae:
         wls_version = WebLogicHelper(__logger).get_actual_weblogic_version()
         wlst_mode = WlstModes.from_value(__wlst_mode)
@@ -255,14 +255,15 @@ def _add_domain_name(location, aliases):
         raise de
 
 
-def __discover_multi_tenant(model, model_context, base_location, aliases):
+def __discover_multi_tenant(model, model_context, base_location, aliases, injector):
     """
     Discover the multi-tenant-related parts of the domain, if they exist.
     :param model: the model object to populate
     :param model_context: the model context object
     :raises DiscoverException: if an error occurs during discovery
     """
-    MultiTenantDiscoverer(model, model_context, base_location, wlst_mode=__wlst_mode, aliases=aliases).discover()
+    MultiTenantDiscoverer(model, model_context, base_location,
+                          wlst_mode=__wlst_mode, aliases=aliases, variable_injector=injector).discover()
     return
 
 
@@ -423,7 +424,7 @@ def __persist_model(model, model_context):
     return
 
 
-def __check_and_customize_model(model, model_context, aliases):
+def __check_and_customize_model(model, model_context, aliases, injector):
     """
     Customize the model dictionary before persisting. Validate the model after customization for informational
     purposes. Any validation errors will not stop the discovered model to be persisted.
@@ -435,10 +436,12 @@ def __check_and_customize_model(model, model_context, aliases):
     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(_program_name, model.get_model(), model_context,
-                                                                    WebLogicHelper(
-                                                                        __logger).get_actual_weblogic_version()).\
-        inject_variables_keyword_file()
+    cache = None
+    if injector is not None:
+        cache = injector.get_variable_cache()
+    inserted, variable_model, variable_file_name = \
+        VariableInjector(_program_name, model.get_model(), model_context,
+                         WebLogicHelper(__logger).get_actual_weblogic_version(), cache).inject_variables_keyword_file()
     if inserted:
         model = Model(variable_model)
     try:
@@ -481,7 +484,6 @@ def main(args):
 
     exit_code = CommandLineArgUtil.PROG_OK_EXIT_CODE
 
-    model_context = None
     try:
         model_context = __process_args(args)
     except CLAException, ex:
@@ -503,15 +505,23 @@ def main(args):
 
     aliases = Aliases(model_context, wlst_mode=__wlst_mode)
     model = None
+    discover_injector = None
+    if model_context.get_variable_file() is not None:
+        discover_injector = VariableInjector(_program_name, dict(), model_context,
+                                             WebLogicHelper(__logger).get_actual_weblogic_version())
+
+        __logger.info('WLSDPLY-06025', class_name=_class_name, method_name=_method_name)
+    else:
+        __logger.info('WLSDPLY-06024', class_name=_class_name, method_name=_method_name)
     try:
-        model = __discover(model_context, aliases)
+        model = __discover(model_context, aliases, discover_injector)
     except DiscoverException, ex:
         __logger.severe('WLSDPLY-06011', _program_name, model_context.get_domain_name(),
                         model_context.get_domain_home(), ex.getLocalizedMessage(),
                         error=ex, class_name=_class_name, method_name=_method_name)
         __log_and_exit(model_context, CommandLineArgUtil.PROG_ERROR_EXIT_CODE, _class_name, _method_name)
-        
-    model = __check_and_customize_model(model, model_context, aliases)
+
+    model = __check_and_customize_model(model, model_context, aliases, discover_injector)
 
     try:
         __persist_model(model, model_context)
@@ -525,6 +535,7 @@ def main(args):
 
     __log_and_exit(model_context, exit_code, _class_name, _method_name)
 
+
 if __name__ == '__main__' or __name__ == 'main':
     WebLogicDeployToolingVersion.logVersionInfo(_program_name)
     main(sys.argv)

core/src/main/python/update.py

@@ -135,6 +135,7 @@ def __process_model_args(optional_arg_map):
     """
     cla_helper.validate_optional_archive(_program_name, optional_arg_map)
     cla_helper.validate_model_present(_program_name, optional_arg_map)
+    cla_helper.validate_variable_file_exists(_program_name, optional_arg_map)
     return
 
 

core/src/main/python/variable_inject.py

@@ -310,6 +310,7 @@ def main(args):
     __logger.exiting(result=exit_code, class_name=_class_name, method_name=_method_name)
     sys.exit(exit_code)
 
+
 if __name__ == '__main__' or __name__ == 'main':
     WebLogicDeployToolingVersion.logVersionInfo(_program_name)
     main(sys.argv)

core/src/main/python/wlsdeploy/aliases/alias_constants.py

@@ -25,6 +25,7 @@
 RESTART_REQUIRED = 'restart_required'
 SET_MBEAN_TYPE = 'set_mbean_type'
 SET_METHOD = 'set_method'
+SHORT_NAME = 'short_name'
 UNRESOLVED_ATTRIBUTES_MAP = '__unresolved_attributes__'
 UNRESOLVED_FOLDERS_MAP = '__unresolved_folders__'
 USES_PATH_TOKENS = 'uses_path_tokens'

core/src/main/python/wlsdeploy/aliases/alias_entries.py

@@ -36,6 +36,7 @@
 from wlsdeploy.aliases.alias_constants import SECURITY_PROVIDER_NAME_MAP
 from wlsdeploy.aliases.alias_constants import SET_MBEAN_TYPE
 from wlsdeploy.aliases.alias_constants import SET_METHOD
+from wlsdeploy.aliases.alias_constants import SHORT_NAME
 from wlsdeploy.aliases.alias_constants import SINGLE
 from wlsdeploy.aliases.alias_constants import UNRESOLVED_ATTRIBUTES_MAP
 from wlsdeploy.aliases.alias_constants import UNRESOLVED_FOLDERS_MAP
@@ -110,7 +111,7 @@ class AliasEntries(object):
         'Server': 'Server',
         'ServerTemplate': 'ServerTemplate',
         'ShutdownClass': 'ShutdownClass',
-        'SingletonService' : 'SingletonService',
+        'SingletonService': 'SingletonService',
         'StartupClass': 'StartupClass',
         'UnixMachine': 'UnixMachine',
         'VirtualHost': 'VirtualHost',
@@ -842,7 +843,7 @@ def is_version_valid_location(self, location):
         """
         _method_name = 'is_version_valid_location'
 
-        _logger.entering(str(location),class_name=_class_name, method_name=_method_name)
+        _logger.entering(str(location), class_name=_class_name, method_name=_method_name)
 
         code = ValidationCodes.VALID
         message = ''
@@ -886,6 +887,21 @@ def is_valid_model_attribute_name_for_location(self, location, model_attribute_n
         _logger.exiting(class_name=_class_name, method_name=_method_name, result=[result, valid_version_range])
         return result, valid_version_range
 
+    def get_folder_short_name_for_location(self, location):
+        """
+        Retrieve the shortened name for the model folder at the provided location.
+        :param location: location context for the model folder
+        :return: short name or model_folder name if not short named assigned
+        """
+        _method_name = 'get_folder_short_name'
+        _logger.entering(location.get_folder_path(), class_name=_class_name, method_name=_method_name)
+        folder_dict = self.__get_dictionary_for_location(location, False)
+        result = ''
+        if SHORT_NAME in folder_dict:
+            result = folder_dict[SHORT_NAME]
+        _logger.exiting(class_name=_class_name, method_name=_method_name, result=result)
+        return result
+
     ###########################################################################
     #                         Private helper methods                          #
     ###########################################################################
@@ -1127,6 +1143,9 @@ def __apply_wlst_context_changes(self, path_name, alias_dict, parent_dict):
         if DEFAULT_NAME_VALUE in alias_dict:
             result[DEFAULT_NAME_VALUE] = self._resolve_curly_braces(alias_dict[DEFAULT_NAME_VALUE])
 
+        if SHORT_NAME in alias_dict:
+            result[SHORT_NAME] = alias_dict[SHORT_NAME]
+
         if WLST_PATHS in alias_dict:
             wlst_paths = alias_dict[WLST_PATHS]
             result_wlst_paths = dict()
@@ -1288,7 +1307,7 @@ def __resolve_folder_params(self, path_name, alias_dict):
                         add_entry = folder_set
                         break
                 for key, value in add_entry.iteritems():
-                    if key not in [ ATTRIBUTES, FOLDERS ]:
+                    if key not in [ATTRIBUTES, FOLDERS]:
                         alias_dict[key] = value
                     else:
                         _logger.fine('WLSDPLY-08136', path_name, value, class_name=_class_name,

core/src/main/python/wlsdeploy/aliases/aliases.py

@@ -152,6 +152,16 @@ def get_model_folder_path(self, location):
         """
         return self._alias_entries.get_model_folder_path_for_location(location)
 
+    def get_folder_short_name(self, location):
+        """
+        Return the short name for the folder at the provided location or an empty
+        string if the short name is not defined for the folder in the alias
+        definition.
+        :param location: location context for the folder
+        :return: short name or empty string if not found
+        """
+        return self._alias_entries.get_folder_short_name_for_location(location)
+
     ###########################################################################
     #                      WLST Path-related methods                          #
     ###########################################################################

core/src/main/python/wlsdeploy/aliases/model_constants.py

@@ -91,6 +91,7 @@
 DISTRIBUTED_QUEUE_MEMBER = 'DistributedQueueMember'
 DISTRIBUTED_TOPIC = 'DistributedTopic'
 DISTRIBUTED_TOPIC_MEMBER = 'DistributedTopicMember'
+DOMAIN = 'Domain'
 DOMAIN_NAME = 'Name'
 DOMAIN_INFO = 'domainInfo'
 DOMAIN_LIBRARIES = 'domainLibraries'

core/src/main/python/wlsdeploy/tool/discover/coherence_resources_discoverer.py

@@ -30,14 +30,15 @@ class CoherenceResourcesDiscoverer(Discoverer):
     Discover the weblogic coherence resources from the domain.
     """
 
-    def __init__(self, model_context, resource_dictionary, base_location, wlst_mode=WlstModes.OFFLINE, aliases=None):
+    def __init__(self, model_context, resource_dictionary, base_location,
+                 wlst_mode=WlstModes.OFFLINE, aliases=None, variable_injector=None):
         """
         Initialize this discoverer instance with the specific information needed to discover coherence resources.
         :param model_context: context about the model for this instance of discover domain
         :param resource_dictionary: was provided on the discover call, else use initialized resources
         :param base_location: current context for discover or new context if not provided
         """
-        Discoverer.__init__(self, model_context, base_location, wlst_mode, aliases)
+        Discoverer.__init__(self, model_context, base_location, wlst_mode, aliases, variable_injector)
         self._dictionary = resource_dictionary
         self._add_att_handler(model_constants.COHERENCE_CUSTOM_CLUSTER_CONFIGURATION,
                               self._add_custom_configuration_to_archive)

core/src/main/python/wlsdeploy/tool/discover/common_resources_discoverer.py

@@ -30,14 +30,15 @@ class CommonResourcesDiscoverer(Discoverer):
     partition resource group.
     """
 
-    def __init__(self, model_context, resource_dictionary, base_location, wlst_mode=WlstModes.OFFLINE, aliases=None):
+    def __init__(self, model_context, resource_dictionary, base_location,
+                 wlst_mode=WlstModes.OFFLINE, aliases=None, variable_injector=None):
         """
 
         :param model_context: context about the model for this instance of discover domain
         :param resource_dictionary: to populate the common resources. By default, populates the initialized resources
         :param base_location: to look for common weblogic resources. By default this is the global path or '/'
         """
-        Discoverer.__init__(self, model_context, base_location, wlst_mode, aliases)
+        Discoverer.__init__(self, model_context, base_location, wlst_mode, aliases, variable_injector)
         self._dictionary = resource_dictionary
         self._add_att_handler(model_constants.PATH_TO_SCRIPT, self._add_wldf_script)
 
@@ -65,7 +66,8 @@ def discover(self):
         model_folder_name, folder_result = self.get_wldf_system_resources()
         discoverer.add_to_model_if_not_empty(self._dictionary, model_folder_name, folder_result)
         CoherenceResourcesDiscoverer(self._model_context, self._dictionary, self._base_location,
-                                     wlst_mode=self._wlst_mode, aliases=self._aliases).discover()
+                                     wlst_mode=self._wlst_mode, aliases=self._aliases,
+                                     variable_injector=self._get_variable_injector()).discover()
 
         _logger.exiting(class_name=_class_name, method_name=_method_name)
         return self._dictionary