Allow discover to run without required archive file (#828)

CarolynRountree · web-flow · commit df51ec5d5f68 · 2021-02-02T16:51:30.000-06:00
* Allow discover to run without required archive file

* Add -skip_archive CLA for discover
diff --git a/core/src/main/java/oracle/weblogic/deploy/util/WLSDeployArchive.java b/core/src/main/java/oracle/weblogic/deploy/util/WLSDeployArchive.java
diff --git a/core/src/main/python/discover.py b/core/src/main/python/discover.py
@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.
+Copyright (c) 2017, 2021, Oracle Corporation and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 The entry point for the discoverDomain tool.
@@ -62,13 +62,14 @@
 
 __required_arguments = [
     CommandLineArgUtil.ORACLE_HOME_SWITCH,
-    CommandLineArgUtil.DOMAIN_HOME_SWITCH,
-    CommandLineArgUtil.ARCHIVE_FILE_SWITCH
+    CommandLineArgUtil.DOMAIN_HOME_SWITCH
 ]
 
 __optional_arguments = [
     # Used by shell script to locate WLST
     CommandLineArgUtil.MODEL_FILE_SWITCH,
+    CommandLineArgUtil.ARCHIVE_FILE_SWITCH,
+    CommandLineArgUtil.SKIP_ARCHIVE_FILE_SWITCH,
     CommandLineArgUtil.DOMAIN_TYPE_SWITCH,
     CommandLineArgUtil.JAVA_HOME_SWITCH,
     CommandLineArgUtil.VARIABLE_FILE_SWITCH,
@@ -94,35 +95,56 @@ def __process_args(args):
 
     __wlst_mode = cla_helper.process_online_args(argument_map)
     target_configuration_helper.process_target_arguments(argument_map)
+    __process_model_archive_args(argument_map)
     __process_archive_filename_arg(argument_map)
     __process_variable_filename_arg(argument_map)
     __process_java_home(argument_map)
 
     return model_context_helper.create_context(_program_name, argument_map)
 
 
-def __process_archive_filename_arg(required_arg_map):
+def __process_model_archive_args(argument_map):
+    """
+    Verify that model file and/or archive file is in the argument map
+    :param argument_map: containing the CLA arguments
+    """
+    _method_name = '__process_model_archive_args'
+    if CommandLineArgUtil.ARCHIVE_FILE_SWITCH not in argument_map:
+        if CommandLineArgUtil.SKIP_ARCHIVE_FILE_SWITCH not in argument_map:
+            ex = exception_helper.create_cla_exception('WLSDPLY-06028')
+            __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+            raise ex
+        if CommandLineArgUtil.MODEL_FILE_SWITCH not in argument_map:
+            ex = exception_helper.create_cla_exception('WLSDPLY-06029')
+            __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+            raise ex
+
+
+def __process_archive_filename_arg(argument_map):
     """
     Validate the archive file name and load the archive file object.
-    :param required_arg_map: the required arguments map
+    :param argument_map: the optional arguments map
     :raises CLAException: if a validation error occurs while loading the archive file object
     """
     _method_name = '__process_archive_filename_arg'
 
-    archive_file_name = required_arg_map[CommandLineArgUtil.ARCHIVE_FILE_SWITCH]
-    archive_dir_name = path_utils.get_parent_directory(archive_file_name)
-    if os.path.exists(archive_dir_name) is False:
-        ex = exception_helper.create_cla_exception('WLSDPLY-06026', archive_file_name)
-        __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
-        raise ex
-    try:
-        archive_file = WLSDeployArchive(archive_file_name)
-    except (IllegalArgumentException, IllegalStateException), ie:
-        ex = exception_helper.create_cla_exception('WLSDPLY-06013', _program_name, archive_file_name,
-                                                   ie.getLocalizedMessage(), error=ie)
-        __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
-        raise ex
-    required_arg_map[CommandLineArgUtil.ARCHIVE_FILE] = archive_file
+    if CommandLineArgUtil.SKIP_ARCHIVE_FILE_SWITCH in argument_map:
+        archive_file = WLSDeployArchive.noArchiveFile()
+    else:
+        archive_file_name = argument_map[CommandLineArgUtil.ARCHIVE_FILE_SWITCH]
+        archive_dir_name = path_utils.get_parent_directory(archive_file_name)
+        if os.path.exists(archive_dir_name) is False:
+            ex = exception_helper.create_cla_exception('WLSDPLY-06026', archive_file_name)
+            __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+            raise ex
+        try:
+            archive_file = WLSDeployArchive(archive_file_name)
+        except (IllegalArgumentException, IllegalStateException), ie:
+            ex = exception_helper.create_cla_exception('WLSDPLY-06013', _program_name, archive_file_name,
+                                                       ie.getLocalizedMessage(), error=ie)
+            __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+            raise ex
+    argument_map[CommandLineArgUtil.ARCHIVE_FILE] = archive_file
     return
 
 
diff --git a/core/src/main/python/wlsdeploy/util/cla_utils.py b/core/src/main/python/wlsdeploy/util/cla_utils.py
@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.
+Copyright (c) 2017, 2021, Oracle Corporation and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 Module that handles command-line argument parsing and common validation.
@@ -46,6 +46,7 @@ class CommandLineArgUtil(object):
     # phony arg used as a key to store the password
     ADMIN_PASS_SWITCH          = '-admin_pass'
     ARCHIVE_FILE_SWITCH        = '-archive_file'
+    SKIP_ARCHIVE_FILE_SWITCH    = '-skip_archive'
     MODEL_FILE_SWITCH          = '-model_file'
     DISCARD_CURRENT_EDIT_SWITCH   = '-discard_current_edit'
     OPSS_WALLET_SWITCH         = '-opss_wallet'
@@ -95,6 +96,7 @@ class CommandLineArgUtil(object):
         ENCRYPT_MANUAL_SWITCH,
         FOLDERS_ONLY_SWITCH,
         MODEL_SAMPLE_SWITCH,
+        SKIP_ARCHIVE_FILE_SWITCH,
         RECURSIVE_SWITCH,
         CANCEL_CHANGES_IF_RESTART_REQ_SWITCH,
         RUN_RCU_SWITCH,
diff --git a/core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties b/core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties
@@ -536,6 +536,8 @@ WLSDPLY-06025=Variable file was provided. Model password attributes will be repl
   values put into the variable file.
 WLSDPLY-06026=Target directory for archive file argument {0} does not exist
 WLSDPLY-06027=JAVA_HOME {0} is not a valid location: {1}
+WLSDPLY-06028=Archive file name is required for discover tool unless -skip_archive argument is used.
+WLSDPLY-06029=Model file name is required for discover tool when -skip_archive argument is used.
 
 # discoverer.py
 WLSDPLY-06100=Find attributes at location {0}
diff --git a/core/src/test/java/oracle/weblogic/deploy/util/WLSDeployArchiveTest.java b/core/src/test/java/oracle/weblogic/deploy/util/WLSDeployArchiveTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
+ * Copyright (c) 2017, 2021, Oracle Corporation and/or its affiliates.  All rights reserved.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 package oracle.weblogic.deploy.util;
@@ -100,6 +100,15 @@ public void testAddDirectory() throws Exception {
         archive.close();
     }
 
+    @Test
+    public void testAddDirectoryNoArchive() throws Exception {
+        WLSDeployArchive archive = WLSDeployArchive.noArchiveFile();
+        File file = new File(APP_DIR_TO_ADD);
+        String appName = archive.addApplication(file);
+        Assert.assertEquals("unexpected app name: " + appName, file.getPath(), appName);
+        archive.close();
+    }
+
     @Test
     public void testIsAFile() throws Exception {
         WLSDeployArchive archive = new WLSDeployArchive(APPS_ARCHIVE_FILE_NAME);
@@ -136,4 +145,10 @@ public void testClearAllBinariesWithEmptyZip() throws Exception {
         Assert.assertFalse("expected appName to be not empty", StringUtils.isEmpty(appName));
         archive.close();
     }
+
+    @Test
+    public void testClearAllBinariesNoArchive() throws Exception {
+        WLSDeployArchive archive = WLSDeployArchive.noArchiveFile();
+        archive.removeAllBinaries();
+    }
 }
diff --git a/installer/src/main/bin/discoverDomain.cmd b/installer/src/main/bin/discoverDomain.cmd
@@ -2,7 +2,7 @@
 @rem **************************************************************************
 @rem discoverDomain.cmd
 @rem
-@rem Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.  All rights reserved.
+@rem Copyright (c) 2017, 2021, Oracle Corporation and/or its affiliates.  All rights reserved.
 @rem Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 @rem
 @rem     NAME
@@ -72,7 +72,8 @@ if "%SHOW_USAGE%" == "false" (
 ECHO.
 ECHO Usage: %SCRIPT_NAME% [-oracle_home ^<oracle_home^>]
 ECHO              -domain_home ^<domain_home^>
-ECHO              -archive_file ^<archive_file^>
+ECHO              [-archive_file ^<archive_file^>]
+ECHO              [-skip_archive]
 ECHO              [-model_file ^<model_file^>]
 ECHO              [-variable_file ^<variable_file^>]
 ECHO              [-domain_type ^<domain_type^>]
@@ -92,7 +93,9 @@ ECHO                          variable is set.
 ECHO.
 ECHO         domain_home    - the domain home directory
 ECHO.
-ECHO         archive_file   - the path to the archive file to create
+ECHO         archive_file   - the path to the archive file
+ECHO.
+ECHO         skip_archive   - do not generate an archive file. The archive_file option will be ignored.
 ECHO.
 ECHO         model_file     - the location to write the model file,
 ECHO                          the default is to write it inside the archive
diff --git a/installer/src/main/bin/discoverDomain.sh b/installer/src/main/bin/discoverDomain.sh
@@ -2,7 +2,7 @@
 # *****************************************************************************
 # discoverDomain.sh
 #
-# Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.  All rights reserved.
+# Copyright (c) 2017, 2021, Oracle Corporation and/or its affiliates.  All rights reserved.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 #
 #     NAME
@@ -35,7 +35,8 @@ usage() {
   echo "Usage: $1 [-help]"
   echo "          [-oracle_home <oracle_home>]"
   echo "          -domain_home <domain_home>"
-  echo "          -archive_file <archive_file>"
+  echo "          [-archive_file <archive_file>]"
+  echo "          [-skip_archive]"
   echo "          [-model_file <model_file>]"
   echo "          [-variable_file <variable_file>]"
   echo "          [-domain_type <domain_type>]"
@@ -57,6 +58,8 @@ usage() {
   echo ""
   echo "        archive_file    - the path to the archive file to use"
   echo ""
+  echo "        skip_archive    - Do not generate the archive file. The archive file command will be ignored"
+  echo ""
   echo "        model_file      - the location of the model file to use; "
   echo "                          the default is to get the model from the archive"
   echo ""
diff --git a/site/discover.md b/site/discover.md
@@ -12,6 +12,7 @@ When creating the archive, the tool will try to gather all binaries, scripts, an
 
 1. Any binaries referenced from the `ORACLE_HOME` will not be gathered, as they are assumed to exist in any target domain to which model-driven operations will be applied.  Doing this is key to allowing the model to be WebLogic Server version independent.
 2. In its current form, the Discover Domain Tool will only gather binaries and scripts that are accessible from the local machine.  Warnings will be generated for any binaries or scripts that cannot be found but the configuration for those binaries will still be collected, where possible.  It is the user's responsibility to add those missing files to the archive in the appropriate locations and edit the the model, as needed, to point to those files inside the archive using the relative path inside the archive (for example, `wlsdeploy/applications/myapp.ear`).
+3. You can you run the discover tool without generating an archive file if you wish to inspect the model file. A create or update domain requires a valid archive file for any binaries, scripts or directories that will be installed into the domain.
 
 You can customize what is generated in the model for password attributes by providing a variable file location and name. This file is a text properties file which will contain a key=value for each password found in the model. The key is a unique token name for a password attribute, and the value is the replacement value; in this case, an empty string. The attribute in the model is injected with the token name and property field notation. For example, `@@PROP:AdminUserName@@` or `@@PROP:JDBCSystemResource.<Name>.JdbcResource.JDBCDriverParams.PasswordEncrypted@@`.
 
