Skip to content

feat: add support for TUnit #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 22, 2024
Merged

feat: add support for TUnit #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d25d44
Add support for TUnit
vbreuss Oct 22, 2024
26e0bf4
Merge branch 'main' into topic/add-support-for-TUnit
vbreuss Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions Source/Testably.Expectations/Core/Adapters/NUnitTestFrameworkAdapter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,22 @@ public bool IsAvailable

[DoesNotReturn]
[StackTraceHidden]
public void Throw(string message)
public void Skip(string message)
{
Type exceptionType = _assembly?.GetType("NUnit.Framework.AssertionException")
Type exceptionType = _assembly?.GetType("NUnit.Framework.IgnoreException")
?? throw new NotSupportedException(
"Failed to create the NUnit fail assertion type");
"Failed to create the NUnit skip assertion type");

throw (Exception)Activator.CreateInstance(exceptionType, message)!;
}

[DoesNotReturn]
[StackTraceHidden]
public void Skip(string message)
public void Throw(string message)
{
Type exceptionType = _assembly?.GetType("NUnit.Framework.IgnoreException")
Type exceptionType = _assembly?.GetType("NUnit.Framework.AssertionException")
?? throw new NotSupportedException(
"Failed to create the NUnit skip assertion type");
"Failed to create the NUnit fail assertion type");

throw (Exception)Activator.CreateInstance(exceptionType, message)!;
}
Expand Down
70 changes: 70 additions & 0 deletions Source/Testably.Expectations/Core/Adapters/TUnitTestFrameworkAdapter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
using System;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Reflection;

namespace Testably.Expectations.Core.Adapters;

/// <summary>
/// Implements the TUnit test framework adapter.
/// </summary>
/// <remarks>
/// <see href="https://github.com/thomhurst/TUnit" />
/// </remarks>
// ReSharper disable once UnusedMember.Global
internal class TUnitTestFrameworkAdapter : ITestFrameworkAdapter
{
private Assembly? _assertionsAssembly;
private Assembly? _coreAssembly;

#region ITestFrameworkAdapter Members

public bool IsAvailable
{
get
{
try
{
// For netfx the assembly is not in AppDomain by default, so we can't just scan AppDomain.CurrentDomain
_coreAssembly = Assembly.Load(new AssemblyName("TUnit.Core"));
_assertionsAssembly = Assembly.Load(new AssemblyName("TUnit.Assertions"));
return _coreAssembly is not null;
}
catch
{
return false;
}
}
}

[DoesNotReturn]
[StackTraceHidden]
public void Skip(string message)
{
Type exceptionType = _coreAssembly?.GetType("TUnit.Core.Exceptions.SkipTestException")
?? throw new NotSupportedException(
"Failed to create the TUnit skip assertion type");

throw (Exception)Activator.CreateInstance(exceptionType, message)!;
}

[DoesNotReturn]
[StackTraceHidden]
public void Throw(string message)
{
if (_assertionsAssembly == null)
{
// When TUnit is used without its assertions library, use the default exception.
throw new FailException(message);
}

Type exceptionType =
_assertionsAssembly?.GetType("TUnit.Assertions.Exceptions.AssertionException")
?? throw new NotSupportedException(
"Failed to create the TUnit fail assertion type");

throw (Exception)Activator.CreateInstance(exceptionType, message)!;
}

#endregion
}
15 changes: 7 additions & 8 deletions Source/Testably.Expectations/Core/Adapters/XUnitTestFrameworkAdapter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ public bool IsAvailable
}
}

[DoesNotReturn]
[StackTraceHidden]
public void Skip(string message)
{
throw new SkipException($"SKIPPED: {message} (xunit v2 does not support skipping test)");
}

[DoesNotReturn]
[StackTraceHidden]
public void Throw(string message)
Expand All @@ -47,13 +54,5 @@ public void Throw(string message)
throw (Exception)Activator.CreateInstance(exceptionType, message)!;
}

[DoesNotReturn]
[StackTraceHidden]
public void Skip(string message)
{
throw new SkipException($"SKIPPED: {message} (xunit v2 does not support skipping test)");
}


#endregion
}
7 changes: 7 additions & 0 deletions Testably.Expectations.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TestFramework.NUnit4.Tests"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TestFramework.FallbackTest", "Tests\TestFrameworks\TestFramework.FallbackTest\TestFramework.FallbackTest.csproj", "{8BCA1B9C-5687-4F5A-8F7F-F6270D12B83B}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestFramework.TUnit.Tests", "Tests\TestFrameworks\TestFramework.TUnit.Tests\TestFramework.TUnit.Tests.csproj", "{00855432-F973-4823-9F57-BC3FE53F5D9D}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -97,6 +99,10 @@ Global
{8BCA1B9C-5687-4F5A-8F7F-F6270D12B83B}.Debug|Any CPU.Build.0 = Debug|Any CPU
{8BCA1B9C-5687-4F5A-8F7F-F6270D12B83B}.Release|Any CPU.ActiveCfg = Release|Any CPU
{8BCA1B9C-5687-4F5A-8F7F-F6270D12B83B}.Release|Any CPU.Build.0 = Release|Any CPU
{00855432-F973-4823-9F57-BC3FE53F5D9D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{00855432-F973-4823-9F57-BC3FE53F5D9D}.Debug|Any CPU.Build.0 = Debug|Any CPU
{00855432-F973-4823-9F57-BC3FE53F5D9D}.Release|Any CPU.ActiveCfg = Release|Any CPU
{00855432-F973-4823-9F57-BC3FE53F5D9D}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand All @@ -114,6 +120,7 @@ Global
{4913DD7C-18AC-402C-9A6D-27D5EA797AD3} = {93C35842-4266-467E-AE87-3E91F83D5DDD}
{9B940AB8-47CE-46C9-90D7-2866E280441A} = {93C35842-4266-467E-AE87-3E91F83D5DDD}
{8BCA1B9C-5687-4F5A-8F7F-F6270D12B83B} = {93C35842-4266-467E-AE87-3E91F83D5DDD}
{00855432-F973-4823-9F57-BC3FE53F5D9D} = {93C35842-4266-467E-AE87-3E91F83D5DDD}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {65C0CC2C-5F10-4F18-9057-176DC70833FA}
Expand Down
12 changes: 0 additions & 12 deletions Tests/TestFrameworks/Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,4 @@
<Nullable>annotations</Nullable>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
<PackageReference Include="Nullable" Version="1.3.1">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="coverlet.collector" Version="6.0.2">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>

</Project>
12 changes: 12 additions & 0 deletions Tests/TestFrameworks/TestFramework.FallbackTest/TestFramework.FallbackTest.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,16 @@
<ProjectReference Include="..\..\..\Source\Testably.Expectations\Testably.Expectations.csproj" />
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
<PackageReference Include="Nullable" Version="1.3.1">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="coverlet.collector" Version="6.0.2">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>

</Project>
12 changes: 12 additions & 0 deletions Tests/TestFrameworks/TestFramework.NUnit3.Tests/TestFramework.NUnit3.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,16 @@
<ProjectReference Include="..\..\..\Source\Testably.Expectations\Testably.Expectations.csproj" />
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
<PackageReference Include="Nullable" Version="1.3.1">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="coverlet.collector" Version="6.0.2">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>

</Project>
12 changes: 12 additions & 0 deletions Tests/TestFrameworks/TestFramework.NUnit4.Tests/TestFramework.NUnit4.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,16 @@
<ProjectReference Include="..\..\..\Source\Testably.Expectations\Testably.Expectations.csproj" />
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
<PackageReference Include="Nullable" Version="1.3.1">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="coverlet.collector" Version="6.0.2">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>

</Project>
27 changes: 27 additions & 0 deletions Tests/TestFrameworks/TestFramework.TUnit.Tests/TUnitTestFrameworkTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
using System.Threading.Tasks;
using Testably.Expectations;
using TUnit.Assertions.Exceptions;
using TUnit.Core.Exceptions;

namespace TestFramework.TUnit.Tests;

public sealed class TUnitTestFrameworkTests
{
[Test]
public async Task OnFail_WhenUsingXunit2AsTestFramework_ShouldThrowXunitException()
{
void Act()
=> Testably.Expectations.Fail.Test("my message");

await Expect.That(Act).Throws<AssertionException>();
}

[Test]
public async Task OnSkip_WhenUsingXunit2AsTestFramework_ShouldThrowSkipException()
{
void Act()
=> Testably.Expectations.Skip.Test("my message");

await Expect.That(Act).Throws<SkipTestException>();
}
}
15 changes: 15 additions & 0 deletions Tests/TestFrameworks/TestFramework.TUnit.Tests/TestFramework.TUnit.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFrameworks>net8.0</TargetFrameworks>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="TUnit" Version="0.1.1099" />
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\..\..\Source\Testably.Expectations\Testably.Expectations.csproj" />
</ItemGroup>

</Project>
12 changes: 12 additions & 0 deletions Tests/TestFrameworks/TestFramework.XUnit2.Tests/TestFramework.XUnit2.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,16 @@
<ProjectReference Include="..\..\..\Source\Testably.Expectations\Testably.Expectations.csproj" />
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
<PackageReference Include="Nullable" Version="1.3.1">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="coverlet.collector" Version="6.0.2">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>

</Project>
Loading