test: Add approval test for public API changes

alexmg · Aug 29, 2024 · 7fc5de3 · 7fc5de3
1 parent 56a7e20
commit 7fc5de3
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 1 deletion.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -31,7 +31,10 @@ jobs:
         run: dotnet build --configuration Release
 
       - name: Run unit tests
-        run: dotnet test --no-build --configuration Release
+        run: dotnet test test\Moniker.Tests --configuration Release --no-build --no-restore
+
+      - name: Run approval tests
+        run: dotnet test test\Moniker.ApprovalTests --configuration Release --no-build --no-restore
 
       - name: Create NuGet packages
         run: dotnet pack --configuration Release

diff --git a/Moniker.sln b/Moniker.sln
@@ -19,6 +19,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Moniker.PerformanceTests", "test\Moniker.PerformanceTests\Moniker.PerformanceTests.csproj", "{FF324EAB-F8AE-4B7E-B8E0-07BD24B537DD}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Moniker.ApprovalTests", "test\Moniker.ApprovalTests\Moniker.ApprovalTests.csproj", "{C0555388-7087-408C-93C5-22D3FC2DA574}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -41,6 +43,10 @@ Global
 		{FF324EAB-F8AE-4B7E-B8E0-07BD24B537DD}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{FF324EAB-F8AE-4B7E-B8E0-07BD24B537DD}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{FF324EAB-F8AE-4B7E-B8E0-07BD24B537DD}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C0555388-7087-408C-93C5-22D3FC2DA574}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C0555388-7087-408C-93C5-22D3FC2DA574}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C0555388-7087-408C-93C5-22D3FC2DA574}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C0555388-7087-408C-93C5-22D3FC2DA574}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

diff --git a/test/Moniker.ApprovalTests/ApiApprovalTests.cs b/test/Moniker.ApprovalTests/ApiApprovalTests.cs
@@ -0,0 +1,24 @@
+using PublicApiGenerator;
+using Shouldly;
+using Xunit;
+
+namespace Moniker.ApprovalTests;
+
+public class ApiApprovalTests
+{
+    [Fact]
+    public void PublicApiShouldNotChangeUnintentionally()
+    {
+        var assembly = typeof(NameGenerator).Assembly;
+        var publicApi = assembly.GeneratePublicApi(
+            new ApiGeneratorOptions
+            {
+                IncludeAssemblyAttributes = false,
+                ExcludeAttributes = ["System.Diagnostics.DebuggerDisplayAttribute"],
+            });
+
+        publicApi.ShouldMatchApproved(options =>
+            options.WithFilenameGenerator((_, _, fileType, fileExtension) =>
+                $"{assembly.GetName().Name!}.{fileType}.{fileExtension}"));
+    }
+}
diff --git a/test/Moniker.ApprovalTests/Moniker.ApprovalTests.csproj b/test/Moniker.ApprovalTests/Moniker.ApprovalTests.csproj
@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <DeterministicSourcePaths>false</DeterministicSourcePaths>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" PrivateAssets="all" />
+    <PackageReference Include="xunit" Version="2.9.0" />
+    <PackageReference Include="Shouldly" Version="4.2.1" />
+    <PackageReference Include="PublicApiGenerator" Version="11.1.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Moniker\Moniker.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/test/Moniker.ApprovalTests/Moniker.approved.txt b/test/Moniker.ApprovalTests/Moniker.approved.txt
@@ -0,0 +1,15 @@
+namespace Moniker
+{
+    public enum MonikerStyle
+    {
+        Moniker = 0,
+        Moby = 1,
+    }
+    public static class NameGenerator
+    {
+        public const string DefaultDelimiter = "-";
+        public static string Generate(Moniker.MonikerStyle monikerStyle, string delimiter = "-") { }
+        public static string GenerateMoby(string delimiter = "-") { }
+        public static string GenerateMoniker(string delimiter = "-") { }
+    }
+}