godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add note about the create_test.py script

Browse Source
This commit is contained in:
Hendrik Brucker
2024-09-04 16:32:18 +02:00
parent b66dc5a8b2
commit b07c27fdbe
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
contributing/development/core_and_modules/unit_testing.rst
View File

@@ -129,6 +129,12 @@ Here's a minimal working test suite with a single test case written:
#endif // TEST_STRING_H
.. note::
You can quickly generate new tests using the ``create_test.py`` script found in the ``tests/`` directory.
This script automatically creates a new test file with the required boilerplate code in the appropriate location.
It's also able to automatically include the new header in ``tests/test_main.cpp`` using invasive mode (``-i`` flag).
To view usage instructions, run the script with the ``-h`` flag.
The ``tests/test_macros.h`` header encapsulates everything which is needed for
writing C++ unit tests in Godot. It includes doctest assertion and logging
macros such as ``CHECK`` as seen above, and of course the definitions for