Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Helix Testing #6992

Merged
80 commits merged into from
Aug 18, 2020
Merged

Helix Testing #6992

80 commits merged into from
Aug 18, 2020

Conversation

miniksa
Copy link
Member

@miniksa miniksa commented Jul 21, 2020

Use the Helix testing orchestration framework to run our Terminal LocalTests and Console Host UIA tests.

References

Creates the following new issues:

Consumes from:

  • Update TAEF to 10.57.200731005-develop #7164 - The update to TAEF includes wttlog.dll. The WTT logs are what MUX's Helix scripts use to track the run state, convert to XUnit format, and notify both Helix and AzDO of what's going on.

Produces for:

  • Terminal: UIA test harness #671 - Making Terminal UIA tests is now possible
  • Apply PGO to Binaries #6963 - MUX's Helix scripts are already ready to capture PGO data on the Helix machines as certain tests run. Presuming we can author some reasonable scenarios, turning on the Helix environment gets us a good way toward automated PGO.

Related:

PR Checklist

Detailed Description of the Pull Request / Additional comments

We have had two classes of tests that don't work in our usual build-machine testing environment:

  1. Tests that require interactive UI automation or input injection (a.k.a. require a logged in user)
  2. Tests that require the entire Windows Terminal to stand up (because our Xaml Islands dependency requires 1903 or later and the Windows Server instance for the build is based on 1809.)

The Helix testing environment solves both of these and is brought to us by our friends over in https://github.com/microsoft/microsoft-ui-xaml.

This PR takes a large portion of scripts and pipeline configuration steps from the Microsoft-UI-XAML repository and adjusts them for Terminal needs.
You can see the source of most of the files in either https://github.com/microsoft/microsoft-ui-xaml/tree/master/build/Helix or https://github.com/microsoft/microsoft-ui-xaml/tree/master/build/AzurePipelinesTemplates

Some of the modifications in the files include (but are not limited to) reasons like:

  • Our test binaries are named differently than MUX's test binaries
  • We don't need certain types of testing that MUX does.
  • We use C++ and C# tests while MUX was using only C# tests (so the naming pattern and some of the parsing of those names is different e.g. :: separators in C++ and . separators in C#)
  • Our pipeline phases work a bit differently than MUX and/or we need significantly fewer pieces to the testing matrix (like we don't test a wide variety of OS versions).

The build now runs in a few stages:

  1. The usual build and run of unit tests/feature tests, packaging verification, and whatnot. This phase now also picks up and packs anything required for running tests in Helix into an artifact. (It also unifies the artifact name between the things Helix needs and the existing build outputs into the single drop artifact to make life a little easier.)
  2. The Helix preparation build runs that picks up those artifacts, generates all the scripts required for Helix to understand the test modules/functions from our existing TAEF tests, packs it all up, and queues it on the Helix pool.
  3. Helix generates a VM for our testing environment and runs all the TAEF tests that require it. The orchestrator at helix.dot.net watches over this and tracks the success/fail and progress of each module and function. The scripts from our MUX friends handle installing dependencies, making the system quiet for better reliability, detecting flaky tests and rerunning them, and coordinating all the log uploads (including for the subruns of tests that are re-run.)
  4. A final build phase is run to look through the results with the Helix API and clean up the marking of tests that are flaky, link all the screenshots and console output logs into the AzDO tests panel, and other such niceities.

We are set to run Helix tests on the Feature test policy of only x64 for now.

Additionally, because the set up of the Helix VMs takes so long, we are NOT running these in PR trigger right now as I believe we all very much value our 15ish minute PR turnaround (and the VM takes another 15 minutes to just get going for whatever reason.) For now, they will only run as a rolling build on master after PRs are merged. We should still know when there's an issue within about an hour of something merging and multiple PRs merging fast will be done on the rolling build as a batch run (not one per).

In addition to setting up the entire Helix testing pipeline for the tests that require it, I've preserved our classic way of running unit and feature tests (that don't require an elaborate environment) directly on the build machines. But with one bonus feature... They now use some of the scripts from MUX to transform their log data and report it to AzDO so it shows up beautifully in the build report. (We used to have this before I removed the MStest/VStest wrapper for performance reasons, but now we can have reporting AND performance!) See https://dev.azure.com/ms/terminal/_build/results?buildId=101654&view=ms.vss-test-web.build-test-results-tab for an example.

I explored running all of the tests on Helix but.... the Helix setup time is long and the resources are more expensive. I felt it was better to preserve the "quick signal" by continuing to run these directly on the build machine (and skipping the more expensive/slow Helix setup if they fail.) It also works well with the split between PR builds not running Helix and the rolling build running Helix. PR builds will get a good chunk of tests for a quick turn around and the rolling build will finish the more thorough job a bit more slowly.

Validation Steps Performed

  • Ran the updated pipelines with Pull Request configuration ensuring that Helix tests don't run in the usual CI
  • Ran with simulation of the rolling build to ensure that the tests now running in Helix will pass. All failures marked for follow on in reference issues.

miniksa added 30 commits July 21, 2020 10:35
…that one in Helix to attempt to bootstrap the helix test process.
…aths inside the artifact to separate out build flavors.
…wer nuget to see if it goes faster. actually build helix config for our module and run the one for our module.
@miniksa miniksa requested a review from PankajBhojwani August 14, 2020 16:17
@miniksa miniksa self-assigned this Aug 14, 2020
@miniksa miniksa added this to the Terminal v1.3 milestone Aug 14, 2020
@zadjii-msft
Copy link
Member

Oh my gosh is it finally ready? That's amazing

@miniksa
Copy link
Member Author

miniksa commented Aug 14, 2020

For reviewers: The most pertinent thing to review is probably runtests.cmd, the changes to the console YAMLs, and any test changes. The Powershell scripts and HelixTestHelpers.cs are 95% lifted from MUX as is. You'll find a few changes as you look closely, but I'm not really looking to clean up how they work, just make them work the same way MUX does.

OpenConsole.sln Outdated Show resolved Hide resolved
build/Helix/CopyVisualTreeVerificationFiles.ps1 Outdated Show resolved Hide resolved
build/scripts/Get-WttLog.ps1 Outdated Show resolved Hide resolved
build/pipelines/templates/build-console-steps.yml Outdated Show resolved Hide resolved
Copy link
Member

@zadjii-msft zadjii-msft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay so I can't honestly say I understand all the powershell that's going on here. I'm kinda trusting that

  • It's mostly copy-pasta from WinUI
  • It works, so I'm okay with that

build/Helix/ProcessHelixFiles.ps1 Outdated Show resolved Hide resolved
build/Helix/PrepareHelixPayload.ps1 Show resolved Hide resolved
Copy link
Member

@DHowett DHowett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have to take some of this on faith.

build/pipelines/templates/build-console-ci.yml Outdated Show resolved Hide resolved
build/pipelines/templates/helix-createprojfile-steps.yml Outdated Show resolved Hide resolved
build/pipelines/templates/helix-runtests-job.yml Outdated Show resolved Hide resolved
build/pipelines/templates/helix-runtests-job.yml Outdated Show resolved Hide resolved
…dsOn statement. Update more TAEF versions. Change creator of Helix job to Terminal (from WinUI)
@zadjii-msft zadjii-msft mentioned this pull request Aug 18, 2020
4 tasks
@miniksa miniksa added the AutoMerge Marked for automatic merge by the bot when requirements are met label Aug 18, 2020
@ghost
Copy link

ghost commented Aug 18, 2020

Hello @miniksa!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@ghost ghost merged commit 5d082ff into master Aug 18, 2020
@ghost ghost deleted the dev/miniksa/helix branch August 18, 2020 18:23
DHowett added a commit that referenced this pull request Sep 3, 2020
Dustin L. Howett
* Clear the last error before calling Mb2Wc in ConvertToW (GH-7391)
* Update clang-format to 10.0 (GH-7389)
* Add til::static_map, a constexpr key-value store (GH-7323)

James Holderness
* Refactor VT control sequence identification (CC-7304)

Mike Griese
* Compensate for VS 16.7, part 2 (GH-7383)
* Add support for iterable, nested commands (GH-6856)

Michael Niksa
* Helix Testing (GH-6992)
* Compensate for new warnings and STL changes in VS 16.7 (GH-7319)

nathpete-msft
* Fix environment block creation (GH-7401)

Chester Liu
* Add initial support for VT DCS sequences (CC-6328)

Related work items: #28791050
@zadjii-msft zadjii-msft mentioned this pull request Feb 17, 2021
3 tasks
zadjii-msft added a commit that referenced this pull request Aug 15, 2023
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:

![image](https://github.com/microsoft/terminal/assets/18356694/3be6de00-22e1-421c-93d4-176bd2be4cab)
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
#4490 (comment),
the vstest module is literally 6x slower than just running TAEF
directly.
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Build Issues pertaining to the build system, CI, infrastructure, meta Area-CodeHealth Issues related to code cleanliness, linting, rules, warnings, errors, static analysis, etc. AutoMerge Marked for automatic merge by the bot when requirements are met Issue-Task It's a feature request, but it doesn't really need a major design. Product-Terminal The new Windows Terminal.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Get the LocalTests running in CI again
3 participants