Merge branch 'github-1576-2' into 'main'

fixing RCU pre-check handling of JDBC driver properties from the model

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

Author: robertpatrick

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

@@ -390,6 +390,7 @@
 DRIVER_NAME = 'DriverName'
 DRIVER_PARAMS_PROPERTY_VALUE = 'Value'
 DRIVER_PARAMS_PROPERTY_VALUE_ENCRYPTED = 'EncryptedValueEncrypted'
+DRIVER_PARAMS_PROPERTY_SYS_PROP_VALUE = 'SysPropValue'
 DRIVER_PARAMS_USER_PROPERTY = 'user'
 DRIVER_PARAMS_TRUSTSTORE_PROPERTY = 'javax.net.ssl.trustStore'
 DRIVER_PARAMS_KEYSTORE_PROPERTY = 'javax.net.ssl.keyStore'

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

@@ -43,6 +43,7 @@
 from wlsdeploy.aliases.model_constants import DRIVER_PARAMS_NET_TNS_ADMIN
 from wlsdeploy.aliases.model_constants import DRIVER_PARAMS_PROPERTY_VALUE
 from wlsdeploy.aliases.model_constants import DRIVER_PARAMS_PROPERTY_VALUE_ENCRYPTED
+from wlsdeploy.aliases.model_constants import DRIVER_PARAMS_PROPERTY_SYS_PROP_VALUE
 from wlsdeploy.aliases.model_constants import DRIVER_PARAMS_TRUSTSTOREPWD_PROPERTY
 from wlsdeploy.aliases.model_constants import DRIVER_PARAMS_TRUSTSTORETYPE_PROPERTY
 from wlsdeploy.aliases.model_constants import DRIVER_PARAMS_TRUSTSTORE_PROPERTY
@@ -887,7 +888,55 @@ def __update_precheck_from_model_data_source(self, jdbc_driver_name, jdbc_conn_s
             props.put('password', new_password)
 
         for prop_key, prop_value in model_properties_dict.iteritems():
-            props.put(prop_key, prop_value)
+            if isinstance(prop_value, dict):
+                if DRIVER_PARAMS_PROPERTY_VALUE in prop_value:
+                    props.put(prop_key, prop_value[DRIVER_PARAMS_PROPERTY_VALUE])
+                elif DRIVER_PARAMS_PROPERTY_SYS_PROP_VALUE in prop_value:
+                    sys_prop_name = prop_value[DRIVER_PARAMS_PROPERTY_SYS_PROP_VALUE]
+                    sys_prop_value = None
+                    if sys_prop_name is not None:
+                        sys_prop_value = System.getProperty(sys_prop_name)
+
+                    if sys_prop_value is not None:
+                        props.put(prop_key, sys_prop_value)
+                    else:
+                        if sys_prop_name is None:
+                            self.__logger.warning('WLSDPLY-12271', data_source_name, prop_key,
+                                                  DRIVER_PARAMS_PROPERTY_SYS_PROP_VALUE,
+                                                  class_name=self.__class_name, method_name=_method_name)
+                        else:
+                            # The system property specified might be something like "weblogic.Name", which
+                            # will be set for the actual DataSource inside the server but typically won't
+                            # be set in a WDT createDomain environment so log as info instead of warning
+                            # so that createDomain doesn't exit with a non-zero exit code.
+                            #
+                            self.__logger.info('WLSDPLY-12273', data_source_name, prop_key,
+                                               DRIVER_PARAMS_PROPERTY_SYS_PROP_VALUE, sys_prop_name,
+                                               class_name=self.__class_name, method_name=_method_name)
+                else:
+                    unhandled_field_name = None
+                    if DRIVER_PARAMS_PROPERTY_VALUE_ENCRYPTED in prop_value:
+                        unhandled_field_name = DRIVER_PARAMS_PROPERTY_VALUE_ENCRYPTED
+
+                    if unhandled_field_name is not None:
+                        ex = exception_helper.create_create_exception('WLSDPLY-12265', data_source_name,
+                                                                      prop_key, DRIVER_PARAMS_PROPERTY_VALUE,
+                                                                      unhandled_field_name)
+                        self.__logger.throwing(ex, class_name=self.__class_name, method_name=_method_name)
+                        raise ex
+                    else:
+                        unhandled_field_names = prop_value.keys()
+                        if len(unhandled_field_names) > 0:
+                            # This should never happen since validation should catch unsupported fields
+                            unhandled_field_name = unhandled_field_names.join(',')
+                            ex = exception_helper.create_create_exception('WLSDPLY-12266', data_source_name,
+                                                                          prop_key, DRIVER_PARAMS_PROPERTY_VALUE,
+                                                                          unhandled_field_name)
+                        else:
+                            ex = exception_helper.create_create_exception('WLSDPLY-12267', data_source_name,
+                                                                          prop_key, DRIVER_PARAMS_PROPERTY_VALUE)
+                        self.__logger.throwing(ex, class_name=self.__class_name, method_name=_method_name)
+                        raise ex
 
         self.__logger.exiting(class_name=self.__class_name, method_name=_method_name,
                               result=[new_jdbc_driver_name, new_jdbc_conn_string])

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

@@ -1846,15 +1846,23 @@ WLSDPLY-12263=Unable to retrieve database connection info, please make sure the
 WLSDPLY-12264=Unable to retrieve database connection string, please make sure it is specified in \
   RCUDbInfo.rcu_db_conn_string field or by using the RCUDbInfo.oracle.net.tns_admin and RCUDbInfo.tns_alias fields to \
   point to the tnsnames.ora file location and tns alias entry to use.
-WLSDPLY-12265=NOT USED
-WLSDPLY-12266=NOT USED
-WLSDPLY-12267=NOT USED
+WLSDPLY-12265=During RCU pre-check, the resources section of the model contained JDBCSystemResource {0} that defined a \
+  JDBCDriverParams Property {1} that did not have the excepted key {2} but had the key {3} instead.  This key is not \
+  currently handled so please raise a GitHub issue if you require support for this key type.
+WLSDPLY-12266=During RCU pre-check, the resources section of the model contained JDBCSystemResource {0} that defined a \
+  JDBCDriverParams Property {1} that did not have the excepted key {2} but had unsupported keys [{3}] instead.
+WLSDPLY-12267=During RCU pre-check, the resources section of the model contained JDBCSystemResource {0} that defined a \
+  JDBCDriverParams Property {1} that did not have the excepted key {2} and no other keys were provided.
 WLSDPLY-12268=Creating empty folder {0}. Folder contains no attributes or sub-folders.
 WLSDPLY-12269=Setting the topology profile to {0}
 WLSDPLY-12270=Unable to retrieve database connection info: {0}
-WLSDPLY-12271=NOT USED
+WLSDPLY-12271=During RCU pre-check, the resources section of the model contained JDBCSystemResource {0} that defined a \
+  JDBCDriverParams Property {1} that specified the key {2} but the specified Java System Property name was not provided, \
+  so it is being skipped.
 WLSDPLY-12272=Failed to create domain because RCUDbinfo is missing rcu_db_conn_string
-WLSDPLY-12273=NOT USED
+WLSDPLY-12273=During RCU pre-check, the resources section of the model contained JDBCSystemResource {0} that defined a \
+  JDBCDriverParams Property {1} that specified the key {2} but the specified Java System Property "{3}" had no value so \
+  is it is being skipped.
 WLSDPLY-12274=Path {0} specified for JDBC driver property {1} does not exist.  Please check your model's RCUDbInfo section.
 WLSDPLY-12275=Setting rcu datasource {0} driver params - url: {1}. schema: {2}. properties: {3}.
 WLSDPLY-12276=Post Create Domain Script {0} was run successfully