ImportExcel/Examples/Pester-To-XLSx.ps1

[CmdletBinding(DefaultParameterSetName = 'Default')]
param(
    [Parameter(Position=0)]
    [string]$XLFile,

    [Parameter(ParameterSetName='Default',Position=1)]
    [Alias('Path', 'relative_path')]
    [object[]]$Script = '.',

    [Parameter(ParameterSetName='Existing',Mandatory=$true)]
    [switch]
    $UseExisting,

    [Parameter(ParameterSetName='Default', Position=2)]
    [Parameter(ParameterSetName='Existing',Position=2, Mandatory=$true)]
    [string]$OutputFile,

    [Parameter(ParameterSetName='Default')]
    [Alias("Name")]
    [string[]]$TestName,

    [Parameter(ParameterSetName='Default')]
    [switch]$EnableExit,

    [Parameter(ParameterSetName='Default')]
    [Alias('Tags')]
    [string[]]$Tag,
    [string[]]$ExcludeTag,

    [Parameter(ParameterSetName='Default')]
    [switch]$Strict,

    [string]$WorkSheetName = 'PesterResults',
    [switch]$append,
    [switch]$Show
)

$InvokePesterParams = @{OutputFormat = 'NUnitXml'} + $PSBoundParameters
if (-not $InvokePesterParams['OutputFile']) {
         $InvokePesterParams['OutputFile'] = Join-Path -ChildPath 'Pester.xml'-Path ([environment]::GetFolderPath([System.Environment+SpecialFolder]::MyDocuments))
}
if ($InvokePesterParams['Show']  ) {}
if ($InvokePesterParams['XLFile']) {$InvokePesterParams.Remove('XLFile')}
else                   {$XLFile =   $InvokePesterParams['OutputFile'] -replace '.xml$','.xlsx'}
if (-not $UseExisting) {
    $InvokePesterParams.Remove('Append')
    $InvokePesterParams.Remove('UseExisting')
    $InvokePesterParams.Remove('Show')
    $InvokePesterParams.Remove('WorkSheetName')
    Invoke-Pester @InvokePesterParams
}
if (-not (Test-Path -Path $InvokePesterParams['OutputFile'])) {
    throw "Could not output file $($InvokePesterParams['OutputFile'])"; return
}

$resultXML   = ([xml](Get-Content $InvokePesterParams['OutputFile'])).'test-results'
$startDate   = [datetime]$resultXML.date
$startTime   = $resultXML.time
$machine     = $resultXML.environment.'machine-name'
#$user       = $resultXML.environment.'user-domain' + '\' + $resultXML.environment.user
$os          = $resultXML.environment.platform -replace '\|.*$'," $($resultXML.environment.'os-version')"
<#hierarchy goes
    root, [date], start [time], [Name] (always "Pester"), test results broken down as [total],[errors],[failures],[not-run] etc.
      Environment (user & machine info)
      Culture-Info (current, and currentUi culture)
      Test-Suite [name] = "Pester" [result], [time] to execute, etc.
        Results
          Test-Suite [name] = filename,[result], [Time] to Execute etc
            Results
               Test-Suite [Name] = Describe block Name, [result], [Time] to execute etc..
                 Results
                   Test-Suite [Name] = Context block name [result], [Time] to execute etc.
                      Results
                        Test-Case [name] = Describe.Context.It block names [description]= it block name, result], [Time] to execute etc
                      or if the tests are parameterized
                        Test suite [description] - name in the the it block with <vars> not filled in
                          Results
                             Test-case  [description] - name as rendered for display with <vars> filled in
#>
$testResults = foreach ($test in $resultXML.'test-suite'.results.'test-suite') {
    $testPs1File         = $test.name
    #Test if there are context blocks in the hierarchy OR if we go straight from Describe to test-case
    if ($test.results.'test-suite'.results.'test-suite' -ne $null) {
        foreach ($suite in $test.results.'test-suite')  {
            $Describe    = $suite.description
            foreach ($subsuite in $suite.results.'test-suite') {
              $Context     = $subsuite.description
              if ($subsuite.results.'test-suite'.results.'test-case') {
                    $testCases = $subsuite.results.'test-suite'.results.'test-case'
              }
              else {$testCases = $subsuite.results.'test-case'}
              $testCases | ForEach-Object {
                New-Object -TypeName psobject -Property ([ordered]@{
                   Machine  = $machine    ; OS       = $os
                   Date     = $startDate  ; Time     = $startTime
                   Executed = $(if ($_.executed -eq 'True') {1})
                   Success  = $(if ($_.success  -eq 'True') {1})
                   Duration = $_.time
                   File     = $testPs1File; Group    = $Describe
                   SubGroup = $Context    ; Name     =($_.Description -replace '\s{2,}', ' ')
                   Result   = $_.result   ; FullDesc = '=Group&" "&SubGroup&" "&Test'})
              }
            }
        }
    }
    else {
        $test.results.'test-suite' | ForEach-Object {
            $Describe = $_.description
            $_.results.'test-case'| ForEach-Object {
                New-Object -TypeName psobject -Property ([ordered]@{
                   Machine  = $machine    ; OS       = $os
                   Date     = $startDate  ; Time     = $startTime
                   Executed = $(if ($_.executed -eq 'True') {1})
                   Success  = $(if ($_.success  -eq 'True') {1})
                   Duration = $_.time
                   File     = $testPs1File; Group    = $Describe
                   SubGroup = $null       ; Name     =($_.Description -replace '\s{2,}', ' ')
                   Result   = $_.result   ; FullDesc = '=Group&" "&Test'})
            }
        }
    }
}
if (-not $testResults) {Write-Warning 'No Results found' ; return}
$clearSheet = -not $Append
$excel      =  $testResults | Export-Excel  -Path $xlFile -WorkSheetname $WorkSheetName -ClearSheet:$clearSheet -Append:$append -PassThru  -BoldTopRow -FreezeTopRow -AutoSize -AutoFilter -AutoNameRange
$ws         =  $excel.Workbook.Worksheets[$WorkSheetName]

<#  Worksheet should look like ..
  |A        |B             |C      D      |E        |F       |G          |H       |I        |J        |K    |L       |M
 1|Machine  |OS            |Date   Time   |Executed |Success |Duration   |File    |Group    |SubGroup |Name |Result  |FullDescription
 2|Flatfish |Name_Version  |[run started] |Boolean  |Boolean |In seconds |xx.ps1  |Describe |Context  |It   |Success |Desc_Context_It
#>

#Display Date as a date, not a date time
Set-Column -Worksheet $ws -Column 3 -NumberFormat 'Short Date' # -AutoSize

#Hide columns E to J (Executed, Success, Duration, File, Group and Subgroup)
(5..10)   | ForEach-Object {Set-ExcelColumn -Worksheet $ws -Column $_ -Hide }

#Use conditional formatting to make Failures red, and Successes green (skipped remains black ) ... and save
$endRow = $ws.Dimension.End.Row
Add-ConditionalFormatting -WorkSheet $ws -range "L2:L$endrow" -RuleType ContainsText -ConditionValue "Failure" -BackgroundPattern None -ForegroundColor Red   -Bold
Add-ConditionalFormatting -WorkSheet $ws -range "L2:L$endRow" -RuleType ContainsText -ConditionValue "Success" -BackgroundPattern None -ForeGroundColor Green
Close-ExcelPackage -ExcelPackage $excel  -Show:$show