# A class doubler used to mock and spy checked implementations class_name GdUnitClassDoubler extends RefCounted const DOUBLER_INSTANCE_ID_PREFIX := "gdunit_doubler_instance_id_" const EXCLUDE_VIRTUAL_FUNCTIONS = [ # we have to exclude notifications because NOTIFICATION_PREDELETE is try # to delete already freed spy/mock resources and will result in a conflict "_notification", "notification", # https://github.com/godotengine/godot/issues/67461 "get_name", "get_path", "duplicate", ] # define functions to be exclude when spy or mock checked a scene const EXLCUDE_SCENE_FUNCTIONS = [ # needs to exclude get/set script functions otherwise it endsup in recursive endless loop "set_script", "get_script", # needs to exclude otherwise verify fails checked collection arguments checked calling to string "_to_string", ] const EXCLUDE_FUNCTIONS = ["new", "free", "get_instance_id", "get_tree"] static func check_leaked_instances() -> void: ## we check that all registered spy/mock instances are removed from the engine meta data for key in Engine.get_meta_list(): if key.begins_with(DOUBLER_INSTANCE_ID_PREFIX): var instance: Variant = Engine.get_meta(key) push_error("GdUnit internal error: an spy/mock instance '%s', class:'%s' is not removed from the engine and will lead in a leaked instance!" % [instance, instance.__SOURCE_CLASS]) await (Engine.get_main_loop() as SceneTree).process_frame # loads the doubler template # class_info = { "class_name": <>, "class_path" : <>} static func load_template(template: String, class_info: Dictionary) -> PackedStringArray: var clazz_name: String = class_info.get("class_name") var source_code := template\ .replace("${source_class}", clazz_name)\ # Replace template class_name DoubledClass with source class name .replace("SourceClassName", clazz_name.replace(".", "_")) var lines := GdScriptParser.to_unix_format(source_code).split("\n") @warning_ignore("return_value_discarded") lines.insert(1, extends_clazz(class_info)) lines.insert(0, "@warning_ignore_start('unsafe_call_argument', 'shadowed_variable', 'untyped_declaration', 'native_method_override', 'int_as_enum_without_cast')") return lines static func extends_clazz(class_info: Dictionary) -> String: var clazz_name: String = class_info.get("class_name") var clazz_path: PackedStringArray = class_info.get("class_path", []) # is inner class? if clazz_path.size() > 1: return "extends %s" % clazz_name if clazz_path.size() == 1 and clazz_path[0].ends_with(".gd"): return "extends '%s'" % clazz_path[0] return "extends %s" % clazz_name # double all functions of given instance static func double_functions(instance: Object, clazz_name: String, clazz_path: PackedStringArray, func_doubler: GdFunctionDoubler, exclude_functions: Array) -> PackedStringArray: var doubled_source := PackedStringArray() var parser := GdScriptParser.new() var exclude_override_functions := EXCLUDE_VIRTUAL_FUNCTIONS + EXCLUDE_FUNCTIONS + exclude_functions var functions := Array() # double script functions if not ClassDB.class_exists(clazz_name): var result := parser.parse(clazz_name, clazz_path) if result.is_error(): push_error(result.error_message()) return PackedStringArray() var class_descriptor: GdClassDescriptor = result.value() for func_descriptor in class_descriptor.functions(): if instance != null and not instance.has_method(func_descriptor.name()): #prints("no virtual func implemented",clazz_name, func_descriptor.name() ) continue if functions.has(func_descriptor.name()) or exclude_override_functions.has(func_descriptor.name()): continue doubled_source += func_doubler.double(func_descriptor) functions.append(func_descriptor.name()) # double regular class functions var clazz_functions := GdObjects.extract_class_functions(clazz_name, clazz_path) for method: Dictionary in clazz_functions: var func_descriptor := GdFunctionDescriptor.extract_from(method) # exclude private core functions if func_descriptor.is_private(): continue if functions.has(func_descriptor.name()) or exclude_override_functions.has(func_descriptor.name()): continue # GD-110: Hotfix do not double invalid engine functions if is_invalid_method_descriptior(method): #prints("'%s': invalid method descriptor found! %s" % [clazz_name, method]) continue # do not double on not implemented virtual functions if instance != null and not instance.has_method(func_descriptor.name()): #prints("no virtual func implemented",clazz_name, func_descriptor.name() ) continue functions.append(func_descriptor.name()) doubled_source.append_array(func_doubler.double(func_descriptor)) return doubled_source # GD-110 static func is_invalid_method_descriptior(method: Dictionary) -> bool: var return_info: Dictionary = method["return"] var type: int = return_info["type"] var usage: int = return_info["usage"] var clazz_name: String = return_info["class_name"] # is method returning a type int with a given 'class_name' we have an enum # and the PROPERTY_USAGE_CLASS_IS_ENUM must be set if type == TYPE_INT and not clazz_name.is_empty() and not (usage & PROPERTY_USAGE_CLASS_IS_ENUM): return true if clazz_name == "Variant.Type": return true return false