Completes basic XML rewrite functionality

Author: aarondandy

.vscode/launch.json

@@ -0,0 +1,26 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "preLaunchTask": "launch-build",
+      "program": "${workspaceFolder}\\buildAndReleaseTask\\index.js",
+      "env": {
+        "INPUT_TARGETFILEPATH": "SampleServiceConfiguration.cscfg",
+        "foo.blank": "blank-override",
+        "FOO_BAR": "bar-override"
+      },
+      "outFiles": [
+        "${workspaceFolder}/**/*.js"
+      ],
+    }
+  ]
+}

.vscode/tasks.json

@@ -0,0 +1,17 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "launch-build",
+      "type": "typescript",
+      "tsconfig": "tsconfig.json",
+      "problemMatcher": ["$tsc"],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ]
+}

SampleServiceConfiguration.cscfg

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  **********************************************************************************************
+
+  This file was generated by a tool from the project file: ServiceConfiguration.cscfg
+
+  Changes to this file may cause incorrect behavior and will be lost if the file is regenerated.
+
+  **********************************************************************************************
+-->
+<ServiceConfiguration serviceName="ServiceName" xmlns="http://schemas.microsoft.com/ServiceHosting/2008/10/ServiceConfiguration" osFamily="6" osVersion="*" schemaVersion="2015-04.2.6">
+  <Role name="RoleName">
+    <Instances count="1" />
+    <ConfigurationSettings>
+      <Setting name="foo.blank" value="" />
+      <Setting name="foo.bar" value="bar" />
+    </ConfigurationSettings>
+  </Role>
+</ServiceConfiguration>

buildAndReleaseTask/index.ts

@@ -1,17 +1,66 @@
-import tl = require('azure-pipelines-task-lib/task');
+import tl = require('azure-pipelines-task-lib');
+import { promises as fsPromises } from 'fs';
+import { DOMParser, XMLSerializer } from 'xmldom';
 
 async function run() {
-    try {
-        const inputString: string | undefined = tl.getInput('samplestring', true);
-        if (inputString == 'bad') {
-            tl.setResult(tl.TaskResult.Failed, 'Bad input was given');
-            return;
-        }
-        console.log('Hello', inputString);
+  try {
+    const targetFilePath: string | undefined = tl.getInput('targetFilePath', true);
+    if (targetFilePath === '' || targetFilePath == null) {
+      tl.setResult(tl.TaskResult.Failed, 'A file path to transform is required');
+      return;
     }
-    catch (err) {
-        tl.setResult(tl.TaskResult.Failed, err.message);
+
+    let fileMutated = false;
+
+    const originalContents = await fsPromises.readFile(targetFilePath, 'utf8');
+    const parser = new DOMParser();
+    
+    let doc = parser.parseFromString(originalContents, 'text/xml');
+    if (doc.documentElement.nodeName !== 'ServiceConfiguration') {
+      tl.setResult(tl.TaskResult.Failed, 'Config file missing root ServiceConfiguration element');
+      return;
+    }
+
+    let roleNode = Array.from(doc.documentElement.childNodes).filter(n => n.nodeType === 1 && n.nodeName === 'Role')[0];
+    if (!roleNode) {
+      tl.setResult(tl.TaskResult.Failed, 'Config file missing Role element');
+      return;
     }
+
+    let configSettingsNode = Array.from(roleNode.childNodes).filter(n => n.nodeType === 1 && n.nodeName === 'ConfigurationSettings')[0];
+    if (!configSettingsNode) {
+      tl.warning("Failed to find a ConfigurationSettings section to update");
+      return;
+    }
+
+    Array.from(configSettingsNode.childNodes).filter(n => n.nodeType === 1 && n.nodeName === 'Setting').forEach(settingsNode => {
+      let settingsElement = <Element>settingsNode;
+      const settingName = settingsElement.getAttribute('name');
+      if (!settingName) {
+        return;
+      }
+
+      let overrideValue = tl.getVariable(settingName);
+
+      if (overrideValue != null) {
+        tl.debug(`Override found for ${settingName}`);
+        settingsElement.setAttribute('value', overrideValue);
+        fileMutated = true;
+      }
+    });
+
+    if (fileMutated) {
+      const newContents = new XMLSerializer().serializeToString(doc);
+      fsPromises.writeFile(targetFilePath, newContents);
+    }
+    else {
+      tl.warning("No variable updates were applied to the file.");
+    }
+
+  }
+  catch (err) {
+    tl.setResult(tl.TaskResult.Failed, err.message);
+  }
 }
 
 run();

buildAndReleaseTask/task.json

@@ -2,30 +2,34 @@
   "$schema": "https://raw.githubusercontent.com/Microsoft/azure-pipelines-task-lib/master/tasks.schema.json",
   "id": "ed1c80dd-0444-415a-9a79-4cbd0251e8f2",
   "name": "cscfg-transform",
-  "friendlyName": "Azure Cloud Services Config Transform",
-  "description": "Transforms Azure Cloud Service cscfg files.",
+  "friendlyName": "Azure Cloud Services Config Variable Transform",
+  "description": "Transforms Azure Cloud Service cscfg variables.",
   "helpMarkDown": "",
   "category": "Utility",
   "author": "rezStream",
+  "visibility": [
+    "Build",
+    "Release"
+  ],
   "version": {
-      "Major": 0,
-      "Minor": 1,
-      "Patch": 0
+    "Major": 0,
+    "Minor": 1,
+    "Patch": 0
   },
-  "instanceNameFormat": "Echo $(samplestring)",
+  "instanceNameFormat": "Transform cscfg $(targetFilePath)",
   "inputs": [
-      {
-          "name": "samplestring",
-          "type": "string",
-          "label": "Sample String",
-          "defaultValue": "",
-          "required": true,
-          "helpMarkDown": "A sample string"
-      }
+    {
+      "name": "targetFilePath",
+      "type": "filePath",
+      "label": "File path",
+      "defaultValue": "",
+      "required": true,
+      "helpMarkDown": "The cscfg file to apply variable transforms to"
+    }
   ],
   "execution": {
-      "Node10": {
-          "target": "index.js"
-      }
+    "Node10": {
+      "target": "index.js"
+    }
   }
-}
+}

package-lock.json

@@ -13,12 +13,14 @@
   "author": "rezStream",
   "license": "MIT",
   "dependencies": {
-    "azure-pipelines-task-lib": "^2.9.3"
+    "azure-pipelines-task-lib": "^2.9.3",
+    "xmldom": "^0.2.1"
   },
   "devDependencies": {
     "@types/mocha": "^7.0.1",
     "@types/node": "^13.7.0",
     "@types/q": "^1.5.2",
+    "@types/xmldom": "^0.1.29",
     "sync-request": "^6.1.0"
   }
 }

package.json

@@ -1,15 +1,15 @@
 {
   "manifestVersion": 1,
   "id": "cscfg-transform",
-  "name": "Azure Cloud Services Config Transform",
+  "name": "Azure Cloud Services Config Variable Transform",
   "version": "0.1.0",
   "publisher": "rezStream",
   "targets": [
     {
       "id": "Microsoft.VisualStudio.Services"
     }
   ],
-  "description": "Transforms Azure Cloud Service cscfg files.",
+  "description": "Transforms Azure Cloud Service cscfg variables.",
   "categories": [
     "Azure Pipelines"
   ],