Added ability to version folder level parameters in alias definitions

CarolynRountree · CarolynRountree · commit 30520ee2f1a4 · 2019-01-18T12:18:29.000-06:00
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_entries.py b/core/src/main/python/wlsdeploy/aliases/alias_entries.py
@@ -1254,9 +1254,11 @@ def __use_alias_dict(self, path_name, alias_dict, parent_dict):
 
     def __resolve_folder_params(self, path_name, alias_dict):
         """
-        This is a folder that has different parameters based on version / offline.
-        Search through the folder params and find the correct set of parameters. Add
-        this set of parameters to the alias_dict directly and remove the folder_params array.
+        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:
         """
@@ -1270,12 +1272,15 @@ def __resolve_folder_params(self, path_name, alias_dict):
                 _logger.throwing(ex, class_name=_class_name, method_name=_method_name)
                 raise ex
 
-            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)
-                    for key, value in folder_set.iteritems():
-                        alias_dict[key] = value
-                    break
+            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):
         """
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/test/python/alias_json_file_test.py b/core/src/test/python/alias_json_file_test.py
@@ -1,7 +1,9 @@
 """
-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
+import os
 import pprint
 import unittest
 
@@ -20,6 +22,7 @@
 from wlsdeploy.aliases.alias_constants import DEFAULT
 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
 from wlsdeploy.aliases.alias_constants import GET_MBEAN_TYPE
@@ -48,6 +51,11 @@
 
 
 class ListTestCase(unittest.TestCase):
+    _resources_dir = '../../test-classes/'
+    _test_json_files = [
+        'Test'
+    ]
+    _test_category_file_map = dict()
 
     _required_category_folder_keys = [
         'copyright',
@@ -67,6 +75,7 @@ class ListTestCase(unittest.TestCase):
         CONTAINS,
         DEFAULT_NAME_VALUE,
         FLATTENED_FOLDER_DATA,
+        FOLDER_PARAMS,
         VERSION,
         WLST_CREATE_PATH,
         WLST_LIST_PATH,
@@ -121,6 +130,9 @@ def setUp(self):
         self.alias_entries = AliasEntries(wls_version='12.2.1.3')
         self.online_alias_entries = AliasEntries(wls_version='12.2.1.3', wlst_mode=WlstModes.ONLINE)
         self.category_file_map = self.alias_entries._unit_test_only_get_category_map_files()
+        for testfile in self._test_json_files:
+            category_file_path = os.path.join(self._resources_dir, '%s.json' % testfile)
+            self._test_category_file_map[testfile] = category_file_path
 
     def testForJsonFileTypos(self):
         category_results = dict()
@@ -132,10 +144,25 @@ def testForJsonFileTypos(self):
         message = pprint.pformat(category_results)
         self.assertEqual(len(category_results), 0, message)
 
+    def testTestFilesForJsonFileTypos(self):
+        category_results = dict()
+        for category_name, category_file_path in self._test_category_file_map.iteritems():
+            category_dict = self._load_test_category_file(category_file_path)
+            results = self._scan_category_dict_for_unknown_fields(category_name, category_dict)
+            if len(results) > 0:
+                category_results[category_name] = results
+        message = pprint.pformat(category_results)
+        self.assertEqual(len(category_results), 0, message)
+
     def _load_category_file(self, category_file_path):
         category_input_stream = FileUtils.getResourceAsStream(category_file_path)
         self.assertNotEquals(category_input_stream, None)
+        json_translator = JsonStreamTranslator(category_file_path, category_input_stream)
+        return json_translator.parse()
 
+    def _load_test_category_file(self, category_file_path):
+        category_input_stream = FileUtils.getFileAsStream(category_file_path)
+        self.assertNotEquals(category_input_stream, None)
         json_translator = JsonStreamTranslator(category_file_path, category_input_stream)
         return json_translator.parse()
 
@@ -277,7 +304,6 @@ def _verify_folder_wlst_paths_attribute_type(self, folder_name, attribute_value)
             result.append(self._get_invalid_dictionary_type_message(folder_name, WLST_PATHS, attribute_value))
         return result
 
-
     def _verify_folder_wlst_type_attribute_type(self, folder_name, attribute_value):
         result = []
         if type(attribute_value) is not str:
@@ -337,6 +363,31 @@ def _verify_folder_flattened_folder_data_attribute_value(self, folder_name, attr
                                                                      attribute_value[NAME_VALUE]))
         return result
 
+    def _verify_folder_folder_params_attribute_value(self, folder_name, attribute_value):
+        result = []
+        if type(attribute_value) is not list or (len(attribute_value) > 0 and
+                                                 type(attribute_value[0]) is not dict):
+            result.append(self._get_invalid_list_of_dict_type_message(folder_name, FOLDER_PARAMS,
+                                                                      attribute_value))
+        else:
+            folder_params = copy.deepcopy(attribute_value)
+            for folder_param in folder_params:
+                if VERSION not in folder_param:
+                    result.append(self._get_missing_required_attribute_key_message(folder_name,
+                                                                                   VERSION, FOLDER_PARAMS))
+                for folder in folder_param:
+                    if folder in self._required_folder_keys:
+                        verify_function_name = '_verify_folder_%s_attribute_type' % folder
+                        verify_function = getattr(self, verify_function_name)
+                        result.extend(verify_function(folder_name, folder_param[folder]))
+                    elif folder in self._optional_folder_keys:
+                        verify_function_name = '_verify_folder_%s_attribute_value' % folder
+                        verify_function = getattr(self, verify_function_name)
+                        result.extend(verify_function(folder_name, folder_param[folder]))
+                    else:
+                        result.append(self._get_unknown_folder_key_message(folder_name, folder))
+        return result
+
     def _verify_folder_version_attribute_value(self, folder_name, attribute_value):
         result = []
         if type(attribute_value) is not str:
@@ -629,6 +680,10 @@ def _get_invalid_list_type_message(self, folder_name, attribute_name, attribute_
         return 'Folder at path %s has %s attribute that is expected to be a list but is a %s instead' % \
                (folder_name, attribute_name, str(type(attribute_value)))
 
+    def _get_invalid_list_of_dict_type_message(self, folder_name, attribute_name, attribute_value):
+        return 'Folder at path %s has %s attribute that is expected to be a list of dict but is a %s instead' % \
+               (folder_name, attribute_name, str(type(attribute_value)))
+
     def _get_invalid_string_type_message(self, folder_name, attribute_name, attribute_value):
         return 'Folder at path %s has %s attribute that is expected to be a string but is a %s instead' % \
                (folder_name, attribute_name, str(type(attribute_value)))
diff --git a/core/src/test/python/aliases_test.py b/core/src/test/python/aliases_test.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
 """
 from org.python.modules import jarray
@@ -599,6 +599,24 @@ def testVersionFilteredFolders(self):
         self.assertNotEqual(mbean_type, None, 'expected DynamicServers type not to be null')
         return
 
+    def testVersionFilteredFoldersWithFolderParams(self):
+        old_wls_version = '10.3.6'
+        new_wls_version = '12.2.1.3'
+
+        old_aliases = Aliases(self.model_context, WlstModes.OFFLINE, old_wls_version)
+        new_aliases = Aliases(self.model_context, WlstModes.OFFLINE, new_wls_version)
+        location = LocationContext()
+        location.append_location(FOLDERS.SAF_AGENT)
+        name_token = old_aliases.get_name_token(location)
+        location.add_name_token(name_token, 'SafAgent')
+        location.append_location(FOLDERS.SAF_MESSAGE_LOG_FILE)
+        mbean_type = old_aliases.get_wlst_mbean_type(location)
+        self.assertEqual(mbean_type, None, 'expected SAF Agent Message Log type to be null')
+        mbean_type = new_aliases.get_wlst_mbean_type(location)
+        self.assertNotEqual(mbean_type, None, 'expected SAF Agent Message Log  not to be null')
+
+        return
+
     def testDomainAttributeMethods(self):
         aliases = Aliases(self.model_context, WlstModes.OFFLINE)
         location = LocationContext()
diff --git a/core/src/test/resources/Test.json b/core/src/test/resources/Test.json
@@ -0,0 +1,59 @@
+{
+  "copyright": "Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.",
+  "license": "The Universal Permissive License (UPL), Version 1.0",
+  "folder_params": [],
+  "wlst_type": "Test",
+  "child_folders_type": "multiple",
+  "folders": {
+    "ChildFolder-12213": {
+      "folder_params": [ {
+        "version": "[10.3.6,12.2.1.3)",
+        "wlst_mode": "online",
+        "wlst_type": "ChildFolder-1036",
+        "wlst_paths": {"WP001": "/Test/%TEST%/child1036/%TEST%"}
+      },{
+        "version": "[12.2.1.3,)",
+        "wlst_type": "ChildFolder-12213",
+        "wlst_mode": "offline",
+        "wlst_paths": {"WP001": "/Test/%TEST%/child12213/NO_NAME_0"}
+      }],
+      "wlst_type": "ChildFolder-1",
+      "folders": {},
+      "child_folders_type": "single",
+      "attributes": {
+        "Notes": [{"version": "[12.2.1.3,)", "wlst_mode": "both", "wlst_name": "Notes", "wlst_path": "WP001", "value": {"default": "None"}, "wlst_type": "string"}]
+      },
+      "wlst_attributes_path": "WP001",
+      "wlst_paths": {
+        "WP001": "/Test/%TEST%/ChildFolder-1/"
+      }
+    },
+    "ChildFolder-2": {
+      "folder_params": [{
+        "version": "[10,12.2.1.3)",
+        "wlst_mode": "offline"
+      }, {
+        "version": "[12.2.1.3,)"
+      }],
+      "wlst_type": "ChildFolder-2",
+      "folders": {},
+      "child_folders_type": "multiple",
+      "attributes": {
+        "Notes":      [ {"version": "[12.2.1.3,)",  "wlst_mode": "both",  "wlst_name": "Notes",  "wlst_path": "WP001", "value": {"default": "None"  }, "wlst_type": "string"  } ]
+      },
+      "wlst_attributes_path": "WP001",
+      "wlst_paths": {
+        "WP001": "/Test/%TEST%/ChildFolder-2/%CHILD2%"
+      }
+    }
+  },
+  "attributes": {
+    "Attribute-1":               [ {"version": "[10,12.1.1)",     "wlst_mode": "offline", "wlst_name": "Attribute",               "wlst_path": "WP001", "value": {"default": "None"           }, "wlst_type": "string",                   "get_method": "${LSA:GET}" } ,
+                                   {"version": "[12.1.1,)",       "wlst_mode": "both",    "wlst_name": "Attribute-1",               "wlst_path": "WP001", "value": {"default": "None"           }, "wlst_type": "string",                   "get_method": "${LSA:GET}" } ],
+    "Attribute-2":               [ {"version": "[12.1.1,)",       "wlst_mode": "both",    "wlst_name": "Attribute-2",                     "wlst_path": "WP001", "value": {"default": -1               }, "wlst_type": "integer"                     } ]
+  },
+  "wlst_attributes_path": "WP001",
+  "wlst_paths": {
+        "WP001": "/Test/%TEST%"
+  }
+}
