mirror of
https://github.com/mihakralj/QuanTAlib.git
synced 2026-08-07 21:47:43 +00:00
Miha Kralj
915d7a007b
- Implemented the Standardize class for calculating Z-Score normalization over a specified lookback period. - Updated NDepend badge SVG files to reflect new metrics. - Modified NDepend project files to reference the updated solution file name. - Removed outdated documentation files related to indicator proposals and channel documentation remediation. - Updated workspace configuration to point to the new solution file.
229 lines
8.6 KiB
PowerShell
229 lines
8.6 KiB
PowerShell
#!/usr/bin/env pwsh
|
|
#requires -Version 7.0
|
|
|
|
[CmdletBinding()]
|
|
param(
|
|
[Parameter(Mandatory = $false)]
|
|
[string]$NdependLicense = $env:NDEPEND_LICENSE
|
|
)
|
|
|
|
$ErrorActionPreference = 'Stop'
|
|
$ProgressPreference = 'SilentlyContinue'
|
|
|
|
# Configuration
|
|
# Determine NDepend installation path based on OS
|
|
if ($IsWindows -or $env:OS -like "Windows*") {
|
|
$NdependDll = "C:\ndepend\net10.0\NDepend.Console.MultiOS.dll"
|
|
} else {
|
|
$NdependDll = Join-Path $HOME "NDepend/net10.0/NDepend.Console.MultiOS.dll"
|
|
}
|
|
# Ensure ScriptDir is set correctly even if $PSScriptRoot is empty (e.g., dot-sourced)
|
|
$ScriptDir = if ($PSScriptRoot) { $PSScriptRoot } else { Split-Path -Parent $MyInvocation.MyCommand.Path }
|
|
$ProjectRoot = Split-Path -Parent $ScriptDir
|
|
$CoverageDir = Join-Path $ScriptDir "coverage"
|
|
$SarifDir = Join-Path $ProjectRoot ".sarif"
|
|
$SolutionFile = Join-Path $ProjectRoot "QuanTAlib.slnx"
|
|
$TestProject = Join-Path $ProjectRoot "lib/QuanTAlib.Tests.csproj"
|
|
$TestProject2 = Join-Path $ProjectRoot "quantower/Quantower.Tests.csproj"
|
|
$RunSettingsFile = Join-Path $ProjectRoot "coverlet.runsettings"
|
|
$NdependProject = Join-Path $ScriptDir "quantalib.ndproj"
|
|
|
|
# Validate prerequisites
|
|
if (-not (Test-Path $NdependDll)) {
|
|
Write-Error "NDepend console not found at: $NdependDll"
|
|
exit 1
|
|
}
|
|
|
|
if ([string]::IsNullOrWhiteSpace($NdependLicense)) {
|
|
Write-Warning "NDEPEND_LICENSE environment variable not set. License activation may fail."
|
|
}
|
|
|
|
if (-not (Test-Path $SolutionFile)) {
|
|
Write-Error "Solution file not found: $SolutionFile"
|
|
exit 1
|
|
}
|
|
|
|
# Helper function for section headers
|
|
function Write-Section {
|
|
param([string]$Message)
|
|
Write-Host "`n=== $Message ===" -ForegroundColor Cyan
|
|
}
|
|
|
|
# Track analysis failure
|
|
$AnalysisFailed = $false
|
|
|
|
try {
|
|
# Create .sarif directory
|
|
Write-Section "Creating .sarif directory for Roslyn analyzer output"
|
|
if (-not (Test-Path $SarifDir)) {
|
|
New-Item -ItemType Directory -Path $SarifDir -Force | Out-Null
|
|
}
|
|
Write-Host "SARIF directory: $SarifDir"
|
|
|
|
# Restore, clean, and build
|
|
Write-Section "Cleaning and building solution (generates SARIF files)"
|
|
|
|
Write-Host "Restoring packages..." -ForegroundColor Gray
|
|
dotnet restore $SolutionFile -v q
|
|
if ($LASTEXITCODE -ne 0) { throw "Restore failed with exit code $LASTEXITCODE" }
|
|
|
|
Write-Host "Cleaning solution..." -ForegroundColor Gray
|
|
dotnet clean $SolutionFile -v q
|
|
if ($LASTEXITCODE -ne 0) { throw "Clean failed with exit code $LASTEXITCODE" }
|
|
|
|
Write-Host "Removing old coverage data..." -ForegroundColor Gray
|
|
if (Test-Path $CoverageDir) {
|
|
Remove-Item -Path $CoverageDir -Recurse -Force
|
|
}
|
|
|
|
Write-Host "Building solution..." -ForegroundColor Gray
|
|
dotnet build $SolutionFile -c Debug --no-incremental
|
|
if ($LASTEXITCODE -ne 0) { throw "Build failed with exit code $LASTEXITCODE" }
|
|
|
|
# Run tests with coverage (QuanTAlib.Tests)
|
|
Write-Section "Running tests with coverage (QuanTAlib.Tests)"
|
|
dotnet test $TestProject `
|
|
-c Debug `
|
|
--no-build `
|
|
--collect:"XPlat Code Coverage" `
|
|
--settings $RunSettingsFile `
|
|
--results-directory:$CoverageDir
|
|
|
|
if ($LASTEXITCODE -ne 0) { throw "Tests failed for QuanTAlib.Tests with exit code $LASTEXITCODE" }
|
|
|
|
# Run tests with coverage (Quantower.Tests)
|
|
Write-Section "Running tests with coverage (Quantower.Tests)"
|
|
dotnet test $TestProject2 `
|
|
-c Debug `
|
|
--no-build `
|
|
--collect:"XPlat Code Coverage" `
|
|
--settings $RunSettingsFile `
|
|
--results-directory:$CoverageDir
|
|
|
|
if ($LASTEXITCODE -ne 0) { throw "Tests failed for Quantower.Tests with exit code $LASTEXITCODE" }
|
|
|
|
# Find coverage files
|
|
Write-Host "`nSearching for coverage files..." -ForegroundColor Gray
|
|
$CoverageFiles = Get-ChildItem -Path $CoverageDir -Filter "coverage.opencover.xml" -Recurse -File |
|
|
Select-Object -ExpandProperty FullName
|
|
|
|
if (-not $CoverageFiles) {
|
|
Write-Warning "No coverage files found in $CoverageDir"
|
|
} else {
|
|
$CoverageFiles | ForEach-Object {
|
|
Write-Host "Coverage file: $_" -ForegroundColor Green
|
|
}
|
|
}
|
|
|
|
# Run JetBrains InspectCode
|
|
Write-Section "Running JetBrains InspectCode"
|
|
$InspectCodeOutput = Join-Path $SarifDir "resharper.sarif.json"
|
|
$jbPath = Get-Command "jb" -ErrorAction SilentlyContinue
|
|
if ($jbPath) {
|
|
Write-Host "Running InspectCode analysis..." -ForegroundColor Gray
|
|
jb inspectcode $SolutionFile --output=$InspectCodeOutput --format=Sarif --no-build
|
|
if ($LASTEXITCODE -ne 0) {
|
|
Write-Warning "InspectCode completed with exit code $LASTEXITCODE"
|
|
} else {
|
|
Write-Host "InspectCode SARIF saved to: $InspectCodeOutput" -ForegroundColor Green
|
|
}
|
|
} else {
|
|
Write-Warning "JetBrains CLI (jb) not found. Skipping InspectCode analysis."
|
|
Write-Host " Install with: dotnet tool install -g JetBrains.ReSharper.GlobalTools" -ForegroundColor Gray
|
|
}
|
|
|
|
# List SARIF files
|
|
Write-Section "SARIF files generated"
|
|
$SarifFiles = Get-ChildItem -Path $SarifDir -Filter "*.json" -ErrorAction SilentlyContinue
|
|
if ($SarifFiles) {
|
|
$SarifFiles | ForEach-Object {
|
|
Write-Host " $($_.Name) ($([math]::Round($_.Length / 1KB, 2)) KB)" -ForegroundColor Gray
|
|
}
|
|
} else {
|
|
Write-Host "No SARIF files found" -ForegroundColor Yellow
|
|
}
|
|
|
|
# Activate NDepend license
|
|
Write-Section "Activating NDepend license"
|
|
if (-not [string]::IsNullOrWhiteSpace($NdependLicense)) {
|
|
dotnet $NdependDll --RegLic $NdependLicense
|
|
if ($LASTEXITCODE -ne 0) { Write-Warning "License activation returned exit code $LASTEXITCODE" }
|
|
} else {
|
|
Write-Warning "Skipping license activation (no license provided)"
|
|
}
|
|
|
|
# Run NDepend analysis
|
|
Write-Section "Running NDepend analysis"
|
|
$NdependArgs = @($NdependProject)
|
|
if ($CoverageFiles) {
|
|
$NdependArgs += "/CoverageFiles"
|
|
foreach ($file in $CoverageFiles) {
|
|
$NdependArgs += $file
|
|
}
|
|
}
|
|
|
|
dotnet $NdependDll @NdependArgs
|
|
if ($LASTEXITCODE -ne 0) {
|
|
Write-Warning "NDepend analysis completed with exit code $LASTEXITCODE"
|
|
$AnalysisFailed = $true
|
|
}
|
|
|
|
} catch {
|
|
Write-Error "Script failed: $_"
|
|
$AnalysisFailed = $true
|
|
} finally {
|
|
# Always deactivate license
|
|
Write-Section "Deactivating NDepend license"
|
|
if (-not [string]::IsNullOrWhiteSpace($NdependLicense)) {
|
|
dotnet $NdependDll --UnregLic
|
|
if ($LASTEXITCODE -ne 0) { Write-Warning "License deactivation returned exit code $LASTEXITCODE" }
|
|
} else {
|
|
Write-Host "Skipping license deactivation (no license provided)" -ForegroundColor Gray
|
|
}
|
|
|
|
# Generate badges from NDepend trend data
|
|
Write-Section "Generating quality badges"
|
|
$NDBadgePath = Join-Path $ScriptDir "NDBadge.exe"
|
|
# Find the most recent trend data file
|
|
$TrendMetricsDir = Join-Path $ScriptDir "NDependOut\TrendMetrics"
|
|
$TrendXml = if (Test-Path $TrendMetricsDir) {
|
|
Get-ChildItem -Path $TrendMetricsDir -Filter "NDependTrendData*.xml" -File |
|
|
Sort-Object Name -Descending |
|
|
Select-Object -First 1 -ExpandProperty FullName
|
|
} else { $null }
|
|
$BadgeDir = Join-Path $ScriptDir "badges"
|
|
|
|
if ((Test-Path $NDBadgePath) -and $TrendXml -and (Test-Path $TrendXml)) {
|
|
if (-not (Test-Path $BadgeDir)) {
|
|
New-Item -ItemType Directory -Path $BadgeDir -Force | Out-Null
|
|
}
|
|
|
|
$Badges = @(
|
|
@{ Metric = "# Lines of Code"; Output = "loc.svg" },
|
|
@{ Metric = "# Source Files"; Output = "files.svg" },
|
|
@{ Metric = "# Classes"; Output = "classes.svg" },
|
|
@{ Metric = "# Methods"; Output = "methods.svg" },
|
|
@{ Metric = "# Public Types"; Output = "public-api.svg" },
|
|
@{ Metric = "Percentage of Comments"; Output = "comments.svg" },
|
|
@{ Metric = "Average Cyclomatic Complexity for Methods"; Output = "complexity.svg" }
|
|
)
|
|
|
|
foreach ($badge in $Badges) {
|
|
$outputPath = Join-Path $BadgeDir $badge.Output
|
|
& $NDBadgePath --xml $TrendXml --metric $badge.Metric --output $outputPath 2>$null
|
|
if ($LASTEXITCODE -eq 0) {
|
|
Write-Host " Generated: $($badge.Output)" -ForegroundColor Gray
|
|
}
|
|
}
|
|
Write-Host "Badges saved to: $BadgeDir" -ForegroundColor Green
|
|
} else {
|
|
Write-Host "Skipping badge generation (NDBadge.exe or trend data not found)" -ForegroundColor Yellow
|
|
}
|
|
|
|
Write-Section "Done"
|
|
|
|
if ($AnalysisFailed) {
|
|
Write-Host "Note: Analysis completed with quality gate failures" -ForegroundColor Yellow
|
|
exit 1
|
|
}
|
|
} |