eng/common/CheckSymbols.ps1

   1 param(
   2   [Parameter(Mandatory=$true)][string] $InputPath,       # Full path to directory where NuGet packages to be checked are stored
   3   [Parameter(Mandatory=$true)][string] $ExtractPath,     # Full path to directory where the packages will be extracted during validation
   4   [Parameter(Mandatory=$true)][string] $SymbolToolPath   # Full path to directory where dotnet symbol-tool was installed
   5 )
   6
   7 Add-Type -AssemblyName System.IO.Compression.FileSystem
   8 . $PSScriptRoot\pipeline-logging-functions.ps1
   9
  10 function FirstMatchingSymbolDescriptionOrDefault {
  11   param(
  12     [string] $FullPath,                  # Full path to the module that has to be checked
  13     [string] $TargetServerParameter,         # Parameter to pass to `Symbol Tool` indicating the server to lookup for symbols
  14     [string] $SymbolsPath
  15   )
  16
  17   $FileName = [System.IO.Path]::GetFileName($FullPath)
  18   $Extension = [System.IO.Path]::GetExtension($FullPath)
  19
  20   # Those below are potential symbol files that the `dotnet symbol` might
  21   # return. Which one will be returned depend on the type of file we are
  22   # checking and which type of file was uploaded.
  23
  24   # The file itself is returned
  25   $SymbolPath = $SymbolsPath + '\' + $FileName
  26
  27   # PDB file for the module
  28   $PdbPath = $SymbolPath.Replace($Extension, '.pdb')
  29
  30   # PDB file for R2R module (created by crossgen)
  31   $NGenPdb = $SymbolPath.Replace($Extension, '.ni.pdb')
  32
  33   # DBG file for a .so library
  34   $SODbg = $SymbolPath.Replace($Extension, '.so.dbg')
  35
  36   # DWARF file for a .dylib
  37   $DylibDwarf = $SymbolPath.Replace($Extension, '.dylib.dwarf')
  38
  39   .\dotnet-symbol.exe --symbols --modules --windows-pdbs $TargetServerParameter $FullPath -o $SymbolsPath | Out-Null
  40
  41   if (Test-Path $PdbPath) {
  42     return 'PDB'
  43   }
  44   elseif (Test-Path $NGenPdb) {
  45     return 'NGen PDB'
  46   }
  47   elseif (Test-Path $SODbg) {
  48     return 'DBG for SO'
  49   }
  50   elseif (Test-Path $DylibDwarf) {
  51     return 'Dwarf for Dylib'
  52   }
  53   elseif (Test-Path $SymbolPath) {
  54     return 'Module'
  55   }
  56   else {
  57     return $null
  58   }
  59 }
  60
  61 function CountMissingSymbols {
  62   param(
  63     [string] $PackagePath          # Path to a NuGet package
  64   )
  65
  66   # Ensure input file exist
  67   if (!(Test-Path $PackagePath)) {
  68     throw "Input file does not exist: $PackagePath"
  69   }
  70
  71   # Extensions for which we'll look for symbols
  72   $RelevantExtensions = @('.dll', '.exe', '.so', '.dylib')
  73
  74   # How many files are missing symbol information
  75   $MissingSymbols = 0
  76
  77   $PackageId = [System.IO.Path]::GetFileNameWithoutExtension($PackagePath)
  78   $PackageGuid = New-Guid
  79   $ExtractPath = Join-Path -Path $ExtractPath -ChildPath $PackageGuid
  80   $SymbolsPath = Join-Path -Path $ExtractPath -ChildPath 'Symbols'
  81
  82   [System.IO.Compression.ZipFile]::ExtractToDirectory($PackagePath, $ExtractPath)
  83
  84   # Makes easier to reference `symbol tool`
  85   Push-Location $SymbolToolPath
  86
  87   Get-ChildItem -Recurse $ExtractPath |
  88     Where-Object {$RelevantExtensions -contains $_.Extension} |
  89     ForEach-Object {
  90       if ($_.FullName -Match '\\ref\\') {
  91         Write-Host "`t Ignoring reference assembly file" $_.FullName
  92         return
  93       }
  94
  95       $SymbolsOnMSDL = FirstMatchingSymbolDescriptionOrDefault -FullPath $_.FullName  -TargetServerParameter '--microsoft-symbol-server' -SymbolsPath $SymbolsPath
  96       $SymbolsOnSymWeb = FirstMatchingSymbolDescriptionOrDefault -FullPath $_.FullName -TargetServerParameter '--internal-server' -SymbolsPath $SymbolsPath
  97
  98       Write-Host -NoNewLine "`t Checking file" $_.FullName "... "
  99
 100       if ($SymbolsOnMSDL -ne $null -and $SymbolsOnSymWeb -ne $null) {
 101         Write-Host "Symbols found on MSDL (${$SymbolsOnMSDL}) and SymWeb (${$SymbolsOnSymWeb})"
 102       }
 103       else {
 104         $MissingSymbols++
 105
 106         if ($SymbolsOnMSDL -eq $null -and $SymbolsOnSymWeb -eq $null) {
 107           Write-Host 'No symbols found on MSDL or SymWeb!'
 108         }
 109         else {
 110           if ($SymbolsOnMSDL -eq $null) {
 111             Write-Host 'No symbols found on MSDL!'
 112           }
 113           else {
 114             Write-Host 'No symbols found on SymWeb!'
 115           }
 116         }
 117       }
 118     }
 119
 120   Pop-Location
 121
 122   return $MissingSymbols
 123 }
 124
 125 function CheckSymbolsAvailable {
 126   if (Test-Path $ExtractPath) {
 127     Remove-Item $ExtractPath -Force  -Recurse -ErrorAction SilentlyContinue
 128   }
 129
 130   Get-ChildItem "$InputPath\*.nupkg" |
 131     ForEach-Object {
 132       $FileName = $_.Name
 133
 134       # These packages from Arcade-Services include some native libraries that
 135       # our current symbol uploader can't handle. Below is a workaround until
 136       # we get issue: https://github.com/dotnet/arcade/issues/2457 sorted.
 137       if ($FileName -Match 'Microsoft\.DotNet\.Darc\.') {
 138         Write-Host "Ignoring Arcade-services file: $FileName"
 139         Write-Host
 140         return
 141       }
 142       elseif ($FileName -Match 'Microsoft\.DotNet\.Maestro\.Tasks\.') {
 143         Write-Host "Ignoring Arcade-services file: $FileName"
 144         Write-Host
 145         return
 146       }
 147
 148       Write-Host "Validating $FileName "
 149       $Status = CountMissingSymbols "$InputPath\$FileName"
 150
 151       if ($Status -ne 0) {
 152         Write-PipelineTelemetryError -Category 'CheckSymbols' -Message "Missing symbols for $Status modules in the package $FileName"
 153       }
 154
 155       Write-Host
 156     }
 157 }
 158
 159 CheckSymbolsAvailable