Use PyRealBoolean to read and write JSON and YAML files

Author: rakillen

core/src/main/java/oracle/weblogic/deploy/json/AbstractJsonTranslator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2017, 2022, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 package oracle.weblogic.deploy.json;
@@ -12,6 +12,7 @@
 import oracle.weblogic.deploy.exception.ExceptionHelper;
 import oracle.weblogic.deploy.logging.PlatformLogger;
 import oracle.weblogic.deploy.util.PyOrderedDict;
+import oracle.weblogic.deploy.util.PyRealBoolean;
 import oracle.weblogic.deploy.util.StringUtils;
 
 import org.antlr.v4.runtime.CharStream;
@@ -240,7 +241,7 @@ public void exitJsonNumber(JSONParser.JsonNumberContext ctx) {
      */
     @Override
     public void enterJsonTrue(JSONParser.JsonTrueContext ctx) {
-        currentScalarValue = new PyString("true");
+        currentScalarValue = new PyRealBoolean(true);
         currentValueType.push(ValueType.SCALAR);
     }
 
@@ -257,7 +258,7 @@ public void exitJsonTrue(JSONParser.JsonTrueContext ctx) {
      */
     @Override
     public void enterJsonFalse(JSONParser.JsonFalseContext ctx) {
-        currentScalarValue = new PyString("false");
+        currentScalarValue = new PyRealBoolean(false);
         currentValueType.push(ValueType.SCALAR);
     }
 

core/src/main/java/oracle/weblogic/deploy/util/PyOrderedDict.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2022, Oracle Corporation and/or its affiliates.  All rights reserved.
+ * Copyright (c) 2017, 2022, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 package oracle.weblogic.deploy.util;
@@ -521,7 +521,8 @@ private static PyObject doDeepCopy(PyObject orig, PyObject memo) {
             case "NoneType":
             case "str":
             case "unicode":
-            case "BooleanValue":
+            case "PyRealBoolean":
+            case "oracle.weblogic.deploy.util.PyRealBoolean":
                 result = orig;
                 break;
 

core/src/main/java/oracle/weblogic/deploy/util/PyRealBoolean.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2022, Oracle and/or its affiliates.
+ * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+ */
+package oracle.weblogic.deploy.util;
+
+import org.python.core.Py;
+import org.python.core.PyObject;
+import org.python.core.PyString;
+
+/**
+ * A boolean value that can be passed to and from parsers, and converted to other types.
+ * The PyBoolean type doesn't exist before Jython 2.7, so this allows
+ * boolean values to be distinguished from other types.
+ */
+public class PyRealBoolean extends PyObject {
+    private final boolean isTrue;
+
+    public PyRealBoolean(boolean isTrue) {
+        this.isTrue = isTrue;
+    }
+
+    public boolean getValue() {
+        return isTrue;
+    }
+
+    // support Python copy.deepcopy()
+    public PyRealBoolean __deepcopy__(PyObject memo) {
+        return new PyRealBoolean(isTrue);
+    }
+
+    @Override
+    // for Python equality checks like abc == xyz
+    public PyObject __eq__(PyObject ob_other) {
+        return equals(ob_other) ? Py.One : Py.Zero;
+    }
+
+    @Override
+    // for Python inequality checks like abc != xyz
+    public PyObject __ne__(PyObject ob_other) {
+        return equals(ob_other) ? Py.Zero : Py.One;
+    }
+
+    @Override
+    // for Python string conversion, like str(abc)
+    public PyString __str__() {
+        return new PyString(toString());
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        if(other instanceof PyRealBoolean) {
+            return isTrue == ((PyRealBoolean) other).isTrue;
+        }
+        return false;
+    }
+
+    @Override
+    public String toString() {
+        return String.valueOf(isTrue);
+    }
+}

core/src/main/java/oracle/weblogic/deploy/yaml/AbstractYamlTranslator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2022, Oracle Corporation and/or its affiliates.
+ * Copyright (c) 2017, 2022, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 package oracle.weblogic.deploy.yaml;
@@ -15,6 +15,7 @@
 import oracle.weblogic.deploy.logging.PlatformLogger;
 import oracle.weblogic.deploy.util.PyOrderedDict;
 
+import oracle.weblogic.deploy.util.PyRealBoolean;
 import org.python.core.Py;
 import org.python.core.PyDictionary;
 import org.python.core.PyFloat;
@@ -233,12 +234,7 @@ private PyObject convertScalarToPythonObject(Object object) throws YamlException
                     break;
 
                 case "java.lang.Boolean":
-                    boolean booleanValue = (Boolean) object;
-                    if (booleanValue) {
-                        result = new PyString("true");
-                    } else {
-                        result = new PyString("false");
-                    }
+                    result = new PyRealBoolean((Boolean) object);
                     break;
 
                 case "java.lang.Integer":

core/src/main/python/wlsdeploy/aliases/alias_utils.py

@@ -18,10 +18,12 @@
 from java.util import Properties
 from javax.management import ObjectName
 
+from oracle.weblogic.deploy.util import PyRealBoolean
 from oracle.weblogic.deploy.aliases import TypeUtils
 from oracle.weblogic.deploy.aliases import VersionException
 from oracle.weblogic.deploy.aliases import VersionUtils
 
+from wlsdeploy.aliases.alias_constants import BOOLEAN
 from wlsdeploy.aliases.alias_constants import ChildFoldersTypes
 from wlsdeploy.aliases.model_constants import MODEL_LIST_DELIMITER
 from wlsdeploy.exception import exception_helper
@@ -52,7 +54,6 @@
 from wlsdeploy.aliases.alias_constants import WLST_TYPE
 from wlsdeploy.aliases.alias_constants import WLST_SUBFOLDERS_PATH
 from wlsdeploy.util import model_helper
-from wlsdeploy.util.boolean_value import BooleanValue
 
 _class_name = 'alias_utils'
 _logger = PlatformLogger('wlsdeploy.aliases')
@@ -534,8 +535,8 @@ def convert_boolean(value):
                 result = True
             elif value.lower() == 'false':
                 result = False
-        elif isinstance(value, BooleanValue):
-            result = value.get_value()
+        elif isinstance(value, PyRealBoolean):
+            result = value.getValue()
     return result
 
 
@@ -848,6 +849,8 @@ def _convert_value_to_model_type(data_type, value, delimiter):
     try:
         if data_type == JAVA_LANG_BOOLEAN:
             converted = Boolean(converted)
+        elif data_type == BOOLEAN:
+            converted = PyRealBoolean('true' == converted)
         elif data_type == JARRAY:
             converted = _create_array(converted, delimiter)
         # elif data_type == PROPERTIES:

core/src/main/python/wlsdeploy/aliases/aliases.py

@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2022, Oracle Corporation and/or its affiliates.
+Copyright (c) 2017, 2022, Oracle and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
 from java.lang import String
@@ -768,8 +768,8 @@ def get_model_restart_required_attribute_names(self, location):
 
             for key, value in module_folder[ATTRIBUTES].iteritems():
                 if RESTART_REQUIRED in value:
-                    restart_required_value = value[RESTART_REQUIRED]
-                    if "true" == restart_required_value.lower():
+                    restart_required = alias_utils.convert_boolean(value[RESTART_REQUIRED])
+                    if restart_required:
                         restart_attribute_names.append(key)
 
             return restart_attribute_names

core/src/main/python/wlsdeploy/json/json_translator.py

@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2022, Oracle Corporation and/or its affiliates.
+Copyright (c) 2017, 2022, Oracle and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 This model provider translation classes that convert between JSON and Python Dictionaries.
@@ -18,7 +18,6 @@
 import oracle.weblogic.deploy.json.JsonTranslator as JJsonTranslator
 
 from wlsdeploy.logging.platform_logger import PlatformLogger
-from wlsdeploy.util.boolean_value import BooleanValue
 import wlsdeploy.exception.exception_helper as exception_helper
 
 # Unlike with yaml files, JSON files do not allow comments. remove from file
@@ -240,8 +239,6 @@ def _format_json_value(value):
     builder = StringBuilder()
     if type(value) == bool:
         builder.append(JBoolean.toString(value))
-    elif isinstance(value, BooleanValue):
-        builder.append(value.get_string_value())
     elif isinstance(value, types.StringTypes):
         builder.append('"').append(_escape_text(value.strip())).append('"')
     else:

core/src/main/python/wlsdeploy/tool/discover/topology_discoverer.py

@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2022, Oracle Corporation and/or its affiliates.
+Copyright (c) 2017, 2022, Oracle and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
 from java.io import File
@@ -12,6 +12,7 @@
 from oracle.weblogic.deploy.util import StringUtils
 from oracle.weblogic.deploy.util import WLSDeployArchiveIOException
 
+from wlsdeploy.aliases import alias_utils
 from wlsdeploy.aliases import model_constants
 from wlsdeploy.aliases.location_context import LocationContext
 from wlsdeploy.aliases.model_constants import MODEL_LIST_DELIMITER
@@ -559,8 +560,9 @@ def _massage_security_credential(self, result, location):
             short_name = self._credential_injector.get_folder_short_name(location)
         if model_constants.SECURITY_CONFIGURATION_PASSWORD in result:
             # default is false
-            if model_constants.SECURITY_CONFIGURATION_CD_ENABLED not in result or \
-                    Boolean.valueOf(result[model_constants.SECURITY_CONFIGURATION_CD_ENABLED]) == Boolean.FALSE:
+            cd_enabled_raw = dictionary_utils.get_element(result, model_constants.SECURITY_CONFIGURATION_CD_ENABLED)
+            cd_enabled = alias_utils.convert_boolean(cd_enabled_raw)
+            if not cd_enabled:
                 # Hard code it here or hard code it later. The target code will bypass tokenize of variable
                 cache_name = short_name + VARIABLE_SEP + model_constants.SECURITY_CONFIGURATION_PASSWORD
                 if cache_name in pass_cache:

core/src/main/python/wlsdeploy/tool/extract/domain_resource_extractor.py

@@ -6,6 +6,7 @@
 
 from java.io import File
 from oracle.weblogic.deploy.util import PyOrderedDict
+from oracle.weblogic.deploy.util import PyRealBoolean
 
 from wlsdeploy.aliases import alias_utils
 from wlsdeploy.aliases.alias_constants import PASSWORD_TOKEN
@@ -18,7 +19,6 @@
 from wlsdeploy.tool.extract import wko_schema_helper
 from wlsdeploy.tool.util import k8s_helper
 from wlsdeploy.util import dictionary_utils
-from wlsdeploy.util.boolean_value import BooleanValue
 from wlsdeploy.util.model_translator import PythonToFile
 
 API_VERSION = 'apiVersion'
@@ -299,7 +299,7 @@ def _get_target_value(model_value, type_name):
     if type_name == 'boolean':
         # the model values can be true, false, 1, 0, etc.
         # target boolean values must be 'true' or 'false'
-        return BooleanValue(model_value)
+        return PyRealBoolean(alias_utils.convert_boolean(model_value))
 
     if type_name == 'array':
         # the model values can be 'abc,123'.

core/src/main/python/wlsdeploy/tool/util/filters/wko_filter.py

@@ -1,12 +1,12 @@
-# Copyright (c) 2021, 2022, Oracle Corporation and/or its affiliates.
+# Copyright (c) 2021, 2022, Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 #
 # ------------
 # Description:
 # ------------
 # WDT filters to prepare a model for use with WKO, using the createDomain or prepareModel tools.
 # These operations can be invoked as a single call, or independently of each other.
-
+from oracle.weblogic.deploy.util import PyRealBoolean
 from wlsdeploy.aliases import alias_utils
 from wlsdeploy.aliases.model_constants import CALCULATED_LISTEN_PORTS
 from wlsdeploy.aliases.model_constants import CLUSTER
@@ -20,7 +20,6 @@
 from wlsdeploy.logging.platform_logger import PlatformLogger
 from wlsdeploy.tool.util.filters.model_traverse import ModelTraverse
 from wlsdeploy.util import dictionary_utils
-from wlsdeploy.util.boolean_value import BooleanValue
 
 _class_name = 'wko_filter'
 _logger = PlatformLogger('wlsdeploy.tool.util')
@@ -69,7 +68,7 @@ def check_clustered_server_ports(model, _model_context):
             if (calculated_listen_ports is None) or alias_utils.convert_boolean(calculated_listen_ports):
                 _logger.info('WLSDPLY-20202', CALCULATED_LISTEN_PORTS, CLUSTER, cluster_name, class_name=_class_name,
                              method_name=_method_name)
-                dynamic_folder[CALCULATED_LISTEN_PORTS] = BooleanValue(False)
+                dynamic_folder[CALCULATED_LISTEN_PORTS] = PyRealBoolean(False)
 
     # be sure every server assigned to a cluster has the same listen port