working around Jython 2.2.1 bug when env var values have a newline

Author: robertpatrick

core/src/main/python/compare_model.py

@@ -1,16 +1,18 @@
-# Copyright (c) 2020, 2023, Oracle and/or its affiliates.
-# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
-#
-# ------------
-# Description:
-# ------------
-#
-#   This code compares python dictionaries.  It is used to compare the new vs the old version.
-#   If the flag -output_dir <directory> is provided, the differences is written as yaml and json
-#   diffed_model.json diffed_model.yaml in the directory; the tool output is written as diffed_output_rc.
-#
-#   If the flag is not provided then all output is written to the standard out.
-#
+"""
+Copyright (c) 2020, 2023, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
+
+------------
+Description:
+------------
+
+  This code compares python dictionaries.  It is used to compare the new vs the old version.
+  If the flag -output_dir <directory> is provided, the differences is written as yaml and json
+  diffed_model.json diffed_model.yaml in the directory; the tool output is written as diffed_output_rc.
+
+  If the flag is not provided then all output is written to the standard out.
+
+"""
 import os
 import sets
 import sys
@@ -39,6 +41,7 @@
 from wlsdeploy.tool.compare.model_comparer import ModelComparer
 from wlsdeploy.tool.validate.validator import Validator
 from wlsdeploy.util import cla_helper
+from wlsdeploy.util import env_helper
 from wlsdeploy.util import tool_main
 from wlsdeploy.util import validate_configuration
 from wlsdeploy.util import variables
@@ -235,7 +238,7 @@ def debug(format_string, *arguments):
     :param format_string:  python formatted string
     :param arguments: arguments for the formatted string
     """
-    if os.environ.has_key('DEBUG_COMPARE_MODEL_TOOL'):
+    if env_helper.has_env('DEBUG_COMPARE_MODEL_TOOL'):
         print(format_string % arguments)
     else:
         __logger.finest(format_string, arguments)

core/src/main/python/create.py

@@ -1,6 +1,6 @@
 """
 Copyright (c) 2017, 2023, Oracle Corporation and/or its affiliates.
-Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 The main module for the WLSDeploy tool to create empty domains.
 """
@@ -41,6 +41,7 @@
 from wlsdeploy.tool.util import wlst_helper
 from wlsdeploy.tool.validate.content_validator import ContentValidator
 from wlsdeploy.util import cla_helper
+from wlsdeploy.util import env_helper
 from wlsdeploy.util import getcreds
 from wlsdeploy.util import tool_main
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
@@ -128,7 +129,7 @@ def __process_java_home_arg(optional_arg_map):
     _method_name = '__process_java_home_arg'
 
     if CommandLineArgUtil.JAVA_HOME_SWITCH not in optional_arg_map:
-        java_home_name = os.environ.get('JAVA_HOME')
+        java_home_name = env_helper.getenv('JAVA_HOME')
         try:
             java_home = FileUtils.validateExistingDirectory(java_home_name)
         except IllegalArgumentException, iae:

core/src/main/python/discover.py

@@ -1,6 +1,6 @@
 """
 Copyright (c) 2017, 2023, Oracle Corporation and/or its affiliates.
-Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 The entry point for the discoverDomain tool.
 """
@@ -49,6 +49,7 @@
 from wlsdeploy.tool.validate.validator import Validator
 from wlsdeploy.util import cla_helper
 from wlsdeploy.util import cla_utils
+from wlsdeploy.util import env_helper
 from wlsdeploy.util import model_translator
 from wlsdeploy.util import path_utils
 from wlsdeploy.util import tool_main
@@ -200,7 +201,7 @@ def __process_java_home(optional_arg_map):
     if CommandLineArgUtil.JAVA_HOME_SWITCH in optional_arg_map:
         java_home_name = optional_arg_map[CommandLineArgUtil.JAVA_HOME_SWITCH]
     else:
-        java_home_name = os.environ.get('JAVA_HOME')
+        java_home_name = env_helper.getenv('JAVA_HOME')
 
     try:
         FileUtils.validateExistingDirectory(java_home_name)
@@ -545,14 +546,14 @@ def __check_and_customize_model(model, model_context, aliases, credential_inject
 def __generate_remote_report_json(model_context):
     _method_name = '__remote_report'
 
-    if not model_context.is_remote() or not os.environ.has_key(_store_result_environment_variable):
+    if not model_context.is_remote() or not env_helper.has_env(_store_result_environment_variable):
         return
 
     # write JSON output if the __WLSDEPLOY_STORE_RESULT__ environment variable is set.
     # write to the file before the stdout so any logging messages come first.
     remote_map = discoverer.remote_dict
 
-    store_path = os.environ.get(_store_result_environment_variable)
+    store_path = env_helper.getenv(_store_result_environment_variable)
     __logger.info('WLSDPLY-06034', store_path, class_name=_class_name, method_name=_method_name)
     missing_archive_entries = []
     for key in remote_map:

core/src/main/python/model_help.py

@@ -1,6 +1,6 @@
 """
-Copyright (c) 2020, 2022, Oracle Corporation and/or its affiliates.
-Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+Copyright (c) 2020, 2023, Oracle Corporation and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 The entry point for the modelHelp tool.
 """
@@ -16,6 +16,7 @@
 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 env_helper
 from wlsdeploy.util import model
 from wlsdeploy.util import tool_main
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
@@ -348,7 +349,7 @@ def interactive_help_main_loop(aliases, model_path, printer):
     history = ['top']
 
     # optionally get input from file instead of stdin (undocumented feature)
-    input_file_name = os.environ.get('WDT_INTERACTIVE_MODE_INPUT_FILE')
+    input_file_name = env_helper.getenv('WDT_INTERACTIVE_MODE_INPUT_FILE')
     input_file = None
     if input_file_name:
       input_file = open(input_file_name, "r")

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

@@ -1,6 +1,6 @@
 """
 Copyright (c) 2019, 2023, Oracle Corporation and/or its affiliates.
-Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 Utility CLS methods shared by multiple tools.
 """
@@ -10,6 +10,7 @@
 from java.io import IOException
 from java.lang import IllegalArgumentException
 from java.lang import String
+
 from oracle.weblogic.deploy.util import FileUtils
 from oracle.weblogic.deploy.util import TranslateException
 from oracle.weblogic.deploy.util import VariableException
@@ -26,6 +27,7 @@
 from wlsdeploy.util import model_helper
 from wlsdeploy.util import model_translator
 from wlsdeploy.util import path_utils
+from wlsdeploy.util import env_helper
 
 from wlsdeploy.util import variables
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
@@ -403,7 +405,7 @@ def persist_model(model_context, model_dictionary):
     _method_name = 'persist_model'
 
     if check_persist_model():
-        store_value = os.environ.get(_store_environment_variable)
+        store_value = env_helper.getenv(_store_environment_variable)
 
         if os.path.isabs(store_value):
             file_path = store_value
@@ -428,4 +430,4 @@ def check_persist_model():
     Determine if the model should be persisted, based on the environment variable __WLSDEPLOY_STORE_MODEL__
     :return: True if the model should be persisted
     """
-    return os.environ.has_key(_store_environment_variable)
+    return env_helper.has_env(_store_environment_variable)

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

@@ -0,0 +1,30 @@
+"""
+Copyright (c) 2023, Oracle Corporation and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
+
+Helper class to work around bugs in Jython 2.2.1 where environment variables with
+newline characters mess up the os.environ data structure.
+"""
+import os
+
+from java.lang import System
+from oracle.weblogic.deploy.util import StringUtils
+
+def getenv(env_var_name, default_value=None):
+    if StringUtils.isEmpty(env_var_name):
+        return default_value
+    elif env_var_name in os.environ:
+        return os.environ[env_var_name]
+    else:
+        retval = System.getenv(env_var_name)
+        if retval is None:
+            return default_value
+        return retval
+
+def has_env(env_var_name):
+    if StringUtils.isEmpty(env_var_name):
+        return False
+    elif env_var_name in os.environ:
+        return True
+    else:
+        return System.getenv(env_var_name) is not None

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

@@ -1,13 +1,14 @@
 """
-Copyright (c) 2017, 2022, 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.
+Copyright (c) 2017, 2023, Oracle Corporation and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
 import os
 
 import java.io.File as JFile
 
 import oracle.weblogic.deploy.util.StringUtils as JStringUtils
 from wlsdeploy.logging.platform_logger import PlatformLogger
+from wlsdeploy.util import env_helper
 
 WLSDEPLOY_HOME_VARIABLE = 'WLSDEPLOY_HOME'
 CUSTOM_CONFIG_VARIABLE = 'WDT_CUSTOM_CONFIG'
@@ -139,7 +140,7 @@ def is_jar_file(file_path):
 
 
 def get_wls_deploy_path():
-    return os.environ.get(WLSDEPLOY_HOME_VARIABLE, None)
+    return env_helper.getenv(WLSDEPLOY_HOME_VARIABLE, None)
 
 
 def find_config_path(file_path):
@@ -152,12 +153,12 @@ def find_config_path(file_path):
     """
     _method_name = 'find_config_path'
 
-    custom_config_dir = os.environ.get(CUSTOM_CONFIG_VARIABLE, None)
+    custom_config_dir = env_helper.getenv(CUSTOM_CONFIG_VARIABLE)
     if custom_config_dir is not None:
         custom_file_path = os.path.join(custom_config_dir, file_path)
         if os.path.isfile(custom_file_path):
             __logger.info('WLSDPLY-01725', custom_file_path, class_name=_class_name, method_name=_method_name)
             return custom_file_path
 
-    wls_deploy_path = os.environ.get(WLSDEPLOY_HOME_VARIABLE, '')
+    wls_deploy_path = env_helper.getenv(WLSDEPLOY_HOME_VARIABLE, '')
     return os.path.join(wls_deploy_path, 'lib', file_path)

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

@@ -1,6 +1,6 @@
 """
-Copyright (c) 2017, 2022, Oracle Corporation and/or its affiliates.
-Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+Copyright (c) 2017, 2023, Oracle Corporation and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
 import os
 import re
@@ -22,6 +22,7 @@
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.logging import platform_logger
 from wlsdeploy.util import dictionary_utils
+from wlsdeploy.util import env_helper
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
 
 _class_name = "variables"
@@ -284,16 +285,16 @@ def _substitute(text, variables, model_context, error_info, attribute_name=None)
             #
             env_var_name = str_helper.to_string(key)
             is_windows = System.getProperty('os.name').startswith('Windows')
-            if is_windows and env_var_name not in os.environ and env_var_name.upper() in os.environ:
+            if is_windows and not env_helper.has_env(env_var_name) and env_var_name.has_env(env_var_name.upper()):
                 env_var_name = env_var_name.upper()
 
-            if env_var_name not in os.environ:
+            if not env_helper.has_env(env_var_name):
                 allow_unresolved = validation_config.allow_unresolved_environment_tokens()
                 _report_token_issue('WLSDPLY-01737', method_name, allow_unresolved, key)
                 _increment_error_count(error_info, allow_unresolved)
                 problem_found = True
                 continue
-            value = os.environ.get(env_var_name)
+            value = env_helper.getenv(env_var_name)
             text = text.replace(token, value)
 
         # check secret variables before @@FILE:/dir/@@SECRET:name:key@@.txt@@
@@ -420,7 +421,7 @@ def _init_secret_token_map(model_context):
 
     # add name/key pairs for files in sub-directories of directories in WDT_MODEL_SECRETS_DIRS.
 
-    locations = os.environ.get(str_helper.to_string(_secret_dirs_variable), None)
+    locations = env_helper.getenv(str_helper.to_string(_secret_dirs_variable))
     if locations is not None:
         for secret_dir in locations.split(","):
             if not os.path.isdir(secret_dir):
@@ -437,7 +438,7 @@ def _init_secret_token_map(model_context):
     # add name/key pairs for files in directories assigned in WDT_MODEL_SECRETS_NAME_DIR_PAIRS.
     # these pairs will override if they were previously added as sub-directory pairs.
 
-    dir_pairs_text = os.environ.get(str_helper.to_string(_secret_dir_pairs_variable), None)
+    dir_pairs_text = env_helper.getenv(str_helper.to_string(_secret_dir_pairs_variable))
     if dir_pairs_text is not None:
         dir_pairs = dir_pairs_text.split(',')
         for dir_pair in dir_pairs:
@@ -533,10 +534,10 @@ def substitute_key(text, variables):
     matches = _environment_pattern.findall(text)
     for token, key in matches:
         # log, or throw an exception if key is not found.
-        if str_helper.to_string(key) not in os.environ:
+        if not env_helper.has_env(str_helper.to_string(key)):
             continue
 
-        value = os.environ.get(str_helper.to_string(key))
+        value = env_helper.getenv(str_helper.to_string(key))
         text = text.replace(token, value)
 
     return text

core/src/test/python/base_test.py

@@ -1,6 +1,6 @@
 """
 Copyright (c) 2021, 2023, Oracle and/or its affiliates.
-Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
 import os
 import shutil
@@ -9,6 +9,7 @@
 from java.util.logging import Level
 
 from wlsdeploy.logging.platform_logger import PlatformLogger
+from wlsdeploy.util import env_helper
 
 
 class BaseTestCase(unittest.TestCase):
@@ -24,7 +25,7 @@ def __init__(self, *args):
         self.TEST_CONFIG_DIR = os.path.join(self.TEST_OUTPUT_DIR, 'wdt-config')
         self.log_levels = {}
 
-        self.original_config_dir = os.environ.get('WDT_CUSTOM_CONFIG', self.TEST_CONFIG_DIR)
+        self.original_config_dir = env_helper.getenv('WDT_CUSTOM_CONFIG', self.TEST_CONFIG_DIR)
         # config items may need to be copied from here
         self.INSTALLER_LIB_DIR = os.path.abspath(os.path.join(self.TEST_CLASSES_DIR, '../../../installer/src/main/lib'))