godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9701 from Geometror/tests-add-special-tags-section

Browse Source 
Add section about special tags to the unit testing guide
This commit is contained in:
Max Hilbrunner
2024-08-04 16:50:31 +02:00
committed by GitHub
parent 1b974d5535 b85d63c69c
commit 95eb1ba85e
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -260,6 +260,25 @@ the engine, for instance:
"Invalid HTML notation should result in a Color with the default values.");
}
Special tags in test case names
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
These tags can be added to the test case name to modify or extend the test environment:
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Tag** | **Description** |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``[SceneTree]`` | Required for test cases that rely on a scene tree with MessageQueue to be available. It also enables a mock rendering server and :ref:`ThemeDB<class_ThemeDB>`. |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``[Editor]`` | Like ``[SceneTree]``, but with additional editor-related infrastructure available, such as :ref:`EditorSettings<class_EditorSettings>`. |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``[Audio]`` | Initializes the :ref:`AudioServer<class_AudioServer>` using a mock audio driver. |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``[Navigation]`` | Creates the default 2D/3D navigation servers and makes them available for testing. |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
You can use them together to combine multiple test environment extensions.
Test tools
----------