Skip to content

Commit b07c27f

Browse files
committed
Add note about the create_test.py script
1 parent b66dc5a commit b07c27f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

contributing/development/core_and_modules/unit_testing.rst

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

0 commit comments

Comments
 (0)