JIRA WDT-47 Enable special processing for custom security providers; allow them to pass validate

Author: rakillen

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

@@ -271,6 +271,18 @@ def is_artificial_type_folder(self, location):
         """
         return self._alias_entries.is_location_child_folder_type(location, ChildFoldersTypes.NONE)
 
+    def is_custom_folder_allowed(self, location):
+        """
+        Returns true if the specified location allows custom, user-defined folder types.
+        This currently corresponds to all MULTIPLE_WITH_TYPE_SUBFOLDER entries.
+        This will need to be refined if new custom types are added, or additional distinctions are required.
+        :param location: the location to be checked
+        :return: True if the location allows custom folder types, False otherwise
+        :raises: AliasException: if an error occurs while getting the folder for the location
+        """
+        return self._alias_entries.is_location_child_folder_type(location,
+                                                                 ChildFoldersTypes.MULTIPLE_WITH_TYPE_SUBFOLDER)
+
     ###########################################################################
     #                     WLST Folder create-related methods                  #
     ###########################################################################

core/src/main/python/wlsdeploy/tool/create/creator.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
 """
 
@@ -12,6 +12,7 @@
 from wlsdeploy.logging.platform_logger import PlatformLogger
 from wlsdeploy.tool.util.alias_helper import AliasHelper
 from wlsdeploy.tool.util.attribute_setter import AttributeSetter
+from wlsdeploy.tool.util.custom_folder_helper import CustomFolderHelper
 from wlsdeploy.tool.util.wlst_helper import WlstHelper
 from wlsdeploy.util import dictionary_utils
 from wlsdeploy.util.model import Model
@@ -29,12 +30,15 @@ def __init__(self, model, model_context, aliases, exception_type=ExceptionType.C
 
         self.logger = logger
         self.aliases = aliases
+        self._exception_type = exception_type
         self.alias_helper = AliasHelper(self.aliases, self.logger, exception_type)
         self.wlst_helper = WlstHelper(self.logger, exception_type)
         self.model = Model(model)
         self.model_context = model_context
         self.wls_helper = WebLogicHelper(self.logger)
         self.attribute_setter = AttributeSetter(self.aliases, self.logger, exception_type)
+        self.custom_folder_helper = CustomFolderHelper(self.aliases, self.logger, exception_type)
+
         # Must be initialized by the subclass since only it has
         # the knowledge required to compute the domain name.
         self.archive_helper = None
@@ -179,27 +183,39 @@ def _create_security_provider_mbeans(self, type_name, model_nodes, base_location
         create_path = self.alias_helper.get_wlst_create_path(location)
         list_path = self.alias_helper.get_wlst_list_path(location)
         existing_folder_names = self._get_existing_folders(list_path)
+        known_providers = self.alias_helper.get_model_subfolder_names(location)
+        allow_custom = str(self.alias_helper.is_custom_folder_allowed(location))
+
         for model_name in model_nodes:
+            model_node = model_nodes[model_name]
+
+            if model_node is None:
+                # The node is empty so nothing to do... move to the next named node.
+                continue
+
+            if len(model_node) != 1:
+                # there should be exactly one type folder under the name folder
+                ex = exception_helper.create_exception(self._exception_type, 'WLSDPLY-12117', type_name, model_name,
+                                                       len(model_node))
+                self.logger.throwing(ex, class_name=self.__class_name, method_name=_method_name)
+                raise ex
+
+            # custom providers require special processing, they are not described in alias framework
+            if allow_custom and (model_name not in known_providers):
+                self.custom_folder_helper.update_security_folder(location, model_name, model_node)
+                continue
+
+            # for a known provider, process using aliases
             prov_location = LocationContext(location)
             name = self.wlst_helper.get_quoted_name_for_wlst(model_name)
             if token_name is not None:
                 prov_location.add_name_token(token_name, name)
 
             wlst_base_provider_type, wlst_name = self.alias_helper.get_wlst_mbean_type_and_name(prov_location)
-            model_node = model_nodes[model_name]
-            if model_node is not None:
-                if len(model_node) == 1:
-                    model_type_subfolder_name = list(model_node.keys())[0]
-                    prov_location.append_location(model_type_subfolder_name)
-                    wlst_type = self.alias_helper.get_wlst_mbean_type(prov_location)
-                else:
-                    ex = exception_helper.create_create_exception('WLSDPLY-12117', type_name,
-                                                                  model_name, len(model_node))
-                    self.logger.throwing(ex, class_name=self.__class_name, method_name=_method_name)
-                    raise ex
-            else:
-                # The node is empty so nothing to do...move to the next named node.
-                continue
+
+            model_type_subfolder_name = list(model_node.keys())[0]
+            prov_location.append_location(model_type_subfolder_name)
+            wlst_type = self.alias_helper.get_wlst_mbean_type(prov_location)
 
             if wlst_name not in existing_folder_names:
                 if log_created:

core/src/main/python/wlsdeploy/tool/create/security_provider_creator.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
 """
 
@@ -35,10 +35,7 @@
 from wlsdeploy.aliases.model_constants import SECURITY_CONFIGURATION
 from wlsdeploy.tool.create.creator import Creator
 from wlsdeploy.tool.deploy import deployer_utils
-from wlsdeploy.tool.util.alias_helper import AliasHelper
-from wlsdeploy.tool.util.wlst_helper import WlstHelper
 from wlsdeploy.util import dictionary_utils
-from wlsdeploy.util.weblogic_helper import WebLogicHelper
 
 
 class SecurityProviderCreator(Creator):
@@ -51,11 +48,6 @@ class SecurityProviderCreator(Creator):
     def __init__(self, model_dictionary, model_context, aliases, exception_type, logger):
         Creator.__init__(self, model_dictionary, model_context, aliases, exception_type, logger)
 
-        self.logger = logger
-        self.alias_helper = AliasHelper(aliases, self.logger, exception_type)
-        self.wlst_helper = WlstHelper(self.logger, exception_type)
-        self.wls_helper = WebLogicHelper(self.logger)
-
         self._topology = self.model.get_model_topology()
 
         #

core/src/main/python/wlsdeploy/tool/util/alias_helper.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 oracle.weblogic.deploy.aliases import AliasException
@@ -275,6 +275,24 @@ def is_artificial_type_folder(self, location):
             raise ex
         return result
 
+    def is_custom_folder_allowed(self, location):
+        """
+        Returns true if the specified location allows custom, user-defined folder types.
+        :param location: the location to be checked
+        :return: True, if the location allows custom folder types, False otherwise
+        :raises: BundleAwareException of the specified type: if an error occurs
+        """
+        _method_name = 'is_custom_folder_allowed'
+
+        try:
+            result = self.__aliases.is_custom_folder_allowed(location)
+        except AliasException, ae:
+            ex = exception_helper.create_exception(self.__exception_type, 'WLSDPLY-19035', str(location),
+                                                   ae.getLocalizedMessage(), error=ae)
+            self.__logger.throwing(ex, class_name=self.__class_name, method_name=_method_name)
+            raise ex
+        return result
+
     def get_wlst_mbean_name(self, location):
         """
         Get the MBean name to use to create it for the specified location.

core/src/main/python/wlsdeploy/tool/validate/validator.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 os
@@ -670,6 +670,9 @@ def __process_model_node(self, model_node, validation_location, validation_resul
                                                                   model_folder_path,
                                                                   validation_location,
                                                                   validation_result)
+            elif self._alias_helper.is_custom_folder_allowed(validation_location):
+                # custom folders are not validated, just log this and continue
+                self._logger.info('WLSDPLY-05037', model_folder_path)
             else:
                 # At this point we know that key IS NOT a valid attribute or folder, meaning
                 # that given the location object, it is NOT:

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

@@ -351,6 +351,7 @@ WLSDPLY-05033=Attribute {0} in model location {1} should be a string but was a {
 WLSDPLY-05034=The value for attribute {0} in model location {1} should be a string or a list but was a {2}
 WLSDPLY-05035=The {0} attribute with value {1} in model location {2}, should be a string but was a {3}
 WLSDPLY-05036=Attribute {0} in model location {1}, uses the {2} macro expression for an integer or references to other another server template configuration element. The Oracle documentation for server templates, cites this as being not supported.
+WLSDPLY-05037=Custom folder {0} will not be validated
 
 
 # wlsdeploy/tools/validate/usage_printer.py
@@ -948,6 +949,7 @@ WLSDPLY-12122=The attribute {0} in model location {1} has value {2} that referen
   archive file but the archive file was not provided
 # The WLSDPLY-12123 resource is used for messages returned from aliases.is_version_valid_location()
 WLSDPLY-12123={0}
+WLSDPLY-12124=Updating custom security folder {0} at location {1}
 
 # domain_creator.py
 WLSDPLY-12200={0} did not find the required {1} section in the model file {2}
@@ -1095,6 +1097,7 @@ WLSDPLY-19032=Failed to get the default value for model attribute {0} at locatio
 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}
+WLSDPLY-19035=Failed to determine if the location ({0}) allows custom folder types: {1}
 
 # wlsdeploy/tool/util/wlst_helper.py
 WLSDPLY-19100=Failed to change to the WLST directory {0}: {1}