Document unit testing in the engine and modules #4017
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Calinou
requested changes
Sep 15, 2020
Adds a new page for C++ unit testing in Godot Engine. Adds a section to "Custom modules in C++" to document the process of writing module tests as well, reusing the same mechanism.
|
Applied suggested changes. I was thinking about adding a section on generating test coverage and running tests with sanitizers, but this could be done in a separate PR, and perhaps by someone more knowledgeable in this area or someone who has already done this (@qarmin, @Calinou). 🙂 In fact, if there are some memory leaks in tests, CI won't let you pass those, but this is more or less advanced topic for testing, and sanitizers are not supported on all platforms out of the box. |
Calinou
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See godotengine/godot#40659.
Adds a new page for C++ unit testing in Godot Engine.
Adds a section to "Custom modules in C++" to document the process of writing module tests as well, reusing the same mechanism.
There are naming conventions which are worth to be considered: godotengine/godot-proposals#1388, but at its current state, this should be enough.
Update: available at https://docs.godotengine.org/en/latest/development/cpp/unit_testing.html.