Merge branch 'custom-resource' into 'main'

Deploy and discover custom resources

See merge request weblogic-cloud/weblogic-deploy-tooling!1741

Author: robertpatrick

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

@@ -54,6 +54,7 @@
 from wlsdeploy.aliases.model_constants import APP_DEPLOYMENTS
 from wlsdeploy.aliases.model_constants import APPLICATION
 from wlsdeploy.aliases.model_constants import CALLOUT
+from wlsdeploy.aliases.model_constants import CUSTOM_RESOURCE
 from wlsdeploy.aliases.model_constants import DOMAIN_INFO
 from wlsdeploy.aliases.model_constants import DOMAIN_INFO_ALIAS
 from wlsdeploy.aliases.model_constants import EJB_CONTAINER
@@ -134,6 +135,7 @@ class AliasEntries(object):
 
     __resources_top_level_folders = [
         'CoherenceClusterSystemResource',
+        CUSTOM_RESOURCE,
         EJB_CONTAINER,
         'FileStore',
         'ForeignJNDIProvider',

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

@@ -74,6 +74,7 @@
 CREDENTIAL_MAPPER = 'CredentialMapper'
 CROSS_DOMAIN = 'CrossDomain'
 CUSTOM_DBMS_AUTHENTICATOR = 'CustomDBMSAuthenticator'
+CUSTOM_RESOURCE = "CustomResource"
 DATA_SOURCE = 'DataSource'
 
 # Deprecated in WDT 4.0.0
@@ -389,6 +390,8 @@
 CUSTOM_TRUST_KEYSTORE_FILE = 'CustomTrustKeyStoreFileName'
 DATABASE_LESS_LEASING_BASIS = 'DatabaseLessLeasingBasis'
 DEPLOYMENT_ORDER = 'DeploymentOrder'
+DESCRIPTOR_BEAN_CLASS = 'DescriptorBeanClass'
+DESCRIPTOR_FILE_NAME = 'DescriptorFileName'
 DESTINATION_SERVER = 'DestinationServer'
 DRIVER_NAME = 'DriverName'
 DRIVER_PARAMS_PROPERTY_VALUE = 'Value'
@@ -422,6 +425,7 @@
 PASSWORD = 'Password'
 PATH_TO_SCRIPT = 'PathToScript'
 PLAN_STAGING_MODE = 'PlanStagingMode'
+RESOURCE_CLASS = 'ResourceClass'
 SECURITY_DD_MODEL = 'SecurityDDModel'
 SET_OPTION_APP_DIR = 'AppDir'
 SET_OPTION_DOMAIN_NAME = 'DomainName'

core/src/main/python/wlsdeploy/tool/deploy/common_resources_deployer.py

@@ -1,7 +1,10 @@
 """
-Copyright (c) 2017, 2024, Oracle and/or its affiliates.  All rights reserved.
+Copyright (c) 2017, 2024, Oracle and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
+from wlsdeploy.aliases.model_constants import CUSTOM_RESOURCE
+from wlsdeploy.aliases.model_constants import DESCRIPTOR_BEAN_CLASS
+from wlsdeploy.aliases.model_constants import DESCRIPTOR_FILE_NAME
 from wlsdeploy.aliases.model_constants import EJB_CONTAINER
 from wlsdeploy.aliases.model_constants import FILE_STORE
 from wlsdeploy.aliases.model_constants import FOREIGN_JNDI_PROVIDER
@@ -13,6 +16,7 @@
 from wlsdeploy.aliases.model_constants import MESSAGING_BRIDGE
 from wlsdeploy.aliases.model_constants import OHS
 from wlsdeploy.aliases.model_constants import PATH_SERVICE
+from wlsdeploy.aliases.model_constants import RESOURCE_CLASS
 from wlsdeploy.aliases.model_constants import SAF_AGENT
 from wlsdeploy.aliases.model_constants import SELF_TUNING
 from wlsdeploy.aliases.model_constants import SNMP_AGENT
@@ -24,6 +28,7 @@
 from wlsdeploy.aliases.model_constants import SYSTEM_COMPONENT
 
 from wlsdeploy.aliases.wlst_modes import WlstModes
+from wlsdeploy.exception import exception_helper
 from wlsdeploy.tool.deploy.deployer import Deployer
 from wlsdeploy.util import dictionary_utils
 
@@ -63,6 +68,27 @@ def _add_subfolders(self, model_nodes, location, excludes=None):
 
         Deployer._add_subfolders(self, model_nodes, location, excludes=excludes)
 
+    # Override
+    def _create_and_cd(self, location, existing_names, child_nodes):
+        """
+        Override the base method for custom resources.
+        These have to be created using cmo.createCustomResource(...) .
+        """
+        parent_type = self.get_location_type(location)
+        if parent_type == CUSTOM_RESOURCE and (self.wlst_mode == WlstModes.ONLINE):
+            self.__create_custom_resource_online_and_cd(location, existing_names, child_nodes)
+        else:
+            Deployer._create_and_cd(self, location, existing_names, child_nodes)
+
+    def add_custom_resources(self, parent_dict, location):
+        """
+        Deploy the custom resource elements in the dictionary at the specified location.
+        :param parent_dict: the dictionary possibly containing custom resource elements
+        :param location: the location to deploy the elements
+        """
+        resources = dictionary_utils.get_dictionary_element(parent_dict, CUSTOM_RESOURCE)
+        self._add_named_elements(CUSTOM_RESOURCE, resources, location)
+
     def add_ejb_container(self, parent_dict, location):
         """
         Deploy the EJB container elements in the dictionary at the specified location.
@@ -180,8 +206,7 @@ def add_snmp_agent_deployments(self, parent_dict, location):
         :param location: the location to deploy the elements
         """
         deployments = dictionary_utils.get_dictionary_element(parent_dict, SNMP_AGENT_DEPLOYMENT)
-        if len(deployments) != 0:
-            self._add_named_elements(SNMP_AGENT_DEPLOYMENT, deployments, location)
+        self._add_named_elements(SNMP_AGENT_DEPLOYMENT, deployments, location)
 
     def add_self_tuning(self, parent_dict, location):
         """
@@ -244,3 +269,38 @@ def add_ohs_components(self, parent_dict, location):
             self.logger.warning('WLSDPLY-09405', OHS, class_name=self._class_name, method_name=_method_name)
         else:
             self._add_named_elements(OHS, system_components, location)
+
+    def __create_custom_resource_online_and_cd(self, location, existing_names, child_nodes):
+        """
+        Create the custom resource at the specified location if it does not exist,
+        and change to the new directory.
+        :param location: the location of the custom resource to create
+        :param existing_names: existing names at the specified location
+        :param child_nodes: used to gather information to create
+        """
+        _method_name = '__create_custom_resource_online_and_cd'
+
+        mbean_name = self.aliases.get_wlst_mbean_name(location)
+        if mbean_name not in existing_names:
+            create_path = self.aliases.get_wlst_create_path(location)
+            self.wlst_helper.cd(create_path)
+            resource_class = dictionary_utils.get_element(child_nodes, RESOURCE_CLASS)
+            if not resource_class:
+                ex = exception_helper.create_deploy_exception(
+                    'WLSDPLY-09426', CUSTOM_RESOURCE, mbean_name, RESOURCE_CLASS)
+                self.logger.throwing(ex, class_name=self._class_name, method_name=_method_name)
+                raise ex
+
+            bean_descriptor_class = dictionary_utils.get_element(child_nodes, DESCRIPTOR_BEAN_CLASS)
+            if not bean_descriptor_class:
+                ex = exception_helper.create_deploy_exception(
+                     'WLSDPLY-09426', CUSTOM_RESOURCE, mbean_name, DESCRIPTOR_BEAN_CLASS)
+                self.logger.throwing(ex, class_name=self._class_name, method_name=_method_name)
+                raise ex
+
+            descriptor_file_name = dictionary_utils.get_element(child_nodes, DESCRIPTOR_FILE_NAME)
+            self.wlst_helper.create_custom_resource(mbean_name, resource_class, bean_descriptor_class,
+                                                    descriptor_file_name)
+
+        wlst_path = self.aliases.get_wlst_attributes_path(location)
+        self.wlst_helper.cd(wlst_path)

core/src/main/python/wlsdeploy/tool/deploy/deployer.py

@@ -114,15 +114,15 @@ def _add_named_elements(self, type_name, model_nodes, location, delete_now=True)
 
             if token is not None:
                 location.add_name_token(token, name)
-            self._create_and_cd(location, existing_names)
 
             child_nodes = dictionary_utils.get_dictionary_element(model_nodes, name)
+            self._create_and_cd(location, existing_names, child_nodes)
             self._set_attributes_and_add_subfolders(location, child_nodes)
 
     #
     # This method exists purely to allow subclasses to override how an mbean is created.
     #
-    def _create_and_cd(self, location, existing_names):
+    def _create_and_cd(self, location, existing_names, child_nodes):
         deployer_utils.create_and_cd(location, existing_names, self.aliases)
 
     def _add_subfolders(self, model_nodes, location, excludes=None):

core/src/main/python/wlsdeploy/tool/deploy/resources_deployer.py

@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2022, Oracle Corporation and/or its affiliates.  All rights reserved.
+Copyright (c) 2017, 2024, Oracle and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
 import wlsdeploy.util.dictionary_utils as dictionary_utils
@@ -66,6 +66,7 @@ def _add_resources(self, location):
         self._add_startup_classes(location)
         self._add_shutdown_classes(location)
 
+        common_deployer.add_custom_resources(self._resources, location)
         common_deployer.add_ejb_container(self._resources, location)
         common_deployer.add_foreign_jndi_providers(self._resources, location)
         common_deployer.add_file_stores(self._resources, location)

core/src/main/python/wlsdeploy/tool/deploy/topology_updater.py

@@ -86,7 +86,7 @@ def _add_model_elements(self, type_name, model_nodes, location):
                                                     self.attribute_setter)
 
     # Override
-    def _create_and_cd(self, location, existing_names):
+    def _create_and_cd(self, location, existing_names, child_nodes):
         _method_name = '_create_and_cd'
 
         self.logger.entering(str_helper.to_string(location), existing_names,

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

@@ -55,9 +55,6 @@ def discover(self):
         _logger.entering(class_name=_class_name, method_name=_method_name)
         model_folder_name, folder_result = self.get_datasources()
         discoverer.add_to_model_if_not_empty(self._dictionary, model_folder_name, folder_result)
-
-        self.discover_domain_single_mbean(model_constants.EJB_CONTAINER, self._dictionary)
-
         model_folder_name, folder_result = self.get_foreign_jndi_providers()
         discoverer.add_to_model_if_not_empty(self._dictionary, model_folder_name, folder_result)
         model_folder_name, folder_result = self.get_mail_sessions()
@@ -69,9 +66,6 @@ def discover(self):
         model_folder_name, folder_result = self.get_path_services()
         discoverer.add_to_model_if_not_empty(self._dictionary, model_folder_name, folder_result)
 
-        self.discover_domain_single_mbean(model_constants.SNMP_AGENT, self._dictionary)
-        self.discover_domain_named_mbeans(model_constants.SNMP_AGENT_DEPLOYMENT, self._dictionary)
-
         JmsResourcesDiscoverer(self._model_context, self._dictionary, self._base_location, wlst_mode=self._wlst_mode,
                                aliases=self._aliases, credential_injector=self._get_credential_injector()).discover()
 

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

@@ -62,6 +62,11 @@ def discover(self):
         model_top_folder_name, optional_feature_deployment = self.get_optional_feature_deployment()
         discoverer.add_to_model_if_not_empty(self._dictionary, model_top_folder_name, optional_feature_deployment)
 
+        self.discover_domain_named_mbeans(model_constants.CUSTOM_RESOURCE, self._dictionary)
+        self.discover_domain_single_mbean(model_constants.EJB_CONTAINER, self._dictionary)
+        self.discover_domain_single_mbean(model_constants.SNMP_AGENT, self._dictionary)
+        self.discover_domain_named_mbeans(model_constants.SNMP_AGENT_DEPLOYMENT, self._dictionary)
+
         _logger.exiting(class_name=_class_name, method_name=_method_name)
         return self._dictionary
 

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

@@ -378,6 +378,25 @@ def create_and_cd(self, aliases, type_name, name, location, create_path=None):
         self.__logger.exiting(result=result, class_name=self.__class_name, method_name=_method_name)
         return result
 
+    def create_custom_resource(self, name, resource_class, bean_descriptor_class, descriptor_file_name):
+        _method_name = 'create_custom_resource'
+        self.__logger.entering(name, resource_class, bean_descriptor_class, descriptor_file_name,
+                               class_name=self.__class_name, method_name=_method_name)
+        try:
+            cmo = self.get_mbean()
+            if descriptor_file_name:
+                resource = cmo.createCustomResource(name, resource_class, bean_descriptor_class, descriptor_file_name)
+            else:
+                resource = cmo.createCustomResource(name, resource_class, bean_descriptor_class)
+            self.__logger.exiting(class_name=self.__class_name, method_name=_method_name)
+            return resource
+        except (self.__load_global('WLSTException'), offlineWLSTException), e:
+            pwe = exception_helper.create_exception(self.__exception_type, 'WLSDPLY-00137', name,
+                                                    resource_class, bean_descriptor_class, descriptor_file_name,
+                                                    _format_exception(e), error=e)
+            self.__logger.throwing(class_name=self.__class_name, method_name=_method_name, error=pwe)
+            raise pwe
+
     def delete(self, name, folder):
         """
         Delete an MBean of the specified name and type at the current location.

core/src/main/python/wlsdeploy/util/tool_main.py

@@ -6,8 +6,8 @@
 import sys
 import traceback
 
-from java.lang import Exception as JException
 from java.lang import System as JSystem
+from java.lang import Throwable as JThrowable
 from java.util.logging import Level as JLevel
 
 from oracle.weblogic.deploy.aliases import VersionUtils
@@ -85,7 +85,7 @@ def run_tool(main, process_args, args, program_name, class_name, logger):
     except exceptions.SystemExit, ex:
         cla_helper.clean_up_temp_files()
         raise ex
-    except (exceptions.Exception, JException), ex:
+    except (exceptions.Exception, JThrowable), ex:
         exit_code = ExitCode.ERROR
         __handle_unexpected_exception(ex, model_context_obj, class_name, _method_name, logger)