Awaiting
If you aren’t sure about coroutines and using await, Godot explains it pretty well. GUT supports coroutines, so you can await at anytime in your tests. GUT also provides some handy methods to make awaiting in your tests a little easier.
You can use await with any of the following methods to pause execution for a duration or until something occurs. You can find more information about each method below, and in the GutTest documentation.
wait_seconds: Waits x seconds.wait_idle_frames: Waits x process frames(_process(delta)).wait_physics_frames: Waits x physics frames(_physics_process(delta)).wait_for_signal: Waits until a signal is emitted, or a maximum amount of time.wait_until: Waits until aCallablereturnstrueor a maximum amount of time.wait_while: Waits while aCallablereturnstrueor a maximum amount of time.pause_before_teardown: can be called in a test to pause execution at the end of a test, before moving on to the next test or ending the run.
Calling await without using one of GUT’s “wait” methods is discouraged. When you use these methods, GUT provides output to indicate that execution is paused. If you don’t use them it can look like your tests have stopped running.
wait_seconds
wait_seconds(time, msg=''):
Sometimes you just want to pause for some amount of time. Use wait_seconds instead of making timers.
The optional msg parameter is logged so you know why test execution is paused.
# wait 2.8 seconds then continue running the test
await wait_seconds(2.8)
# wait .25 seconds, text included in log message
await wait_seconds(.25, "waiting for a short period")
wait_physics_frames
wait_physics_frames(frames, msg=''):
This returns a signal that is emitted after x physics frames have
elpased. You can await this method directly to pause execution for x
physics frames. The frames are counted prior to _physics_process being called
on any node (when SceneTree.physics_frame is emitted). This means the
signal is emitted after x frames and just before the x + 1 frame starts.
await wait_physics_frames(10)
The optional msg parameter is logged so you know why test execution is paused.
# wait 2 frames before continue test execution
await wait_physics_frames(2)
# waits some frames and includes optional message
await wait_physics_frames(20, 'waiting some frames.')
wait_idle_frames
await wait_idle_frames(10)
# wait_process_frames is an alias of wait_idle_frames
await wait_process_frames(10)
This returns a signal that is emitted after x process/idle frames have
elpased. You can await this method directly to pause execution for x
process/idle frames. The frames are counted prior to _process being called
on any node (when SceneTree.process_frame is emitted). This means the
signal is emitted after x frames and just before the x + 1 frame starts.
wait_for_signal
wait_for_signal(sig, max_wait, msg=''):
This method will pause execution until a signal is emitted or until max_wait seconds have passed, whichever comes first. Using wait_for_signal is better than just using await my_obj.my_signal since tests will continue to run if the signal is never emitted.
This method returns true if the signal was emitted before timing out, false if not.
The optional msg parameter is logged so you know why test execution is paused.
...
# wait for my_object to emit the signal 'my_signal'
# or 5 seconds, whichever comes first.
await wait_for_signal(my_object.my_signal, 5)
assert_signal_emitted(my_object, 'my_signal', \
'Maybe it did, maybe it didnt, but we still got here.')
# You can also use the return value directly in an assert
assert_true(await wait_for_signal(my_object.my_signal, 2),
"The signal should have been emitted before timeout")
As a bonus, wait_for_signal internally calls watch_signals for the object, so you can skip that step when asserting signals have been emitted.
wait_until
wait_until(callable, max_wait, p3='', p4=''):
This method takes a Callable predicate method that will be called every frame. The wait will end when the Callable returns true or when max_wait seconds has expired. This requires the method to explicity return true and not a truthy value.
This will return true if the method returned true before the timeout, false if otherwise. You can optionally specify an amount of time to wait between calling the Callable.
p3can be the optional message or an amount of time to wait between tests.p4is the optional message if you have specified an amount of time to wait between tests.
var everything_is_ok = func():
return true
# Call everything_is_ok every frame until it returns true or 5 seconds elapses
await wait_until(everything_is_ok, 5)
# Same as above but we get the result to use later and provide a message to
# display when the await starts.
var result = await wait_until(everything_is_ok, 5, 'Show this message')
# Calls everything_is_ok every second until it returns true and asserts
# on the returned value
assert_true(await wait_until(everything_is_ok, 10, 1),
"Everything should be ok in 10 seconds").
wait_while
GutTest.wait_while
This is the inverse of wait_until. Use the link above for more information.
pause_before_teardown
Sometimes, as you are developing your tests you may want to verify something before the any of the teardown methods are called or just look at things a bit. If you call pause_before_teardown() anywhere in your test then GUT will pause execution until you press the “Continue” button in the GUT GUI. You can also specify an option to ignore all calls to pause_before_teardown through the GUT Panel, command line, or .gutconfig in case you get lazy and don’t want to remove them. You should always remove them, but I know you won’t because I didn’t, so I made that an option.