Snapshot test public API

.gitattributes

@@ -0,0 +1,3 @@
+*.verified.txt text eol=lf
+*.verified.xml text eol=lf
+*.verified.json text eol=lf

.gitignore

@@ -14,3 +14,5 @@ Thumbs.db
 *.log
 *.binlog
 *.orig
+
+*.received.*

src/ZeroLog.Tests.NetStandard/Initializer.cs

@@ -0,0 +1,16 @@
+using DiffEngine;
+using NUnit.Framework;
+using VerifyTests;
+
+namespace ZeroLog.Tests.NetStandard;
+
+[SetUpFixture]
+public static class Initializer
+{
+    [OneTimeSetUp]
+    public static void Initialize()
+    {
+        DiffRunner.Disabled = true;
+        VerifyDiffPlex.Initialize();
+    }
+}

src/ZeroLog.Tests.NetStandard/SanityChecks.cs

@@ -0,0 +1,52 @@
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using NUnit.Framework;
+using PublicApiGenerator;
+using VerifyNUnit;
+
+namespace ZeroLog.Tests.NetStandard;
+
+[TestFixture]
+public class SanityChecks
+{
+    [Test]
+    public Task should_export_expected_namespaces()
+    {
+        return Verifier.Verify(
+            typeof(LogManager).Assembly
+                              .ExportedTypes
+                              .Select(i => i.Namespace)
+                              .OrderBy(i => i)
+                              .Distinct()
+        );
+    }
+
+    [Test]
+    public Task should_export_expected_types()
+    {
+        return Verifier.Verify(
+            typeof(LogManager).Assembly
+                              .ExportedTypes
+                              .Select(i => i.FullName)
+                              .OrderBy(i => i)
+                              .Distinct()
+        );
+    }
+
+    [Test]
+    public Task should_have_expected_public_api()
+    {
+        return Verifier.Verify(
+            typeof(LogManager).Assembly
+                              .GeneratePublicApi(new ApiGeneratorOptions
+                              {
+                                  IncludeAssemblyAttributes = false,
+                                  ExcludeAttributes = new[]
+                                  {
+                                      typeof(ObsoleteAttribute).FullName
+                                  }
+                              })
+        );
+    }
+}

src/ZeroLog.Tests.NetStandard/SanityChecks.should_export_expected_namespaces.verified.txt

@@ -0,0 +1,3 @@
+[
+  ZeroLog
+]

src/ZeroLog.Tests.NetStandard/SanityChecks.should_export_expected_types.verified.txt

@@ -0,0 +1,14 @@
+[
+  ZeroLog.Log,
+  ZeroLog.Log+DebugInterpolatedStringHandler,
+  ZeroLog.Log+ErrorInterpolatedStringHandler,
+  ZeroLog.Log+FatalInterpolatedStringHandler,
+  ZeroLog.Log+InfoInterpolatedStringHandler,
+  ZeroLog.Log+TraceInterpolatedStringHandler,
+  ZeroLog.Log+WarnInterpolatedStringHandler,
+  ZeroLog.LogLevel,
+  ZeroLog.LogManager,
+  ZeroLog.LogMessage,
+  ZeroLog.LogMessage+AppendInterpolatedStringHandler,
+  ZeroLog.LogMessage+AppendOperation`1
+]

src/ZeroLog.Tests.NetStandard/ZeroLog.Tests.NetStandard.csproj

@@ -11,6 +11,9 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
     <PackageReference Include="NUnit" Version="3.13.3" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.3.0" />
+    <PackageReference Include="Verify.NUnit" Version="19.8.3" />
+    <PackageReference Include="Verify.DiffPlex" Version="2.1.0" />
+    <PackageReference Include="PublicApiGenerator" Version="10.3.0" />
   </ItemGroup>
 
   <ItemGroup>

src/ZeroLog.Tests/ModuleInitializer.cs

@@ -0,0 +1,17 @@
+using System.Runtime.CompilerServices;
+using DiffEngine;
+using VerifyTests;
+
+namespace ZeroLog.Tests;
+
+#pragma warning disable CA2255
+
+public static class ModuleInitializer
+{
+    [ModuleInitializer]
+    public static void Initialize()
+    {
+        DiffRunner.Disabled = true;
+        VerifyDiffPlex.Initialize();
+    }
+}

src/ZeroLog.Tests/SanityChecks.cs

@@ -1,56 +1,56 @@
+using System;
 using System.Linq;
+using System.Runtime.CompilerServices;
+using System.Threading.Tasks;
 using NUnit.Framework;
-using ZeroLog.Tests.Support;
+using PublicApiGenerator;
+using VerifyNUnit;
 
 namespace ZeroLog.Tests;
 
 [TestFixture]
 public class SanityChecks
 {
     [Test]
-    public void should_export_expected_types()
+    public Task should_export_expected_namespaces()
     {
-        // This test prevents mistakenly adding public types in the future.
+        return Verifier.Verify(
+            typeof(LogManager).Assembly
+                              .ExportedTypes
+                              .Select(i => i.Namespace)
+                              .OrderBy(i => i)
+                              .Distinct()
+        );
+    }
 
-        var publicTypes = new[]
-        {
-            "ZeroLog.Appenders.Appender",
-            "ZeroLog.Appenders.ConsoleAppender",
-            "ZeroLog.Appenders.DateAndSizeRollingFileAppender",
-            "ZeroLog.Appenders.NoopAppender",
-            "ZeroLog.Appenders.StreamAppender",
-            "ZeroLog.Appenders.TextWriterAppender",
-            "ZeroLog.Configuration.AppenderConfiguration",
-            "ZeroLog.Configuration.AppendingStrategy",
-            "ZeroLog.Configuration.ILoggerConfigurationCollection",
-            "ZeroLog.Configuration.LogMessagePoolExhaustionStrategy",
-            "ZeroLog.Configuration.LoggerConfiguration",
-            "ZeroLog.Configuration.RootLoggerConfiguration",
-            "ZeroLog.Configuration.ZeroLogConfiguration",
-            "ZeroLog.Formatting.DefaultFormatter",
-            "ZeroLog.Formatting.Formatter",
-            "ZeroLog.Formatting.KeyValueList",
-            "ZeroLog.Formatting.KeyValueList+Enumerator",
-            "ZeroLog.Formatting.LoggedKeyValue",
-            "ZeroLog.Formatting.LoggedMessage",
-            "ZeroLog.Log",
-            "ZeroLog.Log+DebugInterpolatedStringHandler",
-            "ZeroLog.Log+ErrorInterpolatedStringHandler",
-            "ZeroLog.Log+FatalInterpolatedStringHandler",
-            "ZeroLog.Log+InfoInterpolatedStringHandler",
-            "ZeroLog.Log+TraceInterpolatedStringHandler",
-            "ZeroLog.Log+WarnInterpolatedStringHandler",
-            "ZeroLog.LogLevel",
-            "ZeroLog.LogManager",
-            "ZeroLog.LogMessage",
-            "ZeroLog.LogMessage+AppendInterpolatedStringHandler",
-            "ZeroLog.LogMessage+AppendOperation`1",
-            "ZeroLog.UnmanagedFormatterDelegate`1",
-        };
+    [Test]
+    public Task should_export_expected_types()
+    {
+        return Verifier.Verify(
+            typeof(LogManager).Assembly
+                              .ExportedTypes
+                              .Select(i => i.FullName)
+                              .OrderBy(i => i)
+                              .Distinct()
+        );
+    }
 
-        typeof(LogManager).Assembly
-                          .ExportedTypes
-                          .Select(i => i.FullName)
-                          .ShouldBeEquivalentTo(publicTypes);
+    [Test]
+    public Task should_have_expected_public_api()
+    {
+        return Verifier.Verify(
+            typeof(LogManager).Assembly
+                              .GeneratePublicApi(new ApiGeneratorOptions
+                              {
+                                  IncludeAssemblyAttributes = false,
+                                  ExcludeAttributes = new[]
+                                  {
+                                      typeof(ObsoleteAttribute).FullName,
+#if NET7_0_OR_GREATER
+                                      typeof(CompilerFeatureRequiredAttribute).FullName
+#endif
+                                  }
+                              })
+        ).UniqueForTargetFrameworkAndVersion();
     }
 }

src/ZeroLog.Tests/SanityChecks.should_export_expected_namespaces.verified.txt

@@ -0,0 +1,6 @@
+[
+  ZeroLog,
+  ZeroLog.Appenders,
+  ZeroLog.Configuration,
+  ZeroLog.Formatting
+]

src/ZeroLog.Tests/SanityChecks.should_export_expected_types.verified.txt

@@ -0,0 +1,34 @@
+[
+  ZeroLog.Appenders.Appender,
+  ZeroLog.Appenders.ConsoleAppender,
+  ZeroLog.Appenders.DateAndSizeRollingFileAppender,
+  ZeroLog.Appenders.NoopAppender,
+  ZeroLog.Appenders.StreamAppender,
+  ZeroLog.Appenders.TextWriterAppender,
+  ZeroLog.Configuration.AppenderConfiguration,
+  ZeroLog.Configuration.AppendingStrategy,
+  ZeroLog.Configuration.ILoggerConfigurationCollection,
+  ZeroLog.Configuration.LoggerConfiguration,
+  ZeroLog.Configuration.LogMessagePoolExhaustionStrategy,
+  ZeroLog.Configuration.RootLoggerConfiguration,
+  ZeroLog.Configuration.ZeroLogConfiguration,
+  ZeroLog.Formatting.DefaultFormatter,
+  ZeroLog.Formatting.Formatter,
+  ZeroLog.Formatting.KeyValueList,
+  ZeroLog.Formatting.KeyValueList+Enumerator,
+  ZeroLog.Formatting.LoggedKeyValue,
+  ZeroLog.Formatting.LoggedMessage,
+  ZeroLog.Log,
+  ZeroLog.Log+DebugInterpolatedStringHandler,
+  ZeroLog.Log+ErrorInterpolatedStringHandler,
+  ZeroLog.Log+FatalInterpolatedStringHandler,
+  ZeroLog.Log+InfoInterpolatedStringHandler,
+  ZeroLog.Log+TraceInterpolatedStringHandler,
+  ZeroLog.Log+WarnInterpolatedStringHandler,
+  ZeroLog.LogLevel,
+  ZeroLog.LogManager,
+  ZeroLog.LogMessage,
+  ZeroLog.LogMessage+AppendInterpolatedStringHandler,
+  ZeroLog.LogMessage+AppendOperation`1,
+  ZeroLog.UnmanagedFormatterDelegate`1
+]