Proof of concept for a hot-reload test case

Author: enetheru

cmake/godotcpp.cmake

@@ -139,6 +139,9 @@ function(godotcpp_options)
     #TODO compiledb_file
 
     set(GODOTCPP_BUILD_PROFILE "" CACHE PATH "Path to a file containing a feature build profile")
+    if(GODOTCPP_BUILD_PROFILE AND EXISTS "${GODOTCPP_BUILD_PROFILE}")
+        set_property(SOURCE APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${GODOTCPP_BUILD_PROFILE}")
+    endif()
 
     set(GODOTCPP_USE_HOT_RELOAD "" CACHE BOOL "Enable the extra accounting required to support hot reload. (ON|OFF)")
 

test/build_profile.json

@@ -8,6 +8,10 @@
 		"OS",
 		"TileMap",
 		"TileSet",
-		"Viewport"
+		"Viewport",
+		"Engine",
+		"DirAccess",
+		"EditorInterface",
+		"GDExtensionManager"
 	]
 }

test/project/example.gdextension

@@ -2,6 +2,7 @@
 
 entry_symbol = "example_library_init"
 compatibility_minimum = "4.1"
+reloadable = true
 
 [libraries]
 

test/project/icon.png.import

@@ -18,13 +18,19 @@ dest_files=["res://.godot/imported/icon.png-487276ed1e3a0c39cad0279d744ee560.cte
 compress/mode=0
 compress/high_quality=false
 compress/lossy_quality=0.7
+compress/uastc_level=0
+compress/rdo_quality_loss=0.0
 compress/hdr_compression=1
 compress/normal_map=0
 compress/channel_pack=0
 mipmaps/generate=false
 mipmaps/limit=-1
 roughness/mode=0
 roughness/src_normal=""
+process/channel_remap/red=0
+process/channel_remap/green=1
+process/channel_remap/blue=2
+process/channel_remap/alpha=3
 process/fix_alpha_border=true
 process/premult_alpha=false
 process/normal_map_invert_y=false

test/project/project.godot

@@ -12,7 +12,7 @@ config_version=5
 
 config/name="GDExtension Test Project"
 run/main_scene="res://main.tscn"
-config/features=PackedStringArray("4.4")
+config/features=PackedStringArray("4.5")
 config/icon="res://icon.png"
 
 [native_extensions]

test/project/reload.gd

@@ -0,0 +1,26 @@
+@tool
+extends Example
+
+func _on_custom_signal( _msg, _value ) -> void:
+	print_rich("[color=green] ******** PASSED ******** [/color]")
+	get_tree().quit(0)
+
+
+func _on_timeout():
+	print_rich("[color=red] ******** FAILED ********[/color]")
+	get_tree().quit(1)
+
+
+func _ready() -> void:
+	# Dont quit if the reload test isn't specified on the command line.
+	if not 'test_reload' in OS.get_cmdline_args(): return
+
+	print("gdscript:Reload Test is Enabled")
+	# Connect to the custom signal of Example
+	custom_signal.connect(_on_custom_signal)
+
+	# Start 5s watchdog timer
+	var timer = get_tree().create_timer(10.0)
+	timer.timeout.connect(_on_timeout)
+
+	print("Awaiting Custom Signal (with 10s timeout)")

test/project/reload.gd.uid

@@ -0,0 +1 @@
+uid://c8v75k3p4pnjj

test/project/reload.tscn

@@ -0,0 +1,6 @@
+[gd_scene load_steps=2 format=3 uid="uid://b4wrd36npp8ov"]
+
+[ext_resource type="Script" uid="uid://c8v75k3p4pnjj" path="res://reload.gd" id="1_icw2l"]
+
+[node name="Reload" type="Example"]
+script = ExtResource("1_icw2l")

test/run-tests.ps1

@@ -0,0 +1,82 @@
+# Define Godot executable (uses environment variable if set, else defaults to 'godot')
+$GODOT = if ($env:GODOT) { $env:GODOT } else { 'godot' }
+
+$END_STRING = "==== TESTS FINISHED ===="
+$FAILURE_STRING = "******** FAILED ********"
+$HAS_FAILURE = 0
+
+# Function to filter spam from output
+function Filter-Output {
+    param([string[]]$Lines)
+    $Lines | ForEach-Object { $_.TrimEnd() } | Where-Object {
+        $_ -notmatch "Narrowing conversion" -and
+        $_ -notmatch "at:\s+GDScript::reload" -and
+        $_ -notmatch "\[\s*\d+%\s*\]" -and
+        $_ -notmatch "first_scan_filesystem" -and
+        $_ -notmatch "loading_editor_layout"
+    }
+}
+
+# Run Godot and capture output and exit code
+try {
+    $OUTPUT = & $GODOT --path project --debug --headless --quit 2>&1
+    $ERRCODE = $LASTEXITCODE
+}
+catch {
+    $OUTPUT = $_.Exception.Message
+    $ERRCODE = 1
+}
+
+# Output the results
+Write-Output $OUTPUT
+Write-Output ""
+
+# Check if tests completed
+if (-not ($OUTPUT -match [regex]::Escape($END_STRING))) {
+    $HAS_FAILURE += 1
+}
+
+# Check for test failures
+if ($OUTPUT -match [regex]::Escape($FAILURE_STRING)) {
+    $HAS_FAILURE += 1
+}
+
+# Lock file path (relative to project dir)
+$LOCK_PATH = "project/test_reload_lock"
+
+# Delete lock file before reload test if it exists
+Remove-Item -Path $LOCK_PATH -Force -ErrorAction SilentlyContinue
+
+# Run Godot and capture output and exit code
+try {
+    $OUTPUT = & $GODOT -e --path project --scene reload.tscn --headless --debug test_reload 2>&1
+    $ERRCODE = $LASTEXITCODE
+}
+catch {
+    $OUTPUT = $_.Exception.Message
+    $ERRCODE = 1
+}
+
+# Filter and output the results
+$FilteredOutput = Filter-Output -Lines ($OUTPUT -split "`n")
+Write-Output ($FilteredOutput -join "`n")
+Write-Output ""
+
+# Check for test failures
+if ($OUTPUT -match [regex]::Escape($FAILURE_STRING)) {
+    $HAS_FAILURE += 1
+}
+
+# Lock file path (relative to project dir)
+$LOCK_PATH = "project/test_reload_lock"
+
+# Delete lock file before reload test if it exists
+Remove-Item -Path $LOCK_PATH -Force -ErrorAction SilentlyContinue
+
+if ($HAS_FAILURE -gt 0 ){
+    Write-Output "ERROR: Tests failed to complete"
+    exit 1
+}
+
+# Success!
+exit 0

test/src/example.cpp

@@ -114,6 +114,9 @@ void Example::_notification(int p_what) {
 		rpc_config("test_rpc", opts);
 	}
 	//UtilityFunctions::print("Notification: ", String::num(p_what));
+	if (p_what == NOTIFICATION_EXTENSION_RELOADED) {
+		emit_custom_signal("NOTIFICATION_EXTENSION_RELOADED ", 0);
+	}
 }
 
 bool Example::_set(const StringName &p_name, const Variant &p_value) {