Merge pull request #361 from sungam3r/api

Add API approval test
serilog · Mar 13, 2023 · 679ce35 · 679ce35
2 parents da62a35 + 2d5e1dd
commit 679ce35
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -132,7 +132,7 @@ publish/
 # Publish Web Output
 *.[Pp]ublish.xml
 *.azurePubxml
-# TODO: Comment the next line if you want to checkin your web deploy settings 
+# TODO: Comment the next line if you want to checkin your web deploy settings
 # but database connection strings (with potential passwords) will be unencrypted
 *.pubxml
 *.publishproj
@@ -200,7 +200,4 @@ FakesAssemblies/
 
 project.lock.json
 
-#Test files
-*.txt
-
 artifacts/
diff --git a/test/Serilog.Settings.Configuration.Tests/ApiApprovalTests.cs b/test/Serilog.Settings.Configuration.Tests/ApiApprovalTests.cs
@@ -0,0 +1,25 @@
+#if NET7_0
+
+using PublicApiGenerator;
+using Shouldly;
+
+namespace Serilog.Settings.Configuration.Tests;
+
+public class ApiApprovalTests
+{
+    [Fact]
+    public void PublicApi_Should_Not_Change_Unintentionally()
+    {
+        var assembly = typeof(ConfigurationReaderOptions).Assembly;
+        var publicApi = assembly.GeneratePublicApi(
+            new()
+            {
+                IncludeAssemblyAttributes = false,
+                ExcludeAttributes = new[] { "System.Diagnostics.DebuggerDisplayAttribute" },
+            });
+
+        publicApi.ShouldMatchApproved(options => options.WithFilenameGenerator((_, _, fileType, fileExtension) => $"{assembly.GetName().Name!}.{fileType}.{fileExtension}"));
+    }
+}
+
+#endif
diff --git a/test/Serilog.Settings.Configuration.Tests/Serilog.Settings.Configuration.Tests.csproj b/test/Serilog.Settings.Configuration.Tests/Serilog.Settings.Configuration.Tests.csproj
@@ -19,10 +19,11 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="6.0.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
-    <PackageReference Include="Microsoft.TestPlatform.ObjectModel" Version="17.5.0" />
     <PackageReference Include="Serilog.Expressions" Version="3.3.0" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" />
     <PackageReference Include="xunit" Version="2.4.2" />
+    <PackageReference Include="Shouldly" Version="4.1.0" />
+    <PackageReference Include="PublicApiGenerator" Version="11.0.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/test/Serilog.Settings.Configuration.Tests/Serilog.Settings.Configuration.approved.txt b/test/Serilog.Settings.Configuration.Tests/Serilog.Settings.Configuration.approved.txt
@@ -0,0 +1,50 @@
+namespace Serilog
+{
+    public static class ConfigurationLoggerConfigurationExtensions
+    {
+        public const string DefaultSectionName = "Serilog";
+        [System.Obsolete("Use ReadFrom.Configuration(IConfiguration configuration, ConfigurationReaderOptio" +
+            "ns readerOptions) instead.")]
+        public static Serilog.LoggerConfiguration Configuration(this Serilog.Configuration.LoggerSettingsConfiguration settingConfiguration, Microsoft.Extensions.Configuration.IConfiguration configuration, Microsoft.Extensions.DependencyModel.DependencyContext dependencyContext) { }
+        [System.Obsolete("Use ReadFrom.Configuration(IConfiguration configuration, ConfigurationReaderOptio" +
+            "ns readerOptions) instead.")]
+        public static Serilog.LoggerConfiguration Configuration(this Serilog.Configuration.LoggerSettingsConfiguration settingConfiguration, Microsoft.Extensions.Configuration.IConfiguration configuration, Serilog.Settings.Configuration.ConfigurationAssemblySource configurationAssemblySource) { }
+        public static Serilog.LoggerConfiguration Configuration(this Serilog.Configuration.LoggerSettingsConfiguration settingConfiguration, Microsoft.Extensions.Configuration.IConfiguration configuration, Serilog.Settings.Configuration.ConfigurationReaderOptions readerOptions = null) { }
+        [System.Obsolete("Use ReadFrom.Configuration(IConfiguration configuration, ConfigurationReaderOptio" +
+            "ns readerOptions) instead.")]
+        public static Serilog.LoggerConfiguration Configuration(this Serilog.Configuration.LoggerSettingsConfiguration settingConfiguration, Microsoft.Extensions.Configuration.IConfiguration configuration, params System.Reflection.Assembly[] assemblies) { }
+        [System.Obsolete("Use ReadFrom.Configuration(IConfiguration configuration, ConfigurationReaderOptio" +
+            "ns readerOptions) instead.")]
+        public static Serilog.LoggerConfiguration Configuration(this Serilog.Configuration.LoggerSettingsConfiguration settingConfiguration, Microsoft.Extensions.Configuration.IConfiguration configuration, string sectionName, Microsoft.Extensions.DependencyModel.DependencyContext dependencyContext = null) { }
+        [System.Obsolete("Use ReadFrom.Configuration(IConfiguration configuration, ConfigurationReaderOptio" +
+            "ns readerOptions) instead.")]
+        public static Serilog.LoggerConfiguration Configuration(this Serilog.Configuration.LoggerSettingsConfiguration settingConfiguration, Microsoft.Extensions.Configuration.IConfiguration configuration, string sectionName, Serilog.Settings.Configuration.ConfigurationAssemblySource configurationAssemblySource) { }
+        [System.Obsolete("Use ReadFrom.Configuration(IConfiguration configuration, ConfigurationReaderOptio" +
+            "ns readerOptions) instead.")]
+        public static Serilog.LoggerConfiguration Configuration(this Serilog.Configuration.LoggerSettingsConfiguration settingConfiguration, Microsoft.Extensions.Configuration.IConfiguration configuration, string sectionName, params System.Reflection.Assembly[] assemblies) { }
+        [System.Obsolete("Use ReadFrom.Configuration(IConfiguration configuration, string sectionName, Depe" +
+            "ndencyContext dependencyContext) instead.")]
+        public static Serilog.LoggerConfiguration ConfigurationSection(this Serilog.Configuration.LoggerSettingsConfiguration settingConfiguration, Microsoft.Extensions.Configuration.IConfigurationSection configSection, Microsoft.Extensions.DependencyModel.DependencyContext dependencyContext = null) { }
+        [System.Obsolete("Use ReadFrom.Configuration(IConfiguration configuration, string sectionName, Conf" +
+            "igurationAssemblySource configurationAssemblySource) instead.")]
+        public static Serilog.LoggerConfiguration ConfigurationSection(this Serilog.Configuration.LoggerSettingsConfiguration settingConfiguration, Microsoft.Extensions.Configuration.IConfigurationSection configSection, Serilog.Settings.Configuration.ConfigurationAssemblySource configurationAssemblySource) { }
+    }
+}
+namespace Serilog.Settings.Configuration
+{
+    public enum ConfigurationAssemblySource
+    {
+        UseLoadedAssemblies = 0,
+        AlwaysScanDllFiles = 1,
+    }
+    public sealed class ConfigurationReaderOptions
+    {
+        public ConfigurationReaderOptions() { }
+        public ConfigurationReaderOptions(Microsoft.Extensions.DependencyModel.DependencyContext dependencyContext) { }
+        public ConfigurationReaderOptions(Serilog.Settings.Configuration.ConfigurationAssemblySource configurationAssemblySource) { }
+        public ConfigurationReaderOptions(params System.Reflection.Assembly[] assemblies) { }
+        public System.IFormatProvider FormatProvider { get; init; }
+        public System.Action<string, Serilog.Core.LoggingLevelSwitch> OnLevelSwitchCreated { get; init; }
+        public string SectionName { get; init; }
+    }
+}