GDScript: Load global classes when running debug tests

[vnen]

So when running compiler debug tests it works with dependencies within a project.

[dalexeev]

I tested it. This works under the following conditions:

1. It's bin/<godot executable> --test gdscript-compiler <path/to/script.gd> command (test_gdscript.cpp).
2. There is project.godot file.
3. There is correct .godot/global_script_class_cache.cfg file.

It doesn't work for regular tests bin/<godot executable> --test (gdscript_test_runner.cpp). Is it intentional?

[anvilfolk]

Interesting! So this only works because it's done within the context of a project. Is there any situation in which this might be run but there is no ProjectSettings singleton, which might cause a crash?

I was working on something similar to try to add a unit test to #79205, but there we cannot rely on ProjectSettings, I believe. My attempted solution was to add global class names found in .gd test scripts, as well as .notest.gd test scripts. Unfortunately that wasn't enough to make the class loadable and I didn't investigate further.

[vnen]

It doesn't work for regular tests bin/<godot executable> --test (gdscript_test_runner.cpp). Is it intentional?

Yes, the test runner does not use a project nor the global classes config. It generates the index on the fly from all the test files:

godot/modules/gdscript/tests/gdscript_test_runner.cpp

Lines 321 to 337 in f618701

	bool GDScriptTestRunner::generate_class_index() {
	StringName gdscript_name = GDScriptLanguage::get_singleton()->get_name();
	for (int i = 0; i < tests.size(); i++) {
	GDScriptTest test = tests[i];
	String base_type;
	String class_name = GDScriptLanguage::get_singleton()->get_global_class_name(test.get_source_file(), &base_type);
	if (class_name.is_empty()) {
	continue;
	}
	ERR_FAIL_COND_V_MSG(ScriptServer::is_global_class(class_name), false,
	"Class name '" + class_name + "' from " + test.get_source_file() + " is already used in " + ScriptServer::get_global_class_path(class_name));
	ScriptServer::add_global_class(class_name, base_type, gdscript_name, test.get_source_file());
	}
	return true;
	}

Interesting! So this only works because it's done within the context of a project. Is there any situation in which this might be run but there is no ProjectSettings singleton, which might cause a crash?

I don't think there's such case. This code is really only run from one code path AFAIK.

[adamscott]

Approved. It has been tested and it works. Thanks @vnen!

[akien-mga]

Thanks!