Replace Moq with NSubstitute - Idempotency

Author: amirkaws

libraries/tests/AWS.Lambda.Powertools.Idempotency.Tests/AWS.Lambda.Powertools.Idempotency.Tests.csproj

@@ -9,18 +9,18 @@
 
     <ItemGroup>
         <PackageReference Include="Amazon.Lambda.APIGatewayEvents" Version="2.6.0" />
-        <PackageReference Include="FluentAssertions" Version="6.7.0" />
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
+        <PackageReference Include="FluentAssertions" Version="6.11.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.0" />
         <PackageReference Include="Amazon.Lambda.Core" Version="2.1.0" />
         <PackageReference Include="Amazon.Lambda.TestUtilities" Version="2.0.0" />
-        <PackageReference Include="Moq" Version="4.18.4" />
+        <PackageReference Include="NSubstitute" Version="5.0.0" />
         <PackageReference Include="Testcontainers" Version="3.3.0" />
-        <PackageReference Include="xunit" Version="2.4.2" />
-        <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
+        <PackageReference Include="xunit" Version="2.5.0" />
+        <PackageReference Include="xunit.runner.visualstudio" Version="2.5.0">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>
-        <PackageReference Include="coverlet.collector" Version="3.2.0">
+        <PackageReference Include="coverlet.collector" Version="6.0.0">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>

libraries/tests/AWS.Lambda.Powertools.Idempotency.Tests/Internal/IdempotentAspectTests.cs

@@ -14,6 +14,7 @@
  */
 
 using System;
+using System.Linq;
 using System.Text.Json;
 using System.Threading.Tasks;
 using Amazon.Lambda.TestUtilities;
@@ -23,7 +24,8 @@
 using AWS.Lambda.Powertools.Idempotency.Tests.Handlers;
 using AWS.Lambda.Powertools.Idempotency.Tests.Model;
 using FluentAssertions;
-using Moq;
+using NSubstitute;
+using NSubstitute.ExceptionExtensions;
 using Xunit;
 
 [assembly: CollectionBehavior(DisableTestParallelization = true)]
@@ -39,10 +41,10 @@ public class IdempotentAspectTests : IDisposable
     public async Task Handle_WhenFirstCall_ShouldPutInStore(Type type)
     {
         //Arrange
-        var store = new Mock<BasePersistenceStore>();
+        var store = Substitute.For<BasePersistenceStore>();
         Idempotency.Configure(builder =>
             builder
-                .WithPersistenceStore(store.Object)
+                .WithPersistenceStore(store)
                 .WithOptions(optionsBuilder => optionsBuilder.WithEventKeyJmesPath("Id"))
             );
 
@@ -55,12 +57,18 @@ public async Task Handle_WhenFirstCall_ShouldPutInStore(Type type)
         //Assert
         basket.Products.Count.Should().Be(1);
         function.HandlerExecuted.Should().BeTrue();
+        
+        await store.Received().SaveInProgress(
+            Arg.Is<JsonDocument>(t =>
+                t.ToString() == JsonSerializer.SerializeToDocument(product, new JsonSerializerOptions()).ToString()),
+            Arg.Any<DateTimeOffset>()
+        );
 
-        store
-            .Verify(x=>x.SaveInProgress(It.Is<JsonDocument>(t=> t.ToString() == JsonSerializer.SerializeToDocument(product, It.IsAny<JsonSerializerOptions>()).ToString()), It.IsAny<DateTimeOffset>()));
-
-        store
-            .Verify(x=>x.SaveSuccess(It.IsAny<JsonDocument>(), It.Is<Basket>(y => y.Equals(basket)), It.IsAny<DateTimeOffset>()));
+        await store.Received().SaveSuccess(
+            Arg.Any<JsonDocument>(),
+            Arg.Is<Basket>(y => y.Equals(basket)),
+            Arg.Any<DateTimeOffset>()
+        );
     }
 
     [Theory]
@@ -69,14 +77,14 @@ public async Task Handle_WhenFirstCall_ShouldPutInStore(Type type)
     public async Task Handle_WhenSecondCall_AndNotExpired_ShouldGetFromStore(Type type)
     {
         //Arrange
-        var store = new Mock<BasePersistenceStore>();
-        store.Setup(x=>x.SaveInProgress(It.IsAny<JsonDocument>(), It.IsAny<DateTimeOffset>()))
-            .Throws<IdempotencyItemAlreadyExistsException>();
+        var store = Substitute.For<BasePersistenceStore>();
+        store.SaveInProgress(Arg.Any<JsonDocument>(), Arg.Any<DateTimeOffset>())
+            .Returns(_ => throw new IdempotencyItemAlreadyExistsException());
 
         // GIVEN
         Idempotency.Configure(builder =>
             builder
-                .WithPersistenceStore(store.Object)
+                .WithPersistenceStore(store)
                 .WithOptions(optionsBuilder => optionsBuilder.WithEventKeyJmesPath("Id"))
             );
 
@@ -88,9 +96,8 @@ public async Task Handle_WhenSecondCall_AndNotExpired_ShouldGetFromStore(Type ty
             DateTimeOffset.UtcNow.AddSeconds(356).ToUnixTimeSeconds(),
             JsonSerializer.SerializeToNode(basket)!.ToString(),
             null);
-        store.Setup(x=>x.GetRecord(It.IsAny<JsonDocument>(), It.IsAny<DateTimeOffset>()))
-            .ReturnsAsync(record);
-    
+        store.GetRecord(Arg.Any<JsonDocument>(), Arg.Any<DateTimeOffset>()).Returns(record);
+
         var function = Activator.CreateInstance(type) as IIdempotencyEnabledFunction;
 
         // Act
@@ -107,15 +114,16 @@ public async Task Handle_WhenSecondCall_AndNotExpired_ShouldGetFromStore(Type ty
     public async Task Handle_WhenSecondCall_AndStatusInProgress_ShouldThrowIdempotencyAlreadyInProgressException(Type type)
     {
         // Arrange
-        var store = new Mock<BasePersistenceStore>();
-        
+        var store = Substitute.For<BasePersistenceStore>();
+
         Idempotency.Configure(builder =>
             builder
-                .WithPersistenceStore(store.Object)
+                .WithPersistenceStore(store)
                 .WithOptions(optionsBuilder => optionsBuilder.WithEventKeyJmesPath("Id"))
             );
-        store.Setup(x=>x.SaveInProgress(It.IsAny<JsonDocument>(), It.IsAny<DateTimeOffset>()))
-            .Throws<IdempotencyItemAlreadyExistsException>();
+        
+        store.SaveInProgress(Arg.Any<JsonDocument>(), Arg.Any<DateTimeOffset>())
+            .Returns(_ => throw new IdempotencyItemAlreadyExistsException());
 
         var product = new Product(42, "fake product", 12);
         var basket = new Basket(product);
@@ -125,9 +133,9 @@ public async Task Handle_WhenSecondCall_AndStatusInProgress_ShouldThrowIdempoten
             DateTimeOffset.UtcNow.AddSeconds(356).ToUnixTimeSeconds(),
             JsonSerializer.SerializeToNode(basket)!.ToString(),
             null);
-        store.Setup(x=>x.GetRecord(It.IsAny<JsonDocument>(), It.IsAny<DateTimeOffset>()))
-            .ReturnsAsync(record);
-    
+        store.GetRecord(Arg.Any<JsonDocument>(), Arg.Any<DateTimeOffset>())
+            .Returns(record);
+
         // Act
         var function = Activator.CreateInstance(type) as IIdempotencyEnabledFunction;
         Func<Task> act = async () => await function!.HandleTest(product, new TestLambdaContext());
@@ -142,11 +150,11 @@ public async Task Handle_WhenSecondCall_AndStatusInProgress_ShouldThrowIdempoten
     public async Task Handle_WhenThrowException_ShouldDeleteRecord_AndThrowFunctionException(Type type) 
     {
         // Arrange
-        var store = new Mock<BasePersistenceStore>();
+        var store = Substitute.For<BasePersistenceStore>();
 
         Idempotency.Configure(builder =>
             builder
-                .WithPersistenceStore(store.Object)
+                .WithPersistenceStore(store)
                 .WithOptions(optionsBuilder => optionsBuilder.WithEventKeyJmesPath("Id"))
             );
 
@@ -158,24 +166,22 @@ public async Task Handle_WhenThrowException_ShouldDeleteRecord_AndThrowFunctionE
 
         // Assert
         await act.Should().ThrowAsync<IndexOutOfRangeException>();
-        store.Verify(
-            x => x.DeleteRecord(It.IsAny<JsonDocument>(), It.IsAny<IndexOutOfRangeException>()));
+        await store.Received().DeleteRecord(Arg.Any<JsonDocument>(), Arg.Any<IndexOutOfRangeException>());
     }
 
     [Theory]
     [InlineData(typeof(IdempotencyEnabledFunction))]
     [InlineData(typeof(IdempotencyEnabledSyncFunction))]
     public async Task Handle_WhenIdempotencyDisabled_ShouldJustRunTheFunction(Type type)
     {
-        
         // Arrange
-        var store = new Mock<BasePersistenceStore>();
+        var store = Substitute.For<BasePersistenceStore>();
 
         Environment.SetEnvironmentVariable(Constants.IdempotencyDisabledEnv, "true");
 
         Idempotency.Configure(builder =>
             builder
-                .WithPersistenceStore(store.Object)
+                .WithPersistenceStore(store)
                 .WithOptions(optionsBuilder => optionsBuilder.WithEventKeyJmesPath("Id"))
             );
 
@@ -186,7 +192,7 @@ public async Task Handle_WhenIdempotencyDisabled_ShouldJustRunTheFunction(Type t
         var basket = await function!.HandleTest(product, new TestLambdaContext());
 
         // Assert
-        store.Invocations.Count.Should().Be(0);
+        store.ReceivedCalls().Count().Should().Be(0);
         basket.Products.Count.Should().Be(1);
         function.HandlerExecuted.Should().BeTrue();
     }
@@ -198,72 +204,76 @@ public void Idempotency_Set_Execution_Environment_Context()
         var assemblyName = "AWS.Lambda.Powertools.Idempotency";
         var assemblyVersion = "1.0.0";
 
-        var env = new Mock<IPowertoolsEnvironment>();
-        env.Setup(x => x.GetAssemblyName(It.IsAny<Idempotency>())).Returns(assemblyName);
-        env.Setup(x => x.GetAssemblyVersion(It.IsAny<Idempotency>())).Returns(assemblyVersion);
+        var env = Substitute.For<IPowertoolsEnvironment>();
+        env.GetAssemblyName(Arg.Any<Idempotency>()).Returns(assemblyName);
+        env.GetAssemblyVersion(Arg.Any<Idempotency>()).Returns(assemblyVersion);
 
-        var conf = new PowertoolsConfigurations(new SystemWrapper(env.Object));
+        var conf = new PowertoolsConfigurations(new SystemWrapper(env));
 
         // Act
         var xRayRecorder = new Idempotency(conf);
 
         // Assert
-        env.Verify(v =>
-            v.SetEnvironmentVariable(
-                "AWS_EXECUTION_ENV", $"{Constants.FeatureContextIdentifier}/Idempotency/{assemblyVersion}"
-            ), Times.Once);
-            
-        env.Verify(v =>
-            v.GetEnvironmentVariable(
-                "AWS_EXECUTION_ENV"
-            ), Times.Once);
+        env.Received(1).SetEnvironmentVariable(
+            "AWS_EXECUTION_ENV",
+            $"{Constants.FeatureContextIdentifier}/Idempotency/{assemblyVersion}"
+        );
+
+        env.Received(1).GetEnvironmentVariable("AWS_EXECUTION_ENV");
 
         Assert.NotNull(xRayRecorder);
     }
-    
+
     [Fact]
-    public void Handle_WhenIdempotencyOnSubMethodAnnotated_AndFirstCall_ShouldPutInStore() 
+    public async Task Handle_WhenIdempotencyOnSubMethodAnnotated_AndFirstCall_ShouldPutInStore()
     {
         // Arrange
-        var store = new Mock<BasePersistenceStore>();
-        Idempotency.Configure(builder => builder.WithPersistenceStore(store.Object));
+        var store = Substitute.For<BasePersistenceStore>();
+        Idempotency.Configure(builder => builder.WithPersistenceStore(store));
 
         // Act
         IdempotencyInternalFunction function = new IdempotencyInternalFunction();
         Product product = new Product(42, "fake product", 12);
         Basket resultBasket = function.HandleRequest(product, new TestLambdaContext());
-    
+
         // Assert
         resultBasket.Products.Count.Should().Be(2);
         function.IsSubMethodCalled.Should().BeTrue();
-        
-        store
-            .Verify(x=>x.SaveInProgress(It.Is<JsonDocument>(t=> t.ToString() == JsonSerializer.SerializeToDocument("fake", It.IsAny<JsonSerializerOptions>()).ToString()), It.IsAny<DateTimeOffset>()));
 
-        store
-            .Verify(x=>x.SaveSuccess(It.IsAny<JsonDocument>(), It.Is<Basket>(y => y.Equals(resultBasket)), It.IsAny<DateTimeOffset>()));
+        await store
+            .Received(1)
+            .SaveInProgress(
+                Arg.Is<JsonDocument>(t =>
+                    t.ToString() == JsonSerializer.SerializeToDocument("fake", new JsonSerializerOptions())
+                        .ToString()),
+                Arg.Any<DateTimeOffset>());
+
+        await store
+            .Received(1)
+            .SaveSuccess(Arg.Any<JsonDocument>(), Arg.Is<Basket>(y => y.Equals(resultBasket)),
+                Arg.Any<DateTimeOffset>());
     }
 
     [Fact]
     public void Handle_WhenIdempotencyOnSubMethodAnnotated_AndSecondCall_AndNotExpired_ShouldGetFromStore()
     {
         // Arrange
-        var store = new Mock<BasePersistenceStore>();
-        store.Setup(x => x.SaveInProgress(It.IsAny<JsonDocument>(), It.IsAny<DateTimeOffset>()))
-            .Throws<IdempotencyItemAlreadyExistsException>();
+        var store = Substitute.For<BasePersistenceStore>();
+        store.SaveInProgress(Arg.Any<JsonDocument>(), Arg.Any<DateTimeOffset>())
+            .Throws(new IdempotencyItemAlreadyExistsException());
 
-        Idempotency.Configure(builder => builder.WithPersistenceStore(store.Object));
+        Idempotency.Configure(builder => builder.WithPersistenceStore(store));
 
-        Product product = new Product(42, "fake product", 12);
-        Basket basket = new Basket(product);
-        DataRecord record = new DataRecord(
+        var product = new Product(42, "fake product", 12);
+        var basket = new Basket(product);
+        var record = new DataRecord(
             "fake",
             DataRecord.DataRecordStatus.COMPLETED,
             DateTimeOffset.UtcNow.AddSeconds(356).ToUnixTimeSeconds(),
             JsonSerializer.SerializeToNode(basket)!.ToString(),
             null);
-        store.Setup(x => x.GetRecord(It.IsAny<JsonDocument>(), It.IsAny<DateTimeOffset>()))
-            .ReturnsAsync(record);
+        store.GetRecord(Arg.Any<JsonDocument>(), Arg.Any<DateTimeOffset>())
+            .Returns(record);
 
         // Act
         var function = new IdempotencyInternalFunction();
@@ -298,10 +308,10 @@ public void Handle_WhenIdempotencyOnSubMethodAnnotated_AndKeyJMESPath_ShouldPutI
     public void Handle_WhenIdempotencyOnSubMethodNotAnnotated_ShouldThrowException() 
     {
         // Arrange
-        var store = new Mock<BasePersistenceStore>();
+        var store = Substitute.For<BasePersistenceStore>();
         Idempotency.Configure(builder =>
             builder
-                .WithPersistenceStore(store.Object)
+                .WithPersistenceStore(store)
         );
 
         // Act
@@ -317,10 +327,10 @@ public void Handle_WhenIdempotencyOnSubMethodNotAnnotated_ShouldThrowException()
     public void Handle_WhenIdempotencyOnSubMethodVoid_ShouldThrowException() 
     {
         // Arrange
-        var store = new Mock<BasePersistenceStore>();
+        var store = Substitute.For<BasePersistenceStore>();
         Idempotency.Configure(builder =>
             builder
-                .WithPersistenceStore(store.Object)
+                .WithPersistenceStore(store)
         );
 
         // Act