JIRA WDT-380 Set typedef correctly for deploy (fix for ODL config) (#495)

* JIRA WDT-380 - Set the typedef correctly to support ODL configuration

* JIRA WDT-380 - Set the typedef correctly for deploy to support ODL configuration

* JIRA WDT-380 - Adjust whitespace

Author: rakillen

core/src/main/python/create.py

@@ -35,9 +35,9 @@
 from wlsdeploy.logging.platform_logger import PlatformLogger
 from wlsdeploy.tool.create.rcudbinfo_helper import RcuDbInfo
 from wlsdeploy.tool.create.domain_creator import DomainCreator
-from wlsdeploy.tool.create.domain_typedef import DomainTypedef
 from wlsdeploy.tool.create.domain_typedef import CREATE_DOMAIN
 from wlsdeploy.tool.util import filter_helper
+from wlsdeploy.tool.util import model_context_helper
 from wlsdeploy.tool.util.alias_helper import AliasHelper
 from wlsdeploy.tool.util.archive_helper import ArchiveHelper
 from wlsdeploy.tool.validate.validator import Validator
@@ -48,7 +48,6 @@
 from wlsdeploy.util import wlst_extended
 from wlsdeploy.util import wlst_helper
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
-from wlsdeploy.util.model_context import ModelContext
 from wlsdeploy.util.weblogic_helper import WebLogicHelper
 from wlsdeploy.tool.create import atp_helper
 
@@ -102,19 +101,15 @@ def __process_args(args):
     #
     # Verify that the domain type is a known type and load its typedef.
     #
-    domain_type = required_arg_map[CommandLineArgUtil.DOMAIN_TYPE_SWITCH]
-    domain_typedef = DomainTypedef(_program_name, domain_type)
-    optional_arg_map[CommandLineArgUtil.DOMAIN_TYPEDEF] = domain_typedef
+    domain_typedef = model_context_helper.create_typedef(_program_name, required_arg_map)
 
-    __process_rcu_args(optional_arg_map, domain_type, domain_typedef)
+    __process_rcu_args(optional_arg_map, domain_typedef.get_domain_type(), domain_typedef)
     __process_encryption_args(optional_arg_map)
     __process_opss_args(optional_arg_map)
 
     combined_arg_map = optional_arg_map.copy()
     combined_arg_map.update(required_arg_map)
-    model_context = ModelContext(_program_name, combined_arg_map)
-    domain_typedef.set_model_context(model_context)
-    return model_context
+    return model_context_helper.create_context(_program_name, combined_arg_map, domain_typedef)
 
 
 def __verify_required_args_present(required_arg_map):
@@ -397,7 +392,7 @@ def main(args):
         cla_helper.clean_up_temp_files()
 
         # create a minimal model for summary logging
-        model_context = ModelContext(_program_name, dict())
+        model_context = model_context_helper.create_exit_context(_program_name)
         tool_exit.end(model_context, exit_code)
 
     variable_map = {}

core/src/main/python/deploy.py

@@ -8,19 +8,15 @@
 import sys
 
 from java.io import IOException, PrintStream
-from java.lang import IllegalArgumentException
 from java.lang import String, System
 
 
 from oracle.weblogic.deploy.deploy import DeployException
 from oracle.weblogic.deploy.exception import BundleAwareException
 from oracle.weblogic.deploy.util import CLAException
-from oracle.weblogic.deploy.util import FileUtils
 from oracle.weblogic.deploy.util import TranslateException
 from oracle.weblogic.deploy.util import VariableException
 from oracle.weblogic.deploy.util import WebLogicDeployToolingVersion
-from oracle.weblogic.deploy.util import WLSDeployArchive
-from oracle.weblogic.deploy.util import WLSDeployArchiveIOException
 from oracle.weblogic.deploy.validate import ValidateException
 
 sys.path.append(os.path.dirname(os.path.realpath(sys.argv[0])))
@@ -35,6 +31,7 @@
 from wlsdeploy.tool.deploy import model_deployer
 from wlsdeploy.tool.validate.validator import Validator
 from wlsdeploy.tool.util import filter_helper
+from wlsdeploy.tool.util import model_context_helper
 from wlsdeploy.tool.util.string_output_stream import StringOutputStream
 from wlsdeploy.tool.util.wlst_helper import WlstHelper
 from wlsdeploy.util import cla_helper
@@ -44,7 +41,6 @@
 from wlsdeploy.util import wlst_extended
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
 from wlsdeploy.util.model import Model
-from wlsdeploy.util.model_context import ModelContext
 from wlsdeploy.util.weblogic_helper import WebLogicHelper
 
 wlst_extended.wlst_functions = globals()
@@ -97,8 +93,7 @@ def __process_args(args):
 
     combined_arg_map = optional_arg_map.copy()
     combined_arg_map.update(required_arg_map)
-
-    return ModelContext(_program_name, combined_arg_map)
+    return model_context_helper.create_context(_program_name, combined_arg_map)
 
 
 def __verify_required_args_present(required_arg_map):
@@ -387,7 +382,7 @@ def main(args):
         cla_helper.clean_up_temp_files()
 
         # create a minimal model for summary logging
-        model_context = ModelContext(_program_name, dict())
+        model_context = model_context_helper.create_exit_context(_program_name)
         tool_exit.end(model_context, exit_code)
 
     variable_map = {}

core/src/main/python/discover.py

@@ -28,30 +28,27 @@
 from wlsdeploy.aliases import model_constants
 from wlsdeploy.aliases.aliases import Aliases
 from wlsdeploy.aliases.location_context import LocationContext
-import wlsdeploy.tool.util.variable_injector as variable_injector
 
 from wlsdeploy.aliases.wlst_modes import WlstModes
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.logging.platform_logger import PlatformLogger
-from wlsdeploy.tool.create.domain_typedef import DomainTypedef
 from wlsdeploy.tool.discover import discoverer
 from wlsdeploy.tool.discover.deployments_discoverer import DeploymentsDiscoverer
 from wlsdeploy.tool.discover.domain_info_discoverer import DomainInfoDiscoverer
 from wlsdeploy.tool.discover.multi_tenant_discoverer import MultiTenantDiscoverer
 from wlsdeploy.tool.discover.resources_discoverer import ResourcesDiscoverer
 from wlsdeploy.tool.discover.topology_discoverer import TopologyDiscoverer
 from wlsdeploy.tool.util import filter_helper
+from wlsdeploy.tool.util import model_context_helper
 from wlsdeploy.tool.util.variable_injector import VariableInjector
 from wlsdeploy.tool.validate.validator import Validator
-from wlsdeploy.util import dictionary_utils
 from wlsdeploy.util import getcreds
 from wlsdeploy.util import model_translator
 from wlsdeploy.util import tool_exit
 from wlsdeploy.util import wlst_extended
 from wlsdeploy.util import wlst_helper
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
 from wlsdeploy.util.model import Model
-from wlsdeploy.util.model_context import ModelContext
 from wlsdeploy.util.weblogic_helper import WebLogicHelper
 
 wlst_extended.wlst_functions = globals()
@@ -90,21 +87,14 @@ def __process_args(args):
     cla_util = CommandLineArgUtil(_program_name, __required_arguments, __optional_arguments)
     required_arg_map, optional_arg_map = cla_util.process_args(args)
 
-    domain_type = dictionary_utils.get_element(optional_arg_map, CommandLineArgUtil.DOMAIN_TYPE_SWITCH)
-    if domain_type is None:
-        domain_type = 'WLS'
-    domain_typedef = DomainTypedef(_program_name, domain_type)
-    optional_arg_map[CommandLineArgUtil.DOMAIN_TYPEDEF] = domain_typedef
-
     __verify_required_args_present(required_arg_map)
     __wlst_mode = __process_online_args(optional_arg_map)
     __process_archive_filename_arg(required_arg_map)
     __process_variable_filename_arg(optional_arg_map)
 
     combined_arg_map = optional_arg_map.copy()
     combined_arg_map.update(required_arg_map)
-
-    return ModelContext(_program_name, combined_arg_map)
+    return model_context_helper.create_context(_program_name, combined_arg_map)
 
 
 def __verify_required_args_present(required_arg_map):
@@ -493,7 +483,7 @@ def main(args):
                             class_name=_class_name, method_name=_method_name)
 
         # create a minimal model for summary logging
-        model_context = ModelContext(_program_name, dict())
+        model_context = model_context_helper.create_exit_context(_program_name)
         __log_and_exit(model_context, exit_code, _class_name, _method_name)
 
     try:

core/src/main/python/update.py

@@ -13,7 +13,6 @@
 from oracle.weblogic.deploy.deploy import DeployException
 from oracle.weblogic.deploy.exception import BundleAwareException
 from oracle.weblogic.deploy.util import CLAException
-from oracle.weblogic.deploy.util import FileUtils
 from oracle.weblogic.deploy.util import TranslateException
 from oracle.weblogic.deploy.util import VariableException
 from oracle.weblogic.deploy.util import WebLogicDeployToolingVersion
@@ -27,24 +26,22 @@
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.exception.expection_types import ExceptionType
 from wlsdeploy.logging.platform_logger import PlatformLogger
-from wlsdeploy.tool.create.domain_typedef import DomainTypedef
 from wlsdeploy.tool.create.domain_typedef import UPDATE_DOMAIN
 from wlsdeploy.tool.deploy import deployer_utils
 from wlsdeploy.tool.deploy import model_deployer
 from wlsdeploy.tool.deploy.topology_updater import TopologyUpdater
 from wlsdeploy.tool.validate.validator import Validator
 from wlsdeploy.tool.util import filter_helper
+from wlsdeploy.tool.util import model_context_helper
 from wlsdeploy.tool.util.wlst_helper import WlstHelper
 from wlsdeploy.tool.util.string_output_stream import StringOutputStream
 from wlsdeploy.util import cla_helper
-from wlsdeploy.util import dictionary_utils
 from wlsdeploy.util import getcreds
 from wlsdeploy.util import tool_exit
 from wlsdeploy.util import variables
 from wlsdeploy.util import wlst_extended
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
 from wlsdeploy.util.model import Model
-from wlsdeploy.util.model_context import ModelContext
 from wlsdeploy.util.weblogic_helper import WebLogicHelper
 from wlsdeploy.util import model as model_helper
 
@@ -96,18 +93,9 @@ def __process_args(args):
 
     __process_encryption_args(optional_arg_map)
 
-    domain_type = dictionary_utils.get_element(optional_arg_map, CommandLineArgUtil.DOMAIN_TYPE_SWITCH)
-    if domain_type is None:
-        domain_type = 'WLS'
-    domain_typedef = DomainTypedef(_program_name, domain_type)
-    optional_arg_map[CommandLineArgUtil.DOMAIN_TYPEDEF] = domain_typedef
-
     combined_arg_map = optional_arg_map.copy()
     combined_arg_map.update(required_arg_map)
-
-    model_context = ModelContext(_program_name, combined_arg_map)
-    domain_typedef.set_model_context(model_context)
-    return model_context
+    return model_context_helper.create_context(_program_name, combined_arg_map)
 
 
 def __verify_required_args_present(required_arg_map):
@@ -405,7 +393,7 @@ def main(args):
         cla_helper.clean_up_temp_files()
 
         # create a minimal model for summary logging
-        model_context = ModelContext(_program_name, dict())
+        model_context = model_context_helper.create_exit_context(_program_name)
         tool_exit.end(model_context, exit_code)
 
     variable_map = {}

core/src/main/python/validate.py

@@ -21,12 +21,12 @@
 from wlsdeploy.aliases.wlst_modes import WlstModes
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.logging.platform_logger import PlatformLogger
+from wlsdeploy.tool.util import model_context_helper
 from wlsdeploy.tool.validate.validator import Validator
 from wlsdeploy.util import cla_helper
 from wlsdeploy.util import tool_exit
 from wlsdeploy.util import wlst_helper
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
-from wlsdeploy.util.model_context import ModelContext
 from wlsdeploy.util.weblogic_helper import WebLogicHelper
 
 
@@ -71,8 +71,7 @@ def __process_args(args):
 
     combined_arg_map = optional_arg_map.copy()
     combined_arg_map.update(required_arg_map)
-
-    return ModelContext(_program_name, combined_arg_map)
+    return model_context_helper.create_context(_program_name, combined_arg_map)
 
 
 def __verify_required_args_present(required_arg_map):

core/src/main/python/variable_inject.py

@@ -24,12 +24,12 @@
 from wlsdeploy.aliases.wlst_modes import WlstModes
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.logging.platform_logger import PlatformLogger
+from wlsdeploy.tool.util import model_context_helper
 from wlsdeploy.tool.util.variable_injector import VariableInjector
 from wlsdeploy.util import wlst_helper
 from wlsdeploy.util import model_translator
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
 from wlsdeploy.util.model import Model
-from wlsdeploy.util.model_context import ModelContext
 from wlsdeploy.util.model_translator import FileToPython
 from wlsdeploy.util.weblogic_helper import WebLogicHelper
 
@@ -73,8 +73,7 @@ def __process_args(args):
 
     combined_arg_map = optional_arg_map.copy()
     combined_arg_map.update(required_arg_map)
-
-    return ModelContext(_program_name, combined_arg_map)
+    return model_context_helper.create_context(_program_name, combined_arg_map)
 
 
 def __verify_required_args_present(required_arg_map):

core/src/main/python/wlsdeploy/tool/util/model_context_helper.py

@@ -0,0 +1,49 @@
+"""
+Copyright (c) 2019, 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.
+"""
+from wlsdeploy.tool.create.domain_typedef import DomainTypedef
+from wlsdeploy.util import dictionary_utils
+from wlsdeploy.util.cla_utils import CommandLineArgUtil
+from wlsdeploy.util.model_context import ModelContext
+
+
+def create_context(program_name, combined_arg_map, domain_typedef=None):
+    """
+    Create a model context object from the specified argument map, with the domain typedef set up correctly.
+    If the domain_typedef is not specified, construct it from the argument map.
+    :param program_name: the program name, used for logging
+    :param combined_arg_map: all the arguments passed to the program
+    :param domain_typedef: a domain typedef object to be used, or None
+    :return: the new model context object
+    """
+    if domain_typedef is None:
+        domain_typedef = create_typedef(program_name, combined_arg_map)
+
+    combined_arg_map[CommandLineArgUtil.DOMAIN_TYPEDEF] = domain_typedef
+    model_context = ModelContext(program_name, combined_arg_map)
+    domain_typedef.set_model_context(model_context)
+    return model_context
+
+
+def create_exit_context(program_name):
+    """
+    Create a minimal model for use when a tool exits due to command-line parsing errors.
+    This will provide some of the values needed for the summary logging.
+    :param program_name: the program name, used for logging
+    :return: the new, minimal model context object
+    """
+    return create_context(program_name, dict())
+
+
+def create_typedef(program_name, argument_map):
+    """
+    Create a domain typedef object for use with a model context.
+    :param program_name: the program name, used for logging
+    :param argument_map: the argument map that may contain a domain type
+    :return: a typedef object
+    """
+    domain_type = dictionary_utils.get_element(argument_map, CommandLineArgUtil.DOMAIN_TYPE_SWITCH)
+    if domain_type is None:
+        domain_type = 'WLS'
+    return DomainTypedef(program_name, domain_type)

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

@@ -26,6 +26,13 @@ class ModelContext(object):
     __TEMP_DIRECTORY_TOKEN = '@@TMP@@'
 
     def __init__(self, program_name, arg_map):
+        """
+        Create a new model context instance.
+        Tools should use model_context_helper.create_context(), to ensure that the typedef is initialized correctly.
+        Unit tests should use this constructor directly, since typedef files are not deployed.
+        :param program_name: the program name, used for logging
+        :param arg_map: all the arguments passed to the tool
+        """
         self._program_name = program_name
         self._logger = platform_logger.PlatformLogger('wlsdeploy.util')
         self._wls_helper = WebLogicHelper(self._logger)