mirror of
https://github.com/microsoft/terminal.git
synced 2025-12-10 00:48:23 -06:00
8f4c63e81b
This does two bits: 1. correctly marks our tests as failed in xUnit, so that AzDo will pick up that the tests have failed. 2. Actually intentionally mark skipped tests as skipped in xUnit. We were doing this accidentally before. 3. Add a CI step to log test failures in a way that they can show up on GitHub Probably regressed around #6992 and #4490. ### details #### Part the first We were relying on the MUX build scripts to convert our WTT test logs to xUnit format, which AzDo then ingests. That script we used relied on some WinUI-specific logic around retrying tests. They have some logic to auto-retry failed tests. They then mark a test as "skipped" if it passed less than some threshold of times. Since we were never setting that variable, we would mark a test as "skipped" if it had _0_ passes. So, all failures showed up on AzDo as "skipped". Why didn't we notice this? Well, the `Run-Tests.ps1` script will still return `1` if _any_ tests failed. So the test job would fail if there was a failure, AzDo just wouldn't know which test it was. #### part the second Updates `ConvertWttLogToXUnitLog` in `HelixTestHelpers.cs` to understand that a test can be skipped, in addition to pass/fail. Removes all the logic for dealing with retries, cause we didn't need that. #### part the third TAEF doesn't emit error messages in a way that AzDo can immediately pick up on which tests failed. This means that Github gives us this useless error message:  That's the only "error" that AzDo knows about. This PR changes that by adding a build step to manually parse the xUnit results, and log the names of any tests that failed. By logging them with a prefix of `##vso[task.logissue type=error]`, then AzDo will surface that text as an error message. GitHub can then grab that text and surface it too. ### Addenda: Why aren't we using the VsTest module as noted in https://github.com/microsoft/terminal/pull/4490#issuecomment-583104982, the vstest module is literally 6x slower than just running TAEF directly.
39 lines
1.9 KiB
PowerShell
39 lines
1.9 KiB
PowerShell
Param(
|
|
[Parameter(Mandatory = $true)]
|
|
[string]$XUnitOutputPath
|
|
)
|
|
|
|
# This script is used to parse the XUnit output from the test runs and print out
|
|
# the tests that failed.
|
|
#
|
|
# Why you might ask? Well, it sure seems like Azure DevOps doesn't like the fact
|
|
# that we just call our tests in a powershell script. It can't seemingly find
|
|
# the actual errors in the TAEF logs. That means when you just go to the
|
|
# "Checks" page on GitHub, the Azure DevOps integration doesn't have anything
|
|
# meaningful to say other than "PowerShell exited with code '1'". If we however,
|
|
# just manually emit the test names formatted with "#[error]" in front of them,
|
|
# well, then the integration will all work like magic.
|
|
|
|
# Load the test results as a XML object
|
|
$testResults = [xml](Get-Content -Path $XUnitOutputPath)
|
|
|
|
# Our XML looks like:
|
|
# <assemblies>
|
|
# <assembly name="MUXControls.Test.dll" test-framework="TAEF" run-date="2023-08-14" run-time="11:38:01" total="524" passed="520" failed="4" skipped="1" time="8943" errors="0">
|
|
# <collection total="524" passed="520" failed="4" skipped="1" name="Test collection" time="8943">
|
|
# <test name="ControlCoreTests::TestSimpleClickSelection" type="ControlCoreTests" method="TestSimpleClickSelection" time="0.016" result="Fail">
|
|
|
|
# Iterate over all the assemblies and print all the tests that failed
|
|
foreach ($assembly in $testResults.assemblies.assembly) {
|
|
foreach ($collection in $assembly.collection) {
|
|
foreach ($test in $collection.test) {
|
|
if ($test.result -eq "Fail") {
|
|
# This particular format is taken from the Azure DevOps documentation:
|
|
# https://github.com/microsoft/azure-pipelines-tasks/blob/master/docs/authoring/commands.md
|
|
# This will treat this line as an error message
|
|
Write-Output "##vso[task.logissue type=error]$($test.name) Failed"
|
|
}
|
|
}
|
|
}
|
|
}
|