tests(Spanner): Fix flakes in PooledSessionTests.

There are two things being fixed here:

1. Using Args.Any when calling a method on a mock is wrong and corrupts the NSubstitute mock's state. Using null also seems to make NSubstitute unable to find the matching overloaded on occasion.
2. When using ForPartsOf to create a mock, the base methods are called when they are not abstract, including during setup. SpannerClient implements all virtual methods, but by throwing UnimplementedException.

It seems like even though we create different mocks for each test, there's some common setup that substitute shares and when 1. happens, it corrupts other subsequent calls, because the unmatched parameters remain in some sort of queue. This is confirmed to some extent by NSubstitute error messages which include "Note this error may have originated in a previous test."

squash

Author: amanda-tarafa

apis/Google.Cloud.Spanner.Data/Google.Cloud.Spanner.Data.Tests/V1/PooledSessionTests.cs

@@ -35,6 +35,7 @@ public class PooledSessionTests
         private static readonly TransactionOptions s_noneOptions = new TransactionOptions { };
         private static readonly ByteString s_transactionId = ByteString.CopyFromUtf8("transaction");
         private static readonly TimeSpan s_releaseWaitTime = TimeSpan.FromSeconds(1);
+        private static readonly CallSettings s_callSettings = CallSettings.FromCancellationToken(default);
 
         public static TheoryData<TransactionOptions> NoTransactionOptionsData => new TheoryData<TransactionOptions>
         {
@@ -55,7 +56,7 @@ public async Task NoTransactionOptions(TransactionOptions options)
                 .ExecuteSqlAsync(Arg.Any<ExecuteSqlRequest>(), Arg.Any<CallSettings>())
                 .Returns(Task.FromResult(new ResultSet()));
 
-            await pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), default);
+            await pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), s_callSettings);
 
             await client.Received(1).ExecuteSqlAsync(
                 Arg.Do<ExecuteSqlRequest>(request =>
@@ -78,7 +79,7 @@ public async Task SingleUseTransactionOptions()
                 .ExecuteSqlAsync(Arg.Any<ExecuteSqlRequest>(), Arg.Any<CallSettings>())
                 .Returns(Task.FromResult(new ResultSet()));
 
-            await pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), default);
+            await pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), s_callSettings);
 
             await client.Received(1).ExecuteSqlAsync(
                 Arg.Do<ExecuteSqlRequest>(request =>
@@ -100,7 +101,7 @@ public async Task ExplicitTransaction()
                 .ExecuteSqlAsync(Arg.Any<ExecuteSqlRequest>(), Arg.Any<CallSettings>())
                 .Returns(Task.FromResult(new ResultSet()));
 
-            await pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), default);
+            await pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), s_callSettings);
 
             await client.Received(1).ExecuteSqlAsync(
                 Arg.Do<ExecuteSqlRequest>(request =>
@@ -129,7 +130,7 @@ public async Task InlinedTransaction()
                     }
                 }));
 
-            await pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), default);
+            await pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), s_callSettings);
 
             Assert.Equal(s_transactionId, pooledSession.TransactionId);
 
@@ -140,6 +141,7 @@ await client.Received(1).ExecuteSqlAsync(
                     Assert.Equal(s_readWriteOptions, request.Transaction.Begin);
                 }),
                 Arg.Any<CallSettings>());
+            await client.DidNotReceive().BeginTransactionAsync(Arg.Any<BeginTransactionRequest>(), Arg.Any<CallSettings>());
         }
 
         [Fact]
@@ -157,7 +159,7 @@ public async Task ReleaseToPool_FurtherRpcsInvalid()
 
             // We now can't make RPCs
             await Assert.ThrowsAsync<ObjectDisposedException>(
-                () => pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), default));
+                () => pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), s_callSettings));
 
             await client.DidNotReceive().ExecuteSqlAsync(Arg.Any<ExecuteSqlRequest>(), Arg.Any<CallSettings>());
             await client.DidNotReceive().RollbackAsync(Arg.Any<RollbackRequest>(), Arg.Any<CallSettings>());
@@ -200,7 +202,7 @@ public async Task ReleaseToPool_CommittedTransactionNotRolledBack()
                 .CommitAsync(Arg.Any<CommitRequest>(), Arg.Any<CallSettings>())
                 .Returns(Task.FromResult(new CommitResponse()));
 
-            await pooledSession.CommitAsync(new CommitRequest(), null);
+            await pooledSession.CommitAsync(new CommitRequest(), s_callSettings);
             await client.Received(1).CommitAsync(
                 Arg.Do<CommitRequest>(request =>
                     Assert.Equal(s_transactionId, request.TransactionId)),
@@ -224,7 +226,7 @@ public async Task ReleaseToPool_RolledBackTransactionNotRolledBack()
                 .RollbackAsync(Arg.Any<RollbackRequest>(), Arg.Any<CallSettings>())
                 .Returns(Task.FromResult(new CommitResponse()));
 
-            await pooledSession.RollbackAsync(new RollbackRequest(), null);
+            await pooledSession.RollbackAsync(new RollbackRequest(), s_callSettings);
             await client.Received(1).RollbackAsync(
                 Arg.Do<RollbackRequest>(request =>
                     Assert.Equal(s_transactionId, request.TransactionId)),
@@ -260,7 +262,7 @@ public async Task ReleaseToPool_ReadWriteUncommittedTransactionRolledBack()
                 .RollbackAsync(Arg.Any<RollbackRequest>(), Arg.Any<CallSettings>())
                 .Returns(Task.FromResult(new CommitResponse()));
 
-            await pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), Arg.Any<CallSettings>());
+            await pooledSession.ExecuteSqlAsync(new ExecuteSqlRequest(), s_callSettings);
             await client.Received(1).ExecuteSqlAsync(
                 Arg.Do<ExecuteSqlRequest>(request =>
                 {

apis/Google.Cloud.Spanner.Data/Google.Cloud.Spanner.Data.Tests/V1/SpannerClientHelpers.cs

@@ -58,7 +58,7 @@ internal static SpannerClient CreateMockClient(Logger logger)
             settings.Scheduler = fakeScheduler;
             settings.Clock = fakeScheduler.Clock;
             settings.Logger = logger;
-            var mock = Substitute.ForPartsOf<SpannerClient>();
+            var mock = Substitute.For<SpannerClient>();
             mock.Settings.Returns(settings);
             return mock;
         }