🩹 [Patch]: Resolve benchmark script linter warnings

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Author: MariusStorhaug

tools/benchmark/Build-LocalModule.ps1

@@ -13,7 +13,7 @@
 param(
     # Path to the module source folder. Defaults to <repo>/src.
     [Parameter()]
-    [string] $SourcePath = (Join-Path $PSScriptRoot '..' '..' 'src'),
+    [string] $SourcePath = (Join-Path -Path $PSScriptRoot -ChildPath '..\..\src'),
 
     # Folder in which the 'Sodium' module folder is created.
     [Parameter(Mandatory)]
@@ -37,31 +37,31 @@ New-Item -ItemType Directory -Path $moduleDir -Force | Out-Null
 $sb = [System.Text.StringBuilder]::new()
 $publicFunctions = @()
 
-foreach ($file in (Get-ChildItem (Join-Path $SourcePath 'variables' 'private') -Filter *.ps1 -ErrorAction SilentlyContinue)) {
+foreach ($file in (Get-ChildItem (Join-Path -Path $SourcePath -ChildPath 'variables\private') -Filter *.ps1 -ErrorAction SilentlyContinue)) {
     [void]$sb.AppendLine((Get-Content $file.FullName -Raw))
 }
-foreach ($file in (Get-ChildItem (Join-Path $SourcePath 'functions' 'private') -Filter *.ps1)) {
+foreach ($file in (Get-ChildItem (Join-Path -Path $SourcePath -ChildPath 'functions\private') -Filter *.ps1)) {
     [void]$sb.AppendLine((Get-Content $file.FullName -Raw))
 }
-foreach ($file in (Get-ChildItem (Join-Path $SourcePath 'functions' 'public') -Filter *.ps1)) {
+foreach ($file in (Get-ChildItem (Join-Path -Path $SourcePath -ChildPath 'functions\public') -Filter *.ps1)) {
     [void]$sb.AppendLine((Get-Content $file.FullName -Raw))
     $publicFunctions += $file.BaseName
 }
-$mainPath = Join-Path $SourcePath 'main.ps1'
+$mainPath = Join-Path -Path $SourcePath -ChildPath 'main.ps1'
 if (Test-Path $mainPath) {
     [void]$sb.AppendLine((Get-Content $mainPath -Raw))
 }
 [void]$sb.AppendLine("Export-ModuleMember -Function '$($publicFunctions -join "', '")' -Alias '*'")
 
-Set-Content -Path (Join-Path $moduleDir 'Sodium.psm1') -Value $sb.ToString() -Encoding UTF8BOM
+Set-Content -Path (Join-Path -Path $moduleDir -ChildPath 'Sodium.psm1') -Value $sb.ToString() -Encoding UTF8BOM
 
-Copy-Item -Path (Join-Path $SourcePath 'libs') -Destination $moduleDir -Recurse
+Copy-Item -Path (Join-Path -Path $SourcePath -ChildPath 'libs') -Destination $moduleDir -Recurse
 
-New-ModuleManifest -Path (Join-Path $moduleDir 'Sodium.psd1') `
+New-ModuleManifest -Path (Join-Path -Path $moduleDir -ChildPath 'Sodium.psd1') `
     -RootModule 'Sodium.psm1' `
     -ModuleVersion '999.0.0' `
     -FunctionsToExport $publicFunctions `
     -CmdletsToExport @() -VariablesToExport @() -AliasesToExport @()
 
 Write-Verbose "Built module at $moduleDir" -Verbose
-Join-Path $moduleDir 'Sodium.psd1'
+Join-Path -Path $moduleDir -ChildPath 'Sodium.psd1'

tools/benchmark/Invoke-ImportBenchmark.ps1

@@ -30,7 +30,7 @@ param(
 $ErrorActionPreference = 'Stop'
 
 if (-not $ModulePath) {
-    $ModulePath = & (Join-Path $PSScriptRoot 'Build-LocalModule.ps1') -OutputPath (Join-Path ([System.IO.Path]::GetTempPath()) 'SodiumBench')
+    $ModulePath = & (Join-Path -Path $PSScriptRoot -ChildPath 'Build-LocalModule.ps1') -OutputPath (Join-Path -Path ([System.IO.Path]::GetTempPath()) -ChildPath 'SodiumBench')
 }
 
 $times = for ($i = 0; $i -lt $Samples; $i++) {
@@ -50,7 +50,7 @@ $result = [pscustomobject]@{
     MinMs   = [math]::Round($stats.Minimum, 1)
     MaxMs   = [math]::Round($stats.Maximum, 1)
 }
-$result | Format-Table -AutoSize | Out-String | Write-Host
-$outFile = Join-Path $OutputPath "import-$Label.json"
+$result | Format-Table -AutoSize | Out-String | Write-Output
+$outFile = Join-Path -Path $OutputPath -ChildPath "import-$Label.json"
 $result | ConvertTo-Json | Set-Content -Path $outFile
 Write-Verbose "Saved $outFile" -Verbose

tools/benchmark/Invoke-PerformanceBenchmark.ps1

@@ -31,12 +31,16 @@ param(
 $ErrorActionPreference = 'Stop'
 
 if (-not $ModulePath) {
-    $ModulePath = & (Join-Path $PSScriptRoot 'Build-LocalModule.ps1') -OutputPath (Join-Path ([System.IO.Path]::GetTempPath()) 'SodiumBench')
+    $ModulePath = & (Join-Path -Path $PSScriptRoot -ChildPath 'Build-LocalModule.ps1') -OutputPath (Join-Path -Path ([System.IO.Path]::GetTempPath()) -ChildPath 'SodiumBench')
 }
 
 Import-Module $ModulePath -Force
 
 function Measure-Op {
+    <#
+        .SYNOPSIS
+        Measures an operation over N iterations and returns aggregate timing metrics.
+    #>
     param([string]$Name, [scriptblock]$Setup, [scriptblock]$Op, [int]$N = $Iterations)
     $ctx = if ($Setup) { & $Setup } else { $null }
     for ($i = 0; $i -lt 25; $i++) { $null = & $Op $ctx }
@@ -99,11 +103,11 @@ $results += Measure-Op -Name 'Full roundtrip (keypair+seal+open)' -N ([math]::Ma
 }
 
 $results += Measure-Op -Name 'ConvertTo-SodiumSealedBox invalid key (throw)' -N 500 -Op {
-    try { ConvertTo-SodiumSealedBox -Message 'x' -PublicKey 'InvalidKey' } catch { }
+    try { ConvertTo-SodiumSealedBox -Message 'x' -PublicKey 'InvalidKey' } catch { $null = $_ }
 }
 
 $results += Measure-Op -Name 'Get-SodiumPublicKey invalid key (throw)' -N 500 -Op {
-    try { Get-SodiumPublicKey -PrivateKey 'InvalidKey' } catch { }
+    try { Get-SodiumPublicKey -PrivateKey 'InvalidKey' } catch { $null = $_ }
 }
 
 # Mirrors the 'Parallel sessions' test context: module import + crypto roundtrip in 4 runspaces.
@@ -125,7 +129,7 @@ $results += [pscustomobject]@{
     OpsPerSec = [math]::Round(1 / $swPar.Elapsed.TotalSeconds, 2)
 }
 
-$results | Format-Table -AutoSize | Out-String -Width 200 | Write-Host
-$outFile = Join-Path $OutputPath "bench-$Label.json"
+$results | Format-Table -AutoSize | Out-String -Width 200 | Write-Output
+$outFile = Join-Path -Path $OutputPath -ChildPath "bench-$Label.json"
 $results | ConvertTo-Json | Set-Content -Path $outFile
 Write-Verbose "Saved $outFile" -Verbose

tools/benchmark/Invoke-ProfilerTrace.ps1

@@ -27,17 +27,18 @@ param(
 $ErrorActionPreference = 'Stop'
 
 if (-not $ModulePath) {
-    $ModulePath = & (Join-Path $PSScriptRoot 'Build-LocalModule.ps1') -OutputPath (Join-Path ([System.IO.Path]::GetTempPath()) 'SodiumBench')
+    $ModulePath = & (Join-Path -Path $PSScriptRoot -ChildPath 'Build-LocalModule.ps1') -OutputPath (Join-Path -Path ([System.IO.Path]::GetTempPath()) -ChildPath 'SodiumBench')
 }
 
 Import-Module Profiler
 Import-Module $ModulePath -Force
 
 $kp = New-SodiumKeyPair
 $box = ConvertTo-SodiumSealedBox -Message 'Hello world!' -PublicKey $kp.PublicKey
+$traceIterations = $Iterations
 
 $trace = Trace-Script {
-    for ($i = 0; $i -lt $Iterations; $i++) {
+    for ($i = 0; $i -lt $traceIterations; $i++) {
         $null = New-SodiumKeyPair
         $null = New-SodiumKeyPair -Seed 'DeterministicSeed'
         $null = ConvertTo-SodiumSealedBox -Message 'Hello world!' -PublicKey $kp.PublicKey
@@ -49,6 +50,6 @@ $trace = Trace-Script {
 
 $trace.Top50SelfDuration |
     Select-Object -First $Top SelfPercent, SelfDuration, HitCount, Function, Line, Text |
-    Format-Table -AutoSize | Out-String -Width 220 | Write-Host
+    Format-Table -AutoSize | Out-String -Width 220 | Write-Output
 
 $trace