bitwes / Gut

Godot Unit Test. Unit testing tool for Godot Game Engine.

Repo Changes

• The default branch is now main.
• GUT 9 (for Godot 4) is now on main.
• GUT 7 (for Godot 3) is now on the godot_3x branch.
• Documentation has moved
  • GUT 9 on readthedocs.io: https://gut.readthedocs.io/en/latest
  • GUT 7 on readthedocs.io: https://gut.readthedocs.io/en/godot_3x

GUT 9.2.1 (Godot 4.2)

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

Donate/Shameless Plug

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!

Features

• 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.

Getting Started

• Install
• Quick Start
• Creating Tests
• Asserts and Methods

VSCode Extension

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.

• Visual Studio Marketplace
• Github repo
• Quick tutorial on setup and use

License

Gut is provided under the MIT license. License is in addons/gut/LICENSE.md

Tutorials

• TDD and P O N G Series
• Wiki list of tutorials https://github.com/bitwes/Gut/wiki/Tutorials.html