Merge pull request #2 from begroff/feature/newupdates

deadlydog · web-flow · commit 468057942cb6 · 2018-08-12T14:14:53.000-06:00
Feature/newupdates
diff --git a/ReadMe.md b/ReadMe.md
@@ -8,15 +8,18 @@ Setting the MinimumRequiredVersion property forces the ClickOnce application to
 
 # Script Parameters
 * **ProjectFilePath** (required) - Path of the .csproj and .vbproj file to process.
-	
+
 * **Version** - The Version to update the ClickOnce version number to. This version must be of the format Major.Minor.Build or Major.Minor.Build.Revision. The Build and Revision parts will be overridden by the BuildSystemsBuildId parameter, if it is provided. The Revision parts will be overriden by the IncrementProjectFilesRevision parameter, if it is provided.
 
 * **BuildSystemsBuildId** - The build system's unique and auto-incrementing Build ID. This will be used to generate the Build and Revision parts of the new Version number. This will override the Build and Revision specified in the Version parameter, if it was provided. This parameter cannot be used with the IncrementProjectFilesRevision parameter.
-	
+
 * **IncrementProjectFilesRevision** - If this switch is provided, the Revision from the project file will be incremented and used in the new ClickOnce Version. This will override the Revision specified in the Version parameter, if it was provided. This parameter cannot be used with the BuildSystemsBuildId parameter.
-	
+
 * **UpdateMinimumRequiredVersionToCurrentVersion** - If this switch is provided, the ClickOnce MinimumRequiredVersion will be updated to match the new Version. Setting the MinimumRequiredVersion property forces the ClickOnce application to update automatically without prompting the user.
 
+* **PublishUrl** - If this switch is provided, the ClickOnce PublishUrl will be updated. The publish url format is \\fileshare\foldername
+
+* **InstallUrl** - If this switch is provided, the ClickOnce InstallUrl will be updated. The install url format is http://fileshare/foldername
 
 # Examples
 Update a project file's ClickOnce version to the specified version.
@@ -52,4 +55,11 @@ Update a project file's ClickOnce version, ignoring the Revision part and increm
 & .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -Version '1.2.3' -IncrementProjectFilesRevision -UpdateMinimumRequiredVersionToCurrentVersion
 ```
 
-[AutoUpdateProjectsMinimumRequiredClickOnceVersionNugetPackageWebpage]: https://www.nuget.org/packages/AutoUpdateProjectsMinimumRequiredClickOnceVersion
+---
+
+Update a project file's ClickOnce version and its install and publish url values.
+```
+& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -Version 1.0.1.9 -PublishUrl "\\fileshare\foldername" -InstallUrl "http://fileshare/foldername"
+```
+
+[AutoUpdateProjectsMinimumRequiredClickOnceVersionNugetPackageWebpage]: https://www.nuget.org/packages/AutoUpdateProjectsMinimumRequiredClickOnceVersion
diff --git a/Set-ProjectFilesClickOnceVersion.ps1 b/Set-ProjectFilesClickOnceVersion.ps1
@@ -2,14 +2,14 @@
 <#
 .SYNOPSIS
    This script updates the ClickOnce version in a project file (.csproj or .vbproj), and may update the MinimumRequiredVersion to be this same version.
-   
+
 .DESCRIPTION
    This script updates the current ClickOnce version in a project file (.csproj or .vbproj), and may update the MinimumRequiredVersion to be this same version.
    Setting the MinimumRequiredVersion property forces the ClickOnce application to update automatically without prompting the user.
-   
+
 .PARAMETER ProjectFilePath
 	(required) Path of the .csproj and .vbproj file to process.
-	
+
 .PARAMETER Version
 	The Version to update the ClickOnce version number to. This version must be of the format Major.Minor.Build or Major.Minor.Build.Revision.
 	The Build and Revision parts will be overridden by the BuildSystemsBuildId parameter, if it is provided.
@@ -19,44 +19,61 @@
 	The build system's unique and auto-incrementing Build ID. This will be used to generate the Build and Revision parts of the new Version number.
 	This will override the Build and Revision specified in the Version parameter, if it was provided.
 	This parameter cannot be used with the IncrementProjectFilesRevision parameter.
-	
+
 .PARAMETER IncrementProjectFilesRevision
 	If this switch is provided, the Revision from the project file will be incremented and used in the new ClickOnce Version.
 	This will override the Revision specified in the Version parameter, if it was provided.
 	This parameter cannot be used with the BuildSystemsBuildId parameter.
-	
+
 .PARAMETER UpdateMinimumRequiredVersionToCurrentVersion
 	If this switch is provided, the ClickOnce MinimumRequiredVersion will be updated to match the new Version.
 	Setting the MinimumRequiredVersion property forces the ClickOnce application to update automatically without prompting the user.
 
+.PARAMETER PublishUrl
+	If this string is provided, it will update the PublishUrl. If it is not provided, the PublishUrl will remain what it is currently. This should be a UNC type file path (e.g. \\servername\foldername)
+
+.PARAMETER InstallUrl
+	If this string is provided, it will update the InstallUrl. If it is not provided the InstallUrl will remain what it is currently. This should be a URL type path (e.g. http://servername/foldername)
+
 .EXAMPLE
 	Update a project file's ClickOnce version to the specified version.
-	
+
 	& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -Version '1.2.3.4'
 
 .EXAMPLE
 	Update the Build and Revision parts of a project file's ClickOnce version, based on a unique, auto-incrementing integer, such as a build system's Build ID.
-	
+
 	& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -BuildSystemsBuildId 123456
 
 .EXAMPLE
 	Increment the Revision of a project file's ClickOnce version.
-	
+
 	& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -IncrementProjectFilesRevision
 
 .EXAMPLE
 	Update a project file's ClickOnce Minimum Required Version to match its current version.
-	
+
 	& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -UpdateMinimumRequiredVersionToCurrentVersion
-	
+
 .EXAMPLE
 	Update a project file's ClickOnce version, ignoring the Revision part and incrementing the Revision stored in the file, and update the Minimum Required Version to be this new version.
-	
+
 	& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -Version '1.2.3' -IncrementProjectFilesRevision -UpdateMinimumRequiredVersionToCurrentVersion
-	
+
+.EXAMPLE
+	Update a project file's ClickOnce version using both Version and a unique, auto-incrementing integer, such as a build system's Build ID. This will keep the major and minor versions you specify but update the build and revision (e.g. 1.0.1.5745)
+
+	& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -Version 1.0.0.0 -BuildSystemBuildId 123456
+
+.EXAMPLE
+	Update a project file's ClickOnce version and its install and publish url values.
+
+	& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -Version 1.0.1.9 -PublishUrl "\\fileshare\foldername" -InstallUrl "http://fileshare/foldername"
+
+
 .LINK
 	Project Home: https://github.com/deadlydog/Set-ProjectFilesClickOnceVersion
-	
+
 .NOTES
 	Author: Daniel Schroeder
 	Version: 2.0.0
@@ -81,7 +98,13 @@ Param
 	[switch]$IncrementProjectFilesRevision = $false,
 
 	[Parameter(Mandatory=$false,HelpMessage="When the switch is provided, the ClickOnce Minimum Required Version will be updated to this new version.")]
-	[switch]$UpdateMinimumRequiredVersionToCurrentVersion = $false
+	[switch]$UpdateMinimumRequiredVersionToCurrentVersion = $false,
+
+	[Parameter(Mandatory = $false, HelpMessage="The Publish URL to update to.")]
+	[string]$PublishUrl = '',
+
+	[Parameter(Mandatory = $false, HelpMessage="The Install URL to update to.")]
+	[string]$InstallUrl = ''
 )
 
 # If we can't find the project file path to update, exit with an error.
@@ -92,17 +115,17 @@ if (!(Test-Path $ProjectFilePath -PathType Leaf))
 }
 
 # If there are no changes to make, just exit.
-if ([string]::IsNullOrEmpty($Version) -and $BuildSystemsBuildId -lt 0 -and !$IncrementProjectFilesRevision -and !$UpdateMinimumRequiredVersionToCurrentVersion)
+if ([string]::IsNullOrEmpty($Version) -and $BuildSystemsBuildId -lt 0 -and !$IncrementProjectFilesRevision -and !$UpdateMinimumRequiredVersionToCurrentVersion -and !$InstallUrl -and !$PublishUrl)
 {
-	Write-Warning "None of the following parameters were provided, so nothing will be changed: Version, BuildSystemsBuildId, IncrementProjectFilesRevision, UpdateMinimumRequiredVersionToCurrentVersion"
+	Write-Warning "None of the following parameters were provided, so nothing will be changed: Version, BuildSystemsBuildId, IncrementProjectFilesRevision, UpdateMinimumRequiredVersionToCurrentVersion, InstallUrl and PublishUrl"
 	return
 }
 
 function Get-XmlNamespaceManager([xml]$XmlDocument, [string]$NamespaceURI = "")
 {
     # If a Namespace URI was not given, use the Xml document's default namespace.
-	if ([string]::IsNullOrEmpty($NamespaceURI)) { $NamespaceURI = $XmlDocument.DocumentElement.NamespaceURI }	
-	
+	if ([string]::IsNullOrEmpty($NamespaceURI)) { $NamespaceURI = $XmlDocument.DocumentElement.NamespaceURI }
+
 	# In order for SelectSingleNode() to actually work, we need to use the fully qualified node path along with an Xml Namespace Manager, so set them up.
 	[System.Xml.XmlNamespaceManager]$xmlNsManager = New-Object System.Xml.XmlNamespaceManager($XmlDocument.NameTable)
 	$xmlNsManager.AddNamespace("ns", $NamespaceURI)
@@ -118,7 +141,7 @@ function Get-XmlNode([xml]$XmlDocument, [string]$NodePath, [string]$NamespaceURI
 {
 	$xmlNsManager = Get-XmlNamespaceManager -XmlDocument $XmlDocument -NamespaceURI $NamespaceURI
 	[string]$fullyQualifiedNodePath = Get-FullyQualifiedXmlNodePath -NodePath $NodePath -NodeSeparatorCharacter $NodeSeparatorCharacter
-	
+
 	# Try and get the node, then return it. Returns $null if the node was not found.
 	$node = $XmlDocument.SelectSingleNode($fullyQualifiedNodePath, $xmlNsManager)
 	return $node
@@ -136,36 +159,36 @@ function Get-XmlNodes([xml]$XmlDocument, [string]$NodePath, [string]$NamespaceUR
 
 function Get-XmlElementsTextValue([xml]$XmlDocument, [string]$ElementPath, [string]$NamespaceURI = "", [string]$NodeSeparatorCharacter = '.')
 {
-	# Try and get the node.	
+	# Try and get the node.
 	$node = Get-XmlNode -XmlDocument $XmlDocument -NodePath $ElementPath -NamespaceURI $NamespaceURI -NodeSeparatorCharacter $NodeSeparatorCharacter
-	
+
 	# If the node already exists, return its value, otherwise return null.
 	if ($node) { return $node.InnerText } else { return $null }
 }
 
 function Set-XmlElementsTextValue([xml]$XmlDocument, [string]$ElementPath, [string]$TextValue, [string]$NamespaceURI = "", [string]$NodeSeparatorCharacter = '.')
 {
-	# Try and get the node.	
+	# Try and get the node.
 	$node = Get-XmlNode -XmlDocument $XmlDocument -NodePath $ElementPath -NamespaceURI $NamespaceURI -NodeSeparatorCharacter $NodeSeparatorCharacter
-	
+
 	# If the node already exists, update its value.
 	if ($node)
-	{ 
+	{
 		$node.InnerText = $TextValue
 	}
 	# Else the node doesn't exist yet, so create it with the given value.
 	else
 	{
 		# Create the new element with the given value.
 		$elementName = $ElementPath.Substring($ElementPath.LastIndexOf($NodeSeparatorCharacter) + 1)
- 		$element = $XmlDocument.CreateElement($elementName, $XmlDocument.DocumentElement.NamespaceURI)		
+ 		$element = $XmlDocument.CreateElement($elementName, $XmlDocument.DocumentElement.NamespaceURI)
 		$textNode = $XmlDocument.CreateTextNode($TextValue)
 		$element.AppendChild($textNode) > $null
-		
+
 		# Try and get the parent node.
 		$parentNodePath = $ElementPath.Substring(0, $ElementPath.LastIndexOf($NodeSeparatorCharacter))
 		$parentNode = Get-XmlNode -XmlDocument $XmlDocument -NodePath $parentNodePath -NamespaceURI $NamespaceURI -NodeSeparatorCharacter $NodeSeparatorCharacter
-		
+
 		if ($parentNode)
 		{
 			$parentNode.AppendChild($element) > $null
@@ -179,9 +202,9 @@ function Set-XmlElementsTextValue([xml]$XmlDocument, [string]$ElementPath, [stri
 
 function Set-XmlNodesElementTextValue([xml]$xml, $node, $elementName, $textValue)
 {
-	if ($node.($elementName) -eq $null)
+	if ($null -eq $node.($elementName))
 	{
-		$element = $xml.CreateElement($elementName, $xml.DocumentElement.NamespaceURI)		
+		$element = $xml.CreateElement($elementName, $xml.DocumentElement.NamespaceURI)
 		$textNode = $xml.CreateTextNode($textValue)
 		$element.AppendChild($textNode) > $null
 		$node.AppendChild($element) > $null
@@ -201,7 +224,7 @@ $versionNumberRegex = New-Object System.Text.RegularExpressions.Regex "(?<MajorM
 # Open the Xml file and get the <PropertyGroup> elements with the ClickOnce properties in it.
 [xml]$xml = Get-Content -Path $ProjectFilePath
 $propertyGroups = Get-XmlNodes -XmlDocument $xml -NodePath 'Project.PropertyGroup'
-[Array]$clickOncePropertyGroups = $propertyGroups | Where-Object { 
+[Array]$clickOncePropertyGroups = $propertyGroups | Where-Object {
 	try
 	{
 		return ($_.ApplicationVersion -ne $null)
@@ -210,7 +233,7 @@ $propertyGroups = Get-XmlNodes -XmlDocument $xml -NodePath 'Project.PropertyGrou
 }
 
 # If no ClickOnce deployment settings were found throw an error.
-if ($clickOncePropertyGroups -eq $null -or $clickOncePropertyGroups.Count -eq 0)
+if ($null -eq $clickOncePropertyGroups -or $clickOncePropertyGroups.Count -eq 0)
 {
 	throw "'$ProjectFilePath' does not appear to have any ClickOnce deployment settings in it. You must publish the project at least once to create the ClickOnce deployment settings."
 }
@@ -223,13 +246,31 @@ foreach ($clickOncePropertyGroup in $clickOncePropertyGroups)
 	$numberOfClickOncePropertyGroupsProcessed++
 	Write-Verbose "Processing ClickOnce property group $numberOfClickOncePropertyGroupsProcessed of $numberOfClickOncePropertyGroups in file '$ProjectFilePath'."
 
+	# If publish url is provided, update it
+	$publishUrl = $PublishUrl
+	if (![string]::IsNullOrEmpty($publishUrl))
+	{
+		Write-Verbose "Publish Url is '$publishUrl'"
+		Write-Output "Updating PublishUrl to be '$publishUrl'"
+		Set-XmlNodesElementTextValue -xml $xml -node $clickOncePropertyGroup -elementName 'PublishUrl' -textValue "$publishUrl"
+	}
+
+	# If install url is provided, update it
+	$installUrl = $InstallUrl
+	if (![string]::IsNullOrEmpty($installUrl))
+	{
+		Write-Verbose "Install Url is '$installUrl'"
+		Write-Output "Updating Install Url to be '$installUrl'"
+		Set-XmlNodesElementTextValue -xml $xml -node $clickOncePropertyGroup -elementName 'InstallUrl' -textValue "$installUrl"
+	}
+
 	# If the Version to use was not provided, get it from the project file.
 	$appVersion = $Version
 	if ([string]::IsNullOrEmpty($appVersion))
 	{
 		$appVersion = $clickOncePropertyGroup.ApplicationVersion
 	}
-	
+
 	# Get the Major, Minor, and Build parts of the version number.
 	$majorMinorBuildMatch = $versionNumberRegex.Match($appVersion)
 	if (!$majorMinorBuildMatch.Success)
@@ -239,20 +280,20 @@ foreach ($clickOncePropertyGroup in $clickOncePropertyGroups)
 	$majorMinor = $majorMinorBuildMatch.Groups["MajorMinor"].Value
 	[int]$build = $majorMinorBuildMatch.Groups["Build"].Value
 	[int]$revision = -1
-	
+
 	# If a Revision was specified in the Version, get it.
 	if (![string]::IsNullOrWhiteSpace($majorMinorBuildMatch.Groups["Revision"]))
 	{
 		$revision = [int]::Parse($majorMinorBuildMatch.Groups["Revision"])
 	}
-	
+
 	# If we should be using the BuildSystemsBuildId for the Build and Revision.
 	if ($BuildSystemsBuildId -gt -1)
 	{
 		# Use a calculation for the Build and Revision to prevent the Revision value from being too large, and to increment the Build value as the BuildSystemsBuildId continues to grow larger.
 		$build = [int][Math]::Floor($BuildSystemsBuildId / $maxVersionPartValueAllowed)
 		$revision = $BuildSystemsBuildId % $maxVersionPartValueAllowed
-		
+
 		Write-Verbose "Translated BuildSystemsBuildId '$BuildSystemsBuildId' into Build.Revision '$build.$revision'."
 	}
 
@@ -261,22 +302,22 @@ foreach ($clickOncePropertyGroup in $clickOncePropertyGroups)
 	{
 		# If the Revision is missing from the file, or not in a valid format, throw an error.
 		$applicationRevisionString = $clickOncePropertyGroup.ApplicationRevision
-		if ($applicationRevisionString -eq $null)
+		if ($null -eq $applicationRevisionString)
 		{
 			throw "Could not find the <ApplicationRevision> element in the project file '$ProjectFilePath'."
-		}		
+		}
 		if (!($applicationRevisionString -imatch '^\d+$'))
 		{
 			throw "The <ApplicationRevision> elements value '$applicationRevisionString' in the file '$ProjectFilePath' does not appear to be a valid integer."
 		}
-		
+
 		$revision = [int]::Parse($applicationRevisionString)
-		
+
 		# If the Revision should be incremented, do it.
 		if ($IncrementProjectFilesRevision)
 		{
 			$revision = $revision + 1
-			
+
 			# Make sure the Revision version part is not greater than the max allowed value.
 			if ($revision -gt $maxVersionPartValueAllowed)
 			{
@@ -285,12 +326,12 @@ foreach ($clickOncePropertyGroup in $clickOncePropertyGroups)
 			}
 		}
 	}
-	
+
 	# Create the version number to use for the ClickOnce version.
 	$newMajorMinorBuild = "$majorMinor.$build"
 	$newVersionNumber = "$newMajorMinorBuild.$revision"
 	Write-Output "Updating version number to be '$newVersionNumber'."
-	
+
 	# Write the new values to the file.
 	Set-XmlNodesElementTextValue -xml $xml -node $clickOncePropertyGroup -elementName 'ApplicationVersion' -textValue "$newMajorMinorBuild.%2a"
 	Set-XmlNodesElementTextValue -xml $xml -node $clickOncePropertyGroup -elementName 'ApplicationRevision' -textValue $revision.ToString()
@@ -304,4 +345,4 @@ foreach ($clickOncePropertyGroup in $clickOncePropertyGroups)
 }
 
 # Save the changes.
-$xml.Save($ProjectFilePath)
+$xml.Save($ProjectFilePath)
diff --git a/Tests/RunTests.ps1 b/Tests/RunTests.ps1
@@ -33,11 +33,11 @@ function RunScriptWithParameters($parameters)
 			return $matches["Version"]
 		}
 		# If $output contains multiple lines, it will be treated as a collection instead of a string and $matches will not be defined, so catch that case.
-		catch { return $output }		
+		catch { return $output }
 	}
 	return $output
 }
-	
+
 $testNumber = 0
 # Some tests are dependent on the order in which they are ran, which isn't ideal, but good enough for now.
 
@@ -60,3 +60,17 @@ if ($output -eq '1.2.1.57922') { Write-Host "Passed" } else { throw "Test $testN
 Write-Host ("{0}. Use version number parameter and update minimum required version..." -f ++$testNumber)
 $output = RunScriptWithParameters "-Version '5.6.7.8' -UpdateMinimumRequiredVersionToCurrentVersion"
 if ($output.Contains("Updating minimum required version to be '5.6.7.8'.")) { Write-Host "Passed" } else { throw "Test $testNumber failed. Output was '$output'." }
+
+Write-Host ("{0}. Use major/minor of version number parameter and Build Id parameter...." -f ++$testNumber)
+$output = RunScriptWithParameters "-Version '1.1.0.0' -BuildSystemsBuildId 123456"
+if ($output -eq '1.1.1.57921') { Write-Host "Passed" } else { throw "Test $testNumber failed. Output was '$output'." }
+
+Write-Host ("{0}. Use version and publish url parameter...." -f ++$testNumber)
+$output = RunScriptWithParameters "-Version '1.0.5.9' -PublishUrl '\\fileshare\foldername'"
+# Multiple output statements are objects in an array in the order they are outputted
+if ($output[0].Contains('\\fileshare\foldername') -AND $output[1].Contains('1.0.5.9')) { Write-Host "Passed" } else { throw "Test $testNumber failed. Output was '$output'." }
+
+Write-Host ("{0}. Use BuildId parameter, publish url parameter and install url parameter...." -f ++$testNumber)
+$output = RunScriptWithParameters "-BuildSystemsBuildId 123456 -PublishUrl '\\fileshare\foldername' -InstallUrl 'http://fileshare/foldername'"
+# Multiple output statements are objects in an array in the order they are outputted
+if ($output[0].Contains('\\fileshare\foldername') -AND $output[1].Contains('http://fileshare/foldername') -AND $output[2].Contains('1.0.1.57921')) { Write-Host "Passed" } else { throw "Test $testNumber failed. Output was '$output'." }
diff --git a/Tests/TestFiles/TestProject.csproj b/Tests/TestFiles/TestProject.csproj
