gdUnit4.test.adapter 1.0.0-rc.202402192051

GdUnit4 Test Adapter

This is the GdUnit4 Test Adapter, designed to facilitate the integration of GdUnit4 with test frameworks supporting the Visual Studio Test Platform.

Getting Started

Precondisions

• Install the C# Dev Kit Detailed instacruction can be found here https://code.visualstudio.com/docs/csharp/testing

• Setup your test settings It is important you use the right C# Dev Kit version! (Is actual a PreRelease) The property is newly introduced by this issue https://github.com/microsoft/vscode-dotnettools/issues/156

  Open your settings.json and add this property to setup your custom test run settings.

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

1. Install the GdUnit4 Test Adapter NuGet package:

   dotnet add package GdUnit4.TestAdapter
   

2. Add a reference to the GdUnit4 library in your test project:

   dotnet add package GdUnit4
   

3. Configure your test project to use GdUnit4 by adding the following to your .csproj file:

<Project Sdk="Godot.NET.Sdk">

    

    <ItemGroup>
        <PackageReference Include="gdUnit4.api" Version="your-version" />
        <ProjectReference Include="gdUnit4.test.adapter" Version="your-version"/>
    </ItemGroup>

</Project>

.runsettings Configuration

To configure GdUnit4 test execution, you can use a .runsettings file. Below is an example .runsettings file:

<GdUnit4>
    
    
    <Parameters>--verbose</Parameters>
    
    
    <DisplayName>SimpleName</DisplayName>
</GdUnit4>

Ensure to customize the values inside the <Parameters> element based on your specific requirements. This configuration is crucial for successful test execution, especially in headless environments.

Run tests from console

dotnet test ./test/your-project.csproj --settings ./test/.runsettings

Contributing

If you encounter issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the GitHub repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.