Apply latest Library.Template

.gitignore

@@ -140,6 +140,7 @@ _TeamCity*
 # Visual Studio code coverage results
 *.coverage
 *.coveragexml
+/coveragereport/
 
 # NCrunch
 _NCrunch_*

Directory.Build.props

@@ -23,7 +23,7 @@
     <DebugType>embedded</DebugType>
 
     <SignAssembly>true</SignAssembly>
-    <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)\strongname.snk</AssemblyOriginatorKeyFile>
+    <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)strongname.snk</AssemblyOriginatorKeyFile>
 
     <Authors>Andrew Arnott</Authors>
     <Owners>aarnott</Owners>
@@ -42,9 +42,9 @@
   <ItemGroup>
     <PackageReference Include="CSharpIsNullAnalyzer" Version="0.1.300" PrivateAssets="all" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="all" />
-    <PackageReference Include="Nullable" Version="1.3.0" PrivateAssets="all" />
+    <PackageReference Include="Nullable" Version="1.3.1" PrivateAssets="all" />
     <!-- Use the Unstable package ID so that update tools will help us keep it current even though it seems to be ever-unstable lately. -->
-    <PackageReference Include="StyleCop.Analyzers.Unstable" Version="1.2.0.406" PrivateAssets="all" />
+    <PackageReference Include="StyleCop.Analyzers.Unstable" Version="1.2.0.435" PrivateAssets="all" />
   </ItemGroup>
   <ItemGroup>
     <None Include="$(MSBuildThisFileDirectory)3rdPartyNotices.txt" Pack="true" PackagePath="" />
@@ -81,7 +81,7 @@
     It's also not necessary to generate these assets.
   -->
   <PropertyGroup Condition="'$(IsWpfTempProject)' == 'true'">
-    <_WpfTempProjectNuGetFilePathNoExt>$(RepoRootPath)obj\$(_TargetAssemblyProjectName)\$(_TargetAssemblyProjectName)$(MSBuildProjectExtension).nuget.g</_WpfTempProjectNuGetFilePathNoExt>
+    <_WpfTempProjectNuGetFilePathNoExt>$(BaseIntermediateOutputPath)..\$(_TargetAssemblyProjectName)\$(_TargetAssemblyProjectName)$(MSBuildProjectExtension).nuget.g</_WpfTempProjectNuGetFilePathNoExt>
 
     <EnableSourceLink>false</EnableSourceLink>
     <EmbedUntrackedSources>false</EmbedUntrackedSources>

azure-pipelines.yml

@@ -13,6 +13,12 @@ trigger:
     - .github/
     - azure-pipelines/release.yml
 
+parameters:
+- name: RunTests
+  displayName: Run tests
+  type: boolean
+  default: true
+
 resources:
   containers:
   - container: xenial
@@ -37,9 +43,12 @@ stages:
 - stage: Build
   jobs:
   - template: azure-pipelines/build.yml
+    parameters:
+      RunTests: ${{ parameters.RunTests }}
 
 - stage: Test
   displayName: Functional testing
+  condition: and(succeeded(), ${{ parameters.RunTests }})
   jobs:
   - job: linux
     strategy:

azure-pipelines/Get-CodeCovTool.ps1

@@ -0,0 +1,86 @@
+<#
+.SYNOPSIS
+    Downloads the CodeCov.io uploader tool and returns the path to it.
+.PARAMETER AllowSkipVerify
+    Allows skipping signature verification of the downloaded tool if gpg is not installed.
+#>
+[CmdletBinding()]
+Param(
+    [switch]$AllowSkipVerify
+)
+
+if ($IsMacOS) {
+    $codeCovUrl = "https://uploader.codecov.io/latest/macos/codecov"
+    $toolName = 'codecov'
+}
+elseif ($IsLinux) {
+    $codeCovUrl = "https://uploader.codecov.io/latest/linux/codecov"
+    $toolName = 'codecov'
+}
+else {
+    $codeCovUrl = "https://uploader.codecov.io/latest/windows/codecov.exe"
+    $toolName = 'codecov.exe'
+}
+
+$shaSuffix = ".SHA256SUM"
+$sigSuffix = $shaSuffix + ".sig"
+
+Function Get-FileFromWeb([Uri]$Uri, $OutDir) {
+    $OutFile = Join-Path $OutDir $Uri.Segments[-1]
+    if (!(Test-Path $OutFile)) {
+        Write-Verbose "Downloading $Uri..."
+        if (!(Test-Path $OutDir)) { New-Item -ItemType Directory -Path $OutDir | Out-Null }
+        try {
+            (New-Object System.Net.WebClient).DownloadFile($Uri, $OutFile)
+        } finally {
+            # This try/finally causes the script to abort
+        }
+    }
+
+    $OutFile
+}
+
+$toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1"
+$binaryToolsPath = Join-Path $toolsPath codecov
+$testingPath = Join-Path $binaryToolsPath unverified
+$finalToolPath = Join-Path $binaryToolsPath $toolName
+
+if (!(Test-Path $finalToolPath)) {
+    if (Test-Path $testingPath) {
+        Remove-Item -Recurse -Force $testingPath # ensure we download all matching files
+    }
+    $tool = Get-FileFromWeb $codeCovUrl $testingPath
+    $sha = Get-FileFromWeb "$codeCovUrl$shaSuffix" $testingPath
+    $sig = Get-FileFromWeb "$codeCovUrl$sigSuffix" $testingPath
+    $key = Get-FileFromWeb https://keybase.io/codecovsecurity/pgp_keys.asc $testingPath
+
+    if ((Get-Command gpg -ErrorAction SilentlyContinue)) {
+        Write-Host "Importing codecov key" -ForegroundColor Yellow
+        gpg --import $key
+        Write-Host "Verifying signature on codecov hash" -ForegroundColor Yellow
+        gpg --verify $sig $sha
+    } else {
+        if ($AllowSkipVerify) {
+            Write-Warning "gpg not found. Unable to verify hash signature."
+        } else {
+            throw "gpg not found. Unable to verify hash signature. Install gpg or add -AllowSkipVerify to override."
+        }
+    }
+
+    Write-Host "Verifying hash on downloaded tool" -ForegroundColor Yellow
+    $actualHash = (Get-FileHash -Path $tool -Algorithm SHA256).Hash
+    $expectedHash = (Get-Content $sha).Split()[0]
+    if ($actualHash -ne $expectedHash) {
+        # Validation failed. Delete the tool so we can't execute it.
+        #Remove-Item $codeCovPath
+        throw "codecov uploader tool failed signature validation."
+    }
+
+    Copy-Item $tool $finalToolPath
+
+    if ($IsMacOS -or $IsLinux) {
+        chmod u+x $finalToolPath
+    }
+}
+
+return $finalToolPath

azure-pipelines/Get-SymbolFiles.ps1

@@ -18,7 +18,7 @@ Write-Progress -Activity $ActivityName -CurrentOperation "Discovery PDB files"
 $PDBs = Get-ChildItem -rec "$Path/*.pdb"
 
 # Filter PDBs to product OR test related.
-$testregex = "unittest|tests"
+$testregex = "unittest|tests|\.test\."
 
 Write-Progress -Activity $ActivityName -CurrentOperation "De-duplicating symbols"
 $PDBsByHash = @{}
@@ -49,8 +49,13 @@ $PDBs |% {
         $BinaryImagePath = $dllPath
     } elseif (Test-Path $exePath) {
         $BinaryImagePath = $exePath
+    } else {
+        Write-Warning "`"$_`" found with no matching binary file."
+        $BinaryImagePath = $null
     }
 
-    Write-Output $BinaryImagePath
-    Write-Output $_.FullName
+    if ($BinaryImagePath) {
+        Write-Output $BinaryImagePath
+        Write-Output $_.FullName
+    }
 }

azure-pipelines/Merge-CodeCoverage.ps1

@@ -0,0 +1,46 @@
+#!/usr/bin/env pwsh
+
+<#
+.SYNOPSIS
+    Merges code coverage reports.
+.PARAMETER Path
+    The path(s) to search for Cobertura code coverage reports.
+.PARAMETER Format
+    The format for the merged result. The default is Cobertura
+.PARAMETER OutputDir
+    The directory the merged result will be written to. The default is `coveragereport` in the root of this repo.
+#>
+[CmdletBinding()]
+Param(
+    [Parameter(Mandatory=$true)]
+    [string[]]$Path,
+    [ValidateSet('Badges', 'Clover', 'Cobertura', 'CsvSummary', 'Html', 'Html_Dark', 'Html_Light', 'HtmlChart', 'HtmlInline', 'HtmlInline_AzurePipelines', 'HtmlInline_AzurePipelines_Dark', 'HtmlInline_AzurePipelines_Light', 'HtmlSummary', 'JsonSummary', 'Latex', 'LatexSummary', 'lcov', 'MarkdownSummary', 'MHtml', 'PngChart', 'SonarQube', 'TeamCitySummary', 'TextSummary', 'Xml', 'XmlSummary')]
+    [string]$Format='Cobertura',
+    [string]$OutputDir=("$PSScriptRoot/../coveragereport")
+)
+
+$RepoRoot = [string](Resolve-Path $PSScriptRoot/..)
+
+if (!(Test-Path $RepoRoot/obj/reportgenerator*)) {
+    dotnet tool install --tool-path $RepoRoot/obj dotnet-reportgenerator-globaltool --version 5.1.9 --configfile $PSScriptRoot/justnugetorg.nuget.config
+}
+
+Write-Verbose "Searching $Path for *.cobertura.xml files"
+$reports = Get-ChildItem -Recurse $Path -Filter *.cobertura.xml
+
+if ($reports) {
+    $reports |% { $_.FullName } |% {
+        # In addition to replacing {reporoot}, we also normalize on one kind of slash so that the report aggregates data for a file whether data was collected on Windows or not.
+        $xml = [xml](Get-Content -Path $_)
+        $xml.coverage.packages.package.classes.class |? { $_.filename} |% {
+            $_.filename = $_.filename.Replace('{reporoot}', $RepoRoot).Replace([IO.Path]::AltDirectorySeparatorChar, [IO.Path]::DirectorySeparatorChar)
+        }
+
+        $xml.Save($_)
+    }
+
+    $Inputs = [string]::join(';', ($reports |% { Resolve-Path -relative $_.FullName }))
+    & "$RepoRoot/obj/reportgenerator" -reports:"$Inputs" -targetdir:$OutputDir -reporttypes:$Format
+} else {
+    Write-Error "No reports found to merge."
+}

azure-pipelines/artifacts/_all.ps1

@@ -15,6 +15,7 @@
     Executes artifact scripts even if they have already been staged.
 #>
 
+[CmdletBinding(SupportsShouldProcess = $true)]
 param (
     [string]$ArtifactNameSuffix,
     [switch]$Force

azure-pipelines/artifacts/_pipelines.ps1

@@ -1,6 +1,10 @@
-# This script translates all the artifacts described by _all.ps1
-# into commands that instruct Azure Pipelines to actually collect those artifacts.
+<#
+.SYNOPSIS
+    This script translates all the artifacts described by _all.ps1
+    into commands that instruct Azure Pipelines to actually collect those artifacts.
+#>
 
+[CmdletBinding()]
 param (
     [string]$ArtifactNameSuffix,
     [switch]$StageOnly

azure-pipelines/artifacts/_stage_all.ps1

@@ -1,6 +1,10 @@
-# This script links all the artifacts described by _all.ps1
-# into a staging directory, reading for uploading to a cloud build artifact store.
-# It returns a sequence of objects with Name and Path properties.
+<#
+.SYNOPSIS
+    This script links all the artifacts described by _all.ps1
+    into a staging directory, reading for uploading to a cloud build artifact store.
+    It returns a sequence of objects with Name and Path properties.
+#>
+
 [CmdletBinding()]
 param (
     [string]$ArtifactNameSuffix

azure-pipelines/artifacts/coverageResults.ps1

@@ -1,10 +1,11 @@
 $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..")
 
+$coverageFiles = @(Get-ChildItem "$RepoRoot/test/*.cobertura.xml" -Recurse | Where {$_.FullName -notlike "*/In/*"  -and $_.FullName -notlike "*\In\*" })
+
 # Prepare code coverage reports for merging on another machine
 if ($env:SYSTEM_DEFAULTWORKINGDIRECTORY) {
     Write-Host "Substituting $env:SYSTEM_DEFAULTWORKINGDIRECTORY with `"{reporoot}`""
-    $reports = Get-ChildItem "$RepoRoot/bin/coverage.*cobertura.xml" -Recurse
-    $reports |% {
+    $coverageFiles |% {
         $content = Get-Content -Path $_ |% { $_ -Replace [regex]::Escape($env:SYSTEM_DEFAULTWORKINGDIRECTORY), "{reporoot}" }
         Set-Content -Path $_ -Value $content -Encoding UTF8
     }
@@ -16,7 +17,7 @@ if (!((Test-Path $RepoRoot\bin) -and (Test-Path $RepoRoot\obj))) { return }
 
 @{
     $RepoRoot = (
-        @(Get-ChildItem "$RepoRoot\bin\coverage.*cobertura.xml" -Recurse) +
+        $coverageFiles +
         (Get-ChildItem "$RepoRoot\obj\*.cs" -Recurse)
     );
 }

azure-pipelines/artifacts/testResults.ps1

@@ -1,16 +1,11 @@
+[CmdletBinding()]
+Param(
+)
+
 $result = @{}
 
-if ($env:AGENT_TEMPDIRECTORY) {
-    # The DotNetCoreCLI uses an alternate location to publish these files
-    $guidRegex = '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$'
-    $result[$env:AGENT_TEMPDIRECTORY] = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% {
-        Get-ChildItem "$($_.FullName)\dotnet*.dmp","$($_.FullName)\*_crashdump.dmp","$($_.FullName)\testhost*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse
-    });
-}
-else {
-    $testRoot = Resolve-Path "$PSScriptRoot\..\..\test"
-    $result[$testRoot] = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File)
-}
+$testRoot = Resolve-Path "$PSScriptRoot\..\..\test"
+$result[$testRoot] = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File)
 
 $testlogsPath = "$env:BUILD_ARTIFACTSTAGINGDIRECTORY\test_logs"
 if (Test-Path $testlogsPath) {

azure-pipelines/build.yml

@@ -3,6 +3,9 @@ parameters:
   type: object
   default:
     vmImage: windows-2022
+- name: RunTests
+  type: boolean
+  default: true
 
 jobs:
 - job: Windows
@@ -21,24 +24,26 @@ jobs:
       Invoke-WebRequest -Uri "https://dot.net/v1/dotnet-install.ps1" -OutFile dotnet-install.ps1
       & .\dotnet-install.ps1 -Architecture x86 -Channel 3.1 -InstallDir "C:\Program Files (x86)\dotnet\" -NoPath -Verbose -Runtime dotnet
       & .\dotnet-install.ps1 -Architecture x86 -Version 6.0.301 -InstallDir "C:\Program Files (x86)\dotnet\" -NoPath -Verbose
-    displayName: Install 32-bit .NET SDK and runtimes
+    displayName: ⚙ Install 32-bit .NET SDK and runtimes
 
   - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud -c'
-    displayName: Set build number
+    displayName: ⚙ Set build number
 
   - template: dotnet.yml
+    parameters:
+      RunTests: ${{ parameters.RunTests }}
 
 - job: Linux
   pool:
     vmImage: Ubuntu 20.04
-  variables:
-    testModifier: -f net6.0
   steps:
   - checkout: self
     clean: true
     submodules: true # keep the warnings quiet about the wiki not being enlisted
   - template: install-dependencies.yml
   - template: dotnet.yml
+    parameters:
+      RunTests: ${{ parameters.RunTests }}
 
 - job: WrapUp
   dependsOn:
@@ -52,5 +57,6 @@ jobs:
   - template: install-dependencies.yml
     parameters:
       initArgs: -NoRestore
-  - template: publish-codecoverage.yml
+  - ${{ if parameters.RunTests }}:
+    - template: publish-codecoverage.yml
   - template: publish-deployables.yml

azure-pipelines/dotnet-test-cloud.ps1

@@ -48,7 +48,8 @@ if ($x86) {
     --no-build `
     -c $Configuration `
     --filter "TestCategory!=FailsInCloudTest" `
-    -p:CollectCoverage=true `
+    --collect "Code Coverage;Format=cobertura" `
+    --settings "$PSScriptRoot/test.runsettings" `
     --blame-hang-timeout 60s `
     --blame-crash `
     -bl:"$ArtifactStagingFolder/build_logs/test.binlog" `