Merge pull request #221 from oracle/Issue#168-Arrays-needed-to-version-folders

rakillen · web-flow · commit 5c50ae78ab24 · 2019-01-18T14:17:24.000-06:00
Issue#168 arrays needed to version folders
diff --git a/core/src/main/java/oracle/weblogic/deploy/util/FileUtils.java b/core/src/main/java/oracle/weblogic/deploy/util/FileUtils.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
  * The Universal Permissive License (UPL), Version 1.0
  */
 package oracle.weblogic.deploy.util;
@@ -52,6 +52,26 @@ public static InputStream getResourceAsStream(String fileName) {
         return FileUtils.class.getClassLoader().getResourceAsStream(fileName);
     }
 
+    /**
+     * Get the specified file as an InputStream. This method will first
+     * resolve the name to an absolute path and then get the InputStream
+     *
+     * @param fileName of the file to get
+     * @return the InputStream, or null if it was not found.
+     *
+     * @param fileName
+     * @return
+     * @throws IOException
+     */
+    public static InputStream getFileAsStream(String fileName) throws IOException {
+        File file = validateExistingFile(fileName);
+        InputStream inputStream = null;
+        if (file != null) {
+            inputStream = new FileInputStream(getCanonicalFile(file));
+        }
+        return inputStream;
+    }
+
     /**
      * Convert a file path into one that Jython will handle.
      *
diff --git a/core/src/main/python/wlsdeploy/aliases/alias_constants.py b/core/src/main/python/wlsdeploy/aliases/alias_constants.py
@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
 The Universal Permissive License (UPL), Version 1.0
 
 These constants are internal to the aliases module and should not be used, as they are not part of the public API.
@@ -14,6 +14,7 @@
 DEFAULT_NAME_VALUE = 'default_name_value'
 FLATTENED_FOLDER_DATA = 'flattened_folder_data'
 FOLDERS = 'folders'
+FOLDER_PARAMS = 'folder_params'
 GET_MBEAN_TYPE = 'get_mbean_type'
 GET_METHOD = 'get_method'
 MERGE = 'merge'
diff --git a/core/src/main/python/wlsdeploy/aliases/alias_entries.py b/core/src/main/python/wlsdeploy/aliases/alias_entries.py
@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
 The Universal Permissive License (UPL), Version 1.0
 """
 import copy
@@ -26,6 +26,7 @@
 from wlsdeploy.aliases.alias_constants import CONTAINS
 from wlsdeploy.aliases.alias_constants import DEFAULT_NAME_VALUE
 from wlsdeploy.aliases.alias_constants import FLATTENED_FOLDER_DATA
+from wlsdeploy.aliases.alias_constants import FOLDER_PARAMS
 from wlsdeploy.aliases.alias_constants import FOLDERS
 from wlsdeploy.aliases.alias_constants import GET_MBEAN_TYPE
 from wlsdeploy.aliases.alias_constants import GET_METHOD
@@ -590,7 +591,7 @@ def get_name_token_for_location(self, location):
             path = location.get_folder_path()
 
             err_location = LocationContext(location)
-            if  not err_location.is_empty():
+            if not err_location.is_empty():
                 folder_name = err_location.pop_location()
                 code, message = self.is_valid_model_folder_name_for_location(err_location, folder_name)
                 if code == ValidationCodes.VERSION_INVALID:
@@ -790,7 +791,7 @@ def is_valid_model_folder_name_for_location(self, location, model_folder_name):
             folder_dict = self.__get_dictionary_for_location(sub_location, False)
             if folder_dict is None:
                 if UNRESOLVED_FOLDERS_MAP in self._category_dict and \
-                    model_folder_name in self._category_dict[UNRESOLVED_FOLDERS_MAP]:
+                        model_folder_name in self._category_dict[UNRESOLVED_FOLDERS_MAP]:
                     result = ValidationCodes.VERSION_INVALID
                     valid_version_range = self._category_dict[UNRESOLVED_FOLDERS_MAP][model_folder_name]
                 else:
@@ -1091,42 +1092,8 @@ def __apply_wlst_context_changes(self, path_name, alias_dict, parent_dict):
         #
         # First, determine if this dictionary is even relevant to the current WLS version.
         #
-        if VERSION in alias_dict:
-            dict_version_range = alias_dict[VERSION]
-            try:
-                _logger.finer('WLSDPLY-08123', path_name, dict_version_range,
-                              self._wls_helper.get_actual_weblogic_version(),
-                              class_name=_class_name, method_name=_method_name)
-                if not self.__version_in_range(dict_version_range):
-                    _logger.finer('WLSDPLY-08124', path_name, dict_version_range,
-                                  self._wls_helper.get_actual_weblogic_version(),
-                                  class_name=_class_name, method_name=_method_name)
-                    if UNRESOLVED_FOLDERS_MAP not in parent_dict:
-                        parent_dict[UNRESOLVED_FOLDERS_MAP] = dict()
-                    alias_dict_folder_name = alias_utils.compute_folder_name_from_path(path_name)
-                    parent_dict[UNRESOLVED_FOLDERS_MAP][alias_dict_folder_name] = dict_version_range
-                    return None
-                else:
-                    _logger.finer('WLSDPLY-08125', path_name, dict_version_range,
-                                  self._wls_helper.get_actual_weblogic_version(),
-                                  class_name=_class_name, method_name=_method_name)
-            except VersionException, ve:
-                ex = exception_helper.create_alias_exception('WLSDPLY-08126', path_name, dict_version_range,
-                                                             ve.getLocalizedMessage(), error=ve)
-                _logger.throwing(ex, class_name=_class_name, method_name=_method_name)
-                raise ex
-
-        if WLST_MODE in alias_dict:
-            dict_wlst_mode = alias_dict[WLST_MODE]
-            mode =  WlstModes.from_value(self._wlst_mode)
-            if not self.__wlst_mode_matches(dict_wlst_mode):
-                _logger.finer('WLSDPLY-08132', path_name, dict_wlst_mode, mode, class_name=_class_name,
-                              method_name=_method_name)
-                if UNRESOLVED_FOLDERS_MAP not in parent_dict:
-                    parent_dict[UNRESOLVED_FOLDERS_MAP] = dict()
-                alias_dict_folder_name = alias_utils.compute_folder_name_from_path(path_name)
-                parent_dict[UNRESOLVED_FOLDERS_MAP][alias_dict_folder_name] = mode
-                return None
+        if not self.__use_alias_dict(path_name, alias_dict, parent_dict):
+            return None
 
         result = dict()
         if FOLDERS in alias_dict:
@@ -1227,6 +1194,94 @@ def __apply_wlst_context_changes(self, path_name, alias_dict, parent_dict):
 
         return result
 
+    def __is_version(self, path_name, alias_dict):
+        _method_name = '__is_version'
+        is_version = True
+        dict_version_range = alias_utils.get_dictionary_version(alias_dict)
+        if dict_version_range:
+            try:
+                _logger.finer('WLSDPLY-08123', path_name, dict_version_range,
+                              self._wls_helper.get_actual_weblogic_version(),
+                              class_name=_class_name, method_name=_method_name)
+                is_version = self.__version_in_range(dict_version_range)
+
+            except VersionException, ve:
+                ex = exception_helper.create_alias_exception('WLSDPLY-08126', path_name, dict_version_range,
+                                                             ve.getLocalizedMessage(), error=ve)
+                _logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+                raise ex
+        else:
+            dict_version_range = 'All'
+
+        if is_version:
+            _logger.finer('WLSDPLY-08125', path_name, dict_version_range,
+                          self._wls_helper.get_actual_weblogic_version(),
+                          class_name=_class_name, method_name=_method_name)
+
+        return is_version
+
+    def __is_wlst_mode(self, path_name, alias_dict):
+        _method_name = '__is_wlst_mode'
+        is_mode = True
+        mode = WlstModes.from_value(self._wlst_mode)
+        dict_wlst_mode = alias_utils.get_dictionary_mode(alias_dict)
+        if dict_wlst_mode:
+            if not self.__wlst_mode_matches(dict_wlst_mode):
+                _logger.finer('WLSDPLY-08132', path_name, dict_wlst_mode, mode, class_name=_class_name,
+                              method_name=_method_name)
+                is_mode = False
+        else:
+            dict_wlst_mode = 'Both'
+
+        if is_mode:
+            _logger.finer('WLSDPLY-08133', path_name, dict_wlst_mode, class_name=_class_name,
+                          method_name=_method_name)
+        return is_mode
+
+    def __test_dictionary(self, path_name, alias_dict):
+        return self.__is_version(path_name, alias_dict) and self.__is_wlst_mode(path_name, alias_dict)
+
+    def __use_alias_dict(self, path_name, alias_dict, parent_dict):
+        self.__resolve_folder_params(path_name, alias_dict)
+        if not self.__is_version(path_name, alias_dict):
+            _add_to_unresolved_folders(path_name, parent_dict, alias_utils.get_dictionary_version(alias_dict))
+            return False
+        if not self.__is_wlst_mode(path_name, alias_dict):
+            _add_to_unresolved_folders(path_name, parent_dict, alias_utils.get_dictionary_version(alias_dict))
+            return False
+
+        return True
+
+    def __resolve_folder_params(self, path_name, alias_dict):
+        """
+        The folder params has a two-fold purpose. To identify valid version / wlst mode
+        combinations (all version / wlst mode combinations must be represented). And to
+        contain folder parameters that are different depending on the combination. Once
+        a folder parameter version has been selected, then all the folder parameters in the
+        valid entry are added to the alias_dict dictionary parameters.
+        :param alias_dict:
+        :return:
+        """
+        _method_name = '__resolve_folder_params'
+        if FOLDER_PARAMS in alias_dict:
+            folder_params = alias_dict[FOLDER_PARAMS]
+
+            if not isinstance(folder_params, list):
+                ex = exception_helper.create_alias_exception('WLSDPLY-08134', path_name, class_name=_class_name,
+                                                             method_name=_method_name)
+                _logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+                raise ex
+
+            if folder_params:
+                add_entry = folder_params[0]
+                for folder_set in folder_params:
+                    if self.__test_dictionary(path_name, folder_set):
+                        _logger.finer('WLSDPLY-08135', path_name, class_name=_class_name, method_name=_method_name)
+                        add_entry = folder_set
+                        break
+                for key, value in add_entry.iteritems():
+                    alias_dict[key] = value
+
     def __resolve_attribute_by_wlst_context(self, path_name, attr_name, attrs_dict):
         """
         Find the attribute list element that applies to the current WLS version and WLST mode.
@@ -1436,3 +1491,10 @@ def __get_path_for_location(self, location, path_type=WLST_ATTRIBUTES_PATH):
 
         _logger.exiting(class_name=_class_name, method_name=_method_name, result=tokenized_path)
         return tokenized_path
+
+
+def _add_to_unresolved_folders(path_name, parent_dict, unresolved):
+    if UNRESOLVED_FOLDERS_MAP not in parent_dict:
+        parent_dict[UNRESOLVED_FOLDERS_MAP] = dict()
+    alias_dict_folder_name = alias_utils.compute_folder_name_from_path(path_name)
+    parent_dict[UNRESOLVED_FOLDERS_MAP][alias_dict_folder_name] = unresolved
diff --git a/core/src/main/python/wlsdeploy/aliases/alias_utils.py b/core/src/main/python/wlsdeploy/aliases/alias_utils.py
@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
 The Universal Permissive License (UPL), Version 1.0
 """
 import copy
@@ -31,21 +31,21 @@
 from wlsdeploy.aliases.alias_constants import ATTRIBUTES
 from wlsdeploy.aliases.alias_constants import COMMA_DELIMITED_STRING
 from wlsdeploy.aliases.alias_constants import DELIMITED_STRING
-from wlsdeploy.aliases.alias_constants import DICTIONARY
 from wlsdeploy.aliases.alias_constants import JARRAY
 from wlsdeploy.aliases.alias_constants import JAVA_LANG_BOOLEAN
 from wlsdeploy.aliases.alias_constants import LIST
 from wlsdeploy.aliases.alias_constants import LONG
 from wlsdeploy.aliases.alias_constants import PATH_SEPARATOR_DELIMITED_STRING
-from wlsdeploy.aliases.alias_constants import PROPERTIES
 from wlsdeploy.aliases.alias_constants import PREFERRED_MODEL_TYPE
 from wlsdeploy.aliases.alias_constants import SECURITY_PROVIDER_FOLDER_PATHS
 from wlsdeploy.aliases.alias_constants import SECURITY_PROVIDER_MBEAN_NAME_MAP
 from wlsdeploy.aliases.alias_constants import SEMI_COLON_DELIMITED_STRING
 from wlsdeploy.aliases.alias_constants import SPACE_DELIMITED_STRING
+from wlsdeploy.aliases.alias_constants import VERSION
 from wlsdeploy.aliases.alias_constants import WLST_ATTRIBUTES_PATH
 from wlsdeploy.aliases.alias_constants import WLST_CREATE_PATH
 from wlsdeploy.aliases.alias_constants import WLST_LIST_PATH
+from wlsdeploy.aliases.alias_constants import WLST_MODE
 from wlsdeploy.aliases.alias_constants import WLST_PATH
 from wlsdeploy.aliases.alias_constants import WLST_PATHS
 from wlsdeploy.aliases.alias_constants import WLST_READ_TYPE
@@ -806,6 +806,29 @@ def get_security_provider_model_folder_name(mbean_name):
     return result
 
 
+def get_dictionary_version(alias_dict):
+    """
+    Return the version in the alias dictionary, if present. Not present
+    means all versions. The alias dictionary can represent a folder or an attribute.
+    :param alias_dict: in which to find the version
+    :return: alias_dict VERSION or None if not present
+    """
+    if VERSION in alias_dict:
+       return alias_dict[VERSION]
+    return None
+
+
+def get_dictionary_mode(alias_dict):
+    """
+    Return the wlst mode in the alias dictionary, if present. Not present means both offline
+    and online. The alias dictionary can represent a folder or an attribute.
+    :param alias_dict: in which to find the wlst mode
+    :return: alias_dict mode or None if not present
+    """
+    if WLST_MODE in alias_dict:
+        return alias_dict[WLST_MODE]
+    return None
+
 ###############################################################################
 #                              Private functions                              #
 ###############################################################################
diff --git a/core/src/main/python/wlsdeploy/aliases/model_constants.py b/core/src/main/python/wlsdeploy/aliases/model_constants.py
@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
 The Universal Permissive License (UPL), Version 1.0
 """
 
@@ -190,6 +190,7 @@
 SAF_ERROR_HANDLING = 'SAFErrorHandling'
 SAF_IMPORTED_DESTINATION = 'SAFImportedDestinations'
 SAF_LOGIN_CONTEXT = 'SAFLoginContext'
+SAF_MESSAGE_LOG_FILE = 'JmssafMessageLogFile'
 SAF_QUEUE = 'SAFQueue'
 SAF_REMOTE_CONTEXT = 'SAFRemoteContext'
 SAF_TOPIC = 'SAFTopic'
diff --git a/core/src/main/resources/oracle/weblogic/deploy/aliases/category_modules/SAFAgent.json b/core/src/main/resources/oracle/weblogic/deploy/aliases/category_modules/SAFAgent.json
@@ -1,10 +1,16 @@
 {
-    "copyright": "Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.",
+    "copyright": "Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.",
     "license": "The Universal Permissive License (UPL), Version 1.0",
     "wlst_type": "SAFAgent${:s}",
     "child_folders_type": "multiple",
     "folders": {
         "JmssafMessageLogFile": {
+            "folder_params": [{
+                "version": "[10,12.2.1)",
+                "wlst_mode": "online"
+            }, {
+                "version": "[12.2.1,)"
+            }],
             "folders": {},
             "attributes": {
                 "BufferSizeKb":         [ {"version": "[10,)",           "wlst_mode": "both",    "wlst_name": "BufferSize${Kb:KB}",   "wlst_path": "WP001", "value": {"default": 8                                 }, "wlst_type": "integer" } ],
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
@@ -464,6 +464,8 @@ WLSDPLY-06142=The online attribute {0} is in the lsa() list but is a folder not
 WLSDPLY-06143=Attribute {0} at location {1} is not writable and is deprecated
 WLSDPLY-06144=Folder {0} at location {1} is not an online folder. Removing from online subfolder list
 WLSDPLY-06145=Subfolder list {0} at location {1} does not match the mbi containment folder list {2}
+WLSDPLY-06146=Discovered WLST MBean names {0} at location {1}
+WLSDPLY-06147=Call method {0} to get the value for wlst attribute {1} at wlst path {2}
 
 # resources_discoverer.py
 WLSDPLY-06300=Discovering domain model resources
@@ -710,6 +712,10 @@ WLSDPLY-08130=Unable to compute the name token for folder {0} because the folder
 WLSDPLY-08131=Unable to compute the name token for folder {0} because the folder is not valid in \
   WebLogic Server version {1}
 WLSDPLY-08132=Folder {0} present only for {1} mode is not relevant for WLST in {2} mode
+WLSDPLY-08133=Folder {0} present for {1} mode is relevant in WebLogic Server version {2}
+WLSDPLY-08134=Folder parameters for Folder {0} are invalid and cannot be processed
+WLSDPLY-08135=Found a valid parameters for Folder {0} in the array of folder parameters
+
 #
 # Empty slots to fill up...
 #
@@ -1082,6 +1088,8 @@ WLSDPLY-19030=Failed to get the model attribute list that use path tokens for mo
 WLSDPLY-19031=Failed to determine if the model attribute name {0} at location ({1}) is valid: {2}
 WLSDPLY-19032=Failed to get the default value for model attribute {0} at location ({1}): {2}
 WLSDPLY-19033=Failed to determine if location ({0}) is version valid, or not
+WLSDPLY-19034=Failed to get the model attribute list that require a special processing via a method for model \
+  folder ({0}) at location ({1}): {2}
 
 # wlsdeploy/tool/util/wlst_helper.py
 WLSDPLY-19100=Failed to change to the WLST directory {0}: {1}
diff --git a/core/src/test/python/alias_json_file_test.py b/core/src/test/python/alias_json_file_test.py
diff --git a/core/src/test/python/aliases_test.py b/core/src/test/python/aliases_test.py
diff --git a/core/src/test/resources/Test.json b/core/src/test/resources/Test.json
