Issue#54 - Add capability to inline variables by specifying @@file:/<dir>/<name>@@ for variable value. Fixes #54

Author: rakillen

core/src/main/python/create.py

@@ -326,15 +326,16 @@ def main():
         __clean_up_temp_files()
         sys.exit(CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
 
-    if model_context.get_variable_file():
-        try:
+    try:
+        variable_map = {}
+        if model_context.get_variable_file():
             variable_map = variables.load_variables(model_context.get_variable_file())
-            variables.substitute(model, variable_map)
-        except VariableException, ex:
-            __logger.severe('WLSDPLY-20004', _program_name, ex.getLocalizedMessage(), error=ex,
-                            class_name=_class_name, method_name=_method_name)
-            __clean_up_temp_files()
-            sys.exit(CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
+        variables.substitute(model, variable_map)
+    except VariableException, ex:
+        __logger.severe('WLSDPLY-20004', _program_name, ex.getLocalizedMessage(), error=ex,
+                        class_name=_class_name, method_name=_method_name)
+        __clean_up_temp_files()
+        sys.exit(CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
 
     aliases = Aliases(model_context, wlst_mode=__wlst_mode)
     validate_model(model, model_context, aliases)

core/src/main/python/deploy.py

@@ -445,15 +445,16 @@ def main():
         __clean_up_temp_files()
         sys.exit(CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
 
-    if model_context.get_variable_file():
-        try:
+    try:
+        variable_map = {}
+        if model_context.get_variable_file():
             variable_map = variables.load_variables(model_context.get_variable_file())
-            variables.substitute(model_dictionary, variable_map)
-        except VariableException, ex:
-            __logger.severe('WLSDPLY-20004', _program_name, ex.getLocalizedMessage(), error=ex,
-                            class_name=_class_name, method_name=_method_name)
-            __clean_up_temp_files()
-            sys.exit(CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
+        variables.substitute(model_dictionary, variable_map)
+    except VariableException, ex:
+        __logger.severe('WLSDPLY-20004', _program_name, ex.getLocalizedMessage(), error=ex,
+                        class_name=_class_name, method_name=_method_name)
+        __clean_up_temp_files()
+        sys.exit(CommandLineArgUtil.PROG_ERROR_EXIT_CODE)
 
     aliases = Aliases(model_context, wlst_mode=__wlst_mode)
     validate_model(model_dictionary, model_context, aliases)

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

@@ -4,8 +4,10 @@
 """
 import re
 
+from java.io import BufferedReader
 from java.io import FileInputStream
 from java.io import FileOutputStream
+from java.io import FileReader
 from java.io import IOException
 from java.util import Properties
 
@@ -17,6 +19,7 @@
 _class_name = "variables"
 _logger = platform_logger.PlatformLogger('wlsdeploy.variables')
 _variable_pattern = re.compile("\\$\\{[\w.-]+\\}")
+_file_variable_pattern = re.compile("@@FILE:[\w.\\\/:-]+@@")
 
 
 def load_variables(file_path):
@@ -150,5 +153,38 @@ def _substitute(text, variables):
                 value = variables[key]
                 text = text.replace(token, value)
 
+    if '@@FILE:' in text:
+        tokens = _file_variable_pattern.findall(text)
+        if tokens:
+            for token in tokens:
+                path = token[7:-2]
+                value = _read_value_from_file(path)
+                text = text.replace(token, value)
+
     return text
 
+
+def _read_value_from_file(file_path):
+    """
+    Read a single text value from the first line in the specified file.
+    :param file_path: the file from which to read the value
+    :return: the text value
+    :raises BundleAwareException if an error occurs while reading the value
+    """
+    method_name = '_read_value_from_file'
+
+    try:
+        file_reader = BufferedReader(FileReader(file_path))
+        line = file_reader.readLine()
+        file_reader.close()
+    except IOException, e:
+        ex = exception_helper.create_variable_exception('WLSDPLY-01733', file_path, e.getLocalizedMessage(), error=e)
+        _logger.throwing(ex, class_name=_class_name, method_name=method_name)
+        raise ex
+
+    if line is None:
+        ex = exception_helper.create_variable_exception('WLSDPLY-01734', file_path)
+        _logger.throwing(ex, class_name=_class_name, method_name=method_name)
+        raise ex
+
+    return str(line).strip()

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

@@ -247,6 +247,8 @@ WLSDPLY-01720=to_boolean() method called with non-boolean value {0} so returning
 WLSDPLY-01730=Failed to load variables file {0}: {1}
 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}
 
 # wlsdeploy/util/weblogic_helper.py
 WLSDPLY-01740=Encryption failed: Unable to locate SerializedSystemIni

core/src/test/python/variables_test.py

@@ -12,6 +12,8 @@
 class VariablesTestCase(unittest.TestCase):
     _resources_dir = '../../test-classes'
     _variables_file = _resources_dir + '/variables.properties'
+    _file_variable_name = 'file-variable.txt'
+    _file_variable_path = _resources_dir + '/' + _file_variable_name
     _use_ordering = True
 
     def setUp(self):
@@ -48,5 +50,28 @@ def testVariableNotFound(self):
         else:
             self.fail('Test must raise VariableException when variable is not found')
 
+    def testFileVariable(self):
+        path = self._resources_dir + '/' + self._file_variable_name
+        model = {'domainInfo': {'AdminUserName': '@@FILE:' + path + '@@'}}
+        variables.substitute(model, {})
+        self.assertEqual(model['domainInfo']['AdminUserName'], 'file-variable-value')
+
+    def testFileVariableWithVariable(self):
+        model = {'domainInfo': {'AdminUserName': '@@FILE:${variable_dir}/' + self._file_variable_name + '@@'}}
+        variables.substitute(model, {'variable_dir': self._resources_dir})
+        self.assertEqual(model['domainInfo']['AdminUserName'], 'file-variable-value')
+
+    def testFileVariableNotFound(self):
+        try:
+            path = self._resources_dir + '/no-file.txt'
+            model = {'domainInfo': {'AdminUserName': '@@FILE:' + path + '@@'}}
+            variables.substitute(model, {})
+            self.assertEqual(model['domainInfo']['AdminUserName'], 'file-variable-value')
+        except VariableException:
+            pass
+        else:
+            self.fail('Test must raise VariableException when variable file is not found')
+
+
 if __name__ == '__main__':
     unittest.main()

core/src/test/resources/file-variable.txt

@@ -0,0 +1 @@
+file-variable-value