Repository navigation
ci: run engine tests in their own job and drop the per-child test-host relaunch - #7364
Conversation
…t relaunch The Reflection-mode engine tests ran last in the dotnet.yml pipeline: they waited for every other test module and then ran alone for 3-7 minutes. They now run in a job of their own in aot.yml, which UploadToNuGetModule already waits on before it publishes. Every engine test launched TUnit.TestProject with --report-trx and --hangdump. Both run the test host under a test-host controller, so each child process started twice. The test project now writes the TRX in-process when TUNIT_ENGINE_TESTS_TRX_PATH is set, following the TRX extension's outcome, counter and output rules, and child runs are bounded by --timeout. The harness also reads each TRX by its path instead of walking the repository for it, and looks up the AOT app once. Closes #7359
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
No actionable comments were generated in the recent review.
|
| Layer / File(s) | Summary |
|---|---|
In-process TRX reporter tests/TUnit.TestProject/EngineTestSupport/InProcessTrxReporter.cs, tests/TUnit.TestProject/TUnit.TestProject.csproj |
A testing-platform hook registers the reporter when TUNIT_ENGINE_TESTS_TRX_PATH is set. The reporter collects test updates and writes TRX results. |
Engine-test TRX paths and assertions tests/TUnit.Engine.Tests/InvokableTestBase.cs, tests/TUnit.Engine.Tests/TrxAsserter.cs, tests/TUnit.Engine.Tests/ListTestsFilterTests.cs |
The harness supplies a generated TRX path to Reflection and AOT runs and validates results at that path. AOT executable discovery is cached. The Reflection run uses a 10-minute timeout. |
Engine-test category and CI workflow tools/TUnit.Pipeline/PipelineCategories.cs, tools/TUnit.Pipeline/Modules/RunEngineTestsModule.cs, tools/TUnit.Pipeline/Modules/UploadToNuGetModule.cs, tools/TUnit.Pipeline/Modules/Abstract/EngineTestsModuleBase.cs, .github/workflows/aot.yml, .github/workflows/dotnet.yml |
The pipeline adds the EngineTests category, changes module dependencies, and sets engine-test parallelism to four times the processor count. The AOT workflow runs the category in a separate job, while the modular pipeline excludes it. |
Estimated code review effort: 4 (Complex) | ~45 minutes
Change: Other · Severity of issue fixed: Medium
Sequence Diagram(s)
sequenceDiagram
participant GitHubActions
participant RunEngineTestsModule
participant InvokableTestBase
participant TestHost
participant InProcessTrxReporterHook
participant TrxAsserter
GitHubActions->>RunEngineTestsModule: Run EngineTests category
RunEngineTestsModule->>InvokableTestBase: Execute engine-test run
InvokableTestBase->>TestHost: Start process with TRX path
TestHost->>InProcessTrxReporterHook: Register reporter when path is set
InProcessTrxReporterHook->>TestHost: Write TRX results after the run
InvokableTestBase->>TrxAsserter: Assert results at supplied path
Possibly related issues
- thomhurst/TUnit#7359: The changes implement the issue objectives to isolate engine tests in CI, use a timeout for child runs, and replace the child-run TRX reporting flow with an in-process reporter.
Possibly related PRs
- thomhurst/TUnit#7357: Both PRs change CI category allocation in
.github/workflows/dotnet.yml. - thomhurst/TUnit#7296: The in-process reporter consumes test-node updates and serializes results into the TRX file used by engine-test assertions.
- thomhurst/TUnit#7354: Both PRs change engine-test parallelism behavior.
Merge Risk: 
Minimal · up to 2dc46
-
No actionable merge-blocking risk remains.
Pre-merge checks: 
4 · 
1
-
Failed checks: 1 warning Passed checks: 4 passed-
Full details: Linked Issues check
-
Explanation
Issue
#7359has three coding objectives. The workflow adds a separateEngineTestsmatrix job and excludes that category frommodularpipeline.InvokableTestBasereplaces child--hangdumpuse with--timeout 10m. The test project adds an opt-in in-process TRX reporter, and the harness reads the reporter output from a known path while keeping existing TRX assertions. The reported validation covers the matching reflection and source-generated filters. The requirements are implemented at the reviewed head.
Full details: Out of Scope Changes check
-
Explanation
The category changes, workflow dependencies, diagnostic uploads, child timeout, in-process reporter, known-path TRX handling, executable lookup cache, and parallelism setting support the CI objective in issue
#7359. No unrelated change is established by the reviewed scope.
-
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 15.38% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 13 functions across 8 files.
Resolution
Write docstrings for the functions missing them to satisfy the coverage threshold.
-
Finishing Touches
-
Generate docstrings
-
- Commit to this branch
- Create a new PR
Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
A rabbit hops where test runs start,
TRX reports now play their part.
Across three runners, checks proceed,
With timeout bounds for runs in need.
The pipeline sorts each category,
And logs record the journey.
|
Review of #7364: the design is sound. It removes the serial tail job and the double process start per child run. I did not run the engine tests (CI only, per AGENTS.md). Points to consider
No blockers. Item 1 is the one to confirm before merge. Good CI win overall. |
[Medium impact] The latest change appears safe to merge and fixes the missing test waits before package publishing. SummaryThe PR moves reflection-mode engine tests into their own CI jobs and writes child-run TRX files without starting a second test-host process.
|
The engine tests mostly wait on child processes. Under the engine's new 2x default (#7354) about 6-8 children ran at once on a 4-core runner instead of about 12, which cancelled out the per-child savings on ubuntu.
|
Review of PR #7364 (engine tests in their own job, no child hangdump, in-process TRX) I read the pipeline, workflow and Concerns
Positives
Overall a reasonable CI improvement. I'd like items 1 and 2 addressed or explicitly accepted before merge. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7764bbe877
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
Dispositions for the two Claude reviews:
The |
|
Review of #7364: engine tests in own job, no hangdump, in-process TRX I read the diff, InProcessTrxReporter, the harness changes and the new engine-tests job. I didn't run anything or check CI results. I found no blocking correctness bugs. The gain is real: it removes the 3-7 minute serial tail of every modularpipeline job and the double host start per child run. What looks good
Concerns and suggestions
Overall this is a solid CI win and the reporter is careful. I'd want the parity test in (1) and confirmation of (2) and (3) before merge. 🤖 Generated with Claude Code |
Closes #7359.
TUnit.Engine.Tests took most of the CI time. This makes three changes.
1. Engine tests get a job of their own
RunEngineTestsModuledepended on 11 other test modules, so it started last and ran alone for 3-7 minutes at the end of everymodularpipelinejob (run 40786972231: ubuntu 6.4 min, windows 6.6 min, macOS 3.3 min).EngineTestscategory and noDependsOnlist.dotnet.ymlignores that category, and a newengine-testsmatrix job inaot.ymlruns it. That job builds onlyTUnit.Engine.Testsand the pipeline.UploadToNuGetModuledrops itsDependsOn<RunEngineTestsModule>: it already waits foraot.ymlto pass on the commit before it publishes, and that workflow now includes these tests.2. No
--hangdumpon child runsHangdump runs the test host under a test-host controller, so every child process started twice. Child runs are now bounded with
--timeout 10m, as the AOT path already does. Trade-off: a hung child run is cancelled, but no dump is written. The parent run's hangdump only dumps the parent process.3. TRX written in-process
--report-trxalways uses a test-host controller, so it also doubled every child start. With an empty filter locally, a child run took 1.1 s with no extra flags and 1.9 s with--report-trx.TUnit.TestProjectnow hasInProcessTrxReporter, registered through aTestingPlatformBuilderHook. It registers nothing unlessTUNIT_ENGINE_TESTS_TRX_PATHis set.Trx*properties it does for--report-trx. It then writes the TRX elements the engine tests read, using the outcome, counter and output rules of the TRX extension 2.5 (TrxReportEngine,TrxTestResultExtractor, testfx tag v4.5.2). The existing TRX parsing and assertions are unchanged.FileSystemHelpers.FindFilewalked the whole repository, including bin/obj, up to six times per child run. The AOT app is also looked up once instead of once per test.--report-trx. There are only a few of them.Validation
Every literal treenode filter in TUnit.Engine.Tests was run against
TUnit.TestProjecttwice, once with--report-trxand once with the in-process reporter, and the two files were compared. The comparison covered the summary outcome, counters, test-definition class names, distinct test ids, each result's name and outcome, which output sections are present, the first message line, and all stdout lines as a multiset.Total child time across the matching filters, with 12 processes running at once:
--report-trxThis measures the TRX change alone; removing hangdump and the repository walks saves more.
TUnit.TestProjectbuilds with-p:Aot=true, and the new file adds no IL warnings. Theaot.ymlpublish will confirm.As AGENTS.md asks, TUnit.Engine.Tests itself was not run locally; CI runs it.
Note for branch protection
The new jobs are named
Engine tests (<os>). If required status checks list themodularpipelinejobs, add these too, or a PR could merge with failing engine tests.Summary by CodeRabbit