About this project
GUT (Godot Unit Test) is a unit testing framework for the Godot Engine, enabling developers to write and run tests directly in GDScript. It is designed to integrate seamlessly with Godot projects, offering a comprehensive set of tools to validate game logic and behavior.
## Key Features
- **Simple Installation**: Available via the Godot Asset Library or manual zip download, with a plugin that can be enabled in the project settings.
- **Rich Assertion Library**: A wide range of assert and utility methods to make tests concise and expressive.
- **Inner Test Classes**: Support for organizing tests within classes for better context and maintainability.
- **Doubling and Stubbing**: Full and partial doubles, stubbing, and spies to isolate and test components.
- **Command Line Interface (CLI)**: Run tests from the terminal for automation and CI/CD integration.
- **Parameterized Tests**: Run the same test with multiple data sets.
- **JUnit XML Export**: Export test results in standard JUnit XML format for integration with other tools.
- **VSCode Extension**: A companion extension to run tests directly from the editor.
## Version Compatibility
- **GUT 9.x**: For Godot 4.x (with specific versions for 4.0 through 4.7).
- **GUT 7.x**: For Godot 3.x (e.g., 7.4.3 for Godot 3.5).
## Getting Started
Documentation is hosted at [gut.readthedocs.io](https://gut.readthedocs.io/), with guides for installation, quick start, creating tests, and using asserts. The framework is MIT licensed, with the license file included in the addon.
## Support
Development is supported via [Buy Me a Coffee](https://buymeacoffee.com/bitwes).
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.