forked from dotnet/command-line-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
31f2032
commit 3743f10
Showing
33 changed files
with
1,049 additions
and
260 deletions.
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,158 @@ | ||
param( | ||
[Parameter(Mandatory=$true)][string] $InputPath, # Full path to directory where NuGet packages to be checked are stored | ||
[Parameter(Mandatory=$true)][string] $ExtractPath, # Full path to directory where the packages will be extracted during validation | ||
[Parameter(Mandatory=$true)][string] $SymbolToolPath # Full path to directory where dotnet symbol-tool was installed | ||
) | ||
|
||
Add-Type -AssemblyName System.IO.Compression.FileSystem | ||
|
||
function FirstMatchingSymbolDescriptionOrDefault { | ||
param( | ||
[string] $FullPath, # Full path to the module that has to be checked | ||
[string] $TargetServerParam, # Parameter to pass to `Symbol Tool` indicating the server to lookup for symbols | ||
[string] $SymbolsPath | ||
) | ||
|
||
$FileName = [System.IO.Path]::GetFileName($FullPath) | ||
$Extension = [System.IO.Path]::GetExtension($FullPath) | ||
|
||
# Those below are potential symbol files that the `dotnet symbol` might | ||
# return. Which one will be returned depend on the type of file we are | ||
# checking and which type of file was uploaded. | ||
|
||
# The file itself is returned | ||
$SymbolPath = $SymbolsPath + "\" + $FileName | ||
|
||
# PDB file for the module | ||
$PdbPath = $SymbolPath.Replace($Extension, ".pdb") | ||
|
||
# PDB file for R2R module (created by crossgen) | ||
$NGenPdb = $SymbolPath.Replace($Extension, ".ni.pdb") | ||
|
||
# DBG file for a .so library | ||
$SODbg = $SymbolPath.Replace($Extension, ".so.dbg") | ||
|
||
# DWARF file for a .dylib | ||
$DylibDwarf = $SymbolPath.Replace($Extension, ".dylib.dwarf") | ||
|
||
.\dotnet-symbol.exe --symbols --modules --windows-pdbs $TargetServerParam $FullPath -o $SymbolsPath | Out-Null | ||
|
||
if (Test-Path $PdbPath) { | ||
return "PDB" | ||
} | ||
elseif (Test-Path $NGenPdb) { | ||
return "NGen PDB" | ||
} | ||
elseif (Test-Path $SODbg) { | ||
return "DBG for SO" | ||
} | ||
elseif (Test-Path $DylibDwarf) { | ||
return "Dwarf for Dylib" | ||
} | ||
elseif (Test-Path $SymbolPath) { | ||
return "Module" | ||
} | ||
else { | ||
return $null | ||
} | ||
} | ||
|
||
function CountMissingSymbols { | ||
param( | ||
[string] $PackagePath # Path to a NuGet package | ||
) | ||
|
||
# Ensure input file exist | ||
if (!(Test-Path $PackagePath)) { | ||
throw "Input file does not exist: $PackagePath" | ||
} | ||
|
||
# Extensions for which we'll look for symbols | ||
$RelevantExtensions = @(".dll", ".exe", ".so", ".dylib") | ||
|
||
# How many files are missing symbol information | ||
$MissingSymbols = 0 | ||
|
||
$PackageId = [System.IO.Path]::GetFileNameWithoutExtension($PackagePath) | ||
$PackageGuid = New-Guid | ||
$ExtractPath = Join-Path -Path $ExtractPath -ChildPath $PackageGuid | ||
$SymbolsPath = Join-Path -Path $ExtractPath -ChildPath "Symbols" | ||
|
||
[System.IO.Compression.ZipFile]::ExtractToDirectory($PackagePath, $ExtractPath) | ||
|
||
# Makes easier to reference `symbol tool` | ||
Push-Location $SymbolToolPath | ||
|
||
Get-ChildItem -Recurse $ExtractPath | | ||
Where-Object {$RelevantExtensions -contains $_.Extension} | | ||
ForEach-Object { | ||
if ($_.FullName -Match "\\ref\\") { | ||
Write-Host "`t Ignoring reference assembly file" $_.FullName | ||
return | ||
} | ||
|
||
$SymbolsOnMSDL = FirstMatchingSymbolDescriptionOrDefault $_.FullName "--microsoft-symbol-server" $SymbolsPath | ||
$SymbolsOnSymWeb = FirstMatchingSymbolDescriptionOrDefault $_.FullName "--internal-server" $SymbolsPath | ||
|
||
Write-Host -NoNewLine "`t Checking file" $_.FullName "... " | ||
|
||
if ($SymbolsOnMSDL -ne $null -and $SymbolsOnSymWeb -ne $null) { | ||
Write-Host "Symbols found on MSDL (" $SymbolsOnMSDL ") and SymWeb (" $SymbolsOnSymWeb ")" | ||
} | ||
else { | ||
$MissingSymbols++ | ||
|
||
if ($SymbolsOnMSDL -eq $null -and $SymbolsOnSymWeb -eq $null) { | ||
Write-Host "No symbols found on MSDL or SymWeb!" | ||
} | ||
else { | ||
if ($SymbolsOnMSDL -eq $null) { | ||
Write-Host "No symbols found on MSDL!" | ||
} | ||
else { | ||
Write-Host "No symbols found on SymWeb!" | ||
} | ||
} | ||
} | ||
} | ||
|
||
Pop-Location | ||
|
||
return $MissingSymbols | ||
} | ||
|
||
function CheckSymbolsAvailable { | ||
if (Test-Path $ExtractPath) { | ||
Remove-Item $ExtractPath -Force -Recurse -ErrorAction SilentlyContinue | ||
} | ||
|
||
Get-ChildItem "$InputPath\*.nupkg" | | ||
ForEach-Object { | ||
$FileName = $_.Name | ||
|
||
# These packages from Arcade-Services include some native libraries that | ||
# our current symbol uploader can't handle. Below is a workaround until | ||
# we get issue: https://github.com/dotnet/arcade/issues/2457 sorted. | ||
if ($FileName -Match "Microsoft\.DotNet\.Darc\.") { | ||
Write-Host "Ignoring Arcade-services file: $FileName" | ||
Write-Host | ||
return | ||
} | ||
elseif ($FileName -Match "Microsoft\.DotNet\.Maestro\.Tasks\.") { | ||
Write-Host "Ignoring Arcade-services file: $FileName" | ||
Write-Host | ||
return | ||
} | ||
|
||
Write-Host "Validating $FileName " | ||
$Status = CountMissingSymbols "$InputPath\$FileName" | ||
|
||
if ($Status -ne 0) { | ||
Write-Error "Missing symbols for $Status modules in the package $FileName" | ||
} | ||
|
||
Write-Host | ||
} | ||
} | ||
|
||
CheckSymbolsAvailable |
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
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,82 @@ | ||
<!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the LICENSE file in the project root for more information. --> | ||
<Project Sdk="Microsoft.NET.Sdk"> | ||
<!-- | ||
This MSBuild file is intended to be used as the body of the default | ||
publishing release pipeline. The release pipeline will use this file | ||
to invoke the PublishSymbols tasks to publish symbols to MSDL and SymWeb. | ||
Parameters: | ||
- PDBArtifactsDirectory : Full path to directory containing PDB files to be published. | ||
- BlobBasePath : Full path containing *.symbols.nupkg packages to be published. | ||
- DotNetSymbolServerTokenMsdl : PAT to access MSDL. | ||
- DotNetSymbolServerTokenSymWeb : PAT to access SymWeb. | ||
- DotNetSymbolExpirationInDays : Expiration days for published packages. Default is 3650. | ||
--> | ||
|
||
<PropertyGroup> | ||
<TargetFramework>netcoreapp2.1</TargetFramework> | ||
</PropertyGroup> | ||
|
||
<Import Project="$(NuGetPackageRoot)microsoft.symboluploader.build.task\$(SymbolUploaderVersion)\build\PublishSymbols.targets" /> | ||
|
||
<Target Name="PublishSymbols"> | ||
<ItemGroup> | ||
<FilesToPublishToSymbolServer Include="$(PDBArtifactsDirectory)\*.pdb"/> | ||
<PackagesToPublishToSymbolServer Include="$(BlobBasePath)\*.symbols.nupkg"/> | ||
|
||
<!-- | ||
These packages from Arcade-Services include some native libraries that | ||
our current symbol uploader can't handle. Below is a workaround until | ||
we get issue: https://github.com/dotnet/arcade/issues/2457 sorted. | ||
--> | ||
<PackagesToPublishToSymbolServer Remove="$(BlobBasePath)\Microsoft.DotNet.Darc.*" /> | ||
<PackagesToPublishToSymbolServer Remove="$(BlobBasePath)\Microsoft.DotNet.Maestro.Tasks.*" /> | ||
</ItemGroup> | ||
|
||
<PropertyGroup> | ||
<DotNetSymbolExpirationInDays Condition="'$(DotNetSymbolExpirationInDays)' == ''">3650</DotNetSymbolExpirationInDays> | ||
<PublishToSymbolServer>true</PublishToSymbolServer> | ||
<PublishToSymbolServer Condition="'@(FilesToPublishToSymbolServer)' == '' and '@(PackagesToPublishToSymbolServer)' == ''">false</PublishToSymbolServer> | ||
</PropertyGroup> | ||
|
||
<Message | ||
Importance="High" | ||
Text="No symbol package(s) were found to publish." | ||
Condition="$(PublishToSymbolServer) == false" /> | ||
|
||
<!-- Symbol Uploader: MSDL --> | ||
<Message Importance="High" Text="Publishing symbol packages to MSDL ..." Condition="$(PublishToSymbolServer)" /> | ||
<PublishSymbols PackagesToPublish="@(PackagesToPublishToSymbolServer)" | ||
FilesToPublish="@(FilesToPublishToSymbolServer)" | ||
PersonalAccessToken="$(DotNetSymbolServerTokenMsdl)" | ||
SymbolServerPath="https://microsoftpublicsymbols.artifacts.visualstudio.com/DefaultCollection" | ||
ExpirationInDays="$(DotNetSymbolExpirationInDays)" | ||
VerboseLogging="true" | ||
DryRun="false" | ||
ConvertPortablePdbsToWindowsPdbs="false" | ||
PdbConversionTreatAsWarning="" | ||
Condition="$(PublishToSymbolServer)"/> | ||
|
||
<!-- | ||
Symbol Uploader: SymWeb | ||
Watson, VS insertion testings and the typical internal dev usage require SymWeb. | ||
Currently we need to call the task twice (https://github.com/dotnet/core-eng/issues/3489). | ||
--> | ||
<Message Importance="High" Text="Publishing symbol packages to SymWeb ..." Condition="$(PublishToSymbolServer)" /> | ||
<PublishSymbols PackagesToPublish="@(PackagesToPublishToSymbolServer)" | ||
FilesToPublish="@(FilesToPublishToSymbolServer)" | ||
PersonalAccessToken="$(DotNetSymbolServerTokenSymWeb)" | ||
SymbolServerPath="https://microsoft.artifacts.visualstudio.com/DefaultCollection" | ||
ExpirationInDays="$(DotNetSymbolExpirationInDays)" | ||
VerboseLogging="true" | ||
DryRun="false" | ||
ConvertPortablePdbsToWindowsPdbs="false" | ||
PdbConversionTreatAsWarning="" | ||
Condition="$(PublishToSymbolServer)"/> | ||
</Target> | ||
|
||
<ItemGroup> | ||
<PackageReference Include="Microsoft.SymbolUploader.Build.Task" Version="$(SymbolUploaderVersion)" /> | ||
</ItemGroup> | ||
</Project> |
Oops, something went wrong.