Fix [FEATURE] Add tests to CrispyWaffle.Redis and other cache features with gitauto model

.githooks/pre-commit

@@ -3,7 +3,7 @@ LC_ALL=C
 
 local_branch="$(git rev-parse --abbrev-ref HEAD)"
 
-valid_branch_regex="^(dependabot|feature|fix|docs|style|refactor|perf|hotfix|test|chore|create)(\/[a-zA-Z0-9._-]+)+$"
+valid_branch_regex="^(gitauto|dependabot|feature|fix|docs|style|refactor|perf|hotfix|test|chore|create)(\/[a-zA-Z0-9._#-]+)+$"
 
 message="There is something wrong with your branch name. Branch names in this project must adhere to this contract: $valid_branch_regex. Your commit will be rejected. You should rename your branch to a valid name and try again."
 

Directory.Packages.props

@@ -14,8 +14,10 @@
     <PackageVersion Include="JunitXml.TestLogger" Version="3.1.12" />
     <PackageVersion Include="log4net" Version="2.0.17" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
+    <PackageVersion Include="Moq" Version="4.20.70" />
     <PackageVersion Include="NEST" Version="7.17.5" />
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
+    <PackageVersion Include="NSubstitute" Version="5.1.0" />
     <PackageVersion Include="RabbitMQ.Client" Version="6.8.1" />
     <PackageVersion Include="SonarAnalyzer.CSharp" Version="9.29.0.95321" />
     <PackageVersion Include="StackExchange.Redis" Version="2.8.0" />

Src/CrispyWaffle.Redis/Cache/RedisCacheRepository.cs

@@ -11,20 +11,20 @@
 {
     /// <summary>
     /// Class RedisCacheRepository.
-    /// Implements the <see cref="CrispyWaffle.Cache.ICacheRepository" />
-    /// Implements the <see cref="System.IDisposable" />
+    /// Implements the <see cref="CrispyWaffle.Cache.ICacheRepository" />.
+    /// Implements the <see cref="System.IDisposable" />.
     /// </summary>
     /// <seealso cref="CrispyWaffle.Cache.ICacheRepository" />
     /// <seealso cref="System.IDisposable" />
     public class RedisCacheRepository : ICacheRepository, IDisposable
     {
         /// <summary>
-        /// The connector
+        /// The connector.
         /// </summary>
         private readonly RedisConnector _connector;
 
         /// <summary>
-        /// The cache client
+        /// The cache client.
         /// </summary>
         private readonly IRedisClient _cacheClient;
 
@@ -57,7 +57,7 @@
         /// <summary>
         /// Sets to database.
         /// </summary>
-        /// <typeparam name="T"></typeparam>
+        /// <typeparam name="T">The type of the parameter.</typeparam>
         /// <param name="value">The value.</param>
         /// <param name="key">The key.</param>
         /// <param name="databaseNumber">The database number.</param>
@@ -86,12 +86,11 @@
         /// <summary>
         /// Gets from database.
         /// </summary>
-        /// <typeparam name="T"></typeparam>
+        /// <typeparam name="T">The type of the parameter.</typeparam>
         /// <param name="key">The key.</param>
         /// <param name="databaseNumber">The database number.</param>
         /// <returns>T.</returns>
-        /// <exception cref="System.InvalidOperationException"></exception>
-        /// <exception cref="InvalidOperationException"></exception>
+        /// <exception cref="System.InvalidOperationException">Invalid operation.</exception>
         public T GetFromDatabase<T>(string key, int databaseNumber)
         {
             var valueBytes = _connector
@@ -441,6 +440,7 @@
         public void Dispose()
         {
             _connector.Dispose();
+            GC.SuppressFinalize(this);
         }
     }
 }

Src/CrispyWaffle.Redis/Utils/Communications/RedisConnector.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using CrispyWaffle.Configuration;
 using StackExchange.Redis;
@@ -95,10 +94,7 @@ public RedisConnector(string host, int port, string password, ISerializer serial
         /// <param name="password">The password.</param>
         /// <param name="serializer">The serializer.</param>
         /// <param name="queuePrefix">The queue prefix.</param>
-        /// <exception cref="System.ArgumentNullException">queuePrefix</exception>
-        /// <exception cref="ArgumentNullException">queuePrefix</exception>
-        [SuppressMessage("ReSharper", "UnusedMember.Global")]
-        [SuppressMessage("ReSharper", "TooManyDependencies")]
+        /// <exception cref="ArgumentNullException">queuePrefix.</exception>
         public RedisConnector(
             string host,
             int port,
@@ -116,8 +112,7 @@ string queuePrefix
         /// <param name="password">The password.</param>
         /// <param name="serializer">The serializer.</param>
         /// <param name="queuePrefix">The queue prefix.</param>
-        /// <exception cref="System.ArgumentNullException">queuePrefix</exception>
-        /// <exception cref="ArgumentNullException">queuePrefix</exception>
+        /// <exception cref="ArgumentNullException">queuePrefix.</exception>
         public RedisConnector(
             string hostsList,
             string password,
@@ -168,6 +163,26 @@ public RedisConnector(string hostsList, string password, ISerializer serializer)
             QueuePrefix = "crispy-waffle";
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RedisConnector"/> class.
+        /// </summary>
+        /// <param name="client">The client.</param>
+        /// <param name="connectionPoolManager">The connection pool manager.</param>
+        /// <param name="serializer">The serializer.</param>
+        /// <param name="queuePrefix">The queue prefix.</param>
+        public RedisConnector(
+            IRedisClient client,
+            IRedisConnectionPoolManager connectionPoolManager,
+            ISerializer serializer,
+            string queuePrefix
+        )
+        {
+            _connectionPoolManager = connectionPoolManager;
+            Serializer = serializer;
+            Cache = client;
+            QueuePrefix = queuePrefix;
+        }
+
         /// <summary>
         /// Finalizes an instance of the <see cref="RedisConnector" /> class.
         /// </summary>

Src/CrispyWaffle/Serialization/SerializerConverter.cs

@@ -6,7 +6,6 @@
 using System.Text;
 using System.Xml;
 using CrispyWaffle.Composition;
-using CrispyWaffle.Extensions;
 using CrispyWaffle.Log;
 using CrispyWaffle.Serialization.Adapters;
 using Newtonsoft.Json;

Tests/CrispyWaffle.Tests/Cache/CacheManagerTests.cs

@@ -0,0 +1,64 @@
+using System;
+using CrispyWaffle.Cache;
+using Moq;
+using Xunit;
+
+namespace CrispyWaffle.Tests.Cache;
+
+public class CacheManagerTests
+{
+    private readonly Mock<ICacheRepository> _mockRepository1;
+    private readonly Mock<ICacheRepository> _mockRepository2;
+
+    public CacheManagerTests()
+    {
+        _mockRepository1 = new Mock<ICacheRepository>();
+        _mockRepository2 = new Mock<ICacheRepository>();
+        CacheManager.AddRepository(_mockRepository1.Object, 1);
+        CacheManager.AddRepository(_mockRepository2.Object, 2);
+    }
+
+    [Fact]
+    public void Set_ShouldStoreValueInAllRepositories()
+    {
+        // Arrange
+        var key = "test-key";
+        var value = "test-value";
+
+        // Act
+        CacheManager.Set(value, key);
+
+        // Assert
+        _mockRepository1.Verify(m => m.Set(value, key, (TimeSpan?)null), Times.Once);
+        _mockRepository2.Verify(m => m.Set(value, key, (TimeSpan?)null), Times.Once);
+    }
+
+    [Fact]
+    public void Get_ShouldRetrieveValueFromRepository()
+    {
+        // Arrange
+        var key = "test-key";
+        var expectedValue = "test-value";
+        _mockRepository1.Setup(m => m.TryGet(key, out expectedValue)).Returns(true);
+
+        // Act
+        var actualValue = CacheManager.Get<string>(key);
+
+        // Assert
+        Assert.Equal(expectedValue, actualValue);
+    }
+
+    [Fact]
+    public void Remove_ShouldRemoveValueFromAllRepositories()
+    {
+        // Arrange
+        var key = "test-key";
+
+        // Act
+        CacheManager.Remove(key);
+
+        // Assert
+        _mockRepository1.Verify(m => m.Remove(key), Times.Once);
+        _mockRepository2.Verify(m => m.Remove(key), Times.Once);
+    }
+}

Tests/CrispyWaffle.Tests/Cache/MemoryCacheRepositoryTests.cs

@@ -0,0 +1,64 @@
+using System;
+using CrispyWaffle.Cache;
+using FluentAssertions;
+using Xunit;
+
+namespace CrispyWaffle.Tests.Cache;
+
+public class MemoryCacheRepositoryTests
+{
+    private readonly MemoryCacheRepository _repository;
+
+    public MemoryCacheRepositoryTests()
+    {
+        _repository = new MemoryCacheRepository();
+    }
+
+    [Fact]
+    public void Set_ShouldStoreValue()
+    {
+        // Arrange
+        var key = "test-key";
+        var value = "test-value";
+
+        _repository.Set(value, key);
+
+        // Act
+        var actualValue = _repository.Get<string>(key);
+
+        // Assert
+        actualValue.Should().Be(value);
+    }
+
+    [Fact]
+    public void Get_ShouldReturnStoredValue()
+    {
+        // Arrange
+        var key = "test-key";
+        var expectedValue = "test-value";
+        _repository.Set(expectedValue, key);
+
+        // Act
+        var actualValue = _repository.Get<string>(key);
+
+        // Assert
+        actualValue.Should().Be(expectedValue);
+    }
+
+    [Fact]
+    public void Remove_ShouldRemoveStoredValue()
+    {
+        // Arrange
+        var key = "test-key";
+        _repository.Set("test-value", key);
+        _repository.Remove(key);
+
+        // Act
+        var exception = Assert.Throws<InvalidOperationException>(
+            () => _repository.Get<string>(key)
+        );
+
+        // Assert
+        exception.Should().NotBeNull();
+    }
+}

Tests/CrispyWaffle.Tests/Cache/RedisCacheRepositoryTests.cs

@@ -0,0 +1,84 @@
+using System.Text;
+using CrispyWaffle.Redis.Cache;
+using CrispyWaffle.Redis.Utils.Communications;
+using FluentAssertions;
+using NSubstitute;
+using StackExchange.Redis;
+using StackExchange.Redis.Extensions.Core;
+using StackExchange.Redis.Extensions.Core.Abstractions;
+using Xunit;
+
+namespace CrispyWaffle.Tests.Cache;
+
+public class RedisCacheRepositoryTests
+{
+    private readonly IDatabase _database;
+    private readonly RedisConnector _connector;
+    private readonly RedisCacheRepository _repository;
+
+    public RedisCacheRepositoryTests()
+    {
+        const string key = "test-key";
+        const string value = "test-value";
+
+        _database = Substitute.For<IDatabase>();
+        _database.StringGet(key, CommandFlags.PreferReplica).Returns(new RedisValue(value));
+        var connectionPoolManager = Substitute.For<IRedisConnectionPoolManager>();
+        connectionPoolManager.GetConnection().GetDatabase(0).Returns(_database);
+        var serializer = Substitute.For<ISerializer>();
+        serializer.Deserialize<string>(Arg.Any<byte[]>()).Returns(value);
+        serializer.Serialize(Arg.Is(value)).Returns(Encoding.UTF8.GetBytes(value));
+        var client = Substitute.For<IRedisClient>();
+        _connector = Substitute.For<RedisConnector>(
+            client,
+            connectionPoolManager,
+            serializer,
+            "prefix"
+        );
+        _repository = new RedisCacheRepository(_connector);
+    }
+
+    [Fact]
+    public void SetToDatabase_ShouldStoreValue()
+    {
+        // Arrange
+        var key = "test-key";
+        var value = "test-value";
+
+        // Act
+        _repository.SetToDatabase(value, key, 0);
+
+        // Assert
+        _connector.Received(1).GetDatabase(0);
+        _database
+            .Received(1)
+            .StringSet(key, Arg.Any<RedisValue>(), null, When.Always, CommandFlags.None);
+    }
+
+    [Fact]
+    public void GetFromDatabase_ShouldReturnStoredValue()
+    {
+        // Arrange
+        var key = "test-key";
+        var expectedValue = "test-value";
+
+        // Act
+        var actualValue = _repository.GetFromDatabase<string>(key, 0);
+
+        // Assert
+        actualValue.Should().Be(expectedValue);
+    }
+
+    [Fact]
+    public void RemoveFromDatabase_ShouldRemoveValue()
+    {
+        // Arrange
+        var key = "test-key";
+
+        // Act
+        _repository.RemoveFromDatabase(key, 0);
+
+        // Assert
+        _connector.Received(1).GetDatabase(0).KeyDelete(key, CommandFlags.FireAndForget);
+    }
+}

Tests/CrispyWaffle.Tests/CrispyWaffle.Tests.csproj

@@ -12,14 +12,17 @@
     <PackageReference Include="FluentAssertions" />
     <PackageReference Include="JunitXml.TestLogger" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
+    <PackageReference Include="NSubstitute" />
     <PackageReference Include="System.Text.Encoding.CodePages" />
+    <PackageReference Include="Moq" />
     <PackageReference Include="xunit" />
     <PackageReference Include="xunit.runner.visualstudio" />
   </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\..\Src\CrispyWaffle.Configuration\CrispyWaffle.Configuration.csproj" />
     <ProjectReference Include="..\..\Src\CrispyWaffle.ElasticSearch\CrispyWaffle.ElasticSearch.csproj" />
+    <ProjectReference Include="..\..\Src\CrispyWaffle.Redis\CrispyWaffle.Redis.csproj" />
     <ProjectReference Include="..\..\Src\CrispyWaffle\CrispyWaffle.csproj" />
   </ItemGroup>