GdUnit4
An embedded unit testing framework for Godot 4, supporting GDScript and C# with TDD, mocking, and scene testing.
What is GdUnit4?
GdUnit4 is an embedded unit testing framework for the Godot 4 game engine. It allows developers to write and run automated tests for GDScript and C# code, as well as interactive scenes, directly within the Godot editor. It solves the problem of ensuring code quality and preventing regressions in Godot projects through comprehensive testing tools.
Godot developers and teams building games or applications with Godot 4 who want to implement automated testing, test-driven development (TDD), or integrate testing into their CI/CD pipelines.
Developers choose GdUnit4 because it is the most feature-complete, integrated testing solution for Godot 4, offering a rich set of tools like mocking, scene runners, and CI support that are not available in Godot's built-in testing tools.
Overview
Embedded unit testing framework for Godot 4 supporting GDScript and C#. Features test-driven development, embedded test inspector, extensive assertions, mocking, scene testing.
Use Cases
Best For
- Implementing test-driven development (TDD) in Godot 4 projects
- Testing interactive Godot scenes with simulated user input
- Writing unit tests for both GDScript and C# scripts in the same project
- Integrating automated testing into a CI/CD pipeline for a Godot game
- Mocking dependencies and spying on function calls in Godot tests
- Generating detailed HTML or JUnit XML test reports for team review
Not Ideal For
- Projects still using Godot 3.x or earlier versions
- Teams requiring a testing framework that runs completely independently of the Godot editor
- Developers who prefer minimalist, no-frills testing tools without advanced features like mocking or fuzzing
Pros & Cons
Pros
Tests are embedded directly in the Godot editor with features like right-click test creation and an integrated test inspector, streamlining the development workflow without context switching.
Supports both GDScript and C# with dedicated APIs and VSTest integration for C#, enabling consistent testing across mixed-language Godot projects.
Includes a scene runner for simulating user inputs like mouse, keyboard, and touch, along with mocking and spying capabilities, making it ideal for testing interactive Godot scenes and complex logic.
Provides command-line tools with HTML and JUnit XML report generation, plus a dedicated GitHub Action, facilitating easy integration into continuous integration workflows.
Cons
The compatibility table shows tight coupling with specific Godot 4.x versions; updates to Godot can require matching GdUnit4 updates, risking breaking changes or maintenance delays.
Setting up GdUnit4 for C# requires additional configuration steps as per a separate documentation page, which can be cumbersome for developers unfamiliar with Godot's C# ecosystem.
Being deeply embedded in Godot means tests cannot run in isolation without the editor, which may not suit environments requiring lightweight, headless testing or integration with non-Godot tools.
Frequently Asked Questions
Related Projects
PixeloramaUnleash your creativity with Pixelorama, a powerful and accessible open-source pixel art multitool. Whether you want to create sprites, tiles, animations, or just express yourself in the language of pixel art, this software will realize your pixel-perfect dreams with a vast toolbox of features. Available on Windows, Linux, macOS and the Web!
Godot Demo ProjectsDemonstration and Template Projects
LorienInfinite canvas drawing/whiteboarding app for Windows, Linux and macOS. Made with Godot.
Dialogic💬 Create Dialogs, Visual Novels, RPGs, and manage Characters with Godot to create your Game!
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.