TUnit Support

[thomhurst]

Description

A project/package for easy integration with the TUnit testing framework.

Closed issues

#1

Checklist

• Reviewed the contribution guidelines
• Linked the issue(s) the PR closes
• Implemented automated tests and checked coverage
• Provided inline documentation comments for new public API
• Ran the full solution build and validation locally

[thomhurst]

@aivascu

The TUnit versioning system is unclear. Are you using ZeroVer for TUnit or a stable v1 is planned somewhere in the future?

There will be a v1. But Rider and VS have some issues still with the new Microsoft Testing Platform. So I want to wait for those fixes before I release v1, because I don't want to do an "official" release and it be an unpleasant experience for some people.

[aivascu]

There will be a v1. But Rider and VS have some issues still with the new Microsoft Testing Platform. So I want to wait for those fixes before I release v1, because I don't want to do an "official" release and it be an unpleasant experience for some people.

@thomhurst I see. In this case I'll release the package under a zero-based version as well until you publish v1.

[thomhurst]

@aivascu Did you review this?

[aivascu]

@thomhurst hi, yeah kinda. I was just doing some changes to it.
Finally got a couple free days to work on open source. )

[aivascu]

@thomhurst I'm going to push a few changes in a bit. Building the project in validation mode with all code style rules enabled, and .NET 8, kinda sent me down a rabbit hole of refactoring. )

There is one more issue I found in TUnit's source generator file StackTraceHiddenAttribute. This class uses the C# 12 bodyless class declaration (can't remember what it's called), that is not available for when building against older SDKs.
IMO since TUnit supports .NET Standard 2.0 I think it should also support use the version of the C# syntax available at the time when it came out (i.e. C# 8.0).
I haven't checked yet but it's likely that a test project on .NET Framework 4.8 with older build build tools might not be able to build TUnit tests.

[thomhurst]

@thomhurst I'm going to push a few changes in a bit. Building the project in validation mode with all code style rules enabled, and .NET 8, kinda sent me down a rabbit hole of refactoring. )

There is one more issue I found in TUnit's source generator file StackTraceHiddenAttribute. This class uses the C# 12 bodyless class declaration (can't remember what it's called), that is not available for when building against older SDKs. IMO since TUnit supports .NET Standard 2.0 I think it should also support use the version of the C# syntax available at the time when it came out (i.e. C# 8.0). I haven't checked yet but it's likely that a test project on .NET Framework 4.8 with older build build tools might not be able to build TUnit tests.

Do you mean file scoped namespaces?

[aivascu]

Do you mean file scoped namespaces?

No, I mean declarations like public class MyClass;. I'm not at my PC ATM, I'll send you the exact declaration later today.
But since you mentioned it, file scoped namespaces could also be an issue, depending on the SDK building the test project.
It's not a blocker for this PR, but it might be something you'd want to look into.

[aivascu]

@thomhurst the generated file I mentioned looks like below. I couldn't reproduce a syntax error under older SDKs since it was not generated. Probably because the polyfill is not necessary under those targets?

namespace System.Diagnostics;

using System;
using System.Diagnostics.CodeAnalysis;

[AttributeUsage(
    AttributeTargets.Class |
    AttributeTargets.Method |
    AttributeTargets.Constructor |
    AttributeTargets.Struct,
    Inherited = false)]
sealed class StackTraceHiddenAttribute : Attribute;

I could however reproduce a primary constructor syntax error when I set the language version to 10 while building under .NET 8.0 SDK.

0>StackTraceHiddenAttribute.g.cs(12,51): Error CS8936 : Feature 'primary constructors' is not available in C# 10.0. Please use language version 12.0 or greater.

and the namespace error when I set the language version even lower.

0>StackTraceHiddenAttribute.g.cs(1,1): Error CS8400 : Feature 'file-scoped namespace' is not available in C# 8.0. Please use language version 10.0 or greater.

IMO auto-generated code should be as unambiguous and backward compatible as possible.

namespace System.Diagnostics
{
    [global::System.AttributeUsage(
        global::System.AttributeTargets.Class |
        global::System.AttributeTargets.Method |
        global::System.AttributeTargets.Constructor |
        global::System.AttributeTargets.Struct,
        Inherited = false)]
    internal sealed class StackTraceHiddenAttribute : global::System.Attribute
    {
    }
}

[thomhurst]

I'll add it to my to-do list to make it more legacy friendly

[thomhurst]

Apart from that, is the rest of the pr okay?

[aivascu]

Apart from that, is the rest of the pr okay?

I think so, yes. I should have some time near eow to finish the changes and merge the PR.