Awesome

THIS REPO IS NOT 4.0 COMPATIABLE!

WAT

1. Install
2. Project Settings
3. GUI
4. CLI
5. Example Tests
6. Assertions

Install

<a name="Install"></a>

0. It is advised to download WAT from the Godot Asset Library.
1. You may download WAT or WAT Mono from the release page.
2. Extract the downloaded zip file.
3. Add the addons folder from the extracted files to your Godot Project.
4. Enable the Plugin in Project -> Project Settings -> Plugin Tab
5. You should see a new "Tests" button in the bottom middle bar of the Godot Editor.

Project Settings

<a name="ProjectSettings"></a> Once you have enabled the WAT Plugin, you will be able to see the settings in ProjectSettings -> General -> Wat (right at the bottom). If you don't see it, you may need to close the project settings and then re-open.

• Test Directory

  The test directory is where WAT will look for your tests. It defaults to your project's root but it is suggested to use a dedicated tests folder. You can also use an absolute path external to your project (like "C:/Users/YourName/YourProject/Tests").

• Results Directory

  The results directory is where WAT will store the results of your tests in JUnit Standard XML. It defaults to your project's root but it is suggested to store it inside your tests folder. This is usefulfor those of you who use Continous Integration (such as the github workflow action for WAT itself.)

• Metadata Directory

  The metadata directory is where WAT will store metadata about your test scripts. Namely wheter they failed the last time and which tags they have been given. It defaults to your project's root but it is suggested to be stored in your test directory.

• Tags

  You can add string tags to your test so that you can run tests that are split across different folders in a group. You define which tags can be added in this setting but you do the actual adding via the GUI.

• Cache Tests

  Will avoid rescanning your test directory unless changes to them are detected. Disable this if you're using an external editor, since not all changes from an external editor are detected.

• Window Size

  Defines the window size when running Tests.

• Port

  This port is the port used for debugging tests. It is unlikely you'll need to change this often.

• Display

  This defines wheter the Test Panel is stored in the bottom window or one of the many docks around Godot's Editor.

Graphical User Interface

<a name="GUI"></a>

Top Left Menu ( Left To Right )

Run All Tests

Runs all tests directly in the Editor. WAT does not have access to the
debugger when run this way.

Note: A Rebuild might be required by any User who is using WAT Mono.

Debug All Tests

Runs all tests in the Scene. WAT does have access to the debugger when
run this way.

Select Tests

Users may select to Run (in editor) or Debug (in scene): previously failed tests, a set of tagged tests, a Directory, Script or a Method.

Note: Users may organize their tests into nested directories but this is only
for organizational purposes. WAT will *only* run the top-level tests of any directory.

Note: To edit the tags of a script, navigate to the script and then to Edit Tags. Check which tags you want the script to have (or uncheck those which you
don't want it to have)/

Filter Results

Users can choose to collapse all results, expand all results or expand only failures (which will collapse all results but expand the failed methods).

Repeat X Times

Users can choose to repeat a Test Run immediatly so many times. This can help
when testing erratic bugs where the problem only exists sometimes. Choose 0
to run the tests once.

Run on X Thread(s)

Users can set the count of threads to run their tests on (to the limit of their
processor core count - 1 for WAT itself otherwise it will stall).

Use 1 thread to not run on any additional threads.

Note: Do not use Repeats & Threads together. There is currently a bug.

Links

A Set of links that may or may not be useful to you.

Bottom Left Labels ( Left to Right )

Runs

The number of times tests have been run since WAT was open.

Total Tests

The number of total tests scripts ran in the previous Test Run.

Passed Tests

The number of total test scripts that passed in the previous Test Run.

Failed Tests

The number of total test scripts that failed in the previous Test Run.

Times

The time the Test Run is taking (or has taken if finished). This updates
live.

Command Line Interface

<a name="CLI"></a> You can run tests in your command line interface by navigating to your Project Directory and executing the command: godot addons/cli.tscn [ARGUMENTS]

Run All Tests

godot addons/WAT/cli.tscn run=all

Run Directory

// Where X is the path of the directory you want to run
godot addons/WAT/cli.tscn run=dir+X

Run Script

// Where X is the project path of the script you want to run (Project Path meaning res:// path)
godot addons/WAT/cli.tscn run=res://script+X

Run Method

// Where X is the absolute path of the script where the method is contained
// and where Y is the name of the method
godot addons/WAT/cli.tscn run=method+X+Y

Run Failed

godot addons/WAT/cli.tscn run=failed

Run Tagged

// Where X is the name of the tag you want to run
godot addons/WAT/cli.tscn run=tag+X

Repeat Tests

godot addons/WAT/cli.tscn run=all repeat=2
OR
godot addons/WAT/cli.tscn run=all r=2

Note: Argument order does not matter so you can do this either
godot addons/WAT/cli.tscn r=2 run=all

Run on X Threads

godot addons/WAT/cli.tscn run=all thread=3
OR
godot addons/WAT/cli.tscn run=all t=3

Note: Argument order does not matter so you can do this either
godot addons/WAT/cli.tscn t=2 run=all

Examples

<a name="GDScriptExamples"></a>

• GDScript Examples
  • Basic Test
  • Yielding in Tests
  • Watching Signals in Tests
  • Test Doubles

<a name="CSharpExamples"></a>

• C# Examples
  • Basic Test
  • Awaiting in Tests
  • Watching Signals in Tests

Assertions

<a name="Assertions"></a>

• GDScript Assertions
• C# Assertions