Build.ps1

# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT license. See LICENSE file in the project root for full license information.

# Build script for MSTest Test Framework.

[CmdletBinding(PositionalBinding = $false)]
Param(  
  [ValidateSet("Debug", "Release")]
  [Alias("c")]
  [string] $Configuration = "Debug",

  [Alias("fv")]
  [string] $FrameworkVersion = "99.99.99",
  
  [Alias("av")]
  [string] $AdapterVersion = "99.99.99",

  [Alias("vs")]
  [string] $VersionSuffix = "dev",
  
  [string] $BuildVersionPrefix = "14.0",

  [string] $BuildVersionSuffix = "9999.99",
  
  [string] $Target = "Build",
  
  [Alias("h")]
  [Switch] $Help,

  [Alias("cl")]
  [Switch] $Clean,

  [Alias("sr")]
  [Switch] $SkipRestore,

  [Alias("cache")]
  [Switch] $ClearPackageCache,

  [Switch] $Official,

  [Switch] $Full,

  [Alias("uxlf")]
  [Switch] $UpdateXlf,

  [Alias("loc")]
  [Switch] $IsLocalizedBuild,

  [Alias("tpv")]
  [string] $TestPlatformVersion = $null,

  [Alias("np")]
  [Switch] $DisallowPrereleaseMSBuild,

  [Alias("f")]
  [Switch] $Force, 

  [Alias("s")]
  [String[]] $Steps = @("UpdateTPVersion", "Restore", "Build", "Publish")
)

. $PSScriptRoot\common.lib.ps1

#
# Build configuration
#
Write-Verbose "Setup build configuration."
$TFB_Configuration = $Configuration
$TFB_FrameworkVersion = $FrameworkVersion
$TFB_AdapterVersion = $AdapterVersion
$TFB_VersionSuffix = $VersionSuffix
$TFB_BuildVersion = $BuildVersionPrefix + "." + $BuildVersionSuffix
$TFB_SkipRestore = $SkipRestore
$TFB_Clean = $Clean
$TFB_ClearPackageCache = $ClearPackageCache
$TFB_Full = $Full
$TFB_Official = $Official
$TFB_UpdateXlf = $UpdateXlf
$TFB_IsLocalizedBuild = $IsLocalizedBuild -or $TFB_Official

$TFB_Solutions = @(
  "TestFx.sln"
)

$TFB_NetCoreProjects = @(
  "src\Adapter\PlatformServices.NetCore\PlatformServices.NetCore.csproj"

  "test\ComponentTests\TestAssets\TestProjectForAssemblyResolution\TestProjectForAssemblyResolution.csproj"
  "test\E2ETests\TestAssets\CompatTestProject\CompatTestProject.csproj"
  "test\E2ETests\TestAssets\DataRowTestProject\DataRowTestProject.csproj"
  "test\E2ETests\TestAssets\DataSourceTestProject\DataSourceTestProject.csproj"
  "test\E2ETests\TestAssets\DeploymentTestProject\DeploymentTestProject.csproj"
  "test\E2ETests\TestAssets\DeploymentTestProjectNetCore\DeploymentTestProjectNetCore.csproj"
  "test\E2ETests\TestAssets\DoNotParallelizeTestProject\DoNotParallelizeTestProject.csproj"
  "test\E2ETests\TestAssets\FSharpTestProject\FSharpTestProject.fsproj"
  "test\E2ETests\TestAssets\TimeoutTestProject\TimeoutTestProject.csproj"
  "test\E2ETests\TestAssets\TimeoutTestProjectNetCore\TimeoutTestProjectNetCore.csproj"
  "test\UnitTests\PlatformServices.NetCore.Unit.Tests\PlatformServices.NetCore.Unit.Tests.csproj"
)

#
# Script Preferences
#
$ErrorActionPreference = "Stop"

#
# Prints help text for the switches this script supports.
#
function Print-Help {
  if (-not $Help) {
    return
  }

  Write-Host -object ""
  Write-Host -object "********* MSTest Adapter Build Script *********"
  Write-Host -object ""
  Write-Host -object "  Help (-h)                        - [switch]   - Prints this help message."
  Write-Host -object "  Clean (-cl)                      - [switch]   - Indicates that this should be a clean build."
  Write-Host -object "  SkipRestore (-sr)                - [switch]   - Indicates nuget package restoration should be skipped."
  Write-Host -object "  ClearPackageCache (-cache)       - [switch]   - Indicates local package cache should be cleared before restore."
  Write-Host -object "  Updatexlf (-uxlf)                - [switch]   - Indicates that there are resource changes and that these need to be copied to other languages as well."
  Write-Host -object "  IsLocalizedBuild (-loc)          - [switch]   - Indicates that the build needs to generate resource assemblies as well."
  Write-Host -object "  Official                         - [switch]   - Indicates that this is an official build. Only used in CI builds."
  Write-Host -object "  Full                             - [switch]   - Indicates to perform a full build which includes Adapter, Framework"
  Write-Host -object "  DisallowPrereleaseMSBuild (-np)  - [switch]   - Uses an RTM version of MSBuild to build the projects"
  Write-Host -object ""                                               
  Write-Host -object "  Configuration (-c)               - [string]   - Specifies the build configuration. Defaults to 'Debug'."
  Write-Host -object "  FrameworkVersion (-fv)           - [string]   - Specifies the version of the Test Framework nuget package."
  Write-Host -object "  AdapterVersion (-av)             - [string]   - Specifies the version of the Test Adapter nuget package."
  Write-Host -object "  VersionSuffix (-vs)              - [string]   - Specifies the version suffix for the nuget packages."
  Write-Host -object "  Target                           - [string]   - Specifies the build target. Defaults to 'Build'."
  Write-Host -object ""
  Write-Host -object "  Steps (-s)                       - [string[]] - List of build steps to run, valid steps: `"UpdateTPVersion`", `"Restore`", `"Build`", `"Publish`""

  Write-Host -object ""
  Exit 0
}

#
# Restores packages for the solutions.
#
function Perform-Restore {
  $timer = Start-Timer

  Write-Log "Perform-Restore: Started."
  
  if ($TFB_SkipRestore) {
    Write-Log "Perform-Restore: Skipped."
    return;
  }

  $nuget = Locate-NuGet
  $nugetConfig = Locate-NuGetConfig
  $toolset = Locate-Toolset
  
  if ($TFB_ClearPackageCache) {
    Write-Log "    Clearing local package cache..."
    & $nuget locals all -clear
  }

  Write-Log "    Starting toolset restore..."
  Write-Verbose "$nuget restore -msbuildVersion $msbuildVersion -verbosity normal -nonInteractive -configFile $nugetConfig $toolset"
  & $nuget restore -msbuildVersion $msbuildVersion -verbosity normal -nonInteractive -configFile $nugetConfig $toolset
  
  if ($lastExitCode -ne 0) {
    throw "The restore failed with an exit code of '$lastExitCode'."
  }

  Write-Verbose "Locating MSBuild install path..."
  $msbuildPath = Locate-MSBuildPath 

  Write-Verbose "Starting solution restore..."
  foreach ($solution in $TFB_Solutions) {
    $solutionPath = Locate-Item -relativePath $solution

    Write-Verbose "$nuget restore -msbuildPath $msbuildPath -verbosity quiet -nonInteractive -configFile $nugetConfig $solutionPath"
    & $nuget restore -msbuildPath $msbuildPath -verbosity quiet -nonInteractive -configFile $nugetConfig $solutionPath
  }

  if ($lastExitCode -ne 0) {
    throw "The restore failed with an exit code of '$lastExitCode'."
  }
  
  $msbuild = Join-Path $msbuildPath "MSBuild.exe"
  
  Write-Verbose "Starting restore for NetCore Projects"
  foreach ($project in $TFB_NetCoreProjects) {
    $projectPath = Locate-Item -relativePath $project

    Write-Verbose "$msbuild /t:restore -verbosity:minimal $projectPath /m"
    & $msbuild /t:restore -verbosity:minimal $projectPath /m
  }
  
  if ($lastExitCode -ne 0) {
    throw "The restore failed with an exit code of '$lastExitCode'."
  }

  Write-Log "Perform-Restore: Completed. {$(Get-ElapsedTime($timer))}"
}

#
# Builds the solutions specified.
#
function Perform-Build {
  $timer = Start-Timer

  Write-Log "Perform-Build: Started."

  if ($TFB_Clean) {
    $foldersToDel = @( $TFB_Configuration, "TestAssets" )
    Write-Log "    Clean build requested."
    foreach ($folder in $foldersToDel) {
      $outDir = Join-Path $env:TF_OUT_DIR -ChildPath $folder
      
      if (Test-Path $outDir) {
        Write-Output "    Deleting $outDir"
        Remove-Item -Recurse -Force $outDir
      }
    }
  }

  Invoke-Build -solution "TestFx.sln"
   
  Write-Log "Perform-Build: Completed. {$(Get-ElapsedTime($timer))}"
}

function Invoke-Build([string] $solution, $hasVsixExtension = "false") {
  $msbuild = Locate-MSBuild -hasVsixExtension $hasVsixExtension
  $solutionPath = Locate-Item -relativePath $solution
  $solutionDir = [System.IO.Path]::GetDirectoryName($solutionPath)
  $solutionSummaryLog = Join-Path -path $solutionDir -childPath "msbuild.log"
  $solutionWarningLog = Join-Path -path $solutionDir -childPath "msbuild.wrn"
  $solutionFailureLog = Join-Path -path $solutionDir -childPath "msbuild.err"

  Write-Log "    Building $solution..."
  Write-Verbose "$msbuild /t:$Target /p:Configuration=$configuration /v:m /flp1:Summary`;Verbosity=diagnostic`;Encoding=UTF-8`;LogFile=$solutionSummaryLog /flp2:WarningsOnly`;Verbosity=diagnostic`;Encoding=UTF-8`;LogFile=$solutionWarningLog /flp3:ErrorsOnly`;Verbosity=diagnostic`;Encoding=UTF-8`;LogFile=$solutionFailureLog /p:IsLocalizedBuild=$TFB_IsLocalizedBuild /p:UpdateXlf=$TFB_UpdateXlf /p:BuildVersion=$TFB_BuildVersion $solutionPath /bl /m" 
  & $msbuild /t:$Target /p:Configuration=$configuration /v:m /flp1:Summary`;Verbosity=diagnostic`;Encoding=UTF-8`;LogFile=$solutionSummaryLog /flp2:WarningsOnly`;Verbosity=diagnostic`;Encoding=UTF-8`;LogFile=$solutionWarningLog /flp3:ErrorsOnly`;Verbosity=diagnostic`;Encoding=UTF-8`;LogFile=$solutionFailureLog /p:IsLocalizedBuild=$TFB_IsLocalizedBuild /p:UpdateXlf=$TFB_UpdateXlf /p:BuildVersion=$TFB_BuildVersion $solutionPath /bl /m
  
  if ($lastExitCode -ne 0) {
    throw "Build failed with an exit code of '$lastExitCode'."
  }
}

#
# Creates Fx & Adapter nuget packages
#
function Create-NugetPackages {
  $timer = Start-Timer

  Write-Log "Create-NugetPackages: Started."

  $stagingDir = Join-Path $env:TF_OUT_DIR $TFB_Configuration
  $packageOutDir = Join-Path $stagingDir "MSTestPackages"
  $tfSrcPackageDir = Join-Path $env:TF_SRC_DIR "Package"

  "" > "$stagingDir\_._"

  # Copy over the nuspecs to the staging directory
  if ($TFB_Official) {
    $nuspecFiles = @("MSTest.TestAdapter.nuspec", "MSTest.TestAdapter.symbols.nuspec", "MSTest.TestFramework.nuspec", "MSTest.TestFramework.symbols.nuspec", "MSTest.Internal.TestFx.Documentation.nuspec")
  }
  else {
    $nuspecFiles = @("MSTest.TestAdapter.Enu.nuspec", "MSTest.TestFramework.enu.nuspec")
  }

  foreach ($file in $nuspecFiles) {
    Copy-Item $tfSrcPackageDir\$file $stagingDir -Force
  }
  
  Copy-Item (Join-Path $tfSrcPackageDir "Icon.png") $stagingDir -Force

  Copy-Item -Path "$($env:TF_PACKAGES_DIR)\microsoft.testplatform.adapterutilities\$TestPlatformVersion\lib" -Destination "$($stagingDir)\Microsoft.TestPlatform.AdapterUtilities" -Recurse -Force

  # Copy over LICENSE file to staging directory
  $licenseFilePath = Join-Path $env:TF_ROOT_DIR "LICENSE"
  Copy-Item $licenseFilePath $stagingDir -Force

  # Call nuget pack on these components.
  $nugetExe = Locate-Nuget

  foreach ($file in $nuspecFiles) {
    $version = $TFB_FrameworkVersion
        
    if ($file.Contains("TestAdapter")) {
      $version = $TFB_AdapterVersion
    }

    if (![string]::IsNullOrEmpty($TFB_VersionSuffix)) {
      $versionSuffix = $TFB_VersionSuffix -replace "\.", "-"
      $version = $version + "-" + $versionSuffix
    }

    Write-Verbose "$nugetExe pack $stagingDir\$file -OutputDirectory $packageOutDir -Version $version -Properties Version=$version``;Srcroot=$env:TF_SRC_DIR``;Packagesroot=$env:TF_PACKAGES_DIR``;TestPlatformVersion=$TestPlatformVersion``;NOWARN=`"NU5127,NU5128,NU5129`""
    & $nugetExe pack $stagingDir\$file -OutputDirectory $packageOutDir -Version $version -Properties Version=$version`;Srcroot=$env:TF_SRC_DIR`;Packagesroot=$env:TF_PACKAGES_DIR`;TestPlatformVersion=$TestPlatformVersion`;NOWARN="NU5127,NU5128,NU5129"
    if ($lastExitCode -ne 0) {
      throw "Nuget pack failed with an exit code of '$lastExitCode'."
    }
  }

  Write-Log "Create-NugetPackages: Complete. {$(Get-ElapsedTime($timer))}"
}

function Replace-InFile($File, $RegEx, $ReplaceWith) {
  $content = Get-Content -Raw -Encoding utf8 $File 
  $newContent = ($content -replace $RegEx, $ReplaceWith)
  if (-not $content.Equals($newContent)) {
    Write-Log "Updating TestPlatform version in $File"
    $newContent | Set-Content -Encoding utf8 $File -NoNewline
  }
}

function Sync-PackageVersions {
  $versionsRegex = '(?mi)<(MicrosoftNETTestSdkVersion.*?)>(.*?)<\/MicrosoftNETTestSdkVersion>'
  $packageRegex = '(?mi)<package id="Microsoft\.TestPlatform([0-9a-z.]+)?" version="([0-9a-z.-]*)"'
  $sourceRegex = '(?mi)(.+[a-z =]+\@?\")Microsoft\.TestPlatform\.([0-9.-a-z]+)\";'

  if ([String]::IsNullOrWhiteSpace($TestPlatformVersion)) {
    $TestPlatformVersion = (([XML](Get-Content $TF_VERSIONS_FILE)).Project.PropertyGroup.MicrosoftNETTestSdkVersion).InnerText
  }
  else {
    Replace-InFile -File $TF_VERSIONS_FILE -RegEx $versionsRegex -ReplaceWith "<`$1>$TestPlatformVersion</MicrosoftNETTestSdkVersion>"
  }

  (Get-ChildItem "$PSScriptRoot\..\src\*packages.config", "$PSScriptRoot\..\test\*packages.config" -Recurse) | ForEach-Object {
    Replace-InFile -File $_ -RegEx $packageRegex -ReplaceWith ('<package id="Microsoft.TestPlatform$1" version="{0}"' -f $TestPlatformVersion)
  }

  Replace-InFile -File "$PSScriptRoot\..\test\E2ETests\Automation.CLI\CLITestBase.common.cs" -RegEx $sourceRegex -ReplaceWith ('$1Microsoft.TestPlatform.{0}";' -f $TestPlatformVersion)
}

function ShouldRunStep([string[]]$CurrentSteps) {
  if ($Force) {
    return $true
  }
  
  foreach ($step in $CurrentSteps) {
    if ($Steps -contains $step) {
      return $true
    }
  }

  return $false
}

Print-Help

if (ShouldRunStep @("UpdateTPVersion")) {
  Sync-PackageVersions
}

if (ShouldRunStep @("UpdateTPVersion", "Restore")) {
  Perform-Restore
}

if (ShouldRunStep @("Build")) {
  Perform-Build
}

if (ShouldRunStep @("Publish")) {
  Create-NugetPackages
}