feat: Add PublicApiAttribute for marking PublicApi test definitions

src/NetEvolve.Extensions.MSTest/Internals.cs

@@ -104,4 +104,9 @@ internal static class Internals
     /// TestGroup
     /// </summary>
     public const string TestGroup = nameof(TestGroup);
+
+    /// <summary>
+    /// PublicApi
+    /// </summary>
+    public const string PublicApi = nameof(PublicApi);
 }

src/NetEvolve.Extensions.MSTest/PublicApiAttribute.cs

@@ -0,0 +1,17 @@
+namespace NetEvolve.Extensions.MSTest;
+
+using System;
+using NetEvolve.Extensions.MSTest.Internal;
+
+/// <summary>
+/// Attribute used to decorate a test class or method as <b>PublicApi</b>.
+/// </summary>
+[AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true)]
+public sealed class PublicApiAttribute : TestTraitBaseAttribute
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PublicApiAttribute"/> class.
+    /// </summary>
+    public PublicApiAttribute()
+        : base(Internals.PublicApi) { }
+}

src/NetEvolve.Extensions.NUnit/Internals.cs

@@ -104,4 +104,9 @@ internal static class Internals
     /// TestGroup
     /// </summary>
     public const string TestGroup = nameof(TestGroup);
+
+    /// <summary>
+    /// PublicApi
+    /// </summary>
+    public const string PublicApi = nameof(PublicApi);
 }

src/NetEvolve.Extensions.NUnit/PublicApiAttribute.cs

@@ -0,0 +1,17 @@
+namespace NetEvolve.Extensions.NUnit;
+
+using System;
+using global::NUnit.Framework;
+
+/// <summary>
+/// Attribute used to decorate a test class or method as <b>PublicApi</b>.
+/// </summary>
+[AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true)]
+public sealed class PublicApiAttribute : CategoryAttribute
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PublicApiAttribute"/> class.
+    /// </summary>
+    public PublicApiAttribute()
+        : base(Internals.PublicApi) { }
+}

src/NetEvolve.Extensions.TUnit/Internals.cs

@@ -89,4 +89,9 @@ internal static class Internals
     /// TestGroup
     /// </summary>
     public const string TestGroup = nameof(TestGroup);
+
+    /// <summary>
+    /// PublicApi
+    /// </summary>
+    public const string PublicApi = nameof(PublicApi);
 }

src/NetEvolve.Extensions.TUnit/PublicApiAttribute.cs

@@ -0,0 +1,17 @@
+namespace NetEvolve.Extensions.TUnit;
+
+using System;
+using NetEvolve.Extensions.TUnit.Internal;
+
+/// <summary>
+/// Attribute used to decorate a test class or method as <b>PublicApi</b>.
+/// </summary>
+[AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true)]
+public sealed class PublicApiAttribute : CategoryTraitBaseAttribute
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PublicApiAttribute"/> class.
+    /// </summary>
+    public PublicApiAttribute()
+        : base(Internals.PublicApi) { }
+}

src/NetEvolve.Extensions.XUnit.V3/Internals.cs

@@ -114,4 +114,9 @@ internal static class Internals
     /// TestGroup
     /// </summary>
     public const string TestGroup = nameof(TestGroup);
+
+    /// <summary>
+    /// PublicApi
+    /// </summary>
+    public const string PublicApi = nameof(PublicApi);
 }

src/NetEvolve.Extensions.XUnit.V3/PublicApiAttribute.cs

@@ -0,0 +1,17 @@
+namespace NetEvolve.Extensions.XUnit.V3;
+
+using System;
+using NetEvolve.Extensions.XUnit.V3.Internal;
+
+/// <summary>
+/// Attribute used to decorate a test class or method as <b>PublicApi</b>.
+/// </summary>
+[AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true)]
+public sealed class PublicApiAttribute : CategoryTraitBaseAttribute
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PublicApiAttribute"/> class.
+    /// </summary>
+    public PublicApiAttribute()
+        : base(Internals.PublicApi) { }
+}

tests/NetEvolve.Extensions.MSTest.Tests.PublicApi/_snapshots/DotNet10_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -60,6 +60,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NetEvolve.Extensions.MSTest.Internal.TestTraitBaseAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class TestGroupAttribute : NetEvolve.Extensions.MSTest.Internal.TestCategoryWithIdBaseAttribute
     {
         public TestGroupAttribute(string id) { }

tests/NetEvolve.Extensions.MSTest.Tests.PublicApi/_snapshots/DotNet8_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -60,6 +60,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NetEvolve.Extensions.MSTest.Internal.TestTraitBaseAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class TestGroupAttribute : NetEvolve.Extensions.MSTest.Internal.TestCategoryWithIdBaseAttribute
     {
         public TestGroupAttribute(string id) { }

tests/NetEvolve.Extensions.MSTest.Tests.PublicApi/_snapshots/DotNet9_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -60,6 +60,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NetEvolve.Extensions.MSTest.Internal.TestTraitBaseAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class TestGroupAttribute : NetEvolve.Extensions.MSTest.Internal.TestCategoryWithIdBaseAttribute
     {
         public TestGroupAttribute(string id) { }

tests/NetEvolve.Extensions.MSTest.Tests.Unit/PublicApiAttributeTests.cs

@@ -0,0 +1,28 @@
+namespace NetEvolve.Extensions.MSTest.Tests.Unit;
+
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.Threading.Tasks;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+/// <summary>
+/// Unit tests for <see cref="PublicApiAttribute"/>.
+/// </summary>
+[ExcludeFromCodeCoverage]
+[TestClass]
+public class PublicApiAttributeTests : AttributeTestsBase
+{
+    [TestMethod]
+    [PublicApi]
+    [DataRow(nameof(PublicApi_without_parameters))]
+    [DataRow(nameof(PublicApi_without_or_invalid_parameters))]
+    public async Task PublicApi_without_or_invalid_parameters(string methodName)
+    {
+        var properties = GetProperties(methodName);
+
+        _ = await VerifyMSTest(properties).UseParameters(methodName);
+    }
+
+    [PublicApi]
+    private void PublicApi_without_parameters() => throw new NotSupportedException();
+}

tests/NetEvolve.Extensions.NUnit.Tests.PublicApi/_snapshots/DotNet10_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -72,6 +72,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NUnit.Framework.CategoryAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class TestGroupAttribute : NetEvolve.Extensions.NUnit.Internal.NamedCategoryBaseAttribute
     {
         public TestGroupAttribute(string id) { }

tests/NetEvolve.Extensions.NUnit.Tests.PublicApi/_snapshots/DotNet8_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -72,6 +72,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NUnit.Framework.CategoryAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class TestGroupAttribute : NetEvolve.Extensions.NUnit.Internal.NamedCategoryBaseAttribute
     {
         public TestGroupAttribute(string id) { }

tests/NetEvolve.Extensions.NUnit.Tests.PublicApi/_snapshots/DotNet9_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -72,6 +72,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NUnit.Framework.CategoryAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class TestGroupAttribute : NetEvolve.Extensions.NUnit.Internal.NamedCategoryBaseAttribute
     {
         public TestGroupAttribute(string id) { }

tests/NetEvolve.Extensions.NUnit.Tests.Unit/PublicApiAttributeTests.cs

@@ -0,0 +1,27 @@
+namespace NetEvolve.Extensions.NUnit.Tests.Unit;
+
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.Threading.Tasks;
+using global::NUnit.Framework;
+
+/// <summary>
+/// Unit tests for <see cref="PublicApiAttribute"/>.
+/// </summary>
+[ExcludeFromCodeCoverage]
+public class PublicApiAttributeTests : AttributeTestsBase
+{
+    [Theory]
+    [PublicApi]
+    [TestCase(nameof(PublicApi_without_parameters))]
+    [TestCase(nameof(PublicApi_without_or_invalid_parameters))]
+    public async Task PublicApi_without_or_invalid_parameters(string methodName)
+    {
+        var properties = GetProperties(methodName);
+
+        _ = await Verify(properties).UseParameters(methodName);
+    }
+
+    [PublicApi]
+    private void PublicApi_without_parameters() => throw new NotSupportedException();
+}

tests/NetEvolve.Extensions.TUnit.Tests.PublicApi/_snapshots/DotNet10_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -60,6 +60,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NetEvolve.Extensions.TUnit.Internal.CategoryTraitBaseAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class SkipOnFailureAttribute : System.Attribute, TUnit.Core.Interfaces.IEventReceiver, TUnit.Core.Interfaces.ITestEndEventReceiver
     {
         public SkipOnFailureAttribute() { }

tests/NetEvolve.Extensions.TUnit.Tests.PublicApi/_snapshots/DotNet6_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -60,6 +60,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NetEvolve.Extensions.TUnit.Internal.CategoryTraitBaseAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class SkipOnFailureAttribute : System.Attribute, TUnit.Core.Interfaces.IEventReceiver, TUnit.Core.Interfaces.ITestEndEventReceiver
     {
         public SkipOnFailureAttribute() { }

tests/NetEvolve.Extensions.TUnit.Tests.PublicApi/_snapshots/DotNet8_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -60,6 +60,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NetEvolve.Extensions.TUnit.Internal.CategoryTraitBaseAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class SkipOnFailureAttribute : System.Attribute, TUnit.Core.Interfaces.IEventReceiver, TUnit.Core.Interfaces.ITestEndEventReceiver
     {
         public SkipOnFailureAttribute() { }

tests/NetEvolve.Extensions.TUnit.Tests.PublicApi/_snapshots/DotNet9_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -60,6 +60,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NetEvolve.Extensions.TUnit.Internal.CategoryTraitBaseAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class SkipOnFailureAttribute : System.Attribute, TUnit.Core.Interfaces.IEventReceiver, TUnit.Core.Interfaces.ITestEndEventReceiver
     {
         public SkipOnFailureAttribute() { }

tests/NetEvolve.Extensions.TUnit.Tests.Unit/PublicApiAttributeTests.cs

@@ -0,0 +1,26 @@
+namespace NetEvolve.Extensions.TUnit.Tests.Unit;
+
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.Threading.Tasks;
+
+/// <summary>
+/// Unit tests for <see cref="PublicApiAttribute"/>.
+/// </summary>
+[ExcludeFromCodeCoverage]
+public class PublicApiAttributeTests : AttributeTestsBase
+{
+    [Test]
+    [PublicApi]
+    [Arguments(nameof(PublicApi_without_parameters))]
+    [Arguments(nameof(PublicApi_without_or_invalid_parameters))]
+    public async Task PublicApi_without_or_invalid_parameters(string methodName)
+    {
+        var traits = GetTraits(methodName);
+
+        _ = await Verify(traits).UseParameters(methodName);
+    }
+
+    [PublicApi]
+    protected void PublicApi_without_parameters() => throw new NotSupportedException();
+}

tests/NetEvolve.Extensions.XUnit.V3.Tests.PublicApi/_snapshots/DotNet10_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -60,6 +60,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NetEvolve.Extensions.XUnit.V3.Internal.CategoryTraitBaseAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class TestGroupAttribute : NetEvolve.Extensions.XUnit.V3.Internal.CategoryWithIdTraitBaseAttribute
     {
         public TestGroupAttribute(string id) { }

tests/NetEvolve.Extensions.XUnit.V3.Tests.PublicApi/_snapshots/DotNet8_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -60,6 +60,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NetEvolve.Extensions.XUnit.V3.Internal.CategoryTraitBaseAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class TestGroupAttribute : NetEvolve.Extensions.XUnit.V3.Internal.CategoryWithIdTraitBaseAttribute
     {
         public TestGroupAttribute(string id) { }

tests/NetEvolve.Extensions.XUnit.V3.Tests.PublicApi/_snapshots/DotNet9_0/PublicApiTests.PublicApi_HasNotChanged_Expected.verified.txt

@@ -60,6 +60,10 @@
     {
         public PreDeploymentAttribute() { }
     }
+    public sealed class PublicApiAttribute : NetEvolve.Extensions.XUnit.V3.Internal.CategoryTraitBaseAttribute
+    {
+        public PublicApiAttribute() { }
+    }
     public sealed class TestGroupAttribute : NetEvolve.Extensions.XUnit.V3.Internal.CategoryWithIdTraitBaseAttribute
     {
         public TestGroupAttribute(string id) { }

tests/NetEvolve.Extensions.XUnit.V3.Tests.Unit/PublicApiAttributeTests.cs

@@ -0,0 +1,27 @@
+namespace NetEvolve.Extensions.XUnit.V3.Tests.Unit;
+
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.Threading.Tasks;
+using Xunit;
+
+/// <summary>
+/// Unit tests for <see cref="PublicApiAttribute"/>.
+/// </summary>
+[ExcludeFromCodeCoverage]
+public class PublicApiAttributeTests : AttributeTestsBase
+{
+    [Theory]
+    [PublicApi]
+    [InlineData(nameof(PublicApi_without_parameters))]
+    [InlineData(nameof(PublicApi_without_or_invalid_parameters))]
+    public async Task PublicApi_without_or_invalid_parameters(string methodName)
+    {
+        var traits = GetTraits(methodName);
+
+        _ = await Verify(traits).UseParameters(methodName);
+    }
+
+    [PublicApi]
+    protected void PublicApi_without_parameters() => throw new NotSupportedException();
+}

tests/_snapshots/DotNet10_0/PublicApiAttributeTests.PublicApi_without_or_invalid_parameters_methodName=PublicApi_without_or_invalid_parameters.verified.txt

@@ -0,0 +1,5 @@
+[
+  {
+    TestCategory: PublicApi
+  }
+]

tests/_snapshots/DotNet10_0/PublicApiAttributeTests.PublicApi_without_or_invalid_parameters_methodName=PublicApi_without_parameters.verified.txt

@@ -0,0 +1,5 @@
+[
+  {
+    TestCategory: PublicApi
+  }
+]

tests/_snapshots/DotNet6_0/PublicApiAttributeTests.PublicApi_without_or_invalid_parameters_methodName=PublicApi_without_or_invalid_parameters.verified.txt

@@ -0,0 +1,5 @@
+[
+  {
+    TestCategory: PublicApi
+  }
+]

tests/_snapshots/DotNet6_0/PublicApiAttributeTests.PublicApi_without_or_invalid_parameters_methodName=PublicApi_without_parameters.verified.txt

@@ -0,0 +1,5 @@
+[
+  {
+    TestCategory: PublicApi
+  }
+]

tests/_snapshots/DotNet8_0/PublicApiAttributeTests.PublicApi_without_or_invalid_parameters_methodName=PublicApi_without_or_invalid_parameters.verified.txt

@@ -0,0 +1,5 @@
+[
+  {
+    TestCategory: PublicApi
+  }
+]