Check for token syntax errors after substitutions (#575)

* JIRA OWLS-80571 Check for token syntax errors after substitutions

* JIRA OWLS-80571 Revised variable name

Author: rakillen

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

@@ -30,6 +30,9 @@
 _secret_pattern = re.compile("(@@SECRET:([\\w.-]+):([\\w.-]+)@@)")
 _file_nested_variable_pattern = re.compile("@@FILE:@@[\w]+@@[\w.\\\/:-]+@@")
 
+# if this pattern is found, token substitution was incomplete
+_unresolved_token_pattern = re.compile("(@@(PROP|FILE|ENV|SECRET):)")
+
 _secret_dirs_variable = "WDT_MODEL_SECRETS_DIRS"
 _secret_dirs_default = "/weblogic-operator/config-overrides-secrets"
 _secret_dir_pairs_variable="WDT_MODEL_SECRETS_NAME_DIR_PAIRS"
@@ -276,6 +279,17 @@ def _substitute(text, variables, model_context):
                 value = _read_value_from_file(path, model_context)
                 text = text.replace(token, value)
 
+        # if any @@TOKEN: remains in the value, throw an exception
+        matches = _unresolved_token_pattern.findall(text)
+        if matches:
+            match = matches[0]
+            token = match[1]
+            sample = "@@" + token + ":<name>"
+            if token == "SECRET":
+                sample += ":<key>"
+            sample += "@@"
+            _report_token_issue("WLSDPLY-01745", method_name, model_context, token, sample)
+
     return text
 
 

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

@@ -301,6 +301,9 @@ WLSDPLY-01739=Error: Could not resolve secret token "{0}". Known secrets include
 WLSDPLY-01740=Encryption failed: Unable to locate SerializedSystemIni
 WLSDPLY-01741=Encryption failed: Unable to initialize encryption service
 
+# wlsdeploy/util/variables.py (cont'd)
+WLSDPLY-01745=Invalid syntax for token {0}, should be "{1}"
+
 # oracle.weblogic.deploy.util.WebLogicDeployToolingVersion.java (in src/main/resources/templates)
 WLSDPLY-01750=The WebLogic Deploy Tooling {0} version is {1}
 

core/src/test/python/variables_test.py

@@ -144,6 +144,29 @@ def testSecretTokenNotFound(self):
         else:
             self.fail('Test must raise VariableException when secret token is not found')
 
+    def testTokenSyntaxErrors(self):
+        """
+        Test that exceptions are thrown for token syntax errors.
+        """
+        self._test_token_syntax_error("@@SECRET:my-secret/my-key@@")
+        self._test_token_syntax_error("@@SECRET:@@ENVmy-secret:-my-key@@-some-more-text")
+        self._test_token_syntax_error("@@ENV:my-secret!@@")
+        self._test_token_syntax_error("@@FILE:@@ORACLE_HOME@@/my-file")
+        self._test_token_syntax_error("@@PROP:")
+
+    def _test_token_syntax_error(self, value):
+        """
+        Test that an exception is thrown for a token syntax error in the specified value.
+        :param value: the text value to be checked
+        """
+        try:
+            model = {'domainInfo': {'AdminUserName': value}}
+            variables.substitute(model, {}, self.model_context)
+        except VariableException, e:
+            pass
+        else:
+            self.fail('Test must raise VariableException when token has a syntax error')
+
 
 if __name__ == '__main__':
     unittest.main()