gdUnit4.api 5.0.0

• net8.0

  • CommandLineParser (>= 2.9.1)
  • GodotSharp (>= 4.4.0)
  • Microsoft.CodeAnalysis (>= 4.14.0)
  • Microsoft.CodeAnalysis.CSharp (>= 4.14.0)
  • Microsoft.CodeAnalysis.CSharp.Workspaces (>= 4.14.0)
  • Mono.Cecil (>= 0.11.6)
  • Moq (>= 4.20.72)
  • Newtonsoft.Json (>= 13.0.3)

• net9.0

  • CommandLineParser (>= 2.9.1)
  • GodotSharp (>= 4.4.0)
  • Microsoft.CodeAnalysis (>= 4.14.0)
  • Microsoft.CodeAnalysis.CSharp (>= 4.14.0)
  • Microsoft.CodeAnalysis.CSharp.Workspaces (>= 4.14.0)
  • Mono.Cecil (>= 0.11.6)
  • Moq (>= 4.20.72)
  • Newtonsoft.Json (>= 13.0.3)

v5.0.0

## Major Architecture Overhaul

**BREAKING CHANGES:**
* Test Engine Redesign: Complete rework of the test engine that no longer requires Godot runtime by default
* Migration Required: Tests using Godot features (scenes, nodes, resources) must now be marked with `[RequireGodotRuntime]` attribute
* Significant performance improvements for logic-only tests (up to 10x faster)

✨ New Features
GD-138: Add capture test case execution stdout to the test report by @MikeSchulze in #139
GD-144: Add AwaitInputProcessed to SceneRunner by @MikeSchulze in #145
GD-46: Added support of DataPoint attributes, which make it possible to define parameterized tests with dynamic test data by @MikeSchulze in #147
GD-153: Add Roslyn Analyzer to validate TestCase and DataPoint attribute combinations by @MikeSchulze in #154
GD-156: Add an exception hook to report exceptions as test failures that are caught by Godot by @MikeSchulze in #157
GD-160: Apply runsettings environment variables to the test execution context by @MikeSchulze in #161
GD-163: Collect the Godot log file into test report by @MikeSchulze in #164
GD-156: Install Godot exception handler and forward uncaught exceptions as test failure. by @MikeSchulze in #162
GD-682: Rework on GdUnit4Net API Godot bridge by @MikeSchulze in #197
GD-27: Add VSTest filter support with test categories and traits by @MikeSchulze in #201
GD-240: Add GDUNIT4NET_API_V5 Conditional Compilation Constant by @MikeSchulze in #241
Upgrade to .NET 8/9 with C# 12 support by @MikeSchulze in #267
GD-211: Implement missing AwaitSignalOn by @MikeSchulze in #282

🪲 Bug Fixes
GD-149: Add error to the execution log when the test session timeout occurs by @MikeSchulze in #150
GD-152: Fix test case display name for dynamic test data driven tests by @MikeSchulze in #176
Fixes Godot exception monitoring issues by @MikeSchulze in #187
Make WithTimeout public by @MikeSchulze in #189
GD-199: TestRunner install ends with abnormal exit on large projects by @MikeSchulze in #200
GD-203: Handle failure reporting for test stages [Before] and [After] by @MikeSchulze in #204
GD-212: Fix vector assertion IsEqualApprox by @MikeSchulze in #214
GD-284: Fix test failure causes the entire test execution if it is executed in the Godot Editor by @MikeSchulze in #285

🧹 Maintenance
GD-140: GdUnit4 API: code cleanup and formatting by @MikeSchulze in https://github.com/MikeSchulze/gdUni...

## 📋 Migration Guide:

**Before v5.0.0:**
```csharp
[Test]
public void MyTest()
{
   // All tests ran in Godot runtime
   var node = new Node();
   AddChild(node);
}
```

**v5.0.0:**
```csharp
[Test]
public void MyLogicTest()
{
   // Runs fast without Godot runtime
   var result = Calculator.Add(1, 2);
   AssertThat(result).IsEqual(3);
}

[Test]
[RequireGodotRuntime]  // Required for Godot-dependent tests
public void MyGodotTest()
{
   var node = new Node();
   AddChild(node);
}

[Test]
[DataPoint(nameof(TestData))]  // Data-driven tests
public void TestCalculations(int a, int b, int expected)
{
   AssertThat(Calculator.Add(a, b)).IsEqual(expected);
}

[Test]
[ThrowsException(typeof(ArgumentNullException), "Value cannot be null")]
public void TestValidation()
{
   Calculator.Add(null, 5); // Expects specific exception
}

public static IEnumerable<object[]> TestData => new[]
{
   new object[] { 1, 2, 3 },
   new object[] { 5, 7, 12 }
};
```

## ⚙️ Configuration:

New `.runsettings` options:
```xml
<RunSettings>
 <GdUnit4>
   <CaptureStdOut>true</CaptureStdOut>
   <Parameters>--verbose --headless</Parameters>
   <DisplayName>FullyQualifiedName</DisplayName>
   <CompileProcessTimeout>30000</CompileProcessTimeout>
 </GdUnit4>
</RunSett>
```

This release represents a major evolution in GdUnit4's architecture, providing developers with the flexibility to write fast, efficient tests while maintaining full Godot integration capabilities when required.
-------------------------------------------------------------------------------------------------------

v4.3.1

Bug Fixes:
* GD-135: Cannot test signals on non-node classes

-------------------------------------------------------------------------------------------------------

v4.3.0

Improvements:
* GD-127: Replace stdout based TestEventProcessor by IPC implementation
* GD-124: Use LaunchProcessWithDebuggerAttached instead of AttachDebuggerIfNeed for Rider 2024.2

-------------------------------------------------------------------------------------------------------

v4.2.5

Bug Fixes:
* GD-110: Allow a Node to be passed in to SceneRunner.Load as the root of the scene.
* GD-121: Improve AssertSignal by adding a StartMonitoring method

-------------------------------------------------------------------------------------------------------

V4.2.4

Improvements:
* GD-89: Add input action support to the `SceneRunner` by @MikeSchulze in https://github.com/MikeSchulze/gdUnit4Net/pull/92
   - Added input action handling to the SceneRunner
   - `SimulateActionPressed(string action)`
   - `SimulateActionPress(string action)`
   - `SimulateActionRelease(string action)`
* GD-94: Improve assertions error message when comparing objects by @MikeSchulze in https://github.com/MikeSchulze/gdUnit4Net/pull/95
* GD-99: Add support to load a scene by `uid://` path to the Scene Runner by @MikeSchulze in https://github.com/MikeSchulze/gdUnit4Net/pull/100


Bug Fixes:
* GD-90: Cleanup old runner configuration before run new tests by @MikeSchulze in https://github.com/MikeSchulze/gdUnit4Net/pull/93
* GD-96: Fix methods with a single parameterized test case are not executed by @MikeSchulze in https://github.com/MikeSchulze/gdUnit4Net/pull/97
* GD-101: Respect the GdUnit4 settings to notify about orphan nodes by @MikeSchulze in https://github.com/MikeSchulze/gdUnit4Net/pull/102
* GD-103: Trim MSTest assert stack trace by @MikeSchulze in https://github.com/MikeSchulze/gdUnit4Net/pull/105
* GD-104: Fix exception failure message propagation by @MikeSchulze in https://github.com/MikeSchulze/gdUnit4Net/pull/108


-------------------------------------------------------------------------------------------------------

v4.2.3

Bug Fixes:
- Fix `AssertThat` for dynamic assert type resolving

-------------------------------------------------------------------------------------------------------

v4.2.2

What's Changed:

- Rename repository from `gdUnit4Mono` to `gdUnit4Net`
- Update project to GodotSharp v4.1.0
- Format and fix warnings according to C# standards
- Format the tests according to the C# Formatting rules
- Format the code to C# standard
- Support both net7 and net8 at once
- Add full .NET8 support
- Provide generic vector assert to support all Godot vector types
- Revision of the stack trace collection for failed tests
- Complete missing features for `IDictionaryAssert`
- Complete missing features for `IEnumerableAssert`
- Complete missing features for `INumberAssert`
- Add missing `SimulateMouseMoveRelative` and `SimulateMouseMoveAbsolute` to `ISceneRunner`

Bug Fixes:
- SceneRunner: Fix InputEvent handling
- Calling Invoke on `SceneRunner` must propagate exceptions
- Fix GdUnit4MonoAPI `IsTestSuite` cannot run TestSuite
- Fix test run stops at some point
- Parameterized test cases are not run from Godot Editor GdUnit4 inspector

-------------------------------------------------------------------------------------------------------

v4.2.0

- gdUnit4 API initial version.