Scope

Can test any plain objects.

Running Tests

godot --headless -s addons/gdscript-script-test-runner/src/run_tests.gd

Running Specific Tests

The first two arguments after the above command are file and method filters (regex).

godot --headless -s addons/gdscript-script-test-runner/src/run_tests.gd -- file_filter=<file_filter>, method_filter=<method_filter>

CLI Parameters (Godot)

Name	Type	Default	Description
print_output	bool	true	Print the output to console?
file_output	String	NA	File to write the output log to. Does not write if no path given.
file_filter	String	.*	regex pattern for refining test file search. for example, file_filter=.*my_script.tests.gd will match any file named my_script.tests.gd in the project.
method_filter	String	.*	regex pattern for filtering test methods. Same usage as file_filter.
stop_on_first_failed_test	bool	false	Stop execution as soon as the first failed test is encountered.

CLI Parameters (Python)

NOTE: The python wrapper requires godot to be on your PATH.

Name	Type	Default	Description
--project-root	String	CWD	Path to the Godot project root.
--file-filter	String	.*	Regex for test file paths.
--method-filter	String	.*	Regex for test method names.
--hide-passed	bool	false	Hide passed tests in the output.
--print-output	bool	true	Print the test log to stdout.
--file-output	String	NA	Write the log to a file.
--stop-on-first-failed-test	bool	false	Stop execution as soon as the first failed test is encountered.

Making Tests

All tests must be in files ending with .tests.gd

Unit Tests

func test_<name>() -> ScriptTestResult | Array[ScriptTestResult]

For example

func test_condition() -> ScriptTestResult:
	...
	return ScriptTestResult.new(condition)

Unit Test Generator

To programmatically create unit tests

func <name>_test_generator() -> Dictionary[String, Callable]

For example (this is not a good test, but a syntactically valid generator)

func my_method_test_generator() -> Dictionary[String, Callable]:
	var tests = {}
	for item_name in ["item1", "item2", "item3"]:
		tests["test_my_test_method_with" + item_name] = func(): return my_test_method(i)
	return tests