Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-29 09:18:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Testing (markdown)

Charlie Kindel
2020-06-07 22:19:41 -06:00
parent 7429fb62f7
commit fe6ef2abb0
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
Testing.md

@@ -1,3 +1,20 @@
# Automated Unit Tests
`Terminal.Gui` uses [xunit](https://xunit.net/) for automated unit tests run automatically with Github Actions.
## Notes
* Running tests in parallel is disabled because `Application` is a singleton. Do not change those settings.
## Guidelines for Adding More Tests
1. Do. Please. Add lots.
2. Structure the tests by class. Name the test classes in the form of `ClassNameTests` and the file `ClassNameTests.cs`.
3. The test functions themselves should have descriptive names like `TestBeginEnd`.
4. IMPORTANT: Remember `Application` is a static class (singleton). You must clean up after your tests by calling `Application.Shutdown`.
See the README.md in `UnitTests/` for details on how xunit is configured.
## Standard Regression Tests required before submitting a Pull Request
- Ensure a UI Catalog Scenario has been developed that *specifically* exercises the code involved in the PR. This Scenario should explicitly and intentionally exercise the following common functional areas: