Users/ajya/azure rmwebapp task ps3 #1802
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| param | ||
| ( | ||
| [String] [Parameter(Mandatory = $true)] | ||
| $ConnectedServiceName, | ||
|
|
||
| [String] [Parameter(Mandatory = $true)] | ||
| $WebAppName, | ||
|
|
||
| [String] [Parameter(Mandatory = $true)] | ||
| $DeployToSlotFlag, | ||
|
|
||
| [String] [Parameter(Mandatory = $false)] | ||
| $ResourceGroupName, | ||
|
|
||
| [String] [Parameter(Mandatory = $false)] | ||
| $SlotName, | ||
|
|
||
| [String] [Parameter(Mandatory = $true)] | ||
| $Package, | ||
|
|
||
| [String] [Parameter(Mandatory = $false)] | ||
| $SetParametersFile, | ||
|
|
||
| [String] [Parameter(Mandatory = $false)] | ||
| $RemoveAdditionalFilesFlag, | ||
|
|
||
| [String] [Parameter(Mandatory = $false)] | ||
| $ExcludeFilesFromAppDataFlag, | ||
|
|
||
| [String] [Parameter(Mandatory = $false)] | ||
| $TakeAppOfflineFlag, | ||
|
|
||
| [String] [Parameter(Mandatory = $false)] | ||
| $VirtualApplication, | ||
|
|
||
| [String] [Parameter(Mandatory = $false)] | ||
| [String] $AdditionalArguments, | ||
|
|
||
| [String] [Parameter(Mandatory = $false)] | ||
| [string]$WebAppUri | ||
| ) | ||
|
|
||
| Write-Verbose "Starting AzureRM WebApp Deployment Task" | ||
|
|
||
| Write-Verbose "ConnectedServiceName = $ConnectedServiceName" | ||
| Write-Verbose "WebAppName = $WebAppName" | ||
| Write-Verbose "DeployToSlotFlag = $DeployToSlotFlag" | ||
| Write-Verbose "ResourceGroupName = $ResourceGroupName" | ||
| Write-Verbose "SlotName = $SlotName" | ||
| Write-Verbose "Package = $Package" | ||
| Write-Verbose "SetParametersFile = $SetParametersFile" | ||
| Write-Verbose "RemoveAdditionalFilesFlag = $RemoveAdditionalFilesFlag" | ||
| Write-Verbose "ExcludeFilesFromAppDataFlag = $ExcludeFilesFromAppDataFlag" | ||
| Write-Verbose "TakeAppOfflineFlag = $TakeAppOfflineFlag" | ||
| Write-Verbose "VirtualApplication = $VirtualApplication" | ||
| Write-Verbose "AdditionalArguments = $AdditionalArguments" | ||
| Write-Verbose "WebAppUri = $WebAppUri" | ||
|
|
||
| $WebAppUri = $WebAppUri.Trim() | ||
| $Package = $Package.Trim('"').Trim() | ||
|
|
||
| if( [string]::IsNullOrEmpty($Package) ){ | ||
| Throw (Get-LocalizedString -Key "Invalid webapp package path provided") | ||
| } | ||
|
|
||
| $SetParametersFile = $SetParametersFile.Trim('"').Trim() | ||
|
|
||
| # Import all the dlls and modules which have cmdlets we need | ||
| Import-Module "Microsoft.TeamFoundation.DistributedTask.Task.Internal" | ||
| Import-Module "Microsoft.TeamFoundation.DistributedTask.Task.Common" | ||
|
|
||
| # Load all dependent files for execution | ||
| Import-Module ./AzureUtility.ps1 -Force | ||
| Import-Module ./Utility.ps1 -Force | ||
| Import-Module ./FindInstalledMSDeploy.ps1 | ||
|
|
||
| # Importing required version of azure cmdlets according to azureps installed on machine | ||
| $azureUtility = Get-AzureUtility | ||
|
|
||
| Write-Verbose "Loading $azureUtility" | ||
| Import-Module ./$azureUtility -Force | ||
|
|
||
| $ErrorActionPreference = 'Stop' | ||
|
|
||
| #### MAIN EXECUTION OF AZURERM WEBAPP DEPLOYMENT TASK BEGINS HERE #### | ||
|
|
||
| # Get msdeploy.exe path | ||
| $msDeployExePath = Get-MsDeployExePath | ||
|
|
||
| # Ensure that at most a package (.zip) file is found | ||
| $packageFilePath = Get-SingleFilePath -file $Package | ||
|
|
||
| # Since the SetParametersFile is optional, but it's a FilePath type, it will have the value System.DefaultWorkingDirectory when not specified | ||
| if( $SetParametersFile -eq $env:SYSTEM_DEFAULTWORKINGDIRECTORY -or $SetParametersFile -eq [String]::Concat($env:SYSTEM_DEFAULTWORKINGDIRECTORY, "\") -or [string]::IsNullOrEmpty($SetParametersFile)){ | ||
| $setParametersFilePath = "" | ||
| } else { | ||
| $setParametersFilePath = Get-SingleFilePath -file $SetParametersFile | ||
| } | ||
|
|
||
| # Get destination azureRM webApp connection details | ||
| $azureRMWebAppConnectionDetails = Get-AzureRMWebAppConnectionDetails -webAppName $WebAppName -deployToSlotFlag $DeployToSlotFlag ` | ||
| -resourceGroupName $ResourceGroupName -slotName $SlotName | ||
|
|
||
| # webApp Name to be used in msdeploy command | ||
| $webAppNameForMSDeployCmd = Get-WebAppNameForMSDeployCmd -webAppName $WebAppName -deployToSlotFlag $DeployToSlotFlag -slotName $SlotName | ||
|
|
||
| # Construct arguments for msdeploy command | ||
| $msDeployCmdArgs = Get-MsDeployCmdArgs -packageFile $packageFilePath -webAppNameForMSDeployCmd $webAppNameForMSDeployCmd -azureRMWebAppConnectionDetails $azureRMWebAppConnectionDetails -removeAdditionalFilesFlag $RemoveAdditionalFilesFlag ` | ||
| -excludeFilesFromAppDataFlag $ExcludeFilesFromAppDataFlag -takeAppOfflineFlag $TakeAppOfflineFlag -virtualApplication $VirtualApplication -AdditionalArguments $AdditionalArguments ` | ||
| -setParametersFile $setParametersFilePath | ||
|
|
||
| # Deploy azureRM webApp using msdeploy Command | ||
| Run-MsDeployCommand -msDeployExePath $msDeployExePath -msDeployCmdArgs $msDeployCmdArgs | ||
|
|
||
| # Get azure webapp hosted url | ||
| $azureWebsitePublishURL = Get-AzureRMWebAppPublishUrl -webAppName $WebAppName -deployToSlotFlag $DeployToSlotFlag ` | ||
| -resourceGroupName $ResourceGroupName -slotName $SlotName | ||
|
|
||
| # Publish azure webApp url | ||
| Write-Host (Get-LocalizedString -Key "Webapp successfully published at Url : {0}" -ArgumentList $azureWebsitePublishURL) | ||
|
|
||
| # Set ouput vairable with azureWebsitePublishUrl | ||
| if(-not [string]::IsNullOrEmpty($WebAppUri)) | ||
| { | ||
|
|
||
| if( [string]::IsNullOrEmpty($azureWebsitePublishURL)) | ||
| { | ||
| Throw (Get-LocalizedString -Key "Unable to retrieve webapp publish url for webapp : '{0}'." -ArgumentList $webAppName) | ||
| } | ||
|
|
||
| Write-Host "##vso[task.setvariable variable=$WebAppUri;]$azureWebsitePublishURL" | ||
| } | ||
|
|
||
| Write-Verbose "Completed AzureRM WebApp Deployment Task" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,134 +1,111 @@ | ||
| [CmdletBinding()] | ||
| param() | ||
|
|
||
| Trace-VstsEnteringInvocation $MyInvocation | ||
|
|
||
| try{ | ||
|
|
||
| # Get inputs. | ||
| $WebAppName = Get-VstsInput -Name WebAppName -Require | ||
| $DeployToSlotFlag = Get-VstsInput -Name DeployToSlotFlag -Require -AsBool | ||
| $ResourceGroupName = Get-VstsInput -Name ResourceGroupName | ||
| $SlotName = Get-VstsInput -Name SlotName | ||
| $Package = Get-VstsInput -Name Package -Require | ||
| $RemoveAdditionalFilesFlag = Get-VstsInput -Name RemoveAdditionalFilesFlag -AsBool | ||
| $ExcludeFilesFromAppDataFlag = Get-VstsInput -Name ExcludeFilesFromAppDataFlag -AsBool | ||
| $TakeAppOfflineFlag = Get-VstsInput -Name TakeAppOfflineFlag -AsBool | ||
| $VirtualApplication = Get-VstsInput -Name VirtualApplication | ||
| $AdditionalArguments = Get-VstsInput -Name AdditionalArguments | ||
| $WebAppUri = Get-VstsInput -Name WebAppUri | ||
| $SetParametersFile = Get-VstsInput -Name SetParametersFile | ||
|
|
||
| # Initialize Azure. | ||
|
|
||
| Import-Module $PSScriptRoot\ps_modules\VstsAzureHelpers_ | ||
| Initialize-Azure | ||
|
|
||
| # Import the loc strings. | ||
| Import-VstsLocStrings -LiteralPath $PSScriptRoot/Task.json | ||
|
|
||
| $WebAppUri = $WebAppUri.Trim() | ||
| $Package = "$Package".Trim('"').Trim() | ||
|
|
||
| if( [string]::IsNullOrEmpty($Package) ){ | ||
|
There was a problem hiding this comment. fyi - simpler powershell syntax is also fyi - I think the web UI already trims values on save. The double-quotes issue is interesting, although I have never trimmed it in tasks before, and haven't heard any issues. Just a thought. |
||
| Throw (Get-VstsLocString -Key "Invalidwebapppackagepathprovided") | ||
| } | ||
|
|
||
| $SetParametersFile = $SetParametersFile.Trim('"').Trim() | ||
|
There was a problem hiding this comment. Will this ever null ref? A safer route would be: There was a problem hiding this comment. I had a comment here before about the possibility of null ref exception. Re-adding in case you overlooked it by accident. Again, a safer option would be the following (double quotes added around the variable before calling trim): $SetParametersFile = "$SetParametersFile".Trim('"').Trim() |
||
|
|
||
|
|
||
| # Load all dependent files for execution | ||
| . $PSScriptRoot/AzureUtility.ps1 -Force | ||
|
There was a problem hiding this comment. I see you switched over to dot sourcing the scripts instead of calling There was a problem hiding this comment. I thought about this a bit more. Beware there are differences between dot sourcing and importing as a module (modules run within a module context with a different variable inheritance hierarchy and separate session state). I was quite confused when I originally saw importing the ps1 file. If you're comfortable with switching this over to dot sourcing, then all the better. If not, you may want to consider leaving it as is - sometimes I'm hesitant to change something if it's working as is - or consider changing the file names to psm1 so it's not confusing. It's your call. If you end up leaving it as import-module and ps1 extension, it would be nice to add a comment - or a TODO comment - so it's not confusing to anyone who needs to read the source code in the future. |
||
| . $PSScriptRoot/Utility.ps1 -Force | ||
| . $PSScriptRoot/FindInstalledMSDeploy.ps1 | ||
|
|
||
| # Importing required version of azure cmdlets according to azureps installed on machine | ||
| $azureUtility = Get-AzureUtility | ||
|
|
||
| Write-Verbose "Loading $azureUtility" | ||
| . $PSScriptRoot/$azureUtility -Force | ||
|
|
||
| #### MAIN EXECUTION OF AZURERM WEBAPP DEPLOYMENT TASK BEGINS HERE #### | ||
|
|
||
| # Get msdeploy.exe path | ||
| $msDeployExePath = Get-MsDeployExePath | ||
|
|
||
| # Ensure that at most a package (.zip) file is found | ||
| $packageFilePath = Get-SingleFilePath -file $Package | ||
|
|
||
| Write-Verbose "Value of package file path : $SetParametersFile" -verbose | ||
|
|
||
| # Since the SetParametersFile is optional, but it's a FilePath type, it will have the value System.DefaultWorkingDirectory when not specified | ||
| if( $SetParametersFile -eq $env:SYSTEM_DEFAULTWORKINGDIRECTORY -or $SetParametersFile -eq [String]::Concat($env:SYSTEM_DEFAULTWORKINGDIRECTORY, "\" ) -or [string]::IsNullOrEmpty($SetParametersFile) ){ | ||
| Write-Verbose "Is empty" -verbose | ||
| $setParametersFilePath = "" | ||
| } else { | ||
| Write-Verbose "Is not empty" -verbose | ||
| $setParametersFilePath = Get-SingleFilePath -file $SetParametersFile | ||
| } | ||
|
|
||
| # Get destination azureRM webApp connection details | ||
| $azureRMWebAppConnectionDetails = Get-AzureRMWebAppConnectionDetails -webAppName $WebAppName -deployToSlotFlag $DeployToSlotFlag ` | ||
| -resourceGroupName $ResourceGroupName -slotName $SlotName | ||
|
|
||
| # webApp Name to be used in msdeploy command | ||
| $webAppNameForMSDeployCmd = Get-WebAppNameForMSDeployCmd -webAppName $WebAppName -deployToSlotFlag $DeployToSlotFlag -slotName $SlotName | ||
|
|
||
| # Construct arguments for msdeploy command | ||
| $msDeployCmdArgs = Get-MsDeployCmdArgs -packageFile $packageFilePath -webAppNameForMSDeployCmd $webAppNameForMSDeployCmd -azureRMWebAppConnectionDetails $azureRMWebAppConnectionDetails -removeAdditionalFilesFlag $RemoveAdditionalFilesFlag ` | ||
| -excludeFilesFromAppDataFlag $ExcludeFilesFromAppDataFlag -takeAppOfflineFlag $TakeAppOfflineFlag -virtualApplication $VirtualApplication -AdditionalArguments $AdditionalArguments ` | ||
| -setParametersFile $setParametersFilePath | ||
|
|
||
| # Deploy azureRM webApp using msdeploy Command | ||
| Run-MsDeployCommand -msDeployExePath $msDeployExePath -msDeployCmdArgs $msDeployCmdArgs | ||
|
|
||
| # Get azure webapp hosted url | ||
| $azureWebsitePublishURL = Get-AzureRMWebAppPublishUrl -webAppName $WebAppName -deployToSlotFlag $DeployToSlotFlag ` | ||
| -resourceGroupName $ResourceGroupName -slotName $SlotName | ||
|
|
||
| # Publish azure webApp url | ||
| Write-Host (Get-VstsLocString -Key "WebappsuccessfullypublishedatUrl0" -ArgumentList $azureWebsitePublishURL) | ||
|
|
||
| # Set ouput vairable with azureWebsitePublishUrl | ||
| if(-not [string]::IsNullOrEmpty($WebAppUri)) | ||
|
There was a problem hiding this comment. fyi - simpler powershell syntax is |
||
| { | ||
|
|
||
| if( [string]::IsNullOrEmpty($azureWebsitePublishURL)) | ||
| { | ||
| Throw (Get-VstsLocString -Key "Unabletoretrievewebapppublishurlforwebapp0" -ArgumentList $webAppName) | ||
| } | ||
|
|
||
| Set-VstsTaskVariable -Name $WebAppUri -Value $azureWebsitePublishURL | ||
| } | ||
|
|
||
| Write-Verbose "Completed AzureRM WebApp Deployment Task" | ||
|
|
||
| } finally { | ||
| Trace-VstsLeavingInvocation $MyInvocation | ||
| } | ||
|
|
||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This won't work. You're calling
Utility.ps1andAzureUtility.ps1which you've updated to the new lib (callsGet-VstsLocStringnow).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ericsciple What is correct solution to this problem ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes copying the originals to Utility-Legacy.ps1/AzureUtility-Legacy.ps1 would solve the problem. Ultimately the legacy implementation should be deleted in a sprint or two after it's served it's purpose.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ericsciple - Thanks eric , I have done changes and have verified it .