Issue #559 Implement environment variable lookup in model (#570)

Author: rakillen

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

@@ -25,6 +25,7 @@
 _logger = platform_logger.PlatformLogger('wlsdeploy.variables')
 _file_variable_pattern = re.compile("@@FILE:[\w.\\\/:-]+@@")
 _property_pattern = re.compile("(@@PROP:([\\w.-]+)@@)")
+_environment_pattern = re.compile("(@@ENV:([\\w.-]+)@@)")
 _file_nested_variable_pattern = re.compile("@@FILE:@@[\w]+@@[\w.\\\/:-]+@@")
 
 
@@ -234,6 +235,23 @@ def _substitute(text, variables, model_context):
             value = variables[key]
             text = text.replace(token, value)
 
+        # check environment variables before @@FILE:/dir/@@ENV:name@@.txt@@
+        matches = _environment_pattern.findall(text)
+        for token, key in matches:
+            # log, or throw an exception if key is not found.
+            if not os.environ.has_key(key):
+                if model_context.get_validation_method() == 'strict':
+                    _logger.severe('WLSDPLY-01737', key, class_name=_class_name, method_name=method_name)
+                    ex = exception_helper.create_variable_exception('WLSDPLY-01737', key)
+                    _logger.throwing(ex, class_name=_class_name, method_name=method_name)
+                    raise ex
+                else:
+                    _logger.info('WLSDPLY-01737', key, class_name=_class_name, method_name=method_name)
+                    continue
+
+            value = os.environ.get(key)
+            text = text.replace(token, value)
+
         tokens = _file_variable_pattern.findall(text)
         if tokens:
             for token in tokens:

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

@@ -293,6 +293,7 @@ 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}@@
 WLSDPLY-01736=Default variable file name {0}
+WLSDPLY-01737=Environment variable "{0}" was not found
 
 # wlsdeploy/util/weblogic_helper.py
 WLSDPLY-01740=Encryption failed: Unable to locate SerializedSystemIni

core/src/test/python/variables_test.py

@@ -4,6 +4,8 @@
 """
 import unittest
 
+import os
+
 import wlsdeploy.util.variables as variables
 from oracle.weblogic.deploy.util import VariableException
 from wlsdeploy.util.model_context import ModelContext
@@ -88,6 +90,27 @@ def testFileVariableNotFound(self):
         else:
             self.fail('Test must raise VariableException when variable file is not found')
 
+    def testEnvironmentVariable(self):
+        os.environ['envVariable'] = 'the-admin-user'
+        model = {'domainInfo': {'AdminUserName': '@@ENV:envVariable@@'}}
+        variables.substitute(model, {}, self.model_context)
+        self.assertEqual(model['domainInfo']['AdminUserName'], 'the-admin-user')
+
+    def testFileVariableWithEnvironmentVariable(self):
+        os.environ['variableDir'] = self._resources_dir
+        model = {'domainInfo': {'AdminUserName': '@@FILE:@@ENV:variableDir@@/' + self._file_variable_name + '@@'}}
+        variables.substitute(model, {}, self.model_context)
+        self.assertEqual(model['domainInfo']['AdminUserName'], 'file-variable-value')
+
+    def testEnvironmentVariableNotFound(self):
+        try:
+            model = {'domainInfo': {'AdminUserName': '@@ENV:notaVariable@@'}}
+            variables.substitute(model, {}, self.model_context)
+        except VariableException:
+            pass
+        else:
+            self.fail('Test must raise VariableException when variable file is not found')
+
 
 if __name__ == '__main__':
     unittest.main()