Skip to content

Running from the UI

Vest's UI lives in the editor's bottom panel.

vest UI

Elements

While each element has its tooltip or description, here's an overview:

Run Run tests
Run all test scripts matching the Test glob.
Debug Debug tests

Run all test scripts matching the Test glob, in debug mode.

Useful when something doesn't behave as expected and needs debugging.

Clear Clear results
Clear the test report, emptying the panel.
Run on save Run on save

Toggles Run on save - when enabled, tests are re-run each time a script is modified and saved.

Useful for getting quick feedback while implementing tests.

Filter results Filter results

Opens a menu to specify which tests to display in the results. The icon changes into a closed eye if no results are displayed due to the filtering.

Useful for drilling down into results, e.g. showing only failed tests.

Search results Search results

Allows fuzzy searching for test suites and cases. For test cases, it also considers the original method name, if available ( e.g. test_addition() ). To prefer the method name in your search, append () at the end of the query.

Upon losing focus, the input field is hidden if no search string is specified.

Expand / collapse Expand / collapse results
Expands or collapses all test results recursively. If there's at least one collapsed item, this button will expand the results.
Refresh mixins Refresh mixins

Vest's VestTest class is generated from multiple mixin classes. In case any of these change, use the Refresh mixins button to update the generated classes.

Usually only necessary during addon development.

Run vs. Debug

In order to be as unintrusive as possible, vest runs your tests in the background, in headless mode. This means spawning a process completely independent of the Godot editor, without connecting to the debugger.

Running tests independently means that the editor cannot debug the tests while running, or receive any print()s.

If you want to debug your tests, use the Debug debug button.