ruedoux / sgt

Simple Godot Tests - Easy to use addon for testing C# scripts in Godot

Simple Godot Tests

About

Addon for Godot that allows you to easily create tests for your C# scripts. Its designed to be as simple to use as possible and have as little dependency issues with different Godot versions.

Wiki

All information needed to use this plugin is provided here.

Dev info

Everything is as Godot/IDE agnostic as possible to minigate all of compatibility issues that other plugins tend to have. The only interface entry points with Godot are Logger and EditorRunner classes.

Testing class can be in any .cs file in your project, I would recommend putting all tests in a test folder so its easier to exclude the testing files in your .csproj file from the realase version of the game:

<PropertyGroup>
  <DefaultItemExcludes Condition="'$(Configuration)' == 'ExportRelease'">
    $(DefaultItemExcludes);YourTestFolderName/**;addons/SGT/**
  </DefaultItemExcludes>
</PropertyGroup>

For older versions of godot everything in addons/SGT/Bridge/GUI can be simply deleted because it only serves as GUI and all core parts are written in pure C#. All you need to do to run the tests is to modify addons/SGT/Bridge/GodotTestRoot.cs to be compatible with your version of godot, and simply call RunTestsInNamespaces(string[] namespaces). If you want to run tests for all namespaces you can get them via AssemblyExtractor.GetAllTestNamespaces().ToArray(), this function gets all namespaces with tests in your entire project.

Q/A

Q: Why no bottom panel?
A: Bottom panel requires using [Tool] attribute for class, and that doesn't work for mono in 4.x

sgt's Issues

Need OnReady?

Topic OnReady for c#

It took a long time delay before the loaded TestNode.tscn is Ready to set

shouldBe10 = 10;

https://github.com/RedouxG/SGT/blob/a495933f9bfa81c8018b73a28773dff700a7d13e/Examples/SceneTest.cs#L19

Todo

TODO:

Make GUI more pleasant to look at.
Standarize output, possibly to XML format similar to other testing frameworks.

Do look at either

• GodotXUnit (better)
• NURF

Integration Scene Test

What is your approach to display e.g. animated scene integration test?
Do you have plan to get there?

Documentation related question

Why this project needed? we have Xunit framework, exactly what solution it overcomes? Will I be able to create behavioural test, end to end test cases using this? Is it a way to automate my testing like ChatGPT helps us?

Need to manually create the /addons/SGT/Temp folder

Temp folder is missing!