mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 02:19:06 +00:00
### Motivation and Context <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> Resolves: https://github.com/microsoft/semantic-kernel/issues/8586 This PR contains changes to add code coverage generation for experimental packages. This enables code coverage for all packages, but threshold is used only for non-experimental packages (with green checkmark on screenshot):  ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [x] The code builds clean without any errors or warnings - [x] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [x] All unit tests pass, and I have added new tests where possible - [x] I didn't break anyone 😄
79 lines
2.5 KiB
PowerShell
79 lines
2.5 KiB
PowerShell
param (
|
|
[string]$JsonReportPath,
|
|
[double]$CoverageThreshold
|
|
)
|
|
|
|
$jsonContent = Get-Content $JsonReportPath -Raw | ConvertFrom-Json
|
|
$coverageBelowThreshold = $false
|
|
|
|
$nonExperimentalAssemblies = [System.Collections.Generic.HashSet[string]]::new()
|
|
|
|
$assembliesCollection = @(
|
|
'Microsoft.SemanticKernel.Abstractions'
|
|
'Microsoft.SemanticKernel.Core'
|
|
'Microsoft.SemanticKernel.PromptTemplates.Handlebars'
|
|
'Microsoft.SemanticKernel.Connectors.OpenAI'
|
|
'Microsoft.SemanticKernel.Connectors.AzureOpenAI'
|
|
'Microsoft.SemanticKernel.Yaml'
|
|
'Microsoft.SemanticKernel.Agents.Abstractions'
|
|
'Microsoft.SemanticKernel.Agents.Core'
|
|
'Microsoft.SemanticKernel.Agents.OpenAI'
|
|
)
|
|
|
|
foreach ($assembly in $assembliesCollection) {
|
|
$nonExperimentalAssemblies.Add($assembly)
|
|
}
|
|
|
|
function Get-FormattedValue {
|
|
param (
|
|
[float]$Coverage,
|
|
[bool]$UseIcon = $false
|
|
)
|
|
$formattedNumber = "{0:N1}" -f $Coverage
|
|
$icon = if (-not $UseIcon) { "" } elseif ($Coverage -ge $CoverageThreshold) { '✅' } else { '❌' }
|
|
|
|
return "$formattedNumber% $icon"
|
|
}
|
|
|
|
$lineCoverage = $jsonContent.summary.linecoverage
|
|
$branchCoverage = $jsonContent.summary.branchcoverage
|
|
|
|
$totalTableData = [PSCustomObject]@{
|
|
'Metric' = 'Total Coverage'
|
|
'Line Coverage' = Get-FormattedValue -Coverage $lineCoverage
|
|
'Branch Coverage' = Get-FormattedValue -Coverage $branchCoverage
|
|
}
|
|
|
|
$totalTableData | Format-Table -AutoSize
|
|
|
|
$assemblyTableData = @()
|
|
|
|
foreach ($assembly in $jsonContent.coverage.assemblies) {
|
|
$assemblyName = $assembly.name
|
|
$assemblyLineCoverage = $assembly.coverage
|
|
$assemblyBranchCoverage = $assembly.branchcoverage
|
|
|
|
$isNonExperimentalAssembly = $nonExperimentalAssemblies -contains $assemblyName
|
|
|
|
if ($isNonExperimentalAssembly -and ($assemblyLineCoverage -lt $CoverageThreshold -or $assemblyBranchCoverage -lt $CoverageThreshold)) {
|
|
$coverageBelowThreshold = $true
|
|
}
|
|
|
|
$assemblyTableData += [PSCustomObject]@{
|
|
'Assembly Name' = $assemblyName
|
|
'Line' = Get-FormattedValue -Coverage $assemblyLineCoverage -UseIcon $isNonExperimentalAssembly
|
|
'Branch' = Get-FormattedValue -Coverage $assemblyBranchCoverage -UseIcon $isNonExperimentalAssembly
|
|
}
|
|
}
|
|
|
|
$sortedTable = $assemblyTableData | Sort-Object {
|
|
$nonExperimentalAssemblies -contains $_.'Assembly Name'
|
|
} -Descending
|
|
|
|
$sortedTable | Format-Table -AutoSize
|
|
|
|
if ($coverageBelowThreshold) {
|
|
Write-Host "Code coverage is lower than defined threshold: $CoverageThreshold. Stopping the task."
|
|
exit 1
|
|
}
|