How GdUnit4Net Achieves IDE Support

GdUnit4Net leverages the industry-standard (VSTest) API to provide comprehensive IDE integration. By implementing the VSTest adapter interface, GdUnit4Net allows IDEs that support the Visual Studio Test Platform to:

• Discover tests automatically in your Godot C# projects
• Execute tests with real-time feedback and reporting
• Debug tests with full breakpoint and variable inspection support
• Filter and organize test runs based on various criteria
• Generate detailed reports in multiple formats

This approach ensures a consistent testing experience across different IDEs while maintaining full compatibility with existing .NET testing workflows.

The project repository can be found here gdunit4.test.adapter.

Preconditions

Before configuring your IDE, ensure you have completed the following setup requirements:

Supported IDE’s

IDE	Test Discovery	Test Run	Test Debug	Jump to Failure	Solution test config file	Test Filter	Parallel Test Execution
Visual Studio	✅	✅	✅	✅	✅	✅	❌
Visual Studio Code	✅	✅	✅	✅	✅	✅	❌
JetBrains Rider version 2024.2	✅	✅	✅	✅	✅	✅	❌

✅ - supported
☑️ - supported by a workaround (link)
❌ - not supported
🔜 - not yet implemented

1. Project Configuration

Your Godot C# project must be properly configured with GdUnit4Net dependencies as described in the Setup Documentation. This includes:

• Correct .NET framework targeting (net8.0 or net9.0)
• Required NuGet package references (gdUnit4.api, gdUnit4.test.adapter, etc.)
• Proper project file structure

2. Environment Variable Setup

You must configure the GODOT_BIN environment variable pointing to your Godot executable.

Platform	Environment Variable	Example Path
Windows	%GODOT_BIN%	d:\development\Godot_v4.4.1-stable_mono_win64\Godot_v4.4.1-stable_mono_win64.exe
Linux/Unix/Mac	$GODOT_BIN	/Users/MisterX/Documents/develop/GodotMono.app/Contents/MacOS/Godot

Or define it in the .runsettings under EnvironmentVariables see below.

3. RunSettings Configuration

Create a .runsettings file in your project to configure test execution. The full guide to configure the settings can be found here.

Below is an example:

<?xml version="1.0" encoding="utf-8"?>
<RunSettings>
    <RunConfiguration>
        <MaxCpuCount>1</MaxCpuCount>
        <ResultsDirectory>./TestResults</ResultsDirectory>
        <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
        <TestSessionTimeout>180000</TestSessionTimeout>
        <TreatNoTestsAsError>true</TreatNoTestsAsError>
        <EnvironmentVariables>
            <GODOT_BIN>d:\development\Godot_v4.4.1-stable_mono_win64\Godot_v4.4.1-stable_mono_win64.exe</GODOT_BIN>
        </EnvironmentVariables>
    </RunConfiguration>

    <LoggerRunSettings>
        <Loggers>
            <Logger friendlyName="console" enabled="True">
                <Configuration>
                    <Verbosity>detailed</Verbosity>
                </Configuration>
            </Logger>
            <Logger friendlyName="html" enabled="True">
                <Configuration>
                    <LogFileName>test-result.html</LogFileName>
                </Configuration>
            </Logger>
            <Logger friendlyName="trx" enabled="True">
                <Configuration>
                    <LogFileName>test-result.trx</LogFileName>
                </Configuration>
            </Logger>
        </Loggers>
    </LoggerRunSettings>

    <GdUnit4>
        <!-- Additional Godot runtime parameters-->
        <Parameters></Parameters>
        <!-- Controls the Display name attribute of the TestCase. Allowed values are SimpleName and FullyQualifiedName.
             This likely determines how the test names are displayed in the test results.-->
        <DisplayName>FullyQualifiedName</DisplayName>
    </GdUnit4>
</RunSettings>

---

Visual Studio

Do follow this steps to activate the test explorer:

• Activate the test explorer
• Configure the path to your .runsettings
• Restart Visual Studio

---

Visual Studio Code

Do follow this steps to activate the test explorer:

• Install the C# Dev Kit (v1.5.12 (pre-release) recommended). Detailed instructions can be found here.

• Open your .vscode/settings.json and add the following property to your project settings: It is important to use the correct C# Dev Kit version, which is currently a PreRelease. The property is newly introduced by this issue.

    "dotnet.unitTests.runSettingsPath": "./test/.runsettings"
  

• Restart Visual Studio Code

---

JetBrains Rider

Do follow these steps to activate the test explorer:

Advice

We recommend to use Rider 2024.2 or higher to enable test debugging! Checkout for the latest version
For older Rider versions check the workaround.

• Install the Godot Support plugin
• Configure the path to your .runsettings
• Enable the VSTest adapters in the Rider settings
• Restart JetBrains Rider

---

Issues and Workarounds

Issue	Solution
The test discovery is aborted and not all tests are found	Increase the <TestSessionTimeout> in your RunSettings
Test Debug workaround for JetBrains Rider	click here

Test Debug workaround for JetBrains Rider less version 2024.2

• Paste this code into your test suite to wait until the debugger is connected to the Godot process.

    [BeforeTest]
    public void DebugWorkaround()
    {
        while (!Debugger.IsAttached)
        {
        }
    }

• Set your breakpoints
• Start debugging test
• Attach the debugger to the running Godot instance.
• Search for Godot and select and press attach

---

document version v5.0.0