Merge branch 'wdt-776' into 'main'

Adding new mechanism to skip RCU drop schemas and other RCU-related cleanup

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

Author: robertpatrick

core/src/main/java/oracle/weblogic/deploy/create/RCURunner.java

@@ -62,7 +62,8 @@ public class RCURunner {
     private static final String COMPONENT_INFO_LOCATION_SWITCH = "-compInfoXMLLocation";
     private static final String STORAGE_LOCATION_SWITCH = "-storageXMLLocation";
 
-    private static final Pattern SCHEMA_DOES_NOT_EXIST_PATTERN = Pattern.compile("(ORA-01918|RCU-6013|ORA-12899)");
+    private static final Pattern SCHEMA_DOES_NOT_EXIST_PATTERN = Pattern.compile("(ORA-01918|RCU-6013[^0-9])");
+    private static final Pattern SCHEMA_ALREADY_EXISTS_PATTERN = Pattern.compile("RCU-6016[^0-9]");
 
     private final File oracleHome;
     private final File javaHome;
@@ -236,7 +237,7 @@ public void setXmlLocations(String componentInfoLocation, String storageLocation
      * @param rcuSchemaPass the RCU database schema password to use for all RCU schemas
      * @throws CreateException if an error occurs with parameter validation or running RCU
      */
-    public void runRcu(String rcuSysPass, String rcuSchemaPass) throws CreateException {
+    public void runRcu(String rcuSysPass, String rcuSchemaPass, boolean disableRcuDropSchema) throws CreateException {
         final String METHOD = "runRcu";
 
         File rcuBinDir = new File(new File(oracleHome, "oracle_common"), "bin");
@@ -246,45 +247,50 @@ public void runRcu(String rcuSysPass, String rcuSchemaPass) throws CreateExcepti
         validateNonEmptyString(rcuSysPass, "rcu_sys_password", true);
         validateNonEmptyString(rcuSchemaPass, "rcu_schema_password", true);
 
-        Map<String, String> dropEnv = getRcuDropEnv();
-        String[] scriptArgs = getCommandLineArgs(DROP_REPO_SWITCH);
-        List<String> scriptStdinLines = getRcuDropStdinLines(rcuSysPass, rcuSchemaPass);
-        ScriptRunner runner = new ScriptRunner(dropEnv, RCU_DROP_LOG_BASENAME);
-        int exitCode;
-        try {
-            exitCode = runner.executeScript(rcuScript, scriptStdinLines, scriptArgs);
-        } catch (ScriptRunnerException sre) {
-            CreateException ce = new CreateException("WLSDPLY-12001", sre, CLASS, sre.getLocalizedMessage());
-            LOGGER.throwing(CLASS, METHOD, ce);
-            throw ce;
-        }
-        // RCU is stupid and RCU drop exits with exit code 1 if the schemas do not exist...sigh
-        //
-
-        if (exitCode != 0 && !isSchemaNotExistError(runner)) {
-            CreateException ce = new CreateException("WLSDPLY-12002", CLASS, exitCode, runner.getStdoutFileName());
-            LOGGER.throwing(CLASS, METHOD, ce);
-            throw ce;
+        if (!disableRcuDropSchema) {
+            Map<String, String> dropEnv = getRcuDropEnv();
+            String[] scriptArgs = getCommandLineArgs(DROP_REPO_SWITCH);
+            List<String> scriptStdinLines = getRcuDropStdinLines(rcuSysPass, rcuSchemaPass);
+            ScriptRunner runner = new ScriptRunner(dropEnv, RCU_DROP_LOG_BASENAME);
+            int exitCode;
+            try {
+                exitCode = runner.executeScript(rcuScript, scriptStdinLines, scriptArgs);
+            } catch (ScriptRunnerException sre) {
+                CreateException ce = new CreateException("WLSDPLY-12001", sre, CLASS, sre.getLocalizedMessage());
+                LOGGER.throwing(CLASS, METHOD, ce);
+                throw ce;
+            }
+            // RCU is stupid and RCU drop exits with exit code 1 if the schemas do not exist...sigh
+            //
+            if (exitCode != 0 && !isSchemaNotExistError(runner)) {
+                CreateException ce = new CreateException("WLSDPLY-12002", CLASS, exitCode, runner.getStdoutFileName());
+                LOGGER.throwing(CLASS, METHOD, ce);
+                throw ce;
+            }
         }
 
         Map<String, String> createEnv = getRcuCreateEnv();
-        scriptArgs = getCommandLineArgs(CREATE_REPO_SWITCH);
-        scriptStdinLines = getRcuCreateStdinLines(rcuSysPass, rcuSchemaPass);
-        runner = new ScriptRunner(createEnv, RCU_CREATE_LOG_BASENAME);
+        String[] scriptArgs = getCommandLineArgs(CREATE_REPO_SWITCH);
+        List<String> scriptStdinLines = getRcuCreateStdinLines(rcuSysPass, rcuSchemaPass);
+        ScriptRunner runner = new ScriptRunner(createEnv, RCU_CREATE_LOG_BASENAME);
+        int exitCode;
         try {
             exitCode = runner.executeScript(rcuScript, scriptStdinLines, scriptArgs);
-            if (atpDB && exitCode != 0 && isSchemaNotExistError(runner)) {
-                exitCode = 0;
-            }
         } catch (ScriptRunnerException sre) {
             CreateException ce = new CreateException("WLSDPLY-12003", sre, CLASS, sre.getLocalizedMessage());
             LOGGER.throwing(CLASS, METHOD, ce);
             throw ce;
         }
         if (exitCode != 0) {
-            CreateException ce = new CreateException("WLSDPLY-12002", CLASS, exitCode, runner.getStdoutFileName());
-            LOGGER.throwing(CLASS, METHOD, ce);
-            throw ce;
+            if (disableRcuDropSchema && isSchemaAlreadyExistsError(runner)) {
+                CreateException ce = new CreateException("WLSDPLY-12015", CLASS, rcuPrefix, runner.getStdoutFileName());
+                LOGGER.throwing(CLASS, METHOD, ce);
+                throw ce;
+            } else {
+                CreateException ce = new CreateException("WLSDPLY-12002", CLASS, exitCode, runner.getStdoutFileName());
+                LOGGER.throwing(CLASS, METHOD, ce);
+                throw ce;
+            }
         }
     }
 
@@ -424,6 +430,19 @@ private static boolean isSchemaNotExistError(ScriptRunner runner) {
         return schemaDoesNotExist;
     }
 
+    private static boolean isSchemaAlreadyExistsError(ScriptRunner runner) {
+        List<String> stdoutBuffer = runner.getStdoutBuffer();
+        boolean schemaAlreadyExists = false;
+        for (String line : stdoutBuffer) {
+            Matcher matcher = SCHEMA_ALREADY_EXISTS_PATTERN.matcher(line);
+            if (matcher.find()) {
+                schemaAlreadyExists = true;
+                break;
+            }
+        }
+        return schemaAlreadyExists;
+    }
+
     private static String quoteStringForCommandLine(String text, String textTypeName) throws CreateException {
         String result = validateNonEmptyString(text, textTypeName);
         return StringUtils.quoteString(result);

core/src/main/python/create.py

@@ -28,6 +28,8 @@
 from wlsdeploy.aliases import model_constants
 from wlsdeploy.aliases.model_constants import DEFAULT_WLS_DOMAIN_NAME
 from wlsdeploy.aliases.model_constants import DOMAIN_NAME
+from wlsdeploy.aliases.model_constants import PATH_TO_RCU_DB_CONN
+from wlsdeploy.aliases.model_constants import PATH_TO_RCU_PREFIX
 from wlsdeploy.aliases.model_constants import TOPOLOGY
 from wlsdeploy.aliases.wlst_modes import WlstModes
 from wlsdeploy.exception import exception_helper
@@ -248,23 +250,21 @@ def validate_rcu_args_and_model(model_context, model, archive_helper, aliases):
         has_atpdbinfo = rcu_db_info.has_atpdbinfo()
         has_ssldbinfo = rcu_db_info.has_ssldbinfo()
 
-        _validate_atp_wallet_in_archive(archive_helper, is_regular_db, has_tns_admin, model,
-                                        model_context)
+        _validate_atp_wallet_in_archive(archive_helper, is_regular_db, has_tns_admin, model)
     else:
-        if model_context.get_domain_typedef().required_rcu():
+        if model_context.get_domain_typedef().requires_rcu():
             if not model_context.get_rcu_database() or not model_context.get_rcu_prefix():
-                __logger.severe('WLSDPLY-12408', model_context.get_domain_type(), CommandLineArgUtil.RCU_DB_SWITCH,
-                                CommandLineArgUtil.RCU_PREFIX_SWITCH, class_name=_class_name, method_name=_method_name)
+                __logger.severe('WLSDPLY-12408', model_context.get_domain_type(), PATH_TO_RCU_DB_CONN,
+                                PATH_TO_RCU_PREFIX, class_name=_class_name, method_name=_method_name)
                 ex = exception_helper.create_create_exception('WLSDPLY-12408', model_context.get_domain_type(),
-                                                              CommandLineArgUtil.RCU_DB_SWITCH,
-                                                              CommandLineArgUtil.RCU_PREFIX_SWITCH)
+                                                              PATH_TO_RCU_DB_CONN, PATH_TO_RCU_PREFIX)
                 __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
                 raise ex
 
     return has_atpdbinfo, has_ssldbinfo
 
 
-def _validate_atp_wallet_in_archive(archive_helper, is_regular_db, has_tns_admin, model, model_context):
+def _validate_atp_wallet_in_archive(archive_helper, is_regular_db, has_tns_admin, model):
     _method_name = '_validate_atp_wallet_in_archive'
     if archive_helper and not is_regular_db:
         # 1. If it does not have the oracle.net.tns_admin specified, then extract to domain/atpwallet
@@ -307,7 +307,7 @@ def _precheck_rcu_connectivity(model_context, creator, rcu_db_info):
     _method_name = '_precheck_rcu_connectivity'
     domain_typename = model_context.get_domain_typedef().get_domain_type()
 
-    if model_context.get_domain_typedef().required_rcu() and not model_context.is_run_rcu() and 'STB' in \
+    if model_context.get_domain_typedef().requires_rcu() and not model_context.is_run_rcu() and 'STB' in \
             model_context.get_domain_typedef().get_rcu_schemas():
         # how to create rcu_db_info ?
         db_conn_props = None
@@ -399,7 +399,7 @@ def main(model_context):
 
         creator.create()
 
-        if model_context.get_domain_typedef().required_rcu():
+        if model_context.get_domain_typedef().requires_rcu():
             if has_atp:
                 atp_helper.fix_jps_config(rcu_db_info, model_context)
             elif has_ssl:

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

@@ -450,3 +450,7 @@
     DOMAIN_NAME,
     ADMIN_SERVER_NAME
 ]
+
+# Model Path constants
+PATH_TO_RCU_DB_CONN = '%s:/%s/%s' % (DOMAIN_INFO, RCU_DB_INFO, RCU_DB_CONN)
+PATH_TO_RCU_PREFIX = '%s:/%s/%s' % (DOMAIN_INFO, RCU_DB_INFO, RCU_PREFIX)

core/src/main/python/wlsdeploy/tool/create/domain_creator.py

@@ -370,7 +370,8 @@ def __run_rcu(self):
         rcu_storage_location = self.__extract_rcu_xml_file(RCU_STG_INFO, rcu_db_info.get_storage_location())
         runner.setXmlLocations(rcu_comp_info_location, rcu_storage_location)
 
-        runner.runRcu(rcu_sys_pass, rcu_schema_pass)
+        disable_rcu_drop_schema = self.model_context.get_model_config().get_disable_rcu_drop_schema() == 'true'
+        runner.runRcu(rcu_sys_pass, rcu_schema_pass, disable_rcu_drop_schema)
         self.logger.exiting(class_name=self.__class_name, method_name=_method_name)
 
     def _set_rcu_ssl_args_properties(self, ssl_conn_properties, rcu_db_info, keystore, keystore_type, truststore,
@@ -1182,7 +1183,7 @@ def __configure_fmw_infra_database(self):
         self.logger.entering(class_name=self.__class_name, method_name=_method_name)
 
         # only continue with RCU configuration for domain type that requires RCU.
-        if not self._domain_typedef.required_rcu():
+        if not self._domain_typedef.requires_rcu():
             self.logger.finer('WLSDPLY-12249', class_name=self.__class_name, method_name=_method_name)
             return
 

core/src/main/python/wlsdeploy/tool/create/domain_typedef.py

@@ -233,7 +233,7 @@ def get_rcu_schemas(self):
         # resolution for create.py argument processing.
         return list(self._domain_typedef['rcuSchemas'])
 
-    def required_rcu(self):
+    def requires_rcu(self):
         """
         Test whether it requires RCU components.
         :return: true if it requires rcu components

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

@@ -45,8 +45,10 @@
 WLST_EDIT_LOCK_EXCLUSIVE_DEFAULT = 'false'
 YAML_FILE_MAX_CODE_POINTS_PROP = 'yaml.max.file.size'
 YAML_FILE_MAX_CODE_POINTS_DEFAULT = '0'
-USE_DEPRECATION_EXIT_CODE_PROP="use.deprecation.exit.code"
-USE_DEPRECATION_EXIT_CODE_DEFAULT="false"
+USE_DEPRECATION_EXIT_CODE_PROP='use.deprecation.exit.code'
+USE_DEPRECATION_EXIT_CODE_DEFAULT='false'
+DISABLE_RCU_DROP_SCHEMA_PROP='disable.rcu.drop.schema'
+DISABLE_RCU_DROP_SCHEMA_DEFAULT='false'
 
 # System Property overrides for WLST timeout properties
 SYS_PROP_PREFIX = 'wdt.config.'
@@ -165,13 +167,22 @@ def get_use_deprecation_exit_code(self):
         """
         return self._get_from_dict(USE_DEPRECATION_EXIT_CODE_PROP, USE_DEPRECATION_EXIT_CODE_DEFAULT)
 
+    def get_disable_rcu_drop_schema(self):
+        """
+        Returns the value to determine whether to disable RCU from dropping schemas if they exist.
+        :return: the string 'true' or 'false' (default)
+        """
+        return self._get_from_dict(DISABLE_RCU_DROP_SCHEMA_PROP, DISABLE_RCU_DROP_SCHEMA_DEFAULT)
+
     def _get_from_dict(self, name, default_value=None):
         _method_name = '_get_from_dict'
         _logger.entering(name, default_value, class_name=_class_name, method_name=_method_name)
+
         result = default_value
         if name in self.__config_dict:
             result = self.__config_dict[name]
         result = System.getProperty(SYS_PROP_PREFIX + name, result)
+
         _logger.exiting(result=result, class_name=_class_name, method_name=_method_name)
         return result
 
@@ -204,7 +215,7 @@ def _load_properties_file():
 
         # Return an empty dict so that failing to load the tool.properties file does
         # not prevent the code above from working using the default values.  The WLST
-        # unit tests are depending on this behavior until they are refactored to all
+        # unit tests depend on this behavior until they are refactored to all
         # copy the tool.properties file into the target/unit_tests/config directory
         # and setting the WDT_CUSTOM_CONFIG environment variable to point to it.
         #

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

@@ -1347,6 +1347,7 @@ WLSDPLY-12011={0} failed to validate the {1} value because it was either empty o
 WLSDPLY-12012={0} failed to run the post create domain script {1}: {2}
 WLSDPLY-12013={0} received exit code {1} from the post create domain script {2}, see the post create domain script stdout file at {3} for more information about what happened
 WLSDPLY-12014=Post create domain script {0}  failed with exit code {1}, see the post create domain script stdout file at {2} for more information about what happened
+WLSDPLY-12015={0} failed to create the RCU schemas because the schemas with RCU prefix {1} already exists and RCU drop schema was disabled. See the RCU stdout file at {2} for more information about what happened
 
 # creator.py
 WLSDPLY-12100=Creating {0} with the name {1}
@@ -1526,7 +1527,7 @@ WLSDPLY-12404=Failed to read the RCU SYS password input from the user: {0}
 WLSDPLY-12405=Please enter the RCU Schema password
 WLSDPLY-12406=Failed to read the RCU Schema password input from the user: {0}
 WLSDPLY-12407={0} invoked with {1} argument but was missing the {2} argument
-WLSDPLY-12408=Domain type {0} definition has RCU schemas defined so the {1} and {2} arguments are required
+WLSDPLY-12408=Domain type {0} definition has RCU schemas defined so the {1} and {2} model attributes are required
 WLSDPLY-12409={0} failed to create the domain: {1}
 WLSDPLY-12410={0} failed to deploy the resources and applications to the domain: {1}
 WLSDPLY-12411=The model file specified ATP database info without oracle.net.tns_admin directory but the archive does \

installer/src/main/lib/tool.properties

@@ -21,3 +21,11 @@ yaml.max.file.size=0
 # no warnings/errors will exit with a non-zero exit code.
 #
 use.deprecation.exit.code=false
+#
+# If set to true and using -run_rcu argument to createDomain,
+# the RCU execution will skip trying to drop any existing
+# schemas with the same RCU prefix.  If one or more of the
+# schemas already exist, RCU create and load schemas execution
+# will fail, causing createDomain itself to fail.
+#
+disable.rcu.drop.schema=false