|
| 1 | +<# |
| 2 | +.SYNOPSIS |
| 3 | + Verifies that symbols (PDBs) for a single DLL are available on a symbol server. |
| 4 | +
|
| 5 | +.DESCRIPTION |
| 6 | + This script is called by the validate-symbols-job.yml Azure Pipelines job, |
| 7 | + once per package per symbol server. It: |
| 8 | + 1. Locates the .nupkg file in the downloaded artifact directory. |
| 9 | + 2. Extracts the package contents (skipped if already extracted). |
| 10 | + 3. Runs symchk.exe to verify that matching PDBs are available on the |
| 11 | + specified symbol server. |
| 12 | +
|
| 13 | + The script exits with a non-zero exit code if verification fails. |
| 14 | +
|
| 15 | +.PARAMETER ArtifactPath |
| 16 | + The directory containing the downloaded pipeline artifact (.nupkg files). |
| 17 | +
|
| 18 | +.PARAMETER ExtractPath |
| 19 | + The directory where the package will be extracted. |
| 20 | +
|
| 21 | +.PARAMETER PackageName |
| 22 | + The NuGet package name prefix used to locate the .nupkg file |
| 23 | + (e.g. "Microsoft.Data.SqlClient"). |
| 24 | +
|
| 25 | +.PARAMETER DllPath |
| 26 | + The relative path to the DLL inside the extracted package |
| 27 | + (e.g. "lib\net8.0\Microsoft.Data.SqlClient.dll"). |
| 28 | +
|
| 29 | +.PARAMETER SymbolServerUrl |
| 30 | + The symbol server URL that symchk can query |
| 31 | + (e.g. "https://msdl.microsoft.com/download/symbols"). |
| 32 | +
|
| 33 | +.PARAMETER SymbolServerName |
| 34 | + A friendly display name for the symbol server, used in log output. |
| 35 | +
|
| 36 | +.PARAMETER MaxRetries |
| 37 | + Maximum number of attempts when symbols are not yet available. The |
| 38 | + first attempt runs immediately; subsequent attempts wait |
| 39 | + RetryIntervalSeconds between them. Defaults to 10 (~5 minutes total |
| 40 | + with default interval). |
| 41 | +
|
| 42 | +.PARAMETER RetryIntervalSeconds |
| 43 | + Seconds to wait between retry attempts (default 30). |
| 44 | +
|
| 45 | +.EXAMPLE |
| 46 | + .\validate-symbols.ps1 ` |
| 47 | + -ArtifactPath "C:\agent\_work\1\drop_SqlClient" ` |
| 48 | + -ExtractPath "C:\agent\_work\1\s\symchk_packages\Microsoft.Data.SqlClient" ` |
| 49 | + -PackageName "Microsoft.Data.SqlClient" ` |
| 50 | + -DllPath "lib\net8.0\Microsoft.Data.SqlClient.dll" ` |
| 51 | + -SymbolServerUrl "https://msdl.microsoft.com/download/symbols" ` |
| 52 | + -SymbolServerName "MSDL (Public)" |
| 53 | +#> |
| 54 | + |
| 55 | +[CmdletBinding()] |
| 56 | +param( |
| 57 | + [Parameter(Mandatory)] |
| 58 | + [string]$ArtifactPath, |
| 59 | + |
| 60 | + [Parameter(Mandatory)] |
| 61 | + [string]$ExtractPath, |
| 62 | + |
| 63 | + [Parameter(Mandatory)] |
| 64 | + [string]$PackageName, |
| 65 | + |
| 66 | + [Parameter(Mandatory)] |
| 67 | + [string]$DllPath, |
| 68 | + |
| 69 | + [Parameter(Mandatory)] |
| 70 | + [string]$SymbolServerUrl, |
| 71 | + |
| 72 | + [Parameter(Mandatory)] |
| 73 | + [string]$SymbolServerName, |
| 74 | + |
| 75 | + [int]$MaxRetries = 10, |
| 76 | + |
| 77 | + [int]$RetryIntervalSeconds = 30 |
| 78 | +) |
| 79 | + |
| 80 | +Set-StrictMode -Version Latest |
| 81 | +$ErrorActionPreference = 'Stop' |
| 82 | + |
| 83 | +# -- Extract the package (skip if already done) -------------------------------- |
| 84 | + |
| 85 | +$dllFullPath = Join-Path $ExtractPath $DllPath |
| 86 | + |
| 87 | +if (-not (Test-Path $dllFullPath)) { |
| 88 | + Write-Host "Extracting $PackageName" |
| 89 | + |
| 90 | + New-Item -ItemType Directory -Force -Path $ExtractPath | Out-Null |
| 91 | + |
| 92 | + $nupkg = Get-ChildItem -Path $ArtifactPath -Filter "$PackageName.*.nupkg" ` |
| 93 | + | Where-Object { $_.Name -notlike '*.snupkg' } ` |
| 94 | + | Select-Object -First 1 |
| 95 | + |
| 96 | + if (-not $nupkg) { |
| 97 | + Write-Host "##vso[task.logissue type=error]No $PackageName nupkg found in $ArtifactPath" |
| 98 | + exit 1 |
| 99 | + } |
| 100 | + |
| 101 | + Write-Host "Found: $($nupkg.FullName)" |
| 102 | + |
| 103 | + $zipPath = Join-Path $ExtractPath 'package.zip' |
| 104 | + Copy-Item $nupkg.FullName $zipPath |
| 105 | + Expand-Archive -Path $zipPath -DestinationPath $ExtractPath -Force |
| 106 | + Remove-Item $zipPath |
| 107 | +} |
| 108 | + |
| 109 | +if (-not (Test-Path $dllFullPath)) { |
| 110 | + Write-Host "##vso[task.logissue type=error]DLL not found after extraction: $dllFullPath" |
| 111 | + exit 1 |
| 112 | +} |
| 113 | + |
| 114 | +# -- Locate symchk.exe --------------------------------------------------------- |
| 115 | + |
| 116 | +$symchkCandidates = @( |
| 117 | + "${env:ProgramFiles(x86)}\Windows Kits\10\Debuggers\x64\symchk.exe" |
| 118 | + "${env:ProgramFiles}\Windows Kits\10\Debuggers\x64\symchk.exe" |
| 119 | +) |
| 120 | + |
| 121 | +$symchkPath = $null |
| 122 | +foreach ($candidate in $symchkCandidates) { |
| 123 | + if (Test-Path $candidate) { |
| 124 | + $symchkPath = $candidate |
| 125 | + break |
| 126 | + } |
| 127 | +} |
| 128 | + |
| 129 | +if (-not $symchkPath) { |
| 130 | + Write-Host "##vso[task.logissue type=error]symchk.exe not found. Ensure Debugging Tools for Windows are installed." |
| 131 | + exit 1 |
| 132 | +} |
| 133 | + |
| 134 | +# -- Verify symbols (with retries for publishing latency) ---------------------- |
| 135 | + |
| 136 | +$dllLeaf = Split-Path $dllFullPath -Leaf |
| 137 | + |
| 138 | +Write-Host "Verifying symbols for $dllLeaf on $SymbolServerName ($SymbolServerUrl)" |
| 139 | +Write-Host "Using symchk: $symchkPath" |
| 140 | +Write-Host "Max attempts: $MaxRetries, interval: ${RetryIntervalSeconds}s" |
| 141 | + |
| 142 | +$symchkArgs = @( |
| 143 | + $dllFullPath, |
| 144 | + "/s", "srv*$SymbolServerUrl", |
| 145 | + "/os" |
| 146 | +) |
| 147 | + |
| 148 | +for ($attempt = 1; $attempt -le $MaxRetries; $attempt++) { |
| 149 | + Write-Host "Attempt $attempt of $MaxRetries -- running: symchk $($symchkArgs -join ' ')" |
| 150 | + $output = & $symchkPath @symchkArgs 2>&1 | Out-String |
| 151 | + $symchkExit = $LASTEXITCODE |
| 152 | + |
| 153 | + Write-Host $output |
| 154 | + |
| 155 | + $passed = ($symchkExit -eq 0) -and |
| 156 | + ($output -match "FAILED files = 0") -and |
| 157 | + ($output -match "PASSED \+ IGNORED files = [1-9]") |
| 158 | + |
| 159 | + if ($passed) { |
| 160 | + Write-Host "Symbols verified successfully for $dllLeaf on $SymbolServerName" |
| 161 | + exit 0 |
| 162 | + } |
| 163 | + |
| 164 | + if ($attempt -lt $MaxRetries) { |
| 165 | + Write-Host "Symbols not yet available. Retrying in $RetryIntervalSeconds seconds..." |
| 166 | + Start-Sleep -Seconds $RetryIntervalSeconds |
| 167 | + } |
| 168 | +} |
| 169 | + |
| 170 | +Write-Host "##vso[task.logissue type=error]symchk could not verify symbols for $dllLeaf on $SymbolServerName after $MaxRetries attempts." |
| 171 | +exit 1 |
0 commit comments