godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
bb273bc972
godot/tests/test_main.cpp

306 lines
10 KiB
C++
Raw Normal View History

GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* test_main.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
Use HTTPS URL for Godot's website in the headers
2017-08-27 12:16:55 +00:00
/* https://godotengine.org */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
Update copyright statements to 2022 Happy new year to the wonderful Godot community!
2022-01-03 20:27:34 +00:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-04 23:50:27 +00:00
Remove unused classes and stray headers Found by reviewing headers with 1 or less matching includes: ``` find -name thirdparty -prune -o -name "*.h" -exec basename {} \; | sort -u > headers for header in $(cat headers); do echo "$header: "; rg -l "#include \"(.*/)?$header\"" | wc -l; done > list-includes ```
2020-03-24 08:50:51 +00:00
#include "test_main.h"
Move and organize tests into subfolders
2021-11-06 21:05:33 +00:00
#include "tests/core/io/test_config_file.h"
#include "tests/core/io/test_file_access.h"
#include "tests/core/io/test_image.h"
#include "tests/core/io/test_json.h"
#include "tests/core/io/test_marshalls.h"
#include "tests/core/io/test_pck_packer.h"
#include "tests/core/io/test_resource.h"
#include "tests/core/io/test_xml_parser.h"
#include "tests/core/math/test_aabb.h"
#include "tests/core/math/test_astar.h"
#include "tests/core/math/test_basis.h"
#include "tests/core/math/test_color.h"
#include "tests/core/math/test_expression.h"
#include "tests/core/math/test_geometry_2d.h"
#include "tests/core/math/test_geometry_3d.h"
Implemented tests for Plane getters and setters. Added tests for intersection and plane-point methods.
2020-12-13 08:50:48 +00:00
#include "tests/core/math/test_plane.h"
Move and organize tests into subfolders
2021-11-06 21:05:33 +00:00
#include "tests/core/math/test_random_number_generator.h"
#include "tests/core/math/test_rect2.h"
Core: Move Rect2i to its own `rect2i.h` header And take the opportunity to improve interdependencies a bit with forward declares where possible.
2022-02-04 12:28:02 +00:00
#include "tests/core/math/test_rect2i.h"
Add tests for Vector2/Vector2i/Vector3/Vector3i
2021-11-13 05:45:40 +00:00
#include "tests/core/math/test_vector2.h"
#include "tests/core/math/test_vector2i.h"
#include "tests/core/math/test_vector3.h"
#include "tests/core/math/test_vector3i.h"
Move and organize tests into subfolders
2021-11-06 21:05:33 +00:00
#include "tests/core/object/test_class_db.h"
#include "tests/core/object/test_method_bind.h"
#include "tests/core/object/test_object.h"
Add a test suite for OS
2020-08-09 16:50:56 +00:00
#include "tests/core/os/test_os.h"
Move and organize tests into subfolders
2021-11-06 21:05:33 +00:00
#include "tests/core/string/test_node_path.h"
#include "tests/core/string/test_string.h"
#include "tests/core/string/test_translation.h"
#include "tests/core/templates/test_command_queue.h"
Add a new HashMap implementation Adds a new, cleaned up, HashMap implementation. * Uses Robin Hood Hashing (https://en.wikipedia.org/wiki/Hash_table#Robin_Hood_hashing). * Keeps elements in a double linked list for simpler, ordered, iteration. * Allows keeping iterators for later use in removal (Unlike Map<>, it does not do much for performance vs keeping the key, but helps replace old code). * Uses a more modern C++ iterator API, deprecates the old one. * Supports custom allocator (in case there is a wish to use a paged one). This class aims to unify all the associative template usage and replace it by this one: * Map<> (whereas key order does not matter, which is 99% of cases) * HashMap<> * OrderedHashMap<> * OAHashMap<>
2022-05-08 08:09:19 +00:00
#include "tests/core/templates/test_hash_map.h"
Add a new HashSet template * Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19 15:00:06 +00:00
#include "tests/core/templates/test_hash_set.h"
Move and organize tests into subfolders
2021-11-06 21:05:33 +00:00
#include "tests/core/templates/test_list.h"
#include "tests/core/templates/test_local_vector.h"
#include "tests/core/templates/test_lru.h"
#include "tests/core/templates/test_paged_array.h"
#include "tests/core/templates/test_vector.h"
#include "tests/core/test_crypto.h"
#include "tests/core/test_hashing_context.h"
#include "tests/core/test_time.h"
Implement a Worker ThreadPool This PR implements a worked thread pool. It uses a fixed amount of threads in a pool and allows scheduling tasks that can be run on threads (and then waited for). It satisfies the following use cases: * HTML5 thread count is fixed (and similar restrictions are known in consoles) so we need to reuse threads. * Thread spawning is slow in general, so reusing threads is faster anyway. * This implementation supports recursive waiting for tasks, making it less prone to deadlocks if threads from the pool also run tasks. After this is approved and merged, subsequent PRs will be needed to replace the ThreadWorkPool usage by this class.
2022-07-18 10:09:19 +00:00
#include "tests/core/threads/test_worker_thread_pool.h"
Move and organize tests into subfolders
2021-11-06 21:05:33 +00:00
#include "tests/core/variant/test_array.h"
#include "tests/core/variant/test_dictionary.h"
#include "tests/core/variant/test_variant.h"
Add a unit test suite for Animation
2022-01-21 13:12:55 +00:00
#include "tests/scene/test_animation.h"
Move and organize tests into subfolders
2021-11-06 21:05:33 +00:00
#include "tests/scene/test_code_edit.h"
#include "tests/scene/test_curve.h"
#include "tests/scene/test_gradient.h"
#include "tests/scene/test_path_3d.h"
Add inital TextEdit UnitTests
2022-04-22 16:53:58 +00:00
#include "tests/scene/test_text_edit.h"
Validate theme type/item names
2022-04-26 10:21:34 +00:00
#include "tests/scene/test_theme.h"
Move and organize tests into subfolders
2021-11-06 21:05:33 +00:00
#include "tests/servers/test_text_server.h"
#include "tests/test_validate_testing.h"
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
Enable support for C++ modules tests Modules-specific tests can be written under respective module folders. Each module should have "tests" folder created with the tests implemented as `doctest` headers, so they can be collected by the buildsystem and included directly in `tests/test_main.cpp` to be compiled.
2020-07-26 11:46:44 +00:00
#include "modules/modules_tests.gen.h"
Hide implementation details of doctest macros `test_macros.h` is created to provide various macros acting as aliases for doctest macros to work better with Godot internals and conventions. This also makes it accessible for those who'd like to start writing tests in Godot, as most vital information can be put together and documented directly in `test_macros.h` header. Developers are encouraged to include the new `tests/test_macros.h` for writing new tests over `thirdparty/doctest/doctest.h`. Added `TEST_CASE_PENDING("name")` as an alias for `TEST_CASE("name", doctest::skip())` which could be used to mark failing tests for issues yet to be fixed, so as to not affect CI testing results. Added `ERR_PRINT_OFF` and `ERR_PRINT_ON` to control error printing for testing various **expected** failure paths within Godot without polluting the test summary with error messages.
2020-07-30 13:54:08 +00:00
#include "tests/test_macros.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Move and organize tests into subfolders
2021-11-06 21:05:33 +00:00
#include "scene/resources/default_theme/default_theme.h"
Improve compilation speed (forward declarations/includes cleanup)
2022-02-12 01:46:22 +00:00
#include "servers/navigation_server_2d.h"
#include "servers/navigation_server_3d.h"
#include "servers/physics_server_2d.h"
#include "servers/physics_server_3d.h"
#include "servers/rendering/rendering_server_default.h"
Move and organize tests into subfolders
2021-11-06 21:05:33 +00:00
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
int test_main(int argc, char *argv[]) {
Register GDScript test tools as test commands to run via command-line
2020-08-18 14:24:45 +00:00
bool run_tests = true;
// Convert arguments to Godot's command-line.
List<String> args;
for (int i = 0; i < argc; i++) {
args.push_back(String::utf8(argv[i]));
}
Add support for command-line user arguments. Implements the standard Unix double dash (--) commandline argument: * Arguments after a double dash (--) are ignored by Godot and stored for the user. * User can access them via `OS.get_cmdline_user_args()` Example: `godot.exe scene_to_run.tscn --fullscreen -- --start-level 2`
2022-07-29 13:30:52 +00:00
OS::get_singleton()->set_cmdline("", args, List<String>());
Register GDScript test tools as test commands to run via command-line
2020-08-18 14:24:45 +00:00
// Run custom test tools.
if (test_commands) {
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
for (const KeyValue<String, TestFunc> &E : (*test_commands)) {
if (args.find(E.key)) {
const TestFunc &test_func = E.value;
Register GDScript test tools as test commands to run via command-line
2020-08-18 14:24:45 +00:00
test_func();
run_tests = false;
break;
}
}
if (!run_tests) {
delete test_commands;
return 0;
}
}
Cleanup obsolete tests from displaying in help
2020-07-29 12:07:16 +00:00
// Doctest runner.
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
doctest::Context test_context;
Register GDScript test tools as test commands to run via command-line
2020-08-18 14:24:45 +00:00
List<String> test_args;
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
Cleanup obsolete tests from displaying in help
2020-07-29 12:07:16 +00:00
// Clean arguments of "--test" from the args.
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
for (int x = 0; x < argc; x++) {
Fix doctest runner ignoring all arguments starting with --test Instead of just the one argument that is exactly --test. The long-form arguments --test-case and --test-suite were ignored.
2020-09-01 20:46:05 +00:00
String arg = String(argv[x]);
if (arg != "--test") {
test_args.push_back(arg);
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
}
}
Fix some warnings raised by GCC-11.1
2021-05-25 15:03:12 +00:00
if (test_args.size() > 0) {
// Convert Godot command line arguments back to standard arguments.
char **doctest_args = new char *[test_args.size()];
for (int x = 0; x < test_args.size(); x++) {
// Operation to convert Godot string to non wchar string.
CharString cs = test_args[x].utf8();
const char *str = cs.get_data();
// Allocate the string copy.
doctest_args[x] = new char[strlen(str) + 1];
// Copy this into memory.
memcpy(doctest_args[x], str, strlen(str) + 1);
}
test_context.applyCommandLine(test_args.size(), doctest_args);
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
Fix some warnings raised by GCC-11.1
2021-05-25 15:03:12 +00:00
for (int x = 0; x < test_args.size(); x++) {
delete[] doctest_args[x];
}
delete[] doctest_args;
Fix memory leak in test args
2020-07-31 20:58:22 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Cleanup obsolete tests from displaying in help
2020-07-29 12:07:16 +00:00
return test_context.run();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
struct GodotTestCaseListener : public doctest::IReporter {
GodotTestCaseListener(const doctest::ContextOptions &p_in) {}
Create framework for testing Signals
2021-07-11 14:21:03 +00:00
SignalWatcher *signal_watcher = nullptr;
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
PhysicsServer3D *physics_server_3d = nullptr;
PhysicsServer2D *physics_server_2d = nullptr;
NavigationServer3D *navigation_server_3d = nullptr;
NavigationServer2D *navigation_server_2d = nullptr;
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
void test_case_start(const doctest::TestCaseData &p_in) override {
Create framework for testing Signals
2021-07-11 14:21:03 +00:00
SignalWatcher::get_singleton()->_clear_signals();
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
String name = String(p_in.m_name);
if (name.find("[SceneTree]") != -1) {
GLOBAL_DEF("memory/limits/multithreaded_server/rid_pool_prealloc", 60);
memnew(MessageQueue);
GLOBAL_DEF("internationalization/rendering/force_right_to_left_layout_direction", false);
Use Input::push_input for tests plus extra mouse testing
2022-04-22 16:39:12 +00:00
memnew(Input);
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
Error err = OK;
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
OS::get_singleton()->set_has_server_feature_callback(nullptr);
for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
if (String("headless") == DisplayServer::get_create_function_name(i)) {
DisplayServer::create(i, "", DisplayServer::WindowMode::WINDOW_MODE_MINIMIZED, DisplayServer::VSyncMode::VSYNC_ENABLED, 0, Vector2i(0, 0), err);
break;
}
}
memnew(RenderingServerDefault());
RenderingServerDefault::get_singleton()->init();
RenderingServerDefault::get_singleton()->set_render_loop_enabled(false);
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
physics_server_3d = PhysicsServer3DManager::new_default_server();
physics_server_3d->init();
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
physics_server_2d = PhysicsServer2DManager::new_default_server();
physics_server_2d->init();
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
navigation_server_3d = NavigationServer3DManager::new_default_server();
navigation_server_2d = memnew(NavigationServer2D);
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
memnew(InputMap);
InputMap::get_singleton()->load_default();
Add MSDF and mipmap generation project settings for the default font This can be used to improve Label3D and scaled Control appearance in prototypes.
2022-04-22 18:05:54 +00:00
make_default_theme(1.0, Ref<Font>());
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
memnew(SceneTree);
SceneTree::get_singleton()->initialize();
return;
}
}
void test_case_end(const doctest::CurrentTestCaseStats &) override {
if (SceneTree::get_singleton()) {
SceneTree::get_singleton()->finalize();
}
if (MessageQueue::get_singleton()) {
MessageQueue::get_singleton()->flush();
}
if (SceneTree::get_singleton()) {
memdelete(SceneTree::get_singleton());
}
clear_default_theme();
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
if (navigation_server_3d) {
memdelete(navigation_server_3d);
navigation_server_3d = nullptr;
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
}
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
if (navigation_server_2d) {
memdelete(navigation_server_2d);
navigation_server_2d = nullptr;
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
}
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
if (physics_server_3d) {
physics_server_3d->finish();
memdelete(physics_server_3d);
physics_server_3d = nullptr;
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
}
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
if (physics_server_2d) {
physics_server_2d->finish();
memdelete(physics_server_2d);
physics_server_2d = nullptr;
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
}
Use Input::push_input for tests plus extra mouse testing
2022-04-22 16:39:12 +00:00
if (Input::get_singleton()) {
memdelete(Input::get_singleton());
}
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
if (RenderingServer::get_singleton()) {
RenderingServer::get_singleton()->sync();
Rename RenderingServer global shader uniform methods to be more explicit The `global_shader_uniform` name is longer, but it makes it much easier to find the methods when searching in the class reference.
2022-04-03 16:56:43 +00:00
RenderingServer::get_singleton()->global_shader_uniforms_clear();
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
RenderingServer::get_singleton()->finish();
memdelete(RenderingServer::get_singleton());
}
if (DisplayServer::get_singleton()) {
memdelete(DisplayServer::get_singleton());
}
if (InputMap::get_singleton()) {
memdelete(InputMap::get_singleton());
}
if (MessageQueue::get_singleton()) {
MessageQueue::get_singleton()->flush();
memdelete(MessageQueue::get_singleton());
}
}
Create framework for testing Signals
2021-07-11 14:21:03 +00:00
void test_run_start() override {
signal_watcher = memnew(SignalWatcher);
}
void test_run_end(const doctest::TestRunStats &) override {
memdelete(signal_watcher);
}
void test_case_reenter(const doctest::TestCaseData &) override {
SignalWatcher::get_singleton()->_clear_signals();
}
void subcase_start(const doctest::SubcaseSignature &) override {
SignalWatcher::get_singleton()->_clear_signals();
}
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
void report_query(const doctest::QueryData &) override {}
void test_case_exception(const doctest::TestCaseException &) override {}
void subcase_end() override {}
Create framework for testing Signals
2021-07-11 14:21:03 +00:00
Allow unit testing SceneTree Ojects
2021-07-11 13:25:27 +00:00
void log_assert(const doctest::AssertData &in) override {}
void log_message(const doctest::MessageData &) override {}
void test_case_skipped(const doctest::TestCaseData &) override {}
};
REGISTER_LISTENER("GodotTestCaseListener", 1, GodotTestCaseListener);
Reference in New Issue Copy Permalink