Gdunit4

.github/workflows/build_and_test.yml

@@ -0,0 +1,22 @@
+# https://github.com/marketplace/actions/gdunit4-test-runner-action
+name: GdUnit4 Tests
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - uses: godot-gdunit-labs/gdUnit4-action@v1
+        with:
+          godot-version: '4.6'
+          godot-status: 'stable'
+          godot-net: true
+          paths: 'res://Setup/Testing'
+          console-verbosity: 'normal'
+          publish-report: false
+          upload-report: true
+          report-name: test-report.xml

.gitignore

@@ -9,6 +9,12 @@ data_*/
 mono_crash.*.json
 *.DotSettings.user
 
+# gdUnit4
+TestResults/*
+!TestResults/.gdignore
+gdunit4_testadapter_v5/
+.runsettings
+
 # Visual Studio
 .vs/*
 Properties/*

NuGet.config

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <configuration>
   <packageSources>
-    <add key="LocalNugets" value="Framework/Libraries" />
+    <add key="LocalNugets" value="%GITHUB_WORKSPACE%/Framework/Libraries" />
     <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
   </packageSources>
 </configuration>

Setup/Testing/Tests.cs

@@ -0,0 +1,57 @@
+using GdUnit4;
+using static GdUnit4.Assertions;
+using Framework.Netcode;
+using Framework.Netcode.Examples.Topdown;
+using System;
+using System.Diagnostics;
+using System.Threading.Tasks;
+using Framework;
+
+namespace Template.Setup.Testing;
+
+[TestSuite]
+public class Tests
+{
+    [TestCase]
+    public static void StringToLower()
+    {
+        AssertString("AbcD".ToLower()).IsEqual("abcd");
+    }
+
+    [TestCase]
+    [RequireGodotRuntime]
+    public static async Task ServerClientConnects()
+    {
+        GameServer server = new();
+        GameClient client = new();
+
+        server.Start(25565, 100, new ENetOptions());
+
+        Task connectTask = client.Connect("127.0.0.1", 25565, new ENetOptions());
+
+        try
+        {
+            bool connected = false;
+            Stopwatch stopwatch = Stopwatch.StartNew();
+
+            while (stopwatch.Elapsed < TimeSpan.FromSeconds(2))
+            {
+                if (client.IsConnected)
+                {
+                    connected = true;
+                    break;
+                }
+
+                await Task.Delay(10);
+            }
+
+            AssertBool(connected).IsTrue();
+        }
+        finally
+        {
+            client.Stop();
+            server.Stop();
+            await connectTask;
+        }
+    }
+}

Setup/Testing/Tests.cs.uid

@@ -0,0 +1 @@
+uid://btn7any5gk0u3

Template.csproj

@@ -1,19 +1,22 @@
 <Project Sdk="Godot.NET.Sdk/4.6.0">
     <!-- Project Settings -->
     <PropertyGroup>
-        <TargetFramework>net8.0</TargetFramework>
-        <LangVersion>latest</LangVersion>
+        <TargetFramework>net9.0</TargetFramework>
+        <LangVersion>13.0</LangVersion>
         <!--Required for ImGui-->
         <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
         <EnableDynamicLoading>true</EnableDynamicLoading>
         <!--Prevent use of the global usings feature-->
         <ImplicitUsings>false</ImplicitUsings>
         <RootNamespace>Template</RootNamespace>
         <Nullable>disable</Nullable>
+        <!-- gdUnit4 requires this -->
+        <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
         <!-- Disable warnings -->
         <!-- CS0108: 'X' hides inherited member 'Y'. Use the new keyword if hiding was intended. Consider the scenario where you want [OnInstantiate] for both derived and inherited types. -->
         <!-- IDE0290: Use primary constructor. -->
-        <NoWarn>CS0108;IDE0290</NoWarn>
+        <!-- NU1605: Disable warning of invalid/incompatible GodotSharp version (gdUnit4 recommends this) -->
+        <NoWarn>NU1605;CS0108;IDE0290</NoWarn>
     </PropertyGroup>
 
     <ItemGroup>
@@ -26,6 +29,15 @@
         <PackageReference Include="GodotSharp.SourceGenerators" Version="2.6.0" />
         <PackageReference Include="PacketGen" Version="1.1.2" />
 
+        <!-- gdUnit4 package dependencies -->
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.0.0" />
+        <PackageReference Include="gdUnit4.api" Version="5.1.0-rc3" />
+        <PackageReference Include="gdUnit4.test.adapter" Version="3.0.0" />
+        <PackageReference Include="gdUnit4.analyzers" Version="1.0.0">
+            <PrivateAssets>none</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
+
         <!-- References -->
         <!-- This is required for other platforms where the ENet NuGet package is not enough -->
         <Reference Include="ENet-CSharp.dll" Condition="Exists('ENet-CSharp.dll')" />