Add basic test for Coroutine

Author: CedNaru

harness/tests/Spatial.tscn

@@ -2,30 +2,27 @@
 
 [ext_resource type="Script" path="res://scripts/godot/tests/Invocation.gdj" id="1"]
 
-[sub_resource type="NavigationMesh" id="NavigationMesh_prd4u"]
+[sub_resource type="NavigationMesh" id="NavigationMesh_1ex3u"]
 
-[sub_resource type="NavigationMesh" id="NavigationMesh_tuyoa"]
+[sub_resource type="NavigationMesh" id="NavigationMesh_q3pqa"]
 
-[sub_resource type="NavigationMesh" id="NavigationMesh_bh4po"]
+[sub_resource type="NavigationMesh" id="NavigationMesh_hn8kg"]
 
-[sub_resource type="NavigationMesh" id="NavigationMesh_bdc7j"]
+[sub_resource type="NavigationMesh" id="NavigationMesh_87cay"]
 
-[sub_resource type="NavigationMesh" id="NavigationMesh_abcao"]
+[sub_resource type="NavigationMesh" id="NavigationMesh_b12lh"]
 
-[node name="Spatial" type="Node3D" node_paths=PackedStringArray("button")]
+[node name="Spatial" type="Node3D"]
 script = ExtResource("1")
-button = NodePath("CanvasLayer/Button")
-nullable_long = 2
-lateinit_string = "works also from inspector"
-resource_test = SubResource("NavigationMesh_prd4u")
-jvm_id = 319061373
-nav_meshes = Array[NavigationMesh]([SubResource("NavigationMesh_tuyoa")])
-nullable_array = Array[NavigationMesh]([SubResource("NavigationMesh_bh4po"), null])
+resource_test = SubResource("NavigationMesh_1ex3u")
+jvm_id = 780172372
+nav_meshes = Array[NavigationMesh]([SubResource("NavigationMesh_q3pqa")])
+nullable_array = Array[NavigationMesh]([SubResource("NavigationMesh_hn8kg"), null])
 nav_meshes_dictionary = {
-"AwesomeNavmesh": SubResource("NavigationMesh_bdc7j")
+"AwesomeNavmesh": SubResource("NavigationMesh_87cay")
 }
 nullable_dictionary = {
-"notnull": SubResource("NavigationMesh_abcao"),
+"notnull": SubResource("NavigationMesh_b12lh"),
 "null": null
 }
 

harness/tests/src/main/kotlin/godot/tests/Invocation.kt

@@ -40,6 +40,8 @@ import godot.core.Vector3
 import godot.core.asStringName
 import godot.core.dictionaryOf
 import godot.core.variantArrayOf
+import godot.coroutines.GodotCoroutine
+import godot.coroutines.await
 import godot.extensions.getNodeAs
 import godot.registration.Range
 import godot.signals.connect
@@ -392,6 +394,12 @@ class Invocation : Node3D() {
 
 	@RegisterFunction
 	override fun _ready() {
+        GodotCoroutine{
+            println("Before")
+            signalWithMultipleTargets.await()
+            println("After")
+        }
+
 		val formerName = name
 		println("Name is: $name")
 		name = "TestName".asStringName()

harness/tests/test/GutTests.gd

@@ -21,53 +21,53 @@ var _current_test_name = null
 
 
 func _ready():
-	simple_setup()
-	# complex_setup()
+    simple_setup()
+    # complex_setup()
 
 
 func simple_setup():
-	# You must load a gut config file to use this control.  Here we are loading
-	# the default config file used by the command line.  You can use any config
-	# file you have created.  Use the "save as" button in the Settings subpanel
-	# to create a config file, or write your own.
-	#
-	# Some settings may not work.  For example, the exit flags do not have any
-	# effect.
-	#
-	# Settings are not saved, so any changes will be lost. The idea is that you
-	# want to deploy the settings and users should not be able to save them.  If
-	# you want to save changes, you can call:
-	# 	_gut_control.get_config().write_options(path).
-	# Note that you cannot to write to res:// on mobile platforms, so you will
-	# have to juggle the initial loading from res:// or user:// and save to
-	# user://.
-	_gut_control.load_config_file('res://.gutconfig.json')
-
-	# That's it.  Just get a reference to the control you added to the scene and
-	# give it a config.  The rest of the stuff in this script optional.
+    # You must load a gut config file to use this control.  Here we are loading
+    # the default config file used by the command line.  You can use any config
+    # file you have created.  Use the "save as" button in the Settings subpanel
+    # to create a config file, or write your own.
+    #
+    # Some settings may not work.  For example, the exit flags do not have any
+    # effect.
+    #
+    # Settings are not saved, so any changes will be lost. The idea is that you
+    # want to deploy the settings and users should not be able to save them.  If
+    # you want to save changes, you can call:
+    # 	_gut_control.get_config().write_options(path).
+    # Note that you cannot to write to res:// on mobile platforms, so you will
+    # have to juggle the initial loading from res:// or user:// and save to
+    # user://.
+    _gut_control.load_config_file('res://.gutconfig.json')
+
+    # That's it.  Just get a reference to the control you added to the scene and
+    # give it a config.  The rest of the stuff in this script optional.
 
 
 
 func complex_setup():
-	# See simple setup
-	_gut_control.load_config_file('res://.gutconfig.json')
+    # See simple setup
+    _gut_control.load_config_file('res://.gutconfig.json')
 
-	# Returns a gut_config.gd instance.
-	var config = _gut_control.get_config()
+    # Returns a gut_config.gd instance.
+    var config = _gut_control.get_config()
 
-	# Override specific values for the purposes of this scene.  You can see all
-	# the options available in the default_options dictionary in gut_config.gd.
-	# Changing settings AFTER _ready will not have any effect.
-	config.options.should_exit = false
-	config.options.should_exit_on_success = false
-	config.options.compact_mode = false
-	# Note that if you are exporting xml results you may want to set the path to
-	# a file in user:// instead of an absolute path.  Your game may not have
-	# permissions to save files elsewhere when running on a mobile device.
-	config.options.junit_xml_file = 'user://deployed_results.xml'
+    # Override specific values for the purposes of this scene.  You can see all
+    # the options available in the default_options dictionary in gut_config.gd.
+    # Changing settings AFTER _ready will not have any effect.
+    config.options.should_exit = false
+    config.options.should_exit_on_success = false
+    config.options.compact_mode = false
+    # Note that if you are exporting xml results you may want to set the path to
+    # a file in user:// instead of an absolute path.  Your game may not have
+    # permissions to save files elsewhere when running on a mobile device.
+    config.options.junit_xml_file = 'user://deployed_results.xml'
 
-	# Some actions cannot be done until after _ready has finished in all objects
-	_post_ready_setup.call_deferred()
+    # Some actions cannot be done until after _ready has finished in all objects
+    _post_ready_setup.call_deferred()
 
 
 
@@ -76,63 +76,63 @@ func complex_setup():
 # so after _ready.  This is an example of getting a reference to gut and all
 # of the signals it provides.
 func _post_ready_setup():
-	var gut = _gut_control.get_gut()
-	gut.start_run.connect(_on_gut_run_start)
+    var gut = _gut_control.get_gut()
+    gut.start_run.connect(_on_gut_run_start)
 
-	gut.start_script.connect(_on_gut_start_script)
-	gut.end_script.connect(_on_gut_end_script)
+    gut.start_script.connect(_on_gut_start_script)
+    gut.end_script.connect(_on_gut_end_script)
 
-	gut.start_test.connect(_on_gut_start_test)
-	gut.end_test.connect(_on_gut_end_test)
+    gut.start_test.connect(_on_gut_start_test)
+    gut.end_test.connect(_on_gut_end_test)
 
-	gut.end_run.connect(_on_gut_run_end)
+    gut.end_run.connect(_on_gut_run_end)
 
 
 # -----------------------
 # Events
 # -----------------------
 func _on_gut_run_start():
-	print('Starting tests')
+    print('Starting tests')
 
 
 # This signal passes a TestCollector.gd/TestScript instance
 func _on_gut_start_script(script_obj):
-	print(script_obj.get_full_name(), ' has ', script_obj.tests.size(), ' tests')
-	_current_script_object = script_obj
+    print(script_obj.get_full_name(), ' has ', script_obj.tests.size(), ' tests')
+    _current_script_object = script_obj
 
 
 func _on_gut_end_script():
-	var pass_count = 0
-	for test in _current_script_object.tests:
-		if(test.did_pass()):
-			pass_count += 1
-	print(pass_count, '/', _current_script_object.tests.size(), " passed\n")
-	_current_script_object = null
+    var pass_count = 0
+    for test in _current_script_object.tests:
+        if(test.did_pass()):
+            pass_count += 1
+    print(pass_count, '/', _current_script_object.tests.size(), " passed\n")
+    _current_script_object = null
 
 
 func _on_gut_start_test(test_name):
-	_current_test_name = test_name
-	print('  ', test_name)
+    _current_test_name = test_name
+    print('  ', test_name)
 
 
 func _on_gut_end_test():
-	# get_test_named returns a TestCollector.gd/Test instance for the name
-	# passed in.
-	var test_object = _current_script_object.get_test_named(_current_test_name)
-	var status = "failed"
-	if(test_object.did_pass()):
-		status = "passed"
-	elif(test_object.pending):
-		status = "pending"
+    # get_test_named returns a TestCollector.gd/Test instance for the name
+    # passed in.
+    var test_object = _current_script_object.get_test_named(_current_test_name)
+    var status = "failed"
+    if(test_object.did_pass()):
+        status = "passed"
+    elif(test_object.pending):
+        status = "pending"
 
-	print('    ', status)
-	_current_test_name = null
+    print('    ', status)
+    _current_test_name = null
 
 
 func _on_gut_run_end():
-	print('Tests Done')
+    print('Tests Done')
 
 
 # You can kick of the tests via code if you want.
 func _on_run_gut_tests_button_pressed():
-	_gut_control.run_tests()
+    _gut_control.run_tests()

harness/tests/test/GutTests.tscn

@@ -9,3 +9,4 @@ script = ExtResource("1_on71t")
 [node name="GutControl" parent="." instance=ExtResource("1_qrxmy")]
 offset_right = 1171.0
 offset_bottom = 639.0
+bg_color = Color(0, 0, 0, 1)

kt/godot-coroutine-library/build.gradle.kts

@@ -26,11 +26,9 @@ java {
 }
 
 dependencies {
-    // added here as a transitive dependency so the user can use reflection
-    // we need to add it here so reflection is available where the code is loaded (Bootstrap.kt) otherwise it will not work
-    api(kotlin("reflect", version = libs.versions.kotlin.get()))
+    compileOnly(project(":godot-library"))
     implementation("com.utopia-rise:tools-common:$fullGodotKotlinJvmVersion")
-    testImplementation("junit", "junit", "4.12")
+    api("org.jetbrains.kotlinx:kotlinx-coroutines-core:${libs.versions.kotlinCoroutine.get()}")
 }
 
 val targetSuffix = if (isRelease) "release" else "debug"

kt/godot-coroutine-library/src/main/kotlin/godot/coroutines/GodotContinuation.kt

@@ -0,0 +1,16 @@
+package godot.coroutines
+
+import kotlin.coroutines.Continuation
+import kotlin.coroutines.CoroutineContext
+
+class GodotContinuation(override val context: CoroutineContext): Continuation<Unit> {
+
+    override fun resumeWith(result: Result<Unit>) {
+        TODO("Not yet implemented")
+    }
+
+
+    private object Bridge {
+        external fun engine_call_constructor(): VoidPtr
+    }
+}

kt/godot-coroutine-library/src/main/kotlin/godot/coroutines/GodotCoroutine.kt

@@ -0,0 +1,15 @@
+package godot.coroutines
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.CoroutineStart
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.launch
+import kotlin.coroutines.EmptyCoroutineContext
+
+object GodotCoroutine {
+    private val scope = CoroutineScope(EmptyCoroutineContext)
+
+    operator fun invoke( block: suspend CoroutineScope.() -> Unit) {
+        scope.launch(Dispatchers.Default, CoroutineStart.DEFAULT, block)
+    }
+}

kt/godot-coroutine-library/src/main/kotlin/godot/coroutines/GodotScope.kt

@@ -0,0 +1,9 @@
+package godot.coroutines
+
+import godot.signals.Signal
+import kotlinx.coroutines.delay
+
+suspend fun Signal.await() {
+    delay(1000)
+}
+

kt/gradle/libs.versions.toml

@@ -2,6 +2,7 @@
 
 godotKotlinJvm = "0.9.1"
 kotlin = "2.0.0"
+kotlinCoroutine = "1.8.1"
 godot = "4.2.2"
 
 shadowJar = "8.1.1" # https://github.com/johnrengelman/shadow/releases