TemplateUpdate.ps1

<#
.SYNOPSIS
    Makes updates to the MAQS project templates.
.DESCRIPTION
    This powershell script is used to update the MAQS project templates. It updates the specified references in the unzipped templates. Editing of parameters in the powershell file will be necessary to set the desired packages and related versions to update.
.PARAMETER maqsVer
    The desired version of MAQS to set.
.PARAMETER closedSource
    Set true if the closeSource version of MAQS should be updated
.PARAMETER openSource
    Set true if the openSource version of MAQS should be updated
.PARAMETER openSource
    Set true if the openSource version of MAQS should be updated
.NOTES
  Version:        1.0
  Author:         Magenic
  Creation Date:  05/16/2017
  Purpose/Change: Initial script development. 

  Version:        2.0
  Author:         Magenic
  Creation Date:  07/5/2018
  Purpose/Change: Add SpecFlow extension support 

  Version:        3.0
  Author:         Magenic
  Creation Date:  08/23/2018
  Purpose/Change: Add .NET core template support 

  Version:        4.0
  Author:         Magenic
  Creation Date:  12/21/2018
  Purpose/Change: Handle multiple package depths

  Version:        5.0
  Author:         Magenic
  Creation Date:  3/28/2019
  Purpose/Change: Update mongo as well
  
  Version:        6.0
  Author:         Magenic
  Creation Date:  10/9/2019
  Purpose/Change: Make it easier to update the bulk dependency values

  Version:        7.0
  Author:         Magenic
  Creation Date:  2/2/2020
  Purpose/Change: Commented out all package references that do not need updating.  Dependabot handles version upgrades
  
.EXAMPLE
  ./TemplateUpdates

  This command will update the open or closed source version of MAQs to the hardcoded MAQS version, depending on which flags are hardcoded to default to true.
.EXAMPLE
  ./TemplateUpdates -maqsVer 4.0.0

  This command will update the open or closed source version of MAQs to MAQS version 4.0.0, depending on which flags are hardcoded to default to true.
.EXAMPLE
  ./TemplateUpdates -maqsVer "4.0.0" -closedSource $true -openSource $false -specFlowSource $false

  This command will update references in all files in the specified codeLocation to the specified maqs version and zip the templates.
#>

param (
    # MAQS CURRENT VERSION
    [string]$maqsVer = "5.8.1",
    [bool]$closedSource = $true,
    [bool]$openSource = $true,
    [bool]$specFlowSource = $true
)

# Bulk update values
[string]$AppiumWebDriver = "4.0.0.5-beta"
[string]$BouncyCastle = "1.8.5"
[string]$CastleCore = "4.4.0"
[string]$Dapper = "2.0.30"
[string]$DapperContrib = "2.0.30"
[string]$MailKit = "2.3.1.6"
[string]$MicrosoftAspNetWebApiClient = "5.2.7"
[string]$MicrosoftDataSqliteCore = "3.0.0"
[string]$MicrosoftExtensionsConfiguration = "3.0.0"
[string]$MicrosoftExtensionsConfigurationAbstractions = "3.0.0"
[string]$MicrosoftExtensionsConfigurationFileExtensions = "2.2.0"
[string]$MicrosoftExtensionsConfigurationJson = "3.0.0"
[string]$MicrosoftExtensionsFileProvidersAbstractions = "2.2.0"
[string]$MicrosoftExtensionsFileProvidersPhysical = "2.2.0"
[string]$MicrosoftExtensionsFileSystemGlobbing = "2.2.0"
[string]$MicrosoftExtensionsPrimitives = "2.2.0"
[string]$MicrosoftNETTestSdk = "16.2.0"
[string]$MimeKit = "2.3.1"
[string]$MongoDBBson = "2.9.2"
[string]$MongoDBDriver = "2.9.2"
[string]$MongoDBDriverCore = "2.9.2"
[string]$MSTestTestAdapter = "2.0.0"
[string]$MSTestTestFramework = "2.0.0"
[string]$NewtonsoftJson = "12.0.2"
[string]$Npgsql = "4.1.1"
[string]$NUnit = "3.12.0"
[string]$NUnit3TestAdapter = "3.15.1"
[string]$SeleniumAxe = "1.3.0"
[string]$SeleniumSupport = "3.141.0"
[string]$SeleniumWebDriver = "3.141.0"
[string]$SeleniumWebDriverChromeDriver = "78.0.3904.10500"
[string]$SeleniumWebDriverGeckoDriver = "0.25.0"
[string]$SeleniumWebDriverGeckoDriverWin32 = "0.25.0"
[string]$SeleniumWebDriverGeckoDriverWin64 = "0.25.0"
[string]$SeleniumWebDriverIEDriver = "3.150.0"
[string]$SeleniumWebDriverMicrosoftDriver = "17.17134.0"
[string]$SpecFlow = "3.0.225"
[string]$SpecFlowMsTest = "3.0.225"
[string]$SpecFlowNUnit = "3.0.225"
[string]$SQLitePCLRawbundleesqlite3 = "2.0.1"
[string]$SQLitePCLRawcore = "2.0.1"
[string]$SystemDataSqlClient = "4.7.0"
[string]$SystemReflectionEmit = "4.6.0"
[string]$SystemReflectionEmitLightweight = "4.6.0"
[string]$SystemRuntimeCompilerServicesUnsafe = "4.6.0"
[string]$SystemTextEncodingCodePages = "4.6.0"

# to avoid updating a value, set its value to ""

# Which package references need to be updated and the corresponding versions
#$packageList = "Appium.WebDriver", "BouncyCastle", "Castle.Core", "Dapper", "Dapper.Contrib", "Magenic.Maqs", "Magenic.Maqs.NunitOnly", "Magenic.Maqs.SpecFlow", "Magenic.Open.Maqs", "Magenic.Open.Maqs.NunitOnly", "MailKit", "Microsoft.AspNet.WebApi.Client", "Microsoft.Data.Sqlite.Core", "Microsoft.Extensions.Configuration", "Microsoft.Extensions.Configuration.Abstractions", "Microsoft.Extensions.Configuration.FileExtensions", "Microsoft.Extensions.Configuration.Json", "Microsoft.Extensions.FileProviders.Abstractions", "Microsoft.Extensions.FileProviders.Physical", "Microsoft.Extensions.FileSystemGlobbing", "Microsoft.Extensions.Primitives", "Microsoft.NET.Test.Sdk", "MimeKit", "MongoDB.Bson", "MongoDB.Driver", "MongoDB.Driver.Core", "MSTest.TestAdapter", "MSTest.TestFramework", "Newtonsoft.Json", "Npgsql", "NUnit", "NUnit3TestAdapter", "Selenium.Axe", "Selenium.Support", "Selenium.WebDriver", "Selenium.WebDriver.ChromeDriver", "Selenium.WebDriver.GeckoDriver", "Selenium.WebDriver.GeckoDriver.Win32", "Selenium.WebDriver.GeckoDriver.Win64", "Selenium.WebDriver.IEDriver", "Selenium.WebDriver.MicrosoftDriver", "SpecFlow", "SpecFlow.MsTest", "SpecFlow.NUnit", "SQLitePCLRaw.bundle_e_sqlite3", "SQLitePCLRaw.core", "System.Data.SqlClient", "System.Reflection.Emit", "System.Reflection.Emit.Lightweight", "System.Runtime.CompilerServices.Unsafe", "System.Text.Encoding.CodePages"
#$versionList =  $AppiumWebDriver,   $BouncyCastle,  $CastleCore,   $Dapper,  $DapperContrib,   $maqsVer,       $maqsVer,                 $maqsVer,                $maqsVer,            $maqsVer,                      $MailKit,  $MicrosoftAspNetWebApiClient,     $MicrosoftDataSqliteCore,     $MicrosoftExtensionsConfiguration,    $MicrosoftExtensionsConfigurationAbstractions,     $MicrosoftExtensionsConfigurationFileExtensions,     $MicrosoftExtensionsConfigurationJson,     $MicrosoftExtensionsFileProvidersAbstractions,     $MicrosoftExtensionsFileProvidersPhysical,     $MicrosoftExtensionsFileSystemGlobbing,    $MicrosoftExtensionsPrimitives,    $MicrosoftNETTestSdk,     $MimeKit,  $MongoDBBson,   $MongoDBDriver,   $MongoDBDriverCore,    $MSTestTestAdapter,   $MSTestTestFramework,   $NewtonsoftJson,   $Npgsql,  $NUnit,  $NUnit3TestAdapter,  $SeleniumAxe,   $SeleniumSupport,   $SeleniumWebDriver,   $SeleniumWebDriverChromeDriver,    $SeleniumWebDriverGeckoDriver,    $SeleniumWebDriverGeckoDriverWin32,     $SeleniumWebDriverGeckoDriverWin64,     $SeleniumWebDriverIEDriver,    $SeleniumWebDriverMicrosoftDriver,    $SpecFlow,  $SpecFlowMsTest,   $SpecFlowNUnit,   $SQLitePCLRawbundleesqlite3,     $SQLitePCLRawcore,   $SystemDataSqlClient,    $SystemReflectionEmit,    $SystemReflectionEmitLightweight,     $SystemRuntimeCompilerServicesUnsafe,     $SystemTextEncodingCodePages

$packageList = "Magenic.Maqs", "Magenic.Maqs.NunitOnly", "Magenic.Maqs.SpecFlow", "Magenic.Open.Maqs", "Magenic.Open.Maqs.NunitOnly"
$versionList = $maqsVer,       $maqsVer,                 $maqsVer,                $maqsVer,            $maqsVer   


# Which assembly file values need to be updated and the corresponding versions (THIS UPDATES ALL ASSEMBLYINFO.CS FILES IN THE REPO, AND SOME SHOULD BE MANUALLY REVERTED)
$assemblyList = "AssemblyVersion", "AssemblyFileVersion"
$assemblyVer = $maqsVer, $maqsVer

# Which nuspec file values need to be updated and the corresponding versions
$nuspecIds = "Magenic.Maqs", "Magenic.Maqs.NunitOnly", "Magenic.Open.Maqs", "Magenic.Open.Maqs.NunitOnly", "Magenic.Maqs.Templates", "Magenic.Maqs.SpecFlow"
$nuspecVer = $maqsVer,       $maqsVer,                 $maqsVer,             $maqsVer,                      $maqsVer,                 $maqsVer

# Desired nuget.config intranet repository value
#$nugetRepo = "https://magenic.pkgs.visualstudio.com/_packaging/MAQS/nuget/v3/index.json"
$nugetRepo = ""

# Desired HelpFile version
$helpFileVer = $maqsVer

# Desired VSIXManifest version
$vsixManVer = $maqsVer

###################################################################################################################
function UpdateLine($fileText, $regexType, $searchValue, $replaceValue){
    if($regexType -eq "ProjReferences") { $regexPattern = "(<HintPath>..\\..\\packages\\" + $searchValue + ".)([\d\.]*)(\\.*</HintPath>)" }
    if($regexType -eq "ProjReferences2") { $regexPattern = "(<HintPath>..\\packages\\" + $searchValue + ".)([\d\.]*)(\\.*</HintPath>)" }
    if($regexType -eq "PackageReferences") { $regexPattern = "(<package id=""" + $searchValue + """ version="")([\d\.]*)("" targetFramework=""[\w]+"" />)" }
    if($regexType -eq "AssemblyReferences") { $regexPattern = "(\[assembly: " + $searchValue + "\("")([\d\.]*)(""\)\])" }
    if($regexType -eq "NuspecVersion"){ $regexPattern = "(<id>" + $searchValue + "</id>[\r\n\s]*<version>)([\d\.]*)(</version>)" }
    if($regexType -eq "NuspecDep") { $regexPattern = "(<dependency id=""" + $searchValue + """ version="")([\d\.]*)("" />)" }
    if($regexType -eq "HelpDocument") { $regexPattern = "(<HelpFileVersion>)([\d\.]*)(</HelpFileVersion>)" }
    if($regexType -eq "VsixManifest") { $regexPattern = "(<Identity Id=""[A-Za-z0-9 -]*"" Version="")([\d\.]*)("" Language=""en-US"" Publisher=""Magenic"" />)" }
    if($regexType -eq "NugetRepository") { $regexPattern = "(<add key=""intranet repository"" value="")([A-Za-z0-9 \\\.:/_-]*)("" />)" }
    if($regexType -eq "DocumentationSource") {$regexPattern = "(<DocumentationSource sourceFile=""..\\packages\\" + $searchValue + ".)([\d\.]*)(\\lib\\[\w]+\\[\w\.]+"" />)" }
    if($regexType -eq "PackageReferenceOpen") {$regexPattern = "(<PackageReference Include=""" + $searchValue + """ version="")([\d\.]*)("" />)" }
    if($regexType -eq "ProjVersion_") {$regexPattern = "(<Version>)([\d\.]*)(</Version>)" }
    if($regexType -eq "ProjVersion_File") {$regexPattern = "(<FileVersion>)([\d\.]*)(</FileVersion>)" }
    if($regexType -eq "ProjVersion_Assembly") {$regexPattern = "(<AssemblyVersion>)([\d\.]*)(</AssemblyVersion>)" }

    if($regexPattern){
        $replaceValue = "`${1}" + $replaceValue + "`${3}"
        $filetext = $filetext -replace $regexPattern, $replaceValue
    }
    return $filetext
}

function UpdateFileContent($file, $regexType, $matchValueList, $replaceValueList){

    $filetext =  [System.IO.File]::ReadAllText($file)
    if($matchValueList -is [system.array]){
        for($i=0; $i -lt $matchValueList.Length; $i++){
            if(![string]::IsNullOrEmpty($replaceValueList[$i])){
                $filetext = UpdateLine $filetext $regexType $matchValueList[$i] $replaceValueList[$i]
            }
        }
    }
    if(($matchValueList -isnot [system.array]) -and (![string]::IsNullOrEmpty($nugetRepo) -or $regexType -eq "VsixManifest" -or $regexType -like "ProjVersion_*")){
        $filetext = UpdateLine $filetext $regexType $matchValueList $replaceValueList
    }

    [System.IO.File]::WriteAllText($file, $filetext, [System.Text.Encoding]::UTF8)
}

function UpdateFiles($directory, $fileFilter, $regexType, $matchValueList, $replaceValueList){
    Get-ChildItem $directory -Filter $fileFilter -Recurse |
    ForEach-Object{
        Write-Host "Updating " $_.FullName
        UpdateFileContent $_.FullName $regexType $matchValueList $replaceValueList
    }
}

# Comment out what doesn't need to be updated
function WorkFlowFunction($closedSource, $openSource, $specFlowSource){

    if($closedSource){
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtension" "*.csproj" "ProjReferences" $packageList $versionList
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtension" "*.csproj" "ProjReferences2" $packageList $versionList
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtension" "packages.config" "PackageReferences" $packageList $versionList
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtension" "source.extension.vsixmanifest" "VsixManifest" "NotNeeded" $vsixManVer
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtension" "nuget.config" "NugetRepository" "NotNeeded" $nugetRepo
        # .NET Core templates
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtension" "*.csproj" "PackageReferenceOpen" $packageList $versionList  
    }
    if($openSource){
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtensionOss" "*.csproj" "ProjReferences" $packageList $versionList
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtensionOss" "*.csproj" "ProjReferences2" $packageList $versionList
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtensionOss" "packages.config" "PackageReferences" $packageList $versionList
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtensionOss" "source.extension.vsixmanifest" "VsixManifest" "NotNeeded" $vsixManVer
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtensionOss" "nuget.config" "NugetRepository" "NotNeeded" $nugetRepo
        # .NET Core templates
        UpdateFiles $PSScriptRoot"\Extensions\VisualStudioQatExtensionOss" "*.csproj" "PackageReferenceOpen" $packageList $versionList
        UpdateFiles $PSScriptRoot"\Extensions\CoreTemplates" "*.csproj" "PackageReferenceOpen" $packageList $versionList
    }
    if($specFlowSource){
        UpdateFiles $PSScriptRoot"\Extensions\MaqsSpecFlowExtension" "*.csproj" "ProjReferences" $packageList $versionList
        UpdateFiles $PSScriptRoot"\Extensions\MaqsSpecFlowExtension" "*.csproj" "ProjReferences2" $packageList $versionList
        UpdateFiles $PSScriptRoot"\Extensions\MaqsSpecFlowExtension" "packages.config" "PackageReferences" $packageList $versionList
        UpdateFiles $PSScriptRoot"\Extensions\MaqsSpecFlowExtension" "source.extension.vsixmanifest" "VsixManifest" "NotNeeded" $vsixManVer
        UpdateFiles $PSScriptRoot"\Extensions\MaqsSpecFlowExtension" "nuget.config" "NugetRepository" "NotNeeded" $nugetRepo
        # .NET Core templates
        UpdateFiles $PSScriptRoot"\Extensions\MaqsSpecFlowExtension" "*.csproj" "PackageReferenceOpen" $packageList $versionList
    }
    UpdateFiles $PSScriptRoot"\Framework" "AssemblyInfo.cs" "AssemblyReferences" $assemblyList $assemblyVer
    UpdateFiles $PSScriptRoot"\Framework" "*.nuspec" "NuspecVersion" $nuspecIds $nuspecVer
    UpdateFiles $PSScriptRoot"\Framework" "*.nuspec" "NuspecDep" $packageList $versionList
    UpdateFiles $PSScriptRoot"\Framework" "*.csproj" "ProjVersion_" "NotNeeded" $maqsVer
    UpdateFiles $PSScriptRoot"\Framework" "*.csproj" "ProjVersion_File" "NotNeeded" $maqsVer
    UpdateFiles $PSScriptRoot"\Framework" "*.csproj" "ProjVersion_Assembly" "NotNeeded" $maqsVer
    
    # .NET Core templates
    UpdateFiles $PSScriptRoot"\Extensions\CoreTemplates" "*.nuspec" "NuspecVersion" $nuspecIds $nuspecVer
}

WorkFlowFunction $closedSource $openSource $specFlowSource