Separate validate -print_usage into separate tool (#587)

* JIRA WDT-388 Corrected typos for 10.3 and 12.1 server directories

* JIRA WDT-388 Initial commit for modelHelp tool

* JIRA WDT-388 Clean up code; use CLA exception throughout; fix recursive

* JIRA WDT-388 Disable -print_usage in validate, remove from usage, fix shared argument check

* JIRA WDT-388 Remove -print_usage option from validate tool

* JIRA WDT-388 Revised error message

* JIRA WDT-388 Rename ModelHelpPrinter

* JIRA WDT-388 Moved unit tests out of validate, revised to verify output

* JIRA WDT-388 Corrected message

Author: rakillen

core/src/main/python/model_help.py

@@ -0,0 +1,141 @@
+"""
+Copyright (c) 2020, 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 modelHelp tool.
+"""
+import os
+import sys
+from oracle.weblogic.deploy.util import CLAException
+from oracle.weblogic.deploy.util import WebLogicDeployToolingVersion
+
+sys.path.append(os.path.dirname(os.path.realpath(sys.argv[0])))
+
+from wlsdeploy.aliases.aliases import Aliases
+from wlsdeploy.exception import exception_helper
+from wlsdeploy.logging.platform_logger import PlatformLogger
+from wlsdeploy.tool.modelhelp.model_help_printer import ModelHelpPrinter
+from wlsdeploy.tool.util import model_context_helper
+from wlsdeploy.util import cla_helper
+from wlsdeploy.util.cla_utils import CommandLineArgUtil
+
+_program_name = 'modelHelp'
+_class_name = 'model_help'
+__logger = PlatformLogger('wlsdeploy.modelhelp')
+
+__required_arguments = [
+    CommandLineArgUtil.ORACLE_HOME_SWITCH,
+    CommandLineArgUtil.PATH_SWITCH
+]
+
+__optional_arguments = [
+    CommandLineArgUtil.ATTRIBUTES_ONLY_SWITCH,
+    CommandLineArgUtil.FOLDERS_ONLY_SWITCH,
+    CommandLineArgUtil.RECURSIVE_SWITCH
+]
+
+__output_types = [
+    CommandLineArgUtil.ATTRIBUTES_ONLY_SWITCH,
+    CommandLineArgUtil.FOLDERS_ONLY_SWITCH,
+    CommandLineArgUtil.RECURSIVE_SWITCH
+]
+
+
+def __process_args(args):
+    """
+    Process the command-line arguments.
+    :param args: the command-line arguments list
+    :raises CLAException: if an error occurs while validating and processing the command-line arguments
+    """
+    _method_name = '__process_args'
+
+    cla_util = CommandLineArgUtil(_program_name, __required_arguments, __optional_arguments)
+    required_arg_map, optional_arg_map = cla_util.process_args(args)
+
+    cla_helper.verify_required_args_present(_program_name, __required_arguments, required_arg_map)
+
+    combined_arg_map = optional_arg_map.copy()
+    combined_arg_map.update(required_arg_map)
+
+    # zero or one output type arguments should be set
+    found = False
+    for key in __output_types:
+        if key in combined_arg_map:
+            if found:
+                types_text = ', '.join(__output_types)
+                ex = exception_helper.create_cla_exception('WLSDPLY-10100', types_text)
+                ex.setExitCode(CommandLineArgUtil.USAGE_ERROR_EXIT_CODE)
+                __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+                raise ex
+            found = True
+
+    return model_context_helper.create_context(_program_name, combined_arg_map)
+
+
+def print_help(model_path, model_context):
+    """
+    Prints the folders and/or attributes for the specified given model_path,
+    using control_option to filter what is output
+    :param model_path: the model path to print help for
+    :param model_context: the model context, used to determine print options
+    :return: an exit code
+    """
+    _method_name = 'print_help'
+
+    __logger.entering(model_path, class_name=_class_name, method_name=_method_name)
+
+    # default to NORMAL
+    control_option = ModelHelpPrinter.ControlOptions.NORMAL
+
+    # determine control option using the model_context
+    if model_context.get_recursive_control_option():
+        control_option = ModelHelpPrinter.ControlOptions.RECURSIVE
+    elif model_context.get_attributes_only_control_option():
+        control_option = ModelHelpPrinter.ControlOptions.ATTRIBUTES_ONLY
+    elif model_context.get_folders_only_control_option():
+        control_option = ModelHelpPrinter.ControlOptions.FOLDERS_ONLY
+
+    aliases = Aliases(model_context)
+    printer = ModelHelpPrinter(aliases, __logger)
+    printer.print_model_help(model_path, control_option)
+
+    __logger.exiting(class_name=_class_name, method_name=_method_name)
+    return CommandLineArgUtil.PROG_OK_EXIT_CODE
+
+
+def main(args):
+    """
+    The main entry point for the discoverDomain tool.
+    :param args: the command-line arguments
+    """
+    _method_name = 'main'
+
+    __logger.entering(class_name=_class_name, method_name=_method_name)
+    for index, arg in enumerate(args):
+        __logger.finer('sys.argv[{0}] = {1}', str(index), str(arg), class_name=_class_name, method_name=_method_name)
+
+    try:
+        model_context = __process_args(args)
+    except CLAException, ex:
+        exit_code = ex.getExitCode()
+        if exit_code != CommandLineArgUtil.HELP_EXIT_CODE:
+            __logger.severe('WLSDPLY-20008', _program_name, ex.getLocalizedMessage(), error=ex,
+                            class_name=_class_name, method_name=_method_name)
+        cla_helper.clean_up_temp_files()
+        sys.exit(exit_code)
+
+    try:
+        model_path = model_context.get_path()
+        exit_code = print_help(model_path, model_context)
+    except CLAException, ve:
+        __logger.severe('WLSDPLY-10112', _program_name, ve.getLocalizedMessage(), error=ve,
+                        class_name=_class_name, method_name=_method_name)
+        sys.exit(CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
+
+    __logger.exiting(result=exit_code, class_name=_class_name, method_name=_method_name)
+    sys.exit(exit_code)
+
+
+if __name__ == '__main__' or __name__ == 'main':
+    WebLogicDeployToolingVersion.logVersionInfo(_program_name)
+    main(sys.argv)

core/src/main/python/validate.py

@@ -46,13 +46,9 @@
     CommandLineArgUtil.DOMAIN_TYPE_SWITCH,  # Used by shell script to locate WLST
     CommandLineArgUtil.MODEL_FILE_SWITCH,
     CommandLineArgUtil.ARCHIVE_FILE_SWITCH,
-    CommandLineArgUtil.PRINT_USAGE_SWITCH,
     CommandLineArgUtil.VARIABLE_FILE_SWITCH,
     CommandLineArgUtil.TARGET_VERSION_SWITCH,
     CommandLineArgUtil.TARGET_MODE_SWITCH,
-    CommandLineArgUtil.ATTRIBUTES_ONLY_SWITCH,
-    CommandLineArgUtil.FOLDERS_ONLY_SWITCH,
-    CommandLineArgUtil.RECURSIVE_SWITCH,
     CommandLineArgUtil.VALIDATION_METHOD
 ]
 
@@ -69,7 +65,6 @@ def __process_args(args):
 
     __verify_required_args_present(required_arg_map)
     __process_model_args(optional_arg_map)
-    __process_print_usage_args(optional_arg_map)
 
     combined_arg_map = optional_arg_map.copy()
     combined_arg_map.update(required_arg_map)
@@ -101,63 +96,8 @@ def __process_model_args(optional_arg_map):
     """
     _method_name = '__process_model_args'
 
-    if CommandLineArgUtil.PRINT_USAGE_SWITCH in optional_arg_map:
-        # nothing to do since we are printing help information rather than validating supplied artifacts...
-        return
-
     cla_helper.validate_optional_archive(_program_name, optional_arg_map)
     cla_helper.validate_model_present(_program_name, optional_arg_map)
-
-    something_to_validate = False
-    if CommandLineArgUtil.MODEL_FILE_SWITCH in optional_arg_map:
-        something_to_validate = True
-
-    if not something_to_validate:
-        ex = exception_helper.create_cla_exception('WLSDPLY-05400', _program_name,
-                                                   CommandLineArgUtil.PRINT_USAGE_SWITCH,
-                                                   CommandLineArgUtil.MODEL_FILE_SWITCH,
-                                                   CommandLineArgUtil.ARCHIVE_FILE_SWITCH)
-        __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
-        raise ex
-    return
-
-
-def __process_print_usage_args(optional_arg_map):
-    """
-    Validate the -print_usage related arguments.
-    :param optional_arg_map: the optional argument map
-    :raises: CLAException: if the arguments are not valid
-    """
-    _method_name = '__process_print_usage_args'
-
-    if CommandLineArgUtil.PRINT_USAGE_SWITCH in optional_arg_map:
-        print_usage_path = optional_arg_map[CommandLineArgUtil.PRINT_USAGE_SWITCH]
-        found_controller_arg = None
-        if CommandLineArgUtil.ATTRIBUTES_ONLY_SWITCH in optional_arg_map:
-            found_controller_arg = CommandLineArgUtil.ATTRIBUTES_ONLY_SWITCH
-
-        if CommandLineArgUtil.FOLDERS_ONLY_SWITCH in optional_arg_map:
-            if found_controller_arg is None:
-                found_controller_arg = CommandLineArgUtil.FOLDERS_ONLY_SWITCH
-            else:
-                ex = exception_helper.create_cla_exception('WLSDPLY-05401', _program_name,
-                                                           CommandLineArgUtil.PRINT_USAGE_SWITCH,
-                                                           CommandLineArgUtil.FOLDERS_ONLY_SWITCH, found_controller_arg)
-                __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
-                raise ex
-
-        if CommandLineArgUtil.RECURSIVE_SWITCH in optional_arg_map:
-            if found_controller_arg is None:
-                found_controller_arg = CommandLineArgUtil.RECURSIVE_SWITCH
-            else:
-                ex = exception_helper.create_cla_exception('WLSDPLY-05401', _program_name,
-                                                           CommandLineArgUtil.PRINT_USAGE_SWITCH,
-                                                           CommandLineArgUtil.RECURSIVE_SWITCH, found_controller_arg)
-                __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
-                raise ex
-        if found_controller_arg is not None:
-            __logger.fine('WLSDPLY-05402', _program_name, CommandLineArgUtil.PRINT_USAGE_SWITCH, print_usage_path,
-                          found_controller_arg, class_name=_class_name, method_name=_method_name)
     return
 
 
@@ -222,40 +162,29 @@ def main(args):
         cla_helper.clean_up_temp_files()
         sys.exit(exit_code)
 
-    print_usage = model_context.get_print_usage()
-
-    if print_usage is not None:
-        try:
-            model_validator = Validator(model_context, logger=__logger)
-            model_validator.print_usage(print_usage)
-        except ValidateException, ve:
-            __logger.severe('WLSDPLY-05404', _program_name, ve.getLocalizedMessage(), error=ve,
-                            class_name=_class_name, method_name=_method_name)
-            sys.exit(CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
-    else:
-        try:
-            model_file_name = model_context.get_model_file()
-
-            if model_file_name is not None:
-                __perform_model_file_validation(model_file_name, model_context)
-
-                summary_handler = SummaryHandler.findInstance()
-                if summary_handler is not None:
-                    summary_level = summary_handler.getMaximumMessageLevel()
-                    if summary_level == Level.SEVERE:
-                        exit_code = CommandLineArgUtil.PROG_ERROR_EXIT_CODE
-                    elif summary_level == Level.WARNING:
-                        exit_code = CommandLineArgUtil.PROG_WARNING_EXIT_CODE
-
-        except ValidateException, ve:
-            __logger.severe('WLSDPLY-20000', _program_name, ve.getLocalizedMessage(), error=ve,
-                            class_name=_class_name, method_name=_method_name)
-            cla_helper.clean_up_temp_files()
-            sys.exit(CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
-
+    try:
+        model_file_name = model_context.get_model_file()
+
+        if model_file_name is not None:
+            __perform_model_file_validation(model_file_name, model_context)
+
+            summary_handler = SummaryHandler.findInstance()
+            if summary_handler is not None:
+                summary_level = summary_handler.getMaximumMessageLevel()
+                if summary_level == Level.SEVERE:
+                    exit_code = CommandLineArgUtil.PROG_ERROR_EXIT_CODE
+                elif summary_level == Level.WARNING:
+                    exit_code = CommandLineArgUtil.PROG_WARNING_EXIT_CODE
+
+    except ValidateException, ve:
+        __logger.severe('WLSDPLY-20000', _program_name, ve.getLocalizedMessage(), error=ve,
+                        class_name=_class_name, method_name=_method_name)
         cla_helper.clean_up_temp_files()
+        sys.exit(CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
+
+    cla_helper.clean_up_temp_files()
 
-        tool_exit.end(model_context, exit_code)
+    tool_exit.end(model_context, exit_code)
     return
 
 

core/src/main/python/wlsdeploy/tool/modelhelp/__init__.py

@@ -0,0 +1,4 @@
+"""
+Copyright (c) 2020, Oracle Corporation and/or its affiliates.
+Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+"""