Added ICacheLogger.ClearEntries (#284)

* Added ICacheLogger.ClearEntries Closes #280
roryprimrose · Nov 6, 2024 · f1e7589 · f1e7589
1 parent 783dd35
commit f1e7589
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 7 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -23,7 +23,7 @@ jobs:
       run: Add-Content -Path ${env:GITHUB_ENV} "`nprojectName=$(${env:GITHUB_REPOSITORY}.substring(${env:GITHUB_REPOSITORY}.IndexOf('/') + 1))" -Encoding utf8
 
     - name: Checkout
-      uses: actions/checkout@v4.1.7
+      uses: actions/checkout@v4.2.2
       with:
         fetch-depth: 0
 

diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -6,14 +6,14 @@
   </PropertyGroup>
   <ItemGroup Label="Package Versions used by this repository">
     <!-- Direct dependencies -->
-    <PackageVersion Include="Microsoft.Extensions.Logging" Version="8.0.0" />
-    <PackageVersion Include="System.Text.Json" Version="8.0.4" />
+    <PackageVersion Include="Microsoft.Extensions.Logging" Version="8.0.1" />
+    <PackageVersion Include="System.Text.Json" Version="8.0.5" />
     <PackageVersion Include="Xunit.Abstractions" Version="2.0.3" />
-    <PackageVersion Include="NSubstitute" Version="5.1.0" />
+    <PackageVersion Include="NSubstitute" Version="5.3.0" />
     <PackageVersion Include="ModelBuilder" Version="8.6.0" />
-    <PackageVersion Include="FluentAssertions" Version="6.12.0" />
-    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
-    <PackageVersion Include="xunit" Version="2.9.0" />
+    <PackageVersion Include="FluentAssertions" Version="6.12.1" />
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+    <PackageVersion Include="xunit" Version="2.9.2" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" PrivateAssets="All" IncludeAssets="runtime; build; native; contentfiles; analyzers; buildtransitive" />
     <PackageVersion Include="coverlet.msbuild" Version="6.0.2" PrivateAssets="All" IncludeAssets="runtime; build; native; contentfiles; analyzers; buildtransitive" />
     <!-- Overrides -->

diff --git a/Neovolve.Logging.Xunit.UnitTests/CacheLoggerTests.cs b/Neovolve.Logging.Xunit.UnitTests/CacheLoggerTests.cs
@@ -78,6 +78,21 @@ public void CanDisposeWithoutFactory()
             action.Should().NotThrow();
         }
 
+        [Fact]
+        public void ClearEntriesResetsStoredData()
+        {
+            using var sut = new CacheLogger();
+
+            sut.LogInformation("first");
+            sut.LogInformation("second");
+            sut.LogInformation("third");
+            sut.ClearEntries();
+
+            sut.Count.Should().Be(0);
+            sut.Entries.Should().BeEmpty();
+            sut.Last.Should().BeNull();
+        }
+
         [Fact]
         public void DisposeCallsDisposeOnFactory()
         {
@@ -118,6 +133,28 @@ public void EntriesRecordsLogStateInformation()
             data.Should().ContainKey("{OriginalFormat}").WhoseValue.Should().Be(format);
         }
 
+        [Fact]
+        public void EntriesReturnsRecordsEntriesAfterBeingCleared()
+        {
+            using var sut = new CacheLogger();
+
+            sut.LogInformation("first");
+            sut.LogInformation("second");
+            sut.LogInformation("third");
+            sut.ClearEntries();
+            sut.LogInformation("first");
+            sut.LogInformation("second");
+            sut.LogInformation("third");
+
+            var entries = sut.Entries.ToList();
+
+            entries.Should().HaveCount(3);
+            entries[0].Message.Should().Be("first");
+            entries[1].Message.Should().Be("second");
+            entries[2].Message.Should().Be("third");
+            sut.Last!.Message.Should().Be("third");
+        }
+
         [Fact]
         public void EntriesReturnsRecordsEntriesInOrder()
         {
@@ -133,6 +170,7 @@ public void EntriesReturnsRecordsEntriesInOrder()
             entries[0].Message.Should().Be("first");
             entries[1].Message.Should().Be("second");
             entries[2].Message.Should().Be("third");
+            sut.Last!.Message.Should().Be("third");
         }
 
         [Theory]

diff --git a/Neovolve.Logging.Xunit.sln.DotSettings b/Neovolve.Logging.Xunit.sln.DotSettings
@@ -430,6 +430,7 @@
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpPlaceEmbeddedOnSameLineMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpRenamePlacementToArrangementMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpUseContinuousIndentInsideBracesMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002EMemberReordering_002EMigrations_002ECSharpFileLayoutPatternRemoveIsAttributeUpgrade/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EAddAccessorOwnerDeclarationBracesMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EAlwaysTreatStructAsNotReorderableMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002ECSharpPlaceAttributeOnSameLineMigration/@EntryIndexedValue">True</s:Boolean>

diff --git a/Neovolve.Logging.Xunit/CacheLogger.cs b/Neovolve.Logging.Xunit/CacheLogger.cs
@@ -60,6 +60,12 @@ internal CacheLogger(ILogger logger, ILoggerFactory factory)
             return cacheScope;
         }
 
+        /// <inheritdoc />
+        public void ClearEntries()
+        {
+            _logEntries.Clear();
+        }
+
         /// <inheritdoc />
         public void Dispose()
         {

diff --git a/Neovolve.Logging.Xunit/ICacheLogger.cs b/Neovolve.Logging.Xunit/ICacheLogger.cs
@@ -10,6 +10,11 @@
     /// </summary>
     public interface ICacheLogger : ILogger, IDisposable
     {
+        /// <summary>
+        ///     Clears all recorded log entries.
+        /// </summary>
+        void ClearEntries();
+
         /// <summary>
         ///     Gets the number of cache entries recorded.
         /// </summary>