Add -model_sample option to modelHelp (#624)

* JIRA WDT-320 Add -model_sample option to modelHelp

* JIRA WDT-320 Corrections to unit tests and usage in start scripts

Author: rakillen

core/src/main/python/model_help.py

@@ -15,6 +15,7 @@
 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.modelhelp.model_help_utils import ControlOptions
 from wlsdeploy.tool.util import model_context_helper
 from wlsdeploy.util import cla_helper
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
@@ -30,6 +31,7 @@
 __optional_arguments = [
     CommandLineArgUtil.ATTRIBUTES_ONLY_SWITCH,
     CommandLineArgUtil.FOLDERS_ONLY_SWITCH,
+    CommandLineArgUtil.MODEL_SAMPLE_SWITCH,
     CommandLineArgUtil.RECURSIVE_SWITCH
 ]
 
@@ -84,19 +86,20 @@ def print_help(model_path, model_context):
     __logger.entering(model_path, class_name=_class_name, method_name=_method_name)
 
     # default to NORMAL
-    control_option = ModelHelpPrinter.ControlOptions.NORMAL
+    control_option = ControlOptions.NORMAL
 
     # determine control option using the model_context
     if model_context.get_recursive_control_option():
-        control_option = ModelHelpPrinter.ControlOptions.RECURSIVE
+        control_option = ControlOptions.RECURSIVE
     elif model_context.get_attributes_only_control_option():
-        control_option = ModelHelpPrinter.ControlOptions.ATTRIBUTES_ONLY
+        control_option = ControlOptions.ATTRIBUTES_ONLY
     elif model_context.get_folders_only_control_option():
-        control_option = ModelHelpPrinter.ControlOptions.FOLDERS_ONLY
+        control_option = ControlOptions.FOLDERS_ONLY
 
     aliases = Aliases(model_context)
+    as_sample = model_context.get_model_sample_option()
     printer = ModelHelpPrinter(aliases, __logger)
-    printer.print_model_help(model_path, control_option)
+    printer.print_model_help(model_path, control_option, as_sample)
 
     __logger.exiting(class_name=_class_name, method_name=_method_name)
     return CommandLineArgUtil.PROG_OK_EXIT_CODE

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

@@ -7,21 +7,22 @@
 from oracle.weblogic.deploy.exception import ExceptionHelper
 from wlsdeploy.aliases.location_context import LocationContext
 from wlsdeploy.aliases.model_constants import KNOWN_TOPLEVEL_MODEL_SECTIONS
+from wlsdeploy.tool.modelhelp import model_help_utils
+from wlsdeploy.tool.modelhelp.model_help_utils import ControlOptions
+from wlsdeploy.tool.modelhelp.model_sample_printer import ModelSamplePrinter
 from wlsdeploy.util import model
-from wlsdeploy.util.enum import Enum
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.exception.expection_types import ExceptionType
 from wlsdeploy.tool.util.alias_helper import AliasHelper
 
-_class_name = "ModelHelper"
+_class_name = "ModelHelpPrinter"
 MODEL_PATH_PATTERN = re.compile(r'^([a-zA-Z]+:?)?((/[a-zA-Z0-9]+)*)?$')
 
 
 class ModelHelpPrinter(object):
     """
     Class for printing the recognized model metadata to STDOUT.
     """
-    ControlOptions = Enum(['NORMAL', 'RECURSIVE', 'FOLDERS_ONLY', 'ATTRIBUTES_ONLY'])
 
     def __init__(self, aliases, logger):
         """
@@ -31,7 +32,7 @@ def __init__(self, aliases, logger):
         self._logger = logger
         self._alias_helper = AliasHelper(aliases, self._logger, ExceptionType.CLA)
 
-    def print_model_help(self, model_path, control_option):
+    def print_model_help(self, model_path, control_option, as_sample=False):
         """
         Prints out the help information for a given '''model_path'''. '''model_path''' needs to be specified
         using the following pattern:
@@ -46,17 +47,18 @@ def print_model_help(self, model_path, control_option):
 
         :param model_path: a formatted string containing the model path
         :param control_option: a command-line switch that controls what is output
+        :param as_sample: specifies that a model sample should be output
         :raises CLAException: if a problem is encountered
         """
 
         # print filter information, if not NORMAL
-        if control_option == self.ControlOptions.RECURSIVE:
+        if control_option == ControlOptions.RECURSIVE:
             print
             print _format_message('WLSDPLY-10102')
-        elif control_option == self.ControlOptions.FOLDERS_ONLY:
+        elif control_option == ControlOptions.FOLDERS_ONLY:
             print
             print _format_message('WLSDPLY-10103')
-        elif control_option == self.ControlOptions.ATTRIBUTES_ONLY:
+        elif control_option == ControlOptions.ATTRIBUTES_ONLY:
             print
             print _format_message('WLSDPLY-10104')
 
@@ -65,12 +67,16 @@ def print_model_help(self, model_path, control_option):
         section_name = model_path_tokens[0]
         valid_section_folder_keys = self._alias_helper.get_model_section_top_level_folder_names(section_name)
 
-        if model_path_tokens[0] == 'top':
-            self._print_model_top_level_help()
-        elif len(model_path_tokens) == 1:
-            self._print_model_section_help(section_name, valid_section_folder_keys, control_option)
+        if as_sample:
+            sample_printer = ModelSamplePrinter(self._alias_helper, self._logger)
+            sample_printer.print_model_sample(model_path_tokens, control_option)
         else:
-            self._print_model_folder_help(model_path_tokens, valid_section_folder_keys, control_option)
+            if model_path_tokens[0] == 'top':
+                self._print_model_top_level_help()
+            elif len(model_path_tokens) == 1:
+                self._print_model_section_help(section_name, valid_section_folder_keys, control_option)
+            else:
+                self._print_model_folder_help(model_path_tokens, valid_section_folder_keys, control_option)
 
     def _parse_model_path(self, model_path):
         """
@@ -182,20 +188,20 @@ def _print_model_section_help(self, section_name, valid_section_folder_keys, con
         print
         _print_indent(model_section, 0)
 
-        if self._show_attributes(control_option):
+        if model_help_utils.show_attributes(control_option):
             attributes_location = self._alias_helper.get_model_section_attribute_location(section_name)
             if attributes_location is not None:
                 self._print_attributes_help(attributes_location, 1)
 
-        if self._show_folders(control_option):
+        if model_help_utils.show_folders(control_option):
             print
             _print_indent(_format_message('WLSDPLY-10107'), 1)
             valid_section_folder_keys.sort()
 
             for section_folder_key in valid_section_folder_keys:
                 _print_indent(section_folder_key, 2)
 
-                if control_option == self.ControlOptions.RECURSIVE:
+                if control_option == ControlOptions.RECURSIVE:
                     model_location = LocationContext().append_location(section_folder_key)
                     self._print_subfolders_help(model_location, control_option, 2)
 
@@ -210,7 +216,7 @@ def _print_model_folder_help(self, model_path_tokens, valid_section_folder_keys,
         _method_name = '_print_model_folder_help'
 
         self._logger.finest('1 model_path_tokens={0}, control_option={1}, valid_section_folder_keys={0}',
-                            str(model_path_tokens), self.ControlOptions.from_value(control_option),
+                            str(model_path_tokens), ControlOptions.from_value(control_option),
                             str(valid_section_folder_keys), class_name=_class_name, method_name=_method_name)
 
         section_name = model_path_tokens[0]
@@ -242,11 +248,11 @@ def _print_model_folder_help(self, model_path_tokens, valid_section_folder_keys,
         print
         _print_indent(model_path, 0)
 
-        if self._show_attributes(control_option):
+        if model_help_utils.show_attributes(control_option):
             # Print the attributes associated with location context
             self._print_attributes_help(model_location, 1)
 
-        if self._show_folders(control_option):
+        if model_help_utils.show_folders(control_option):
             # Print the folders associated with location context
             print
             _print_indent(_format_message('WLSDPLY-10107'), 1)
@@ -289,7 +295,7 @@ def _print_subfolders_help(self, model_location, control_option, indent_level):
 
             _print_indent(text, indent_level + 1)
 
-            if control_option == self.ControlOptions.RECURSIVE:
+            if control_option == ControlOptions.RECURSIVE:
                 # Call this method recursively
                 self._print_subfolders_help(model_location, control_option, indent_level + 1)
 
@@ -324,22 +330,6 @@ def _print_attributes_help(self, model_location, indent_level):
                 msg = formatted_string % (attr_name, attr_infos[attr_name])
                 _print_indent(msg, indent_level + 1)
 
-    def _show_attributes(self, control_option):
-        """
-        Determine if attributes should be displayed, based on the control option.
-        :param control_option: the control option to be checked
-        :return: True if attributes should be displayed, False otherwise
-        """
-        return control_option in [self.ControlOptions.NORMAL, self.ControlOptions.ATTRIBUTES_ONLY]
-
-    def _show_folders(self, control_option):
-        """
-        Determine if folders should be displayed, based on the control option.
-        :param control_option: the control option to be checked
-        :return: True if folders should be displayed, False otherwise
-        """
-        return control_option != self.ControlOptions.ATTRIBUTES_ONLY
-
     def _get_folder_type_name(self, location):
         """
         Return text indicating the type of a folder, such as "multiple".

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

@@ -0,0 +1,26 @@
+"""
+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.
+"""
+
+from wlsdeploy.util.enum import Enum
+
+ControlOptions = Enum(['NORMAL', 'RECURSIVE', 'FOLDERS_ONLY', 'ATTRIBUTES_ONLY'])
+
+
+def show_attributes(control_option):
+    """
+    Determine if attributes should be displayed, based on the control option.
+    :param control_option: the control option to be checked
+    :return: True if attributes should be displayed, False otherwise
+    """
+    return control_option in [ControlOptions.NORMAL, ControlOptions.ATTRIBUTES_ONLY]
+
+
+def show_folders(control_option):
+    """
+    Determine if folders should be displayed, based on the control option.
+    :param control_option: the control option to be checked
+    :return: True if folders should be displayed, False otherwise
+    """
+    return control_option != ControlOptions.ATTRIBUTES_ONLY