https://github.com/dirkchristianbecker/simpleunittests
Simple Unit tests for Godot.net
https://github.com/dirkchristianbecker/simpleunittests
csharp game-development godot mit-license open-source unit-testing
Last synced: about 2 months ago
JSON representation
Simple Unit tests for Godot.net
- Host: GitHub
- URL: https://github.com/dirkchristianbecker/simpleunittests
- Owner: DirkChristianBecker
- License: mit
- Created: 2023-11-05T17:21:56.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-29T06:37:50.000Z (almost 2 years ago)
- Last Synced: 2025-10-28T12:31:45.444Z (8 months ago)
- Topics: csharp, game-development, godot, mit-license, open-source, unit-testing
- Language: C#
- Homepage:
- Size: 199 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple Unit Tests for Godot.net
Implements unit tests for Godot.net. The project is kept very simple and small to encourage users to modify it to meet their needs.
# Installation
Create a new project and inside this project create a folder called 'addons'. Now clone this repository into the addons folder, then
under 'Project -> Tools -> C#' click 'Create C# Solution'.
Now you should have a 'Build'-Button in the upper right corner of the editor window. Click it in order to build the cloned plugin.
Now we activate the plugin. Go to 'Project -> Project settings -> Plugins' and mark the plugin.
After that the testrunner window should show up.
You can dock it anywhere in your project like any other editor window. If you click on 'Run' at this stage you should see the results from
the examples.
# Writing tests
To implement your own tests derrive from TestSuite and mark each method that is a test with the TestCase-Attribute.
The TestSuite implements some methods that you can use to write your tests (AssertEqual, AssertNotEqual and AssertException).
Here is an example of how to write tests:
```
using SimpleUnitTests;
namespace Tests
{
public class TestTemplate : TestSuite
{
public TestTemplate() : base("Test template")
{
}
[TestCase]
public void TestInteger()
{
AssertEqual(1, 1);
AssertNotEqual(1, 2);
}
// A disabled test case
[TestCase(false)]
public void DeactivatedTest()
{
AssertEqual(true, true);
AssertNotEqual(true, false);
}
private void TestHelper(object o)
{
if(o == null)
{
throw new ArgumentNullException(nameof(o));
}
}
[TestCase()]
public void ExceptionTest()
{
AssertException(() =>
{
TestHelper(null);
});
}
}
}
```
# Run
Once your tests are written, click build in the upper right of the Godot Editor and than Run inside the test runner window.
The test runner will look for all TestSuites in the currently running assembly and run all tests cases it can find. The results will be shown
inside the test runner window. If a test fails you might not be able to read the entire error message. But you can hover with your mouse over
the error message and Godot will show the message as a tooltip.
The project contains a file named TestTemplate.cs. This serves as an example on how to write test cases and is itself
a TestSuite to test the unit tests itself. These tests will also be found by the test runner when it looks for tests suites. This is on purpose
to aid the development of this plugin. However if you don´t want these tests to run you can either delete the template file or deactivate
the test cases by giving a false to the attribute constructor.