FT Variable Substitution - Parser changed from ltx to xmldom (#11401)

Parser changed from ltx to xmldom
microsoft · Oct 11, 2019 · b4692e1 · b4692e1
1 parent f81941e
commit b4692e1
Show file tree

Hide file tree

Showing 17 changed files with 227 additions and 107 deletions.
diff --git a/Tasks/AzureMysqlDeploymentV1/task.json b/Tasks/AzureMysqlDeploymentV1/task.json
@@ -17,7 +17,7 @@
     "version": {
         "Major": 1,
         "Minor": 156,
-        "Patch": 10
+        "Patch": 11
     },
     "demands": [],
     "minimumAgentVersion": "1.100.0",

diff --git a/Tasks/AzureMysqlDeploymentV1/task.loc.json b/Tasks/AzureMysqlDeploymentV1/task.loc.json
@@ -17,7 +17,7 @@
   "version": {
     "Major": 1,
     "Minor": 156,
-    "Patch": 10
+    "Patch": 11
   },
   "demands": [],
   "minimumAgentVersion": "1.100.0",

diff --git a/Tasks/AzureRmWebAppDeploymentV4/task.json b/Tasks/AzureRmWebAppDeploymentV4/task.json
@@ -18,7 +18,7 @@
     "version": {
         "Major": 4,
         "Minor": 157,
-        "Patch": 4
+        "Patch": 5
     },
     "releaseNotes": "What's new in version 4.*<br />Supports Zip Deploy, Run From Package, War Deploy [Details here](https://aka.ms/appServiceDeploymentMethods)<br />Supports App Service Environments<br />Improved UI for discovering different App service types supported by the task<br/>Run From Package is the preferred deployment method, which makes files in wwwroot folder read-only<br/>Click [here](https://aka.ms/azurermwebdeployreadme) for more information.",
     "minimumAgentVersion": "2.104.1",

diff --git a/Tasks/AzureRmWebAppDeploymentV4/task.loc.json b/Tasks/AzureRmWebAppDeploymentV4/task.loc.json
@@ -18,7 +18,7 @@
   "version": {
     "Major": 4,
     "Minor": 157,
-    "Patch": 4
+    "Patch": 5
   },
   "releaseNotes": "ms-resource:loc.releaseNotes",
   "minimumAgentVersion": "2.104.1",

diff --git a/Tasks/Common/webdeployment-common-v2/npmdomutility.ts b/Tasks/Common/webdeployment-common-v2/npmdomutility.ts
@@ -0,0 +1,81 @@
+var varUtility = require("./variableutility.js");
+var DOMParser = require('xmldom').DOMParser;
+
+export class NpmDomUtility  {
+
+    private xmlDomLookUpTable = {};
+    private xmlDom;
+
+    public constructor(xmlContent) {
+        this.xmlDomLookUpTable = {};
+        this.xmlDom = new DOMParser().parseFromString(xmlContent,"text/xml");
+        this.buildLookUpTable(this.xmlDom);
+    }
+
+    public getXmlDom() {
+        return this.xmlDom;
+    }
+
+    public getContentWithHeader(xmlDom) {
+        return xmlDom ? xmlDom.toString() : "";
+    }
+
+    /**
+     * Define method to create a lookup for DOM 
+     */
+    private buildLookUpTable(node) {
+        if(node){
+            let nodeName = node.nodeName;
+            if(nodeName){
+                nodeName = nodeName.toLowerCase();
+                let listOfNodes = this.xmlDomLookUpTable[nodeName];
+                if(listOfNodes == null || !(Array.isArray(listOfNodes))) {
+                    this.xmlDomLookUpTable[nodeName] = [];
+                }
+                (this.xmlDomLookUpTable[nodeName]).push(node);
+                if(node.hasChildNodes()) {
+                    let children = node.childNodes;
+                    for(let i=0 ; i < children.length; i++) {
+                        this.buildLookUpTable(children[i]);
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     *  Returns array of nodes which match with the tag name.
+     */
+    public getElementsByTagName(nodeName) {
+        if(varUtility.isEmpty(nodeName))
+            return [];
+        let selectedElements = this.xmlDomLookUpTable[nodeName.toLowerCase()];
+        if(!selectedElements){
+            selectedElements = [];
+        }
+        return selectedElements;
+    }
+
+    /**
+     *  Search in subtree with provided node name
+     */
+    public getChildElementsByTagName(node, tagName) {
+        if(!varUtility.isObject(node) )
+            return [];
+        var liveNodes = [];
+        if(node.hasChildNodes()){
+            var children = node.childNodes;
+            for(let i=0; i < children.length; i++ ){
+                let childName = children[i].nodeName;
+                if( !varUtility.isEmpty(childName) && tagName == childName){
+                    liveNodes.push(children[i]);
+                }
+                let liveChildNodes = this.getChildElementsByTagName(children[i], tagName);
+                if(liveChildNodes && liveChildNodes.length > 0){
+                    liveNodes = liveNodes.concat(liveChildNodes);
+                }
+            }
+        }
+        return liveNodes;
+    }
+}
diff --git a/Tasks/Common/webdeployment-common-v2/variableutility.ts b/Tasks/Common/webdeployment-common-v2/variableutility.ts
@@ -11,7 +11,7 @@ export function isPredefinedVariable(variable: string): boolean {
 }
 
 export function isEmpty(object){
-    if(object == null || object == "")
+    if(object == null || object == "" || (object.toString()).trim() == null || (object.toString()).trim() == "")
         return true;
     return false;
 }

diff --git a/Tasks/Common/webdeployment-common-v2/xmlvariablesubstitutionutility.ts b/Tasks/Common/webdeployment-common-v2/xmlvariablesubstitutionutility.ts
diff --git a/Tasks/FileTransformV1/task.json b/Tasks/FileTransformV1/task.json
@@ -18,7 +18,7 @@
     "version": {
         "Major": 1,
         "Minor": 156,
-        "Patch": 3
+        "Patch": 4
     },
     "instanceNameFormat": "File Transform: $(Package)",
     "groups": [

diff --git a/Tasks/FileTransformV1/task.loc.json b/Tasks/FileTransformV1/task.loc.json
@@ -18,7 +18,7 @@
   "version": {
     "Major": 1,
     "Minor": 156,
-    "Patch": 3
+    "Patch": 4
   },
   "instanceNameFormat": "ms-resource:loc.instanceNameFormat",
   "groups": [

diff --git a/Tasks/FileTransformV2/task.json b/Tasks/FileTransformV2/task.json
@@ -18,7 +18,7 @@
     "version": {
         "Major": 2,
         "Minor": 0,
-        "Patch": 1
+        "Patch": 2
     },
     "preview": "true",
     "releaseNotes": "More optimized task fields that allow users to enable any/all of the transformation (XML), variable substitution (JSON and XML) features in a single task instance.</br>Task fails when any of the configured transformation/substitution is NOT applied or when the task is no-op.",

diff --git a/Tasks/FileTransformV2/task.loc.json b/Tasks/FileTransformV2/task.loc.json
@@ -18,7 +18,7 @@
   "version": {
     "Major": 2,
     "Minor": 0,
-    "Patch": 1
+    "Patch": 2
   },
   "preview": "true",
   "releaseNotes": "ms-resource:loc.releaseNotes",

diff --git a/Tasks/IISWebAppDeploymentOnMachineGroupV0/task.json b/Tasks/IISWebAppDeploymentOnMachineGroupV0/task.json
@@ -17,7 +17,7 @@
     "version": {
         "Major": 0,
         "Minor": 156,
-        "Patch": 3
+        "Patch": 4
     },
     "demands": [],
     "minimumAgentVersion": "2.104.1",

diff --git a/Tasks/IISWebAppDeploymentOnMachineGroupV0/task.loc.json b/Tasks/IISWebAppDeploymentOnMachineGroupV0/task.loc.json
@@ -17,7 +17,7 @@
   "version": {
     "Major": 0,
     "Minor": 156,
-    "Patch": 3
+    "Patch": 4
   },
   "demands": [],
   "minimumAgentVersion": "2.104.1",

diff --git a/Tasks/MysqlDeploymentOnMachineGroupV1/task.json b/Tasks/MysqlDeploymentOnMachineGroupV1/task.json
@@ -17,7 +17,7 @@
     "version": {
         "Major": 1,
         "Minor": 156,
-        "Patch": 4
+        "Patch": 5
     },
     "demands": [],
     "minimumAgentVersion": "1.100.0",

diff --git a/Tasks/MysqlDeploymentOnMachineGroupV1/task.loc.json b/Tasks/MysqlDeploymentOnMachineGroupV1/task.loc.json
@@ -17,7 +17,7 @@
   "version": {
     "Major": 1,
     "Minor": 156,
-    "Patch": 4
+    "Patch": 5
   },
   "demands": [],
   "minimumAgentVersion": "1.100.0",

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -45,5 +45,8 @@
     "typed-rest-client": "1.0.9",
     "typescript": "2.3.4",
     "validator": "3.33.0"
+  },
+  "dependencies": {
+    "xmldom": "^0.1.27"
   }
 }