Adds new app.config settings update task

Author: aarondandy

appcfg-settings-extension.json

@@ -0,0 +1,36 @@
+{
+  "manifestVersion": 1,
+  "id": "appcfg-settings",
+  "name": "Update .NET XML Config Settings",
+  "version": "0.1.0",
+  "publisher": "rezStream",
+  "targets": [
+    {
+      "id": "Microsoft.VisualStudio.Services"
+    }
+  ],
+  "description": "Updates .NET app.config and web.config settings.",
+  "categories": [
+    "Azure Pipelines"
+  ],
+  "icons": {
+    "default": "images/icon.png"
+  },
+  "files": [
+    {
+      "path": "appcfg-settings"
+    }
+  ],
+  "contributions": [
+    {
+      "id": "appcfg-settings",
+      "type": "ms.vss-distributed-task.task",
+      "targets": [
+        "ms.vss-distributed-task.tasks"
+      ],
+      "properties": {
+        "name": "appcfg-settings"
+      }
+    }
+  ]
+}

appcfg-settings/SampleAppConfiguration.config

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <configSections>
+    <section name="thing" type="Stuff, Thing" />
+  </configSections>
+  <appSettings>
+    <add key="foo.blank" value="" />
+    <add key="foo.bar" value="bar" />
+  </appSettings>
+  <connectionStrings>
+    <clear />
+    <add name="My.ConnectionA" providerName="System.Data.ProviderName" connectionString="" />
+    <add name="my.connection_b" providerName="System.Data.ProviderName" connectionString="Dev Connection String;" />
+  </connectionStrings>
+</configuration>

appcfg-settings/icon.png

@@ -0,0 +1,69 @@
+import tl = require('azure-pipelines-task-lib/task');
+import { promises as fsPromises } from 'fs';
+import { DOMParser, XMLSerializer } from 'xmldom';
+
+async function run() {
+  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;
+    }
+
+    let fileMutated = false;
+
+    const originalContents = await fsPromises.readFile(targetFilePath, 'utf8');
+    const parser = new DOMParser();
+    
+    let doc = parser.parseFromString(originalContents, 'text/xml');
+    let rootNode = doc.documentElement;
+    if (rootNode.nodeName.toUpperCase() !== 'CONFIGURATION') {
+      tl.setResult(tl.TaskResult.Failed, 'Config file missing root configuration element');
+      return;
+    }
+
+    const overrideNode = function(node: Node, nameKey: string, valueKey: string) {
+      let element = <Element>node;
+      const settingName = element.getAttribute(nameKey);
+      if (!settingName) {
+        return;
+      }
+
+      let overrideValue = tl.getVariable(settingName);
+
+      if (overrideValue != null) {
+        tl.debug(`Override found for ${settingName}`);
+        element.setAttribute(valueKey, overrideValue);
+        fileMutated = true;
+      }
+    };
+
+    let appSettingsNode = Array.from(rootNode.childNodes).filter(n => n.nodeType === 1 && n.nodeName.toUpperCase() === 'APPSETTINGS')[0];
+    if (appSettingsNode) {
+      Array.from(appSettingsNode.childNodes)
+        .filter(n => n.nodeType === 1 && n.nodeName.toUpperCase() === 'ADD')
+        .forEach(n => overrideNode(n, 'key', 'value'));
+    }
+
+    let connStrNode = Array.from(rootNode.childNodes).filter(n => n.nodeType === 1 && n.nodeName.toUpperCase() === 'CONNECTIONSTRINGS')[0];
+    if (connStrNode) {
+      Array.from(connStrNode.childNodes)
+        .filter(n => n.nodeType === 1 && n.nodeName.toUpperCase() === 'ADD')
+        .forEach(n => overrideNode(n, 'name', 'connectionString'));
+    }
+
+    if (fileMutated) {
+      const newContents = new XMLSerializer().serializeToString(doc);
+      await 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();