Issue#61 - Add new @@prop:key@@ syntax for variables, deprecate ${key} notation. Fixes #61

Author: rakillen

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

@@ -20,6 +20,7 @@
 _logger = platform_logger.PlatformLogger('wlsdeploy.variables')
 _variable_pattern = re.compile("\\$\\{[\w.-]+\\}")
 _file_variable_pattern = re.compile("@@FILE:[\w.\\\/:-]+@@")
+_property_pattern = re.compile("@@PROP:[\w.-]+@@")
 
 
 def load_variables(file_path):
@@ -146,14 +147,28 @@ def _substitute(text, variables):
         if tokens:
             for token in tokens:
                 key = token[2:-1]
+                # for ${key} variables, leave them in place if not defined.
+                # there are cases where WebLogic allows ${key} values, such as server templates.
+                # ${key} substitution is deprecated, so log if replacement occurs.
+                if key in variables:
+                    value = variables[key]
+                    text = text.replace(token, value)
+                    _logger.info('WLSDPLY-01735', token, key, method_name=method_name, class_name=_class_name)
+
+    # skip lookups for text with no @@
+    if '@@' in text:
+        tokens = _property_pattern.findall(text)
+        if tokens:
+            for token in tokens:
+                key = token[7:-2]
+                # for @@PROP:key@@ variables, throw an exception if key is not found.
                 if key not in variables:
                     ex = exception_helper.create_variable_exception('WLSDPLY-01732', key)
                     _logger.throwing(ex, class_name=_class_name, method_name=method_name)
                     raise ex
                 value = variables[key]
                 text = text.replace(token, value)
 
-    if '@@FILE:' in text:
         tokens = _file_variable_pattern.findall(text)
         if tokens:
             for token in tokens:

core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties

@@ -249,6 +249,7 @@ WLSDPLY-01731=Variables updated after encryption
 WLSDPLY-01732=Variable {0} is not found in properties file
 WLSDPLY-01733=Variable file {0} cannot be read: {1}
 WLSDPLY-01734=No value in variable file {0}
+WLSDPLY-01735=Variable substitution for {0} is deprecated, use @@PROP:{1}@@
 
 # wlsdeploy/util/weblogic_helper.py
 WLSDPLY-01740=Encryption failed: Unable to locate SerializedSystemIni

core/src/test/python/variables_test.py

@@ -29,6 +29,7 @@ def testSubstituteYaml(self):
         variables.substitute(model, variable_map)
         self.assertEqual(model['topology']['Name'], 'xyz123')
         self.assertEqual(model['topology']['Server']['s1']['ListenPort'], '1009')
+        self.assertEqual(model['topology']['Server']['s2']['Cluster'], 'myCluster')
         self.assertEqual(True, 'myCluster' in model['topology']['Cluster'])
 
     def testSubstituteJson(self):
@@ -37,12 +38,27 @@ def testSubstituteJson(self):
         variables.substitute(model, variable_map)
         self.assertEqual(model['topology']['Name'], 'xyz123')
         self.assertEqual(model['topology']['Server']['s1']['ListenPort'], '1009')
+        self.assertEqual(model['topology']['Server']['s2']['Cluster'], 'myCluster')
         self.assertEqual(True, 'myCluster' in model['topology']['Cluster'])
 
     def testVariableNotFound(self):
+        """
+        For ${key} substitution, no replacement is done, and no error is reported, if variable not found.
+        ${key} substitution is deprecated.
+        """
+        model = FileToPython(self._resources_dir + '/variables-test.json', self._use_ordering).parse()
+        model['topology']['Name'] = '${bad.variable}'
+        variable_map = variables.load_variables(self._variables_file)
+        variables.substitute(model, variable_map)
+        self.assertEqual(model['topology']['Name'], '${bad.variable}')
+
+    def testPropertyNotFound(self):
+        """
+        For @@PROP:key@@ substitution, an exception is thrown if variable not found.
+        """
         try:
             model = FileToPython(self._resources_dir + '/variables-test.json', self._use_ordering).parse()
-            model['topology']['Name'] = '${bad.variable}'
+            model['topology']['Name'] = '@@PROP:bad.variable@@'
             variable_map = variables.load_variables(self._variables_file)
             variables.substitute(model, variable_map)
         except VariableException:

core/src/test/resources/variables-test.json

@@ -19,7 +19,7 @@
             "s2": {
                 "ListenAddress": "127.0.0.1",
                 "ListenPort": 8101,
-                "Cluster": "${my.cluster}"
+                "Cluster": "@@PROP:my.cluster@@"
             }
         }
     }

core/src/test/resources/variables-test.yaml

@@ -14,4 +14,4 @@ topology:
         s2:
             ListenAddress: 127.0.0.1
             ListenPort: 8101
-            Cluster: '${my.cluster}'
+            Cluster: '@@PROP:my.cluster@@'