jTest

Minimal test framework for godot, made for use in my projects.

Usage

Add a @tool script file to res://test.
Extend from jTest and call add_test() on your test functions in _init().
Optionally bind parameters to the test functions.

#test/demo.gd
@tool
extends jTest


func _init():
    add_test(simple_test)

    add_test(test_math_sqrt.bind(9.0, 3.0))
    add_test(test_math_sqrt.bind(16.0, 3.0))
    add_test(test_math_sqrt.bind(42.0, 6.48))

    add_test(test_mod.bind(5, 2, 1))
    add_test(test_mod.bind(5, 7, 5))
    add_test(test_mod.bind(5, 5, -1))

    add_test(test_capitalize.bind("hello", "Hello"))
    add_test(test_capitalize.bind("HELLo_goDot", "Hello Godot"))
    add_test(test_capitalize.bind("godot", "Godot"))


func simple_test():
    if abs(-1 - 1) != 1:
        fail("This test should fail.")
    pass


func test_math_sqrt(input: float, expected: float):
    var result = sqrt(input)
    j_is_close_to(result, expected, 0.01)


func test_mod(value: int, modulo: int, expected: int):
    j_is(value % modulo, expected)


func test_capitalize(input: String, expected: String):
    var result = input.capitalize()
    j_is(result, expected)

Then execute from the provided editor dock.

Use Debug if you want to use breakpoints in the editor.

Or execute via shell:

godot -s addons/j_test/run.gd

Assertions

Using the provided assertions is optional.

You may write your own check functions which just report a failure via calling fail.