GUT (Godot Unit Test) is a unit testing framework for the Godot Engine. It allows you to write tests for your gdscript in gdscript.
GUT versions 9.x are for Godot 4.x GUT versions below 9.0.0 (currently 7.4.2) are for Godot 3.x
NOTE The wiki for this version has moved to https://bitwes.github.io/GutWiki/Godot4/. It has not been fully updated yet. The Wiki source is now located in the godot_4
branch and Pull Requests are encouraged. See Wiki section in GODOT_4_README.md for details.
See the GODOT_4_README.md for information about how things have changed in Godot 4.
If you would like to help support GUT check out my game Country or State on Android and iOS. Then, purchase the full version even if you don't like it. Thanks!
- Godot 4.0
- Simple install via the Asset Library.
- A plethora of asserts and utility methods to help make your tests simple and concise.
- Support for Inner Test Classes to give your tests some extra context and maintainability.
- Doubling: Full and Partial, Stubbing, Spies
- Command Line Interface (CLI)
- Parameterized Tests
- Export results in standard JUnit XML format.
More info can be found in the wiki.
Run your tests directly from the VSCode Editor. Search VSCode extensions for "gut-extension". The plugin has commands to run your entire test suite, a single test script or a single test.
Gut is provided under the MIT license. License is in addons/gut/LICENSE.md
- TDD and P O N G Series
- Wiki list of tutorials https://github.com/bitwes/Gut/wiki/Tutorials