azure-pipelines-tasks-webdeployment-common 4.230.1 → 4.230.2

package/Tests/L1XmlVarSub.js

@@ -1,19 +1,38 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runL1XmlVarSubTests = void 0;
+const path = require("path");
+const assert = require("assert");
+const ltx = require("ltx");
+const fs = require("fs");
+const tl = require("azure-pipelines-task-lib");
+const xmlvariablesubstitutionutility_1 = require("../xmlvariablesubstitutionutility");
+const fileencoding_1 = require("../fileencoding");
+function runL1XmlVarSubTests() {
+    this.timeout(60000);
+    beforeEach(function (done) {
+        tl.cp(getAbsolutePath('Web.config'), getAbsolutePath('Web_test.config'), '-f', false);
+        tl.cp(getAbsolutePath('Web.Debug.config'), getAbsolutePath('Web_test.Debug.config'), '-f', false);
+        tl.cp(getAbsolutePath('parameters.xml'), getAbsolutePath('parameters_test.xml'), '-f', false);
+        done();
     });
-};
-var xmlSubstitutionUtility = require('azure-pipelines-tasks-webdeployment-common/xmlvariablesubstitutionutility.js');
-var path = require('path');
-function xmlVarSub() {
-    return __awaiter(this, void 0, void 0, function* () {
-        var tags = ["applicationSettings", "appSettings", "connectionStrings", "configSections"];
-        var configFiles = [path.join(__dirname, 'L1XmlVarSub/Web_test.config'), path.join(__dirname, 'L1XmlVarSub/Web_test.Debug.config')];
-        var variableMap = {
+    afterEach(done => {
+        try {
+            tl.rmRF(getAbsolutePath('parameters_test.xml'));
+            tl.rmRF(getAbsolutePath('Web_test.Debug.config'));
+            tl.rmRF(getAbsolutePath('Web_test.config'));
+        }
+        catch (error) {
+            tl.debug(error);
+        }
+        finally {
+            done();
+        }
+    });
+    it("Runs successfully with XML variable substitution", done => {
+        const parameterFilePath = getAbsolutePath('parameters_test.xml');
+        const tags = ["applicationSettings", "appSettings", "connectionStrings", "configSections"];
+        const variableMap = {
             'conntype': 'new_connType',
             "MyDB": "TestDB",
             'webpages:Version': '1.1.7.3',
@@ -28,10 +47,27 @@ function xmlVarSub() {
             'log_level': 'error,warning',
             'Email:ToOverride': ''
         };
-        var parameterFilePath = path.join(__dirname, 'L1XmlVarSub/parameters_test.xml');
-        for (var configFile of configFiles) {
-            yield xmlSubstitutionUtility.substituteXmlVariables(configFile, tags, variableMap, parameterFilePath);
-        }
+        xmlvariablesubstitutionutility_1.substituteXmlVariables(getAbsolutePath('Web_test.config'), tags, variableMap, parameterFilePath);
+        xmlvariablesubstitutionutility_1.substituteXmlVariables(getAbsolutePath('Web_test.Debug.config'), tags, variableMap, parameterFilePath);
+        assert(compareXmlFiles('Web_test.config', 'Web_Expected.config'), 'Should have substituted variables in Web.config file');
+        assert(compareXmlFiles('Web_test.Debug.config', 'Web_Expected.Debug.config'), 'Should have substituted variables in Web.Debug.config file');
+        assert(compareXmlFiles('parameters_test.xml', 'parameters_Expected.xml'), 'Should have substituted variables in parameters.xml file');
+        done();
     });
+    function getAbsolutePath(file) {
+        return path.join(__dirname, 'L1XmlVarSub', file);
+    }
+    function compareXmlFiles(actualFile, expectedFile) {
+        const actualFilePath = getAbsolutePath(actualFile);
+        const expectedFilePath = getAbsolutePath(expectedFile);
+        var actualXml = ltx.parse(readFile(actualFilePath));
+        var expectedXml = ltx.parse(readFile(expectedFilePath));
+        return ltx.equal(actualXml, expectedXml);
+    }
+    function readFile(path) {
+        const buffer = fs.readFileSync(path);
+        const encoding = fileencoding_1.detectFileEncoding(path, buffer)[0].toString();
+        return buffer.toString(encoding).replace(/(?<!\r)[\n]+/gm, "\r\n");
+    }
 }
-xmlVarSub();
+exports.runL1XmlVarSubTests = runL1XmlVarSubTests;

package/Tests/L1XmlVarSub.ts

@@ -1,29 +1,86 @@
-var xmlSubstitutionUtility = require('azure-pipelines-tasks-webdeployment-common/xmlvariablesubstitutionutility.js');
-var path = require('path');
-
-async function xmlVarSub() {
-    var tags = ["applicationSettings", "appSettings", "connectionStrings", "configSections"];
-    var configFiles = [path.join(__dirname, 'L1XmlVarSub/Web_test.config'), path.join(__dirname, 'L1XmlVarSub/Web_test.Debug.config')];
-    var variableMap = {
-        'conntype' : 'new_connType',
-        "MyDB": "TestDB",
-        'webpages:Version' : '1.1.7.3',
-        'xdt:Transform' : 'DelAttributes',
-        'xdt:Locator' : 'Match(tag)',
-        'DefaultConnection': "Url=https://primary;Database=db1;ApiKey=11111111-1111-1111-1111-111111111111;Failover = {Url:'https://secondary', ApiKey:'11111111-1111-1111-1111-111111111111'}",
-        'OtherDefaultConnection': 'connectionStringValue2',
-        'ParameterConnection': 'New_Connection_String From xml var subs',
-        'connectionString': 'replaced_value',
-        'invariantName': 'System.Data.SqlServer',
-        'blatvar': 'ApplicationSettingReplacedValue',
-        'log_level': 'error,warning',
-        'Email:ToOverride': ''
+import * as path from 'path';
+import * as assert from 'assert';
+import * as ltx from 'ltx';
+import * as fs from 'fs';
+
+import * as tl from 'azure-pipelines-task-lib';
+
+import { substituteXmlVariables } from '../xmlvariablesubstitutionutility';
+import { detectFileEncoding } from "../fileencoding";
+
+export function runL1XmlVarSubTests(this: Mocha.Suite): void {
+
+    this.timeout(60000);
+
+    beforeEach(function (done: Mocha.Done) {
+        tl.cp(getAbsolutePath('Web.config'), getAbsolutePath('Web_test.config'), '-f', false);
+        tl.cp(getAbsolutePath('Web.Debug.config'), getAbsolutePath('Web_test.Debug.config'), '-f', false);
+        tl.cp(getAbsolutePath('parameters.xml'), getAbsolutePath('parameters_test.xml'), '-f', false);
+
+        done();
+    });
+
+    afterEach(done => {
+        try {
+            tl.rmRF(getAbsolutePath('parameters_test.xml'));
+            tl.rmRF(getAbsolutePath('Web_test.Debug.config'));
+            tl.rmRF(getAbsolutePath('Web_test.config'));
+        }
+        catch (error) {
+            tl.debug(error);
+        }
+        finally {
+            done();
+        }
+    });
+
+    it("Runs successfully with XML variable substitution", done => {
+        const parameterFilePath = getAbsolutePath('parameters_test.xml');
+        const tags = ["applicationSettings", "appSettings", "connectionStrings", "configSections"];
+        const variableMap = {
+            'conntype': 'new_connType',
+            "MyDB": "TestDB",
+            'webpages:Version': '1.1.7.3',
+            'xdt:Transform': 'DelAttributes',
+            'xdt:Locator': 'Match(tag)',
+            'DefaultConnection': "Url=https://primary;Database=db1;ApiKey=11111111-1111-1111-1111-111111111111;Failover = {Url:'https://secondary', ApiKey:'11111111-1111-1111-1111-111111111111'}",
+            'OtherDefaultConnection': 'connectionStringValue2',
+            'ParameterConnection': 'New_Connection_String From xml var subs',
+            'connectionString': 'replaced_value',
+            'invariantName': 'System.Data.SqlServer',
+            'blatvar': 'ApplicationSettingReplacedValue',
+            'log_level': 'error,warning',
+            'Email:ToOverride': ''
+        };
+
+        substituteXmlVariables(getAbsolutePath('Web_test.config'), tags, variableMap, parameterFilePath);
+        substituteXmlVariables(getAbsolutePath('Web_test.Debug.config'), tags, variableMap, parameterFilePath);
+
+        assert(compareXmlFiles('Web_test.config', 'Web_Expected.config'), 'Should have substituted variables in Web.config file');
+        assert(compareXmlFiles('Web_test.Debug.config', 'Web_Expected.Debug.config'), 'Should have substituted variables in Web.Debug.config file');
+        assert(compareXmlFiles('parameters_test.xml', 'parameters_Expected.xml'), 'Should have substituted variables in parameters.xml file');
+
+        done();
+    });
+
+    function getAbsolutePath(file: string): string {
+        return path.join(__dirname, 'L1XmlVarSub', file);
+    }
+
+    function compareXmlFiles(actualFile: string, expectedFile: string): boolean {
+        const actualFilePath = getAbsolutePath(actualFile);
+        const expectedFilePath = getAbsolutePath(expectedFile);
+
+        var actualXml = ltx.parse(readFile(actualFilePath));
+        var expectedXml = ltx.parse(readFile(expectedFilePath));
+
+        return ltx.equal(actualXml, expectedXml);
     }
 
-    var parameterFilePath = path.join(__dirname, 'L1XmlVarSub/parameters_test.xml');
-    for(var configFile of configFiles) {
-        await xmlSubstitutionUtility.substituteXmlVariables(configFile, tags, variableMap, parameterFilePath);
+    function readFile(path: string): string {
+        const buffer = fs.readFileSync(path);
+        const encoding = detectFileEncoding(path, buffer)[0].toString();
+        return buffer.toString(encoding).replace(/(?<!\r)[\n]+/gm, "\r\n");
     }
 }
 
-xmlVarSub();

package/package.json

@@ -1,13 +1,14 @@
 {
     "name": "azure-pipelines-tasks-webdeployment-common",
-    "version": "4.230.1",
+    "version": "4.230.2",
     "description": "Common Lib for MSDeploy Utility",
     "repository": {
         "type": "git",
         "url": "git+ssh://git@github.com/Microsoft/azure-pipelines-tasks.git"
     },
     "scripts": {
-        "build": "pwsh build.ps1"
+        "build": "pwsh build.ps1",
+        "test": "nyc --all --src ./_build mocha ./_build/Tests/L0.js"
     },
     "author": "Microsoft Corporation",
     "license": "MIT",
@@ -19,6 +20,7 @@
         "@types/mocha": "^5.2.7",
         "@types/node": "^10.17.0",
         "@xmldom/xmldom": "git+https://github.com/xmldom/xmldom.git#0.8.6",
+        "@types/ltx": "3.0.6",
         "archiver": "1.2.0",
         "azure-pipelines-task-lib": "^4.2.0",
         "decompress-zip": "^0.3.3",
@@ -29,6 +31,8 @@
         "xml2js": "0.6.2"
     },
     "devDependencies": {
-        "typescript": "4.0.2"
+        "typescript": "4.0.2",
+        "mocha": "^6.2.3",
+        "nyc": "^15.1.0"
     }
 }

package/packageUtility.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Package = exports.PackageUtility = exports.PackageType = void 0;
 const tl = require("azure-pipelines-task-lib/task");
 const utility = require("./utility");
-var zipUtility = require('azure-pipelines-tasks-webdeployment-common/ziputility.js');
+const ziputility_1 = require("./ziputility");
 const path = require("path");
 var PackageType;
 (function (PackageType) {
@@ -73,10 +73,11 @@ class Package {
     }
     isMSBuildPackage() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this._isMSBuildPackage == undefined) {
-                this._isMSBuildPackage = this.getPackageType() != PackageType.folder && (yield zipUtility.checkIfFilesExistsInZip(this._path, ["parameters.xml", "systeminfo.xml"]));
-                tl.debug("Is the package an msdeploy package : " + this._isMSBuildPackage);
-            }
+            if (this._isMSBuildPackage !== undefined)
+                return this._isMSBuildPackage;
+            const shouldCheckFiles = this.getPackageType() !== PackageType.folder;
+            this._isMSBuildPackage = shouldCheckFiles && (yield ziputility_1.checkIfFilesExistsInZip(this._path, ["parameters.xml", "systeminfo.xml"]));
+            tl.debug(`Is the package an msdeploy package : ${this._isMSBuildPackage}`);
             return this._isMSBuildPackage;
         });
     }

package/utility.js

@@ -14,7 +14,7 @@ const path = require("path");
 const os = require("os");
 const tl = require("azure-pipelines-task-lib/task");
 const packageUtility_1 = require("./packageUtility");
-var zipUtility = require('azure-pipelines-tasks-webdeployment-common/ziputility.js');
+const zipUtility = require("./ziputility");
 /**
  * Validates the input package and finds out input type
  *

package/webconfigutil.d.ts

@@ -1,2 +1,4 @@
-export declare function generateWebConfigFile(webConfigTargetPath: string, appType: string, substitutionParameters: any): void;
+export declare function generateWebConfigFile(webConfigTargetPath: string, appType: string, substitutionParameters: {
+    [key: string]: string;
+}): void;
 export declare function addWebConfigFile(folderPath: any, webConfigParameters: any, rootDirectoryPath: string): void;

package/xdttransformationutility.js

@@ -21,7 +21,7 @@ exports.expandWildcardPattern = expandWildcardPattern;
 *
 */
 function applyXdtTransformation(sourceFile, transformFile, destinationFile) {
-    var cttPath = path.join(__dirname, "..", "..", "ctt", "ctt.exe");
+    var cttPath = path.join(__dirname, "ctt", "ctt", "ctt.exe");
     var cttArgsArray = [
         "s:" + sourceFile,
         "t:" + transformFile,