/**************************************************************************/ /* gdscript_test_runner_suite.h */ /**************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /**************************************************************************/ /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ /* */ /* 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. */ /**************************************************************************/ #ifndef GDSCRIPT_TEST_RUNNER_SUITE_H #define GDSCRIPT_TEST_RUNNER_SUITE_H #include "gdscript_test_runner.h" #include "tests/test_macros.h" namespace GDScriptTests { TEST_SUITE("[Modules][GDScript]") { // GDScript 2.0 is still under heavy construction. // Allow the tests to fail, but do not ignore errors during development. // Update the scripts and expected output as needed. TEST_CASE("Script compilation and runtime") { bool print_filenames = OS::get_singleton()->get_cmdline_args().find("--print-filenames") != nullptr; GDScriptTestRunner runner("modules/gdscript/tests/scripts", true, print_filenames); int fail_count = runner.run_tests(); INFO("Make sure `*.out` files have expected results."); REQUIRE_MESSAGE(fail_count == 0, "All GDScript tests should pass."); } } TEST_CASE("[Modules][GDScript] Load source code dynamically and run it") { Ref<GDScript> gdscript = memnew(GDScript); gdscript->set_source_code(R"( extends RefCounted func _init(): set_meta("result", 42) )"); // A spurious `Condition "err" is true` message is printed (despite parsing being successful and returning `OK`). // Silence it. ERR_PRINT_OFF; const Error error = gdscript->reload(); ERR_PRINT_ON; CHECK_MESSAGE(error == OK, "The script should parse successfully."); // Run the script by assigning it to a reference-counted object. Ref<RefCounted> ref_counted = memnew(RefCounted); ref_counted->set_script(gdscript); CHECK_MESSAGE(int(ref_counted->get_meta("result")) == 42, "The script should assign object metadata successfully."); } TEST_CASE("[Modules][GDScript] Validate built-in API") { GDScriptLanguage *lang = GDScriptLanguage::get_singleton(); // Validate methods. List<MethodInfo> builtin_methods; lang->get_public_functions(&builtin_methods); SUBCASE("[Modules][GDScript] Validate built-in methods") { for (const MethodInfo &mi : builtin_methods) { for (int j = 0; j < mi.arguments.size(); j++) { PropertyInfo arg = mi.arguments[j]; TEST_COND((arg.name.is_empty() || arg.name.begins_with("_unnamed_arg")), vformat("Unnamed argument in position %d of built-in method '%s'.", j, mi.name)); } } } // Validate annotations. List<MethodInfo> builtin_annotations; lang->get_public_annotations(&builtin_annotations); SUBCASE("[Modules][GDScript] Validate built-in annotations") { for (const MethodInfo &ai : builtin_annotations) { for (int j = 0; j < ai.arguments.size(); j++) { PropertyInfo arg = ai.arguments[j]; TEST_COND((arg.name.is_empty() || arg.name.begins_with("_unnamed_arg")), vformat("Unnamed argument in position %d of built-in annotation '%s'.", j, ai.name)); } } } } } // namespace GDScriptTests #endif // GDSCRIPT_TEST_RUNNER_SUITE_H