-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request grpc#15687 from jtattermusch/csharp_mock_example
Add C# tests that demonstrate how to unit test grpc code with test doubles.
- Loading branch information
Showing
7 changed files
with
154 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
101 changes: 101 additions & 0 deletions
101
src/csharp/Grpc.Examples.Tests/MathClientMockableTest.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| #region Copyright notice and license | ||
|
|
||
| // Copyright 2018 The gRPC Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| #endregion | ||
|
|
||
| using System; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Grpc.Core; | ||
| using Grpc.Core.Testing; | ||
| using NUnit.Framework; | ||
|
|
||
| namespace Math.Tests | ||
| { | ||
| /// <summary> | ||
| /// Demonstrates how to mock method stubs for all method types in a generated client. | ||
| /// </summary> | ||
| public class MathClientMockableTest | ||
| { | ||
| [Test] | ||
| public void ClientBaseBlockingUnaryCallCanBeMocked() | ||
| { | ||
| var mockClient = new Moq.Mock<Math.MathClient>(); | ||
|
|
||
| var expected = new DivReply(); | ||
| mockClient.Setup(m => m.Div(Moq.It.IsAny<DivArgs>(), null, null, CancellationToken.None)).Returns(expected); | ||
| Assert.AreSame(expected, mockClient.Object.Div(new DivArgs())); | ||
| } | ||
|
|
||
| [Test] | ||
| public void ClientBaseBlockingUnaryCallWithCallOptionsCallCanBeMocked() | ||
| { | ||
| var mockClient = new Moq.Mock<Math.MathClient>(); | ||
|
|
||
| var expected = new DivReply(); | ||
| mockClient.Setup(m => m.Div(Moq.It.IsAny<DivArgs>(), Moq.It.IsAny<CallOptions>())).Returns(expected); | ||
| Assert.AreSame(expected, mockClient.Object.Div(new DivArgs(), new CallOptions())); | ||
| } | ||
|
|
||
| [Test] | ||
| public void ClientBaseAsyncUnaryCallCanBeMocked() | ||
| { | ||
| var mockClient = new Moq.Mock<Math.MathClient>(); | ||
|
|
||
| // Use a factory method provided by Grpc.Core.Testing.TestCalls to create an instance of a call. | ||
| var fakeCall = TestCalls.AsyncUnaryCall<DivReply>(Task.FromResult(new DivReply()), Task.FromResult(new Metadata()), () => Status.DefaultSuccess, () => new Metadata(), () => { }); | ||
| mockClient.Setup(m => m.DivAsync(Moq.It.IsAny<DivArgs>(), null, null, CancellationToken.None)).Returns(fakeCall); | ||
| Assert.AreSame(fakeCall, mockClient.Object.DivAsync(new DivArgs())); | ||
| } | ||
|
|
||
| [Test] | ||
| public void ClientBaseClientStreamingCallCanBeMocked() | ||
| { | ||
| var mockClient = new Moq.Mock<Math.MathClient>(); | ||
| var mockRequestStream = new Moq.Mock<IClientStreamWriter<Num>>(); | ||
|
|
||
| // Use a factory method provided by Grpc.Core.Testing.TestCalls to create an instance of a call. | ||
| var fakeCall = TestCalls.AsyncClientStreamingCall<Num, Num>(mockRequestStream.Object, Task.FromResult(new Num()), Task.FromResult(new Metadata()), () => Status.DefaultSuccess, () => new Metadata(), () => { }); | ||
| mockClient.Setup(m => m.Sum(null, null, CancellationToken.None)).Returns(fakeCall); | ||
| Assert.AreSame(fakeCall, mockClient.Object.Sum()); | ||
| } | ||
|
|
||
| [Test] | ||
| public void ClientBaseServerStreamingCallCanBeMocked() | ||
| { | ||
| var mockClient = new Moq.Mock<Math.MathClient>(); | ||
| var mockResponseStream = new Moq.Mock<IAsyncStreamReader<Num>>(); | ||
|
|
||
| // Use a factory method provided by Grpc.Core.Testing.TestCalls to create an instance of a call. | ||
| var fakeCall = TestCalls.AsyncServerStreamingCall<Num>(mockResponseStream.Object, Task.FromResult(new Metadata()), () => Status.DefaultSuccess, () => new Metadata(), () => { }); | ||
| mockClient.Setup(m => m.Fib(Moq.It.IsAny<FibArgs>(), null, null, CancellationToken.None)).Returns(fakeCall); | ||
| Assert.AreSame(fakeCall, mockClient.Object.Fib(new FibArgs())); | ||
| } | ||
|
|
||
| [Test] | ||
| public void ClientBaseDuplexStreamingCallCanBeMocked() | ||
| { | ||
| var mockClient = new Moq.Mock<Math.MathClient>(); | ||
| var mockRequestStream = new Moq.Mock<IClientStreamWriter<DivArgs>>(); | ||
| var mockResponseStream = new Moq.Mock<IAsyncStreamReader<DivReply>>(); | ||
|
|
||
| // Use a factory method provided by Grpc.Core.Testing.TestCalls to create an instance of a call. | ||
| var fakeCall = TestCalls.AsyncDuplexStreamingCall<DivArgs, DivReply>(mockRequestStream.Object, mockResponseStream.Object, Task.FromResult(new Metadata()), () => Status.DefaultSuccess, () => new Metadata(), () => { }); | ||
| mockClient.Setup(m => m.DivMany(null, null, CancellationToken.None)).Returns(fakeCall); | ||
| Assert.AreSame(fakeCall, mockClient.Object.DivMany()); | ||
| } | ||
| } | ||
| } |
47 changes: 47 additions & 0 deletions
47
src/csharp/Grpc.Examples.Tests/MathServiceImplTestabilityTest.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| #region Copyright notice and license | ||
|
|
||
| // Copyright 2018 The gRPC Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| #endregion | ||
|
|
||
| using System; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Grpc.Core; | ||
| using Grpc.Core.Testing; | ||
| using Grpc.Core.Utils; | ||
| using NUnit.Framework; | ||
|
|
||
| namespace Math.Tests | ||
| { | ||
| /// <summary> | ||
| /// Demonstrates how to unit test implementations of generated server stubs. | ||
| /// </summary> | ||
| public class MathServiceImplTestabilityTest | ||
| { | ||
| [Test] | ||
| public async Task ServerCallImplIsTestable() | ||
| { | ||
| var mathImpl = new MathServiceImpl(); | ||
|
|
||
| // Use a factory method provided by Grpc.Core.Testing.TestServerCallContext to create an instance of server call context. | ||
| // This allows testing even those server-side implementations that rely on the contents of ServerCallContext. | ||
| var fakeServerCallContext = TestServerCallContext.Create("fooMethod", null, DateTime.UtcNow.AddHours(1), new Metadata(), CancellationToken.None, "127.0.0.1", null, null, (metadata) => TaskUtils.CompletedTask, () => new WriteOptions(), (writeOptions) => { }); | ||
| var response = await mathImpl.Div(new DivArgs { Dividend = 10, Divisor = 2 }, fakeServerCallContext); | ||
| Assert.AreEqual(5, response.Quotient); | ||
| Assert.AreEqual(0, response.Remainder); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters