Port latest iis manage task changes to releases/m114 (#3726)

Author: asranja

Tasks/IISWebAppManagementOnMachineGroup/Strings/resources.resjson/en-US/resources.resjson

@@ -25,7 +25,7 @@
   "loc.input.label.WebsiteAuthUserName": "Username",
   "loc.input.help.WebsiteAuthUserName": "Provide the user name that will be used to access the website's physical path.",
   "loc.input.label.WebsiteAuthUserPassword": "Password",
-  "loc.input.help.WebsiteAuthUserPassword": "Provide the user's password that will be used to access the website's physical path.",
+  "loc.input.help.WebsiteAuthUserPassword": "Provide the user's password that will be used to access the website's physical path. <br/>The best practice is to create a variable in the Build or Release definition, and mark it as 'Secret' to secure it, and then use it here, like '$(userCredentials)'. <br> Note: Special characters in password are interpreted as per <a href=\"https://go.microsoft.com/fwlink/?linkid=843470\">command-line arguments</a>",
   "loc.input.label.AddBinding": "Add binding",
   "loc.input.help.AddBinding": "Select the option to add port binding for the website.",
   "loc.input.label.Protocol": "Protocol",
@@ -57,7 +57,7 @@
   "loc.input.label.AppPoolUsernameForWebsite": "Username",
   "loc.input.help.AppPoolUsernameForWebsite": "Provide the username of the custom account that you want to use.",
   "loc.input.label.AppPoolPasswordForWebsite": "Password",
-  "loc.input.help.AppPoolPasswordForWebsite": "Provide the password for custom account. <br/>The best practice is to create a variable in the Build or Release definition, and mark it as 'Secret' to secure it, and then use it here, like '$(userCredentials)'. ",
+  "loc.input.help.AppPoolPasswordForWebsite": "Provide the password for custom account. <br/>The best practice is to create a variable in the Build or Release definition, and mark it as 'Secret' to secure it, and then use it here, like '$(userCredentials)'. <br> Note: Special characters in password are interpreted as per <a href=\"https://go.microsoft.com/fwlink/?linkid=843470\">command-line arguments</a>",
   "loc.input.label.ParentWebsiteNameForVD": "Parent website name",
   "loc.input.help.ParentWebsiteNameForVD": "Provide the name of the parent Website of the virtual directory.",
   "loc.input.label.VirtualPathForVD": "Virtual path",
@@ -69,7 +69,7 @@
   "loc.input.label.VDAuthUserName": "Username",
   "loc.input.help.VDAuthUserName": "Provide the user name that will be used to access the virtual directory's physical path.",
   "loc.input.label.VDAuthUserPassword": "Password",
-  "loc.input.help.VDAuthUserPassword": "Provide the user's password that will be used to access the virtual directory's physical path.",
+  "loc.input.help.VDAuthUserPassword": "Provide the user's password that will be used to access the virtual directory's physical path. <br/>The best practice is to create a variable in the Build or Release definition, and mark it as 'Secret' to secure it, and then use it here, like '$(userCredentials)'. <br> Note: Special characters in password are interpreted as per <a href=\"https://go.microsoft.com/fwlink/?linkid=843470\">command-line arguments</a>",
   "loc.input.label.ParentWebsiteNameForApplication": "Parent website name",
   "loc.input.help.ParentWebsiteNameForApplication": "Provide the name of the parent Website under which the application will be created or updated.",
   "loc.input.label.VirtualPathForApplication": "Virtual path",
@@ -81,7 +81,7 @@
   "loc.input.label.ApplicationAuthUserName": "Username",
   "loc.input.help.ApplicationAuthUserName": "Provide the user name that will be used to access the application's physical path.",
   "loc.input.label.ApplicationAuthUserPassword": "Password",
-  "loc.input.help.ApplicationAuthUserPassword": "Provide the user's password that will be used to access the application's physical path.",
+  "loc.input.help.ApplicationAuthUserPassword": "Provide the user's password that will be used to access the application's physical path. <br/>The best practice is to create a variable in the Build or Release definition, and mark it as 'Secret' to secure it, and then use it here, like '$(userCredentials)'. <br> Note: Special characters in password are interpreted as per <a href=\"https://go.microsoft.com/fwlink/?linkid=843470\">command-line arguments</a>",
   "loc.input.label.CreateOrUpdateAppPoolForApplication": "Create or update app pool",
   "loc.input.help.CreateOrUpdateAppPoolForApplication": "Select the option to create or update an application pool. If checked, the application will be created in the specified app pool.",
   "loc.input.label.AppPoolNameForApplication": "Name",
@@ -95,7 +95,7 @@
   "loc.input.label.AppPoolUsernameForApplication": "Username",
   "loc.input.help.AppPoolUsernameForApplication": "Provide the username of the custom account that you want to use.",
   "loc.input.label.AppPoolPasswordForApplication": "Password",
-  "loc.input.help.AppPoolPasswordForApplication": "Provide the password for custom account. <br/>The best practice is to create a variable in the Build or Release definition, and mark it as 'Secret' to secure it, and then use it here, like '$(userCredentials)'.",
+  "loc.input.help.AppPoolPasswordForApplication": "Provide the password for custom account. <br/>The best practice is to create a variable in the Build or Release definition, and mark it as 'Secret' to secure it, and then use it here, like '$(userCredentials)'. <br> Note: Special characters in password are interpreted as per <a href=\"https://go.microsoft.com/fwlink/?linkid=843470\">command-line arguments</a>",
   "loc.input.label.AppPoolName": "Name",
   "loc.input.help.AppPoolName": "Provide the name of the IIS application pool to create or update.",
   "loc.input.label.DotNetVersion": ".NET version",
@@ -107,12 +107,15 @@
   "loc.input.label.AppPoolUsername": "Username",
   "loc.input.help.AppPoolUsername": "Provide the username of the custom account that you want to use.",
   "loc.input.label.AppPoolPassword": "Password",
-  "loc.input.help.AppPoolPassword": "Provide the password for custom account. <br/>The best practice is to create a variable in the Build or Release definition, and mark it as 'Secret' to secure it, and then use it here, like '$(userCredentials)'.",
+  "loc.input.help.AppPoolPassword": "Provide the password for custom account. <br/>The best practice is to create a variable in the Build or Release definition, and mark it as 'Secret' to secure it, and then use it here, like '$(userCredentials)'. <br> Note: Special characters in password are interpreted as per <a href=\"https://go.microsoft.com/fwlink/?linkid=843470\">command-line arguments</a>",
   "loc.input.label.StartStopRecycleAppPoolName": "Application pool name",
   "loc.input.help.StartStopRecycleAppPoolName": "Provide the name of the IIS application pool.",
   "loc.input.label.AppCmdCommands": "Additional appcmd.exe commands",
   "loc.input.help.AppCmdCommands": "Enter additional AppCmd.exe commands. For more than one command use a line separator, like <br/> list apppools <br/> list sites<br/> recycle apppool /apppool.name:ExampleAppPoolName",
   "loc.messages.InvalidSslThumbprint": "Invalid thumbprint. Length is not 40 characters or contains invalid characters.",
   "loc.messages.InvalidVirtualPath": "Virtual path should begin with a /",
-  "loc.messages.InvalidIISDeploymentType": "Invalid IIS Deployment Type : {0}"
+  "loc.messages.InvalidIISDeploymentType": "Invalid IIS Deployment Type : {0}",
+  "loc.messages.InvalidActionIISWebsite": "Invalid action '{0}' selected for the IIS Website.",
+  "loc.messages.InvalidActionIISAppPool": "Invalid action '{0}' selected for the IIS Application Pool.",
+  "loc.messages.SSLCertWarningInvalidCharacters": "SSL Certificate thumbprint contains non-hexadecimal characters. Trimming all non-hexadecimal characters."
 }

Tasks/IISWebAppManagementOnMachineGroup/Tests/L0.ts

@@ -0,0 +1,95 @@
+/// <reference path="../../../definitions/mocha.d.ts"/>
+/// <reference path="../../../definitions/node.d.ts"/>
+/// <reference path="../../../definitions/Q.d.ts"/>
+
+import Q = require('q');
+import assert = require('assert');
+var path = require('path');
+var psm = require('../../../Tests/lib/psRunner');
+var shell = require('shelljs');
+var ps = shell.which('powershell.exe');
+var psr = null;
+
+describe('IISWebAppManagementOnMachineGroup Suite', function () {
+    this.timeout(20000);
+
+    before((done) => {
+        if (ps) {
+            psr = new psm.PSRunner();
+            psr.start();
+        }
+
+        done();
+    });
+
+    after(function () {
+        psr.kill();
+    });
+
+    if (ps) {
+
+        it('test website exists', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdTestWebsiteExists.ps1'), done);
+        }) 
+
+        it('test add and update website', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdAddUpdateWebsite.ps1'), done);
+        }) 
+  		
+  		it('test add binding for website', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdTestBinding.ps1'), done);
+        })
+
+        it('test sni and sslcert addition for https binding', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdTestSSLandSNI.ps1'), done);
+        })
+
+        it('test application pool exists', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdTestApplicationPoolExists.ps1'), done);
+        })
+
+        it('test add and update appPool', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdAddUpdateAppPool.ps1'), done);
+        }) 
+
+        it('test application exists', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdTestApplicationExists.ps1'), done);
+        })
+
+        it('test add and update application', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdAddUpdateApplication.ps1'), done);
+        })
+     	
+        it('test virtual directory exists', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdTestVirtualDirExists.ps1'), done);
+        }) 
+
+        it('test add and update virtual directory', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdAddUpdateVDir.ps1'), done);
+        })
+
+        it('test additional actions for website and application pool', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdAdditionalActions.ps1'), done);
+        }) 
+
+        it('test execute main for appcmd', (done) => {
+            psr.run(path.join(__dirname, 'L0AppcmdExecuteMain.ps1'), done);
+        }) 
+
+        it('test iis manage utility - manage website', (done) => {
+            psr.run(path.join(__dirname, 'L0UtilityManageWebsite.ps1'), done);
+        }) 
+
+        it('test iis manage utility - manage application', (done) => {
+            psr.run(path.join(__dirname, 'L0UtilityManageApp.ps1'), done);
+        })
+
+        it('test iis manage utility - manage virtual directory', (done) => {
+            psr.run(path.join(__dirname, 'L0UtilityManageVDir.ps1'), done);
+        }) 
+        
+        it('test iis manage utility - manage application pool', (done) => {
+            psr.run(path.join(__dirname, 'L0UtilityManageAppPool.ps1'), done);
+        }) 
+    }    
+});

Tasks/IISWebAppManagementOnMachineGroup/Tests/L0AppcmdAddUpdateAppPool.ps1

@@ -0,0 +1,62 @@
+[CmdletBinding()]
+param()
+
+. $PSScriptRoot\..\..\..\Tests\lib\Initialize-Test.ps1
+. $PSScriptRoot\MockHelpers.ps1
+
+. $PSScriptRoot\..\ps_modules\TaskModuleIISManageUtility\AppCmdOnTargetMachines.ps1
+
+$appPoolName = "Sample App Pool"
+$dotNetVersion = "v4.0"
+$pipeLineMode = "Integrated"
+$appPoolIdentity = "ApplicationPoolIdentity"
+$appPoolCredentials = $null
+
+#Test 1 : App pool doesn't exist. Create and update the app pool
+
+Register-Mock Test-AppPoolExist { return $false }
+Register-Mock Invoke-VstsTool { }
+
+Add-And-Update-AppPool -appPoolName $appPoolName -clrVersion $dotNetVersion -pipeLineMode $pipeLineMode -identity $appPoolIdentity -appPoolCredentials $appPoolCredentials 
+
+Assert-WasCalled Test-AppPoolExist -Times 1
+Assert-WasCalled Invoke-VstsTool -Times 2
+Assert-WasCalled Invoke-VstsTool -- -FileName "appcmdPath" -Arguments " add apppool /name:`"Sample App Pool`"" -RequireExitCodeZero
+Assert-WasCalled Invoke-VstsTool -- -FileName "appcmdPath" -Arguments " set apppool /apppool.name:`"Sample App Pool`" -managedRuntimeVersion:v4.0 -managedPipelineMode:Integrated -processModel.identityType:ApplicationPoolIdentity" -RequireExitCodeZero
+
+#Test 2 : App pool exists. Update the app pool
+
+$pipeLineMode = "Classic"
+$dotNetVersion = "No Managed Code"
+$appPoolIdentity = "NetworkService"
+
+Unregister-Mock Test-AppPoolExist
+Unregister-Mock Invoke-VstsTool
+
+Register-Mock Test-AppPoolExist { return $true }
+Register-Mock Invoke-VstsTool { }
+
+Add-And-Update-AppPool -appPoolName $appPoolName -clrVersion $dotNetVersion -pipeLineMode $pipeLineMode -identity $appPoolIdentity -appPoolCredentials $appPoolCredentials 
+
+Assert-WasCalled Test-AppPoolExist -Times 1
+Assert-WasCalled Invoke-VstsTool -Times 1
+Assert-WasCalled Invoke-VstsTool -- -FileName "appcmdPath" -Arguments " set apppool /apppool.name:`"Sample App Pool`" -managedRuntimeVersion: -managedPipelineMode:Classic -processModel.identityType:NetworkService" -RequireExitCodeZero
+
+#Test 3: Applicatin pool exists and updating the app pool identity for specific user 
+
+$pipeLineMode = "Classic"
+$dotNetVersion = "v2.0"
+$appPoolIdentity = "SpecificUser"
+$appPoolCredentials = Get-MockCredentials
+
+Unregister-Mock Test-AppPoolExist
+Unregister-Mock Invoke-VstsTool
+
+Register-Mock Test-AppPoolExist { return $true }
+Register-Mock Invoke-VstsTool { }
+
+Add-And-Update-AppPool -appPoolName $appPoolName -clrVersion $dotNetVersion -pipeLineMode $pipeLineMode -identity $appPoolIdentity -appPoolCredentials $appPoolCredentials 
+
+Assert-WasCalled Test-AppPoolExist -Times 1
+Assert-WasCalled Invoke-VstsTool -Times 1
+Assert-WasCalled Invoke-VstsTool -- -FileName "appcmdPath" -Arguments " set apppool /apppool.name:`"Sample App Pool`" -managedRuntimeVersion:v2.0 -managedPipelineMode:Classic -processModel.identityType:SpecificUser -processModel.userName:`"domain\name`" -processModel.password:`"random!123```"`$password`"" -RequireExitCodeZero

Tasks/IISWebAppManagementOnMachineGroup/Tests/L0AppcmdAddUpdateApplication.ps1

@@ -0,0 +1,62 @@
+[CmdletBinding()]
+param()
+
+. $PSScriptRoot\..\..\..\Tests\lib\Initialize-Test.ps1
+. $PSScriptRoot\MockHelpers.ps1
+
+. $PSScriptRoot\..\ps_modules\TaskModuleIISManageUtility\AppCmdOnTargetMachines.ps1
+
+$websiteName = "Sample Web Site"
+$virtualPath = "/Application"
+$physicalPath = "Drive:/Physical Path"
+$appPoolName = ""
+$physicalPathAuth = "ApplicationUserPassThrough"
+$physicalPathAuthCredentials = $null
+
+Register-Mock Test-Path { return $true } -ParametersEvaluator { $Path -eq $physicalPath }
+
+# Test 1 : Application doesn't exist 
+
+Register-Mock Test-ApplicationExist { return $false }
+Register-Mock Invoke-VstsTool { }
+
+Add-And-Update-Application -siteName $websiteName -virtualPath $virtualPath -physicalPath $physicalPath -applicationPool $appPoolName -physicalPathAuthentication $physicalPathAuth -physicalPathAuthenticationCredentials $physicalPathAuthCredentials
+
+Assert-WasCalled Test-ApplicationExist -Times 1
+Assert-WasCalled Invoke-VstsTool -Times 2
+Assert-WasCalled Invoke-VstsTool -- -FileName "appcmdPath" -Arguments " add app /site.name:`"Sample Web Site`" /path:`"/Application`" /physicalPath:`"Drive:/Physical Path`"" -RequireExitCodeZero
+Assert-WasCalled Invoke-VstsTool -- -FileName "appcmdPath" -Arguments " set app /app.name:`"Sample Web Site/Application`" -[path='/'].physicalPath:`"Drive:/Physical Path`" -[path='/'].userName: -[path='/'].password:" -RequireExitCodeZero
+
+# Test 2 : Application Exists. Updating properties 
+
+$physicalPath = "Drive:/New Physical Path"
+$appPoolName = "Sample App Pool"
+
+Unregister-Mock Test-ApplicationExist
+Unregister-Mock Invoke-VstsTool
+
+Register-Mock Test-ApplicationExist { return $true }
+Register-Mock Invoke-VstsTool { }
+
+Add-And-Update-Application -siteName $websiteName -virtualPath $virtualPath -physicalPath $physicalPath -applicationPool $appPoolName -physicalPathAuthentication $physicalPathAuth -physicalPathAuthenticationCredentials $physicalPathAuthCredentials
+
+Assert-WasCalled Test-ApplicationExist -Times 1
+Assert-WasCalled Invoke-VstsTool -Times 1
+Assert-WasCalled Invoke-VstsTool -- -FileName "appcmdPath" -Arguments " set app /app.name:`"Sample Web Site/Application`" -applicationPool:`"Sample App Pool`" -[path='/'].physicalPath:`"Drive:/New Physical Path`" -[path='/'].userName: -[path='/'].password:" -RequireExitCodeZero
+
+# Test 3 : Updating the application's physical path authentication
+
+$physicalPathAuth = "ApplicationWindowsAuth"
+$physicalPathAuthCredentials = Get-MockCredentials
+
+Unregister-Mock Test-ApplicationExist
+Unregister-Mock Invoke-VstsTool
+
+Register-Mock Test-ApplicationExist { return $true }
+Register-Mock Invoke-VstsTool { }
+
+Add-And-Update-Application -siteName $websiteName -virtualPath $virtualPath -physicalPath $physicalPath -applicationPool $appPoolName -physicalPathAuthentication $physicalPathAuth -physicalPathAuthenticationCredentials $physicalPathAuthCredentials
+
+Assert-WasCalled Test-ApplicationExist -Times 1
+Assert-WasCalled Invoke-VstsTool -Times 1
+Assert-WasCalled Invoke-VstsTool -- -FileName "appcmdPath" -Arguments " set app /app.name:`"Sample Web Site/Application`" -applicationPool:`"Sample App Pool`" -[path='/'].physicalPath:`"Drive:/New Physical Path`" -[path='/'].userName:`"domain\name`" -[path='/'].password:`"random!123```"`$password`"" -RequireExitCodeZero

Tasks/IISWebAppManagementOnMachineGroup/Tests/L0AppcmdAddUpdateVDir.ps1

@@ -0,0 +1,44 @@
+[CmdletBinding()]
+param()
+
+. $PSScriptRoot\..\..\..\Tests\lib\Initialize-Test.ps1
+. $PSScriptRoot\MockHelpers.ps1
+
+. $PSScriptRoot\..\ps_modules\TaskModuleIISManageUtility\AppCmdOnTargetMachines.ps1
+
+$websiteName = "Sample Web Site"
+$virtualPath = "/Applcation/VDir"
+$physicalPath = "Drive:/Physical Path"
+$physicalPathAuth = "VDUserPassThrough"
+$physicalPathAuthCredentials = $null
+
+Register-Mock Test-Path { return $true } -ParametersEvaluator { $Path -eq $physicalPath }
+
+#Test 1 : Virtual Directory doesn't exist. Create new 
+
+Register-Mock Test-VirtualDirectoryExist { return $false }
+Register-Mock Invoke-VstsTool { }
+
+Add-And-Update-VirtualDirectory -siteName $websiteName -virtualPath $virtualPath -physicalPath $physicalPath -physicalPathAuthentication $physicalPathAuth -physicalPathAuthenticationCredentials $physicalPathAuthCredentials
+
+Assert-WasCalled Test-VirtualDirectoryExist -Times 1
+Assert-WasCalled Invoke-VstsTool -Times 2
+Assert-WasCalled Invoke-VstsTool -- -FileName "appcmdPath" -Arguments " add vdir /app.name:`"Sample Web Site/Applcation`" /path:`"/VDir`" /physicalPath:`"Drive:/Physical Path`"" -RequireExitCodeZero
+Assert-WasCalled Invoke-VstsTool -- -FileName "appcmdPath" -Arguments " set vdir /vdir.name:`"Sample Web Site/Applcation/VDir`" -physicalPath:`"Drive:/Physical Path`" -userName: -password:" -RequireExitCodeZero
+
+# Test 2 : Virtual Directory exists. Updating 
+
+$physicalPathAuth = "VDWindowsAuth"
+$physicalPathAuthCredentials = Get-MockCredentials
+
+Unregister-Mock Test-VirtualDirectoryExist
+Unregister-Mock Invoke-VstsTool
+
+Register-Mock Test-VirtualDirectoryExist { return $true }
+Register-Mock Invoke-VstsTool { }
+
+Add-And-Update-VirtualDirectory -siteName $websiteName -virtualPath $virtualPath -physicalPath $physicalPath -physicalPathAuthentication $physicalPathAuth -physicalPathAuthenticationCredentials $physicalPathAuthCredentials
+
+Assert-WasCalled Test-VirtualDirectoryExist -Times 1
+Assert-WasCalled Invoke-VstsTool -Times 1
+Assert-WasCalled Invoke-VstsTool -- -FileName "appcmdPath" -Arguments " set vdir /vdir.name:`"Sample Web Site/Applcation/VDir`" -physicalPath:`"Drive:/Physical Path`" -userName:`"domain\name`" -password:`"random!123```"`$password`"" -RequireExitCodeZero