starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-09-24 07:54:35 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

[PR #4213] [MERGED] Create tests that roundtrip output through a conpty to a Terminal #25690

New Issue
Open
opened 2026-01-31 09:11:09 +00:00 by claunia · 0 comments
claunia commented 2026-01-31 09:11:09 +00:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/microsoft/terminal/pull/4213
Author: @zadjii-msft
Created: 1/14/2020
Status: ✅ Merged
Merged: 1/17/2020
Merged by: @undefined

Base: master ← Head: dev/migrie/f/i-love-these-tests

📝 Commits (8)

  • 302e04a Create some tests that roundtrip content through conpt to verify in the terminal
  • bf4f610 polish for review
  • eb6992e Apply suggestions from code review
  • a8fd596 Merge remote-tracking branch 'origin/master' into dev/migrie/f/i-love-these-tests
  • 77fbfc6 These were some comments from niksa
  • 1b767b4 Merge branch 'master' into dev/migrie/f/i-love-these-tests
  • e2a918e Merge remote-tracking branch 'origin/master' into dev/migrie/f/i-love-these-tests
  • 7c8a7d1 fix @miniksa breaking my build

📊 Changes

16 files changed (+788 additions, -19 deletions)

View changed files

📝 src/cascadia/TerminalCore/Terminal.hpp (+9 -0)
➕ src/cascadia/UnitTests_TerminalCore/ConptyRoundtripTests.cpp (+366 -0)
📝 src/cascadia/UnitTests_TerminalCore/UnitTests.vcxproj (+39 -2)
📝 src/cascadia/UnitTests_TerminalCore/precomp.h (+17 -3)
📝 src/host/screenInfo.hpp (+2 -0)
➕ src/host/ut_host/ConptyOutputTests.cpp (+309 -0)
📝 src/host/ut_host/Host.UnitTests.vcxproj (+1 -0)
📝 src/host/ut_host/TextBufferTests.cpp (+1 -1)
📝 src/host/ut_host/sources (+1 -0)
📝 src/inc/test/CommonState.hpp (+12 -9)
📝 src/renderer/base/renderer.cpp (+6 -2)
📝 src/renderer/base/renderer.hpp (+4 -0)
📝 src/renderer/vt/Xterm256Engine.hpp (+1 -0)
📝 src/renderer/vt/XtermEngine.hpp (+1 -0)
📝 src/renderer/vt/state.cpp (+12 -2)
📝 src/renderer/vt/vtrenderer.hpp (+7 -0)

📄 Description

Summary of the Pull Request

This PR adds two tests:

  • First, I started by writing a test where I could write output to the console host and inspect what output came out of conpty. This is the ConptyOutputTests in the host unit tests.
  • Then I got crazy and thought "what if I could take that output and dump it straight into the Terminal"? Hence, the ConptyRoundtripTests were born, into the TerminalCore unit tests.

References

Done in pursuit of #4200, but I felt this warranted it's own atomic PR

PR Checklist

  • Doesn't close anything on it's own.
  • I work here
  • you better believe this adds tests
  • [n/a] Requires documentation to be updated

Detailed Description of the Pull Request / Additional comments

From the comment in ConptyRoundtripTests:

This test class creates an in-proc conpty host as well as a Terminal, to
validate that strings written to the conpty create the same resopnse on the
terminal end. Tests can be written that validate both the contents of the
host buffer as well as the terminal buffer. Everytime that
renderer.PaintFrame() is called, the tests will validate the expected
output, and then flush the output of the VtEngine straight to th

Also, some other bits had to be updated:

  • The renderer needed to be able to survive without a thread, so I hadded a simple check that it actually had a thread before calling pThread->NotifyPaint
  • Bits in CommonState used NTSTATUS_FROM_HRESULT which did not work outside the host project. Since the NTSTATUS didn't seem that important, I replaced that with a HRESULT
  • CommonState likes to initialize the console to some weird defaults. I added an optional param to let us just use the defaults.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/microsoft/terminal/pull/4213 **Author:** [@zadjii-msft](https://github.com/zadjii-msft) **Created:** 1/14/2020 **Status:** ✅ Merged **Merged:** 1/17/2020 **Merged by:** [@undefined](undefined) **Base:** `master` ← **Head:** `dev/migrie/f/i-love-these-tests` --- ### 📝 Commits (8) - [`302e04a`](https://github.com/microsoft/terminal/commit/302e04a091781e37d1a63404fbd1da87f323aa21) Create some tests that roundtrip content through conpt to verify in the terminal - [`bf4f610`](https://github.com/microsoft/terminal/commit/bf4f6104e57833d1bee58797ebf1e5d8dd074f1e) polish for review - [`eb6992e`](https://github.com/microsoft/terminal/commit/eb6992e03f06ab7fdccb54b9358d68c40e3f68a8) Apply suggestions from code review - [`a8fd596`](https://github.com/microsoft/terminal/commit/a8fd59662fffb11b8f470ec71259feb5ec09780f) Merge remote-tracking branch 'origin/master' into dev/migrie/f/i-love-these-tests - [`77fbfc6`](https://github.com/microsoft/terminal/commit/77fbfc62c8a4339ea4e16d853c05e8b73b2302c2) These were some comments from niksa - [`1b767b4`](https://github.com/microsoft/terminal/commit/1b767b4e2c9bb7997e0dab889f77fbafd1157813) Merge branch 'master' into dev/migrie/f/i-love-these-tests - [`e2a918e`](https://github.com/microsoft/terminal/commit/e2a918e257ee117a4340e3be88ba19edfeebf013) Merge remote-tracking branch 'origin/master' into dev/migrie/f/i-love-these-tests - [`7c8a7d1`](https://github.com/microsoft/terminal/commit/7c8a7d10d8e518d7aee0ca4675fde209979b1202) fix @miniksa breaking my build ### 📊 Changes **16 files changed** (+788 additions, -19 deletions) <details> <summary>View changed files</summary> 📝 `src/cascadia/TerminalCore/Terminal.hpp` (+9 -0) ➕ `src/cascadia/UnitTests_TerminalCore/ConptyRoundtripTests.cpp` (+366 -0) 📝 `src/cascadia/UnitTests_TerminalCore/UnitTests.vcxproj` (+39 -2) 📝 `src/cascadia/UnitTests_TerminalCore/precomp.h` (+17 -3) 📝 `src/host/screenInfo.hpp` (+2 -0) ➕ `src/host/ut_host/ConptyOutputTests.cpp` (+309 -0) 📝 `src/host/ut_host/Host.UnitTests.vcxproj` (+1 -0) 📝 `src/host/ut_host/TextBufferTests.cpp` (+1 -1) 📝 `src/host/ut_host/sources` (+1 -0) 📝 `src/inc/test/CommonState.hpp` (+12 -9) 📝 `src/renderer/base/renderer.cpp` (+6 -2) 📝 `src/renderer/base/renderer.hpp` (+4 -0) 📝 `src/renderer/vt/Xterm256Engine.hpp` (+1 -0) 📝 `src/renderer/vt/XtermEngine.hpp` (+1 -0) 📝 `src/renderer/vt/state.cpp` (+12 -2) 📝 `src/renderer/vt/vtrenderer.hpp` (+7 -0) </details> ### 📄 Description ## Summary of the Pull Request This PR adds two tests: * First, I started by writing a test where I could write output to the console host and inspect what output came out of conpty. This is the `ConptyOutputTests` in the host unit tests. * Then I got crazy and thought _"what if I could take that output and dump it straight into the `Terminal`"_? Hence, the `ConptyRoundtripTests` were born, into the TerminalCore unit tests. ## References Done in pursuit of #4200, but I felt this warranted it's own atomic PR ## PR Checklist * [x] Doesn't close anything on it's own. * [x] I work here * [x] you better believe this adds tests * [n/a] Requires documentation to be updated ## Detailed Description of the Pull Request / Additional comments From the comment in `ConptyRoundtripTests`: > This test class creates an in-proc conpty host as well as a Terminal, to > validate that strings written to the conpty create the same resopnse on the > terminal end. Tests can be written that validate both the contents of the > host buffer as well as the terminal buffer. Everytime that > `renderer.PaintFrame()` is called, the tests will validate the expected > output, and then flush the output of the VtEngine straight to th Also, some other bits had to be updated: * The renderer needed to be able to survive without a thread, so I hadded a simple check that it actually had a thread before calling `pThread->NotifyPaint` * Bits in `CommonState` used `NTSTATUS_FROM_HRESULT` which did _not_ work outside the host project. Since the `NTSTATUS` didn't seem that important, I replaced that with a `HRESULT` * `CommonState` likes to initialize the console to some _weird_ defaults. I added an optional param to let us just use the defaults. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-31 09:11:09 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#25690
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?