#565 RCU alternate user (#653)

jshum2479 · web-flow · commit 46b1edc470bc · 2020-06-24T13:59:25.000-05:00
* support different db user
diff --git a/core/src/main/java/oracle/weblogic/deploy/create/RCURunner.java b/core/src/main/java/oracle/weblogic/deploy/create/RCURunner.java
@@ -76,6 +76,7 @@ public class RCURunner {
     private boolean ATP_DB = false;
     private String atpSSlArgs = null;
     private String atpAdminUser = null;
+    private String rcuAdminUser = DB_USER;
     private String atpDefaultTablespace = null;
     private String atpTemporaryTablespace = null;
     private String rcuVariables = null;
@@ -263,7 +264,7 @@ private String[] getRcuDropArgs() {
 
         } else {
             dropArgs.add(DB_USER_SWITCH);
-            dropArgs.add(DB_USER);
+            dropArgs.add(getRCUAdminUser());
             dropArgs.add(DB_ROLE_SWITCH);
             dropArgs.add(DB_ROLE);
         }
@@ -305,7 +306,7 @@ private String[] getRcuCreateArgs() {
             createArgs.add(atpSSlArgs);
         } else {
             createArgs.add(DB_USER_SWITCH);
-            createArgs.add(DB_USER);
+            createArgs.add(getRCUAdminUser());
             createArgs.add(DB_ROLE_SWITCH);
             createArgs.add(DB_ROLE);
         }
@@ -362,6 +363,14 @@ private int getExtraRcuSchemaPasswordCount(RcuOpType rcuOpType) {
         return result;
     }
 
+    public void setRCUAdminUser(String rcuDBUser) {
+        rcuAdminUser = rcuDBUser;
+    }
+
+    public String getRCUAdminUser() {
+        return rcuAdminUser;
+    }
+
     private static boolean isSchemaNotExistError(ScriptRunner runner) {
         List<String> stdoutBuffer = runner.getStdoutBuffer();
         boolean schemaDoesNotExist = false;
diff --git a/core/src/main/python/create.py b/core/src/main/python/create.py
@@ -69,6 +69,7 @@
     CommandLineArgUtil.RUN_RCU_SWITCH,
     CommandLineArgUtil.RCU_SYS_PASS_SWITCH,
     CommandLineArgUtil.RCU_DB_SWITCH,
+    CommandLineArgUtil.RCU_DB_USER_SWITCH,
     CommandLineArgUtil.RCU_PREFIX_SWITCH,
     CommandLineArgUtil.RCU_SCHEMA_PASS_SWITCH,
     CommandLineArgUtil.VARIABLE_FILE_SWITCH,
diff --git a/core/src/main/python/wlsdeploy/aliases/model_constants.py b/core/src/main/python/wlsdeploy/aliases/model_constants.py
@@ -28,6 +28,7 @@
 RCU_PREFIX = 'rcu_prefix'
 RCU_SCHEMA_PASSWORD = 'rcu_schema_password'
 RCU_ADMIN_PASSWORD = 'rcu_admin_password'
+RCU_DB_USER = 'rcu_db_user'
 RCU_DB_CONN = 'rcu_db_conn_string'
 RCU_VARIABLES = 'rcu_variables'
 USE_ATP = 'useATP'
diff --git a/core/src/main/python/wlsdeploy/tool/create/domain_creator.py b/core/src/main/python/wlsdeploy/tool/create/domain_creator.py
@@ -283,22 +283,28 @@ def __run_rcu(self):
                                    rcu_db_info.get_rcu_variables())
                 runner.runRcu(rcu_sys_pass, rcu_schema_pass)
             else:
+                # Has RCUDbInfo in the model but non ATP case
                 rcu_db = rcu_db_info.get_rcu_regular_db_conn()
                 rcu_prefix = rcu_db_info.get_rcu_prefix()
                 rcu_sys_pass = rcu_db_info.get_admin_password()
                 rcu_schema_pass = rcu_db_info.get_rcu_schema_password()
+                rcu_db_user = rcu_db_info.get_rcu_db_user()
                 self.__validate_rcudbinfo_entries(rcu_properties_map, [RCU_PREFIX, RCU_SCHEMA_PASSWORD,
                                                                        RCU_ADMIN_PASSWORD, RCU_DB_CONN])
                 runner = RCURunner(domain_type, oracle_home, java_home, rcu_db, rcu_prefix, rcu_schemas,
                                    rcu_db_info.get_rcu_variables())
+                runner.setRCUAdminUser(rcu_db_user)
                 runner.runRcu(rcu_sys_pass, rcu_schema_pass)
         else:
+            # No RCUDbInfo in the model. CLI case
             rcu_db = self.model_context.get_rcu_database()
             rcu_prefix = self.model_context.get_rcu_prefix()
             rcu_sys_pass = self.model_context.get_rcu_sys_pass()
             rcu_schema_pass = self.model_context.get_rcu_schema_pass()
+            rcu_db_user = self.model_context.get_rcu_db_user()
 
             runner = RCURunner(domain_type, oracle_home, java_home, rcu_db, rcu_prefix, rcu_schemas, None)
+            runner.setRCUAdminUser(rcu_db_user)
             runner.runRcu(rcu_sys_pass, rcu_schema_pass)
 
         self.logger.exiting(class_name=self.__class_name, method_name=_method_name)
diff --git a/core/src/main/python/wlsdeploy/tool/create/rcudbinfo_helper.py b/core/src/main/python/wlsdeploy/tool/create/rcudbinfo_helper.py
@@ -14,6 +14,7 @@
 from wlsdeploy.aliases.model_constants import RCU_DB_CONN
 from wlsdeploy.aliases.model_constants import RCU_PREFIX
 from wlsdeploy.aliases.model_constants import RCU_SCHEMA_PASSWORD
+from wlsdeploy.aliases.model_constants import RCU_DB_USER
 from wlsdeploy.aliases.model_constants import RCU_VARIABLES
 from wlsdeploy.aliases.model_constants import USE_ATP
 
@@ -75,6 +76,12 @@ def get_atp_admin_user(self):
         else:
             return 'admin'
 
+    def get_rcu_db_user(self):
+        if RCU_DB_USER in self.rcu_properties_map:
+            return self.rcu_properties_map[RCU_DB_USER]
+        else:
+            return 'SYS'
+
     def get_rcu_variables(self):
         if RCU_VARIABLES in self.rcu_properties_map:
             return self.rcu_properties_map[RCU_VARIABLES]
diff --git a/core/src/main/python/wlsdeploy/util/cla_utils.py b/core/src/main/python/wlsdeploy/util/cla_utils.py
@@ -49,6 +49,7 @@ class CommandLineArgUtil(object):
     PREVIOUS_MODEL_FILE_SWITCH = '-prev_model_file'
     VARIABLE_FILE_SWITCH       = '-variable_file'
     RCU_DB_SWITCH              = '-rcu_db'
+    RCU_DB_USER_SWITCH         = '-rcu_db_user'
     RCU_PREFIX_SWITCH          = '-rcu_prefix'
     # phony arg used as a key to store the password
     RCU_SYS_PASS_SWITCH        = '-rcu_sys_pass'
@@ -247,6 +248,10 @@ def process_args(self, args, tool_type=TOOL_TYPE_DEFAULT, trailing_arg_count=0):
                 value, idx = self._get_arg_value(args, idx)
                 self._validate_rcu_database_arg(value)
                 self._add_arg(key, value)
+            elif self.is_rcu_dbuser_key(key):
+                value, idx = self._get_arg_value(args, idx)
+                self._validate_rcu_dbuser_arg(value)
+                self._add_arg(key, value)
             elif self.is_rcu_prefix_key(key):
                 value, idx = self._get_arg_value(args, idx)
                 self._validate_rcu_prefix_arg(value)
@@ -803,6 +808,21 @@ def _validate_rcu_database_arg(self, value):
             raise ex
         return
 
+    def get_rcu_dbuser_key(self):
+        return self.RCU_DB_USER_SWITCH
+
+    def is_rcu_dbuser_key(self, key):
+        return self.RCU_DB_USER_SWITCH == key
+
+    def _validate_rcu_dbuser_arg(self, value):
+        method_name = '_validate_rcu_dbuser_arg'
+        if value is None or len(value) == 0:
+            ex = exception_helper.create_cla_exception('WLSDPLY-01622')
+            ex.setExitCode(self.ARG_VALIDATION_ERROR_EXIT_CODE)
+            self._logger.throwing(ex, class_name=self._class_name, method_name=method_name)
+            raise ex
+        return
+
     def get_rcu_prefix_key(self):
         return self.RCU_PREFIX_SWITCH
 
diff --git a/core/src/main/python/wlsdeploy/util/model_context.py b/core/src/main/python/wlsdeploy/util/model_context.py
@@ -83,6 +83,7 @@ def __init__(self, program_name, arg_map):
         self._variable_injector_file = None
         self._variable_keywords_file = None
         self._variable_properties_file = None
+        self._rcu_db_user = 'SYS'
 
         self._trailing_args = []
 
@@ -148,6 +149,9 @@ def __init__(self, program_name, arg_map):
         if CommandLineArgUtil.RCU_SYS_PASS_SWITCH in arg_map:
             self._rcu_sys_pass = arg_map[CommandLineArgUtil.RCU_SYS_PASS_SWITCH]
 
+        if CommandLineArgUtil.RCU_DB_USER_SWITCH in arg_map:
+            self._rcu_db_user = arg_map[CommandLineArgUtil.RCU_DB_USER_SWITCH]
+
         if CommandLineArgUtil.RCU_SCHEMA_PASS_SWITCH in arg_map:
             self._rcu_schema_pass = arg_map[CommandLineArgUtil.RCU_SCHEMA_PASS_SWITCH]
 
@@ -452,6 +456,13 @@ def get_rcu_prefix(self):
         """
         return self._rcu_prefix
 
+    def get_rcu_db_user(self):
+        """
+        Get the RCU DB user.
+        :return: the RCU dbUser
+        """
+        return self._rcu_db_user
+
     def get_rcu_sys_pass(self):
         """
         Get the RCU database SYS user password.
diff --git a/core/src/main/resources/oracle/weblogic/deploy/aliases/category_modules/RCUDbInfo.json b/core/src/main/resources/oracle/weblogic/deploy/aliases/category_modules/RCUDbInfo.json
@@ -13,6 +13,7 @@
         "rcu_admin_password":               [ {"version": "[10,)", "wlst_mode": "both", "wlst_name": "rcu_admin_password",               "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "password" } ],
         "rcu_db_conn_string":               [ {"version": "[10,)", "wlst_mode": "both", "wlst_name": "rcu_db_conn_string",               "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "string" } ],
         "rcu_prefix":                       [ {"version": "[10,)", "wlst_mode": "both", "wlst_name": "rcu_prefix",                       "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "string" } ],
+        "rcu_db_user":                      [ {"version": "[10,)", "wlst_mode": "both", "wlst_name": "rcu_db_user",                      "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "string" } ],
         "rcu_schema_password":              [ {"version": "[10,)", "wlst_mode": "both", "wlst_name": "rcu_schema_password",              "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "password" } ],
         "rcu_variables":                    [ {"version": "[10,)", "wlst_mode": "both", "wlst_name": "rcu_variables",                    "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "string" } ],
         "tns.alias":                        [ {"version": "[10,)", "wlst_mode": "both", "wlst_name": "tns.alias",                        "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "string" } ],
diff --git a/installer/src/main/bin/createDomain.cmd b/installer/src/main/bin/createDomain.cmd
@@ -82,6 +82,7 @@ ECHO              [-variable_file ^<variable_file^>]
 ECHO              [-wlst_path ^<wlst_path^>]
 ECHO              [-rcu_db ^<rcu_database^>
 ECHO               -rcu_prefix ^<rcu_prefix^>
+ECHO               -rcu_db_user ^<rcu_db_user^>
 ECHO              ]
 ECHO.
 ECHO     where:
@@ -128,6 +129,9 @@ ECHO.
 ECHO         rcu_prefix      - the RCU prefix to use (if the domain type requires
 ECHO                           RCU).
 ECHO.
+ECHO         rcu_db_user    - the RCU dbUser to use (if the domain type requires
+ECHO                           RCU.  Default SYS if not specified).  This user must have SYSDBA privilege
+ECHO.
 ECHO    The -use_encryption switch tells the program that one or more of the
 ECHO    passwords in the model or variables files are encrypted.  The program will
 ECHO    prompt for the decryption passphrase to use to decrypt the passwords.
diff --git a/installer/src/main/bin/createDomain.sh b/installer/src/main/bin/createDomain.sh
@@ -43,6 +43,7 @@ usage() {
   echo "          [-wlst_path <wlst_path>]"
   echo "          [-rcu_db <rcu_database>"
   echo "           -rcu_prefix <rcu_prefix>"
+  echo "           -rcu_db_user <rcu dbUser>"
   echo "          ]"
   echo ""
   echo "    where:"
@@ -89,6 +90,9 @@ usage() {
   echo "        rcu_prefix      - the RCU prefix to use (if the domain type requires"
   echo "                          RCU)."
   echo ""
+  echo "        rcu_db_user     - the RCU dbUser to use (if the domain type requires"
+  echo "                          RCU.  Default SYS if not specified). This user must have SYSDBA privilege"
+  echo ""
   echo "    The -use_encryption switch tells the program that one or more of the"
   echo "    passwords in the model or variables files are encrypted.  The program will"
   echo "    prompt for the decryption passphrase to use to decrypt the passwords."
diff --git a/site/create.md b/site/create.md
@@ -15,7 +15,7 @@ Clearly, creating an empty domain with only the template-defined servers is not
 
 The Create Domain Tool understands three domain types: `WLS`, `RestrictedJRF`, and `JRF`.  When specifying the domain type, the Oracle Home must match the requirements for the domain type.  Both `RestrictedJRF` and `JRF` require an Oracle Home with the FMW Infrastucture (also known as JRF) installed.  When creating a JRF domain, the RCU database information must be provided as arguments to the `createDomain` script.  Note that the tool will prompt for any passwords required.  Optionally, they can be piped to standard input (for example, `stdin`) of the script, to make the script run without user input.  For example, the command to create a JRF domain looks like the one below.  Note that this requires the user to have run RCU prior to running the command.
 
-    weblogic-deploy\bin\createDomain.cmd -oracle_home c:\jrf12213 -domain_type JRF -domain_parent d:\demo\domains -model_file DemoDomain.yaml -rcu_db mydb.example.com:1539/PDBORCL -rcu_prefix DEMO
+    weblogic-deploy\bin\createDomain.cmd -oracle_home c:\jrf12213 -domain_type JRF -domain_parent d:\demo\domains -model_file DemoDomain.yaml -rcu_db mydb.example.com:1539/PDBORCL -rcu_prefix DEMO [-rcu_db_user SYS]
 
 To have the Create Domain Tool run RCU, simply add the `-run_rcu` argument to the previous command line and the RCU schemas will be automatically created.  Be aware that when the tool runs RCU, it will automatically drop any conflicting schemas that already exist with the same RCU prefix prior to creating the new schemas!
 
diff --git a/site/rcuinfo.md b/site/rcuinfo.md
@@ -29,6 +29,9 @@ For a non-ATP database, use the following example:
 domainInfo:
     RCUDbInfo:
         rcu_prefix : DEV
+        # Optional rcu_db_user for creating RCU schema if -run_rcu flag is specified. Default user is SYS if not specified
+        # This user must have SYSDBA privilege and this is the equivalent of -dbUser in the RCU utility
+        rcu_db_user: superuser
         rcu_schema_password : xxxxx
         rcu_admin_password : xxxx
         rcu_db_conn_string : 'dbhost:1521/pdborcl'
diff --git a/site/type_def.md b/site/type_def.md
@@ -100,7 +100,7 @@ This file tells the Create Domain Tool which templates to use to create the doma
 
 After the new domain `typedef` file exists, simply specify the new domain type name to the `createDomain` script, being sure to reference an Oracle Home with the required components installed.  For pre-12.2.1 versions, the `-wlst_path` argument must be used to point to the product home where the appropriate WLST shell script exists; for example, for SOA 12.1.3, add `-wlst_path <ORACLE_HOME>/soa` so that the tool uses the WLST shell script with the proper environment for SOA domains.  In 12.2.1 and later, this is no longer necessary because the WLST shell script in the standard `<ORACLE_HOME>oracle_common/common/bin` directory will automatically load all components in the Oracle Home.  Using the new domain type, simply run the following command to run RCU and create the SOA domain with all of its resources and applications deployed.
 
-    weblogic-deploy\bin\createDomain.cmd -oracle_home d:\SOA12213 -domain_type SOA -domain_parent d:\demo\domains -model_file DemoDomain.yaml -archive_file DemoDomain.zip -variable_file DemoDomain.properties -run_rcu -rcu_db mydb.example.com:1539/PDBORCL -rcu_prefix DEMO
+    weblogic-deploy\bin\createDomain.cmd -oracle_home d:\SOA12213 -domain_type SOA -domain_parent d:\demo\domains -model_file DemoDomain.yaml -archive_file DemoDomain.zip -variable_file DemoDomain.properties -run_rcu -rcu_db mydb.example.com:1539/PDBORCL -rcu_prefix DEMO [-rcu_db_user SYS]
 
 ### Server Group Targeting
 
