Skip to content

tests: Document using the GUT CLI #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 28, 2024
Merged

tests: Document using the GUT CLI #97

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions addons/block_code/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,20 @@ Now `pre-commit` will run automatically on `git commit`!
### Testing

This plugin uses the [Godot Unit Test](https://gut.readthedocs.io/en/latest/) (GUT) plugin for testing. In the editor, select the **GUT** tab in the bottom panel to open the test panel. Then select **Run All** to run the tests.

Tests can also be run from the command line using the GUT command line script:

```
godot --path . --headless --script addons/gut/gut_cmdln.gd -gexit
```

A few options are of note here. `--path` instructs Godot to use the project in
the current directory. `--headless` instructs Godot to run without a display or
sound. `--script` instructs Godot to run the GUT command line script instead of
running the main scene. `-gexit` is an option for the GUT command line script
that instructs GUT to exit after the tests complete.

There are several other GUT command line options for running specific tests.
For example, `-gtest=path/to/test_script_1.gd,path/to/test_script_2.gd` can be
used to run specific test scripts. A specific test function can be specified
with `-gunit_test_name=test_to_run`.