GdUnit and C# Testing

To use the GdUnit C# testing API, you should have Godot-Mono version 3.3.x installed.

How to enable the C# test support?

Before using the GdUnit C# test API we need to configure the project. Official Godot documentary

Enable the GdUnit C# Support

GdUnit3 uses the C# language standard 10.0 and therefore we need to adjust the project settings.

1. Open your Godot Editor Settings and configure mono builds to use:
   • With GdUnit3 version 2.3.0 we fully support .Net6 and LangVersion 10 you have to swtich to dotnet CLI

   

2. Setup your Project

   GdUnit3 C# API uses the framework netstandard2.1 to support the latest language standard
   Open you project file (*.csproj), and change:

   • under section <PropertyGroup>
     • change the TargetFramework to netstandard2.1
     • add <LangVersion>10.0</LangVersion>
     • add <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
   • add the section <ItemGroup> see below
     • add <PackageReference Include="gdUnit3Mono" Version="2.3.1-release*"/>
3. For C# 10 to work, you need the dotnet 6 SDK installed.

dotnet --list-sdks
6.0.101 [C:\Program Files\dotnet\sdk]

If no sdk 6.0 installed you can download it here

If you run in trouble with older SDK’s i suggest to uninstall it.

Here is a complete example of what your project should look like.

<Project Sdk="Godot.NET.Sdk/3.3.0">
	<PropertyGroup>
		<TargetFrameworks>netstandard2.1</TargetFrameworks>
		<LangVersion>10.0</LangVersion>
		<!--Force nullable warnings, you can disable if you want-->
		<Nullable>enable</Nullable>
		<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
	</PropertyGroup>
	<ItemGroup>
		<!--Required for GdUnit3 C#-->
		<PackageReference Include="gdUnit3Mono" Version="2.3.1-release*"/>
	</ItemGroup>
</Project>

Test you C# build settings

Open the `MSBuild` inspector on the bottom of the Godot editor and press `Build Solution`
![](/gdUnit3/assets/images/install/cs-build-test.png)
The output should show the project is build successfully.

Install Visual Studio GdUnit3 Extension

To run and debug C# sharp tests inside the VS-Code IDE you need to install the GdUnit3 extension

1. Click on the Extensions icon in the activity bar and search for GdUnit3

   

2. After successful installation you will find the GdUnit3 inspector in the activity bar.

   

GdUnit3 Extension Settings

You must first configure the GdUnit3 extension settings to set the path for Godot execution.

• Press the settings button on the inspector

  

• Change the path to where you have installed Godot-Mono on your system

  

Using GdUnit3 on VisualStudio-Code

GdUnit provides an VS-Code extension like the GdUnit-Inspector for the Godot editor.

The extension allows you to create run and debug C# sharp test direct inside the VS-Code IDE.