mirror of https://github.com/grpc/grpc.git
Merge pull request #6416 from jtattermusch/csharp_api_polishing
Add C# wrapping tests and fix some issues with the API.pull/6453/head
commit
05146ace34
13 changed files with 825 additions and 188 deletions
@ -0,0 +1,203 @@ |
||||
#region Copyright notice and license |
||||
|
||||
// Copyright 2015, Google Inc. |
||||
// All rights reserved. |
||||
// |
||||
// Redistribution and use in source and binary forms, with or without |
||||
// modification, are permitted provided that the following conditions are |
||||
// met: |
||||
// |
||||
// * Redistributions of source code must retain the above copyright |
||||
// notice, this list of conditions and the following disclaimer. |
||||
// * Redistributions in binary form must reproduce the above |
||||
// copyright notice, this list of conditions and the following disclaimer |
||||
// in the documentation and/or other materials provided with the |
||||
// distribution. |
||||
// * Neither the name of Google Inc. nor the names of its |
||||
// contributors may be used to endorse or promote products derived from |
||||
// this software without specific prior written permission. |
||||
// |
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
#endregion |
||||
|
||||
using System; |
||||
using System.Collections.Generic; |
||||
using System.Runtime.InteropServices; |
||||
using System.Threading.Tasks; |
||||
|
||||
using Grpc.Core.Internal; |
||||
using NUnit.Framework; |
||||
|
||||
namespace Grpc.Core.Internal.Tests |
||||
{ |
||||
/// <summary> |
||||
/// Uses fake native call to test interaction of <c>AsyncCallServer</c> wrapping code with C core in different situations. |
||||
/// </summary> |
||||
public class AsyncCallServerTest |
||||
{ |
||||
Server server; |
||||
FakeNativeCall fakeCall; |
||||
AsyncCallServer<string, string> asyncCallServer; |
||||
|
||||
[SetUp] |
||||
public void Init() |
||||
{ |
||||
var environment = GrpcEnvironment.AddRef(); |
||||
|
||||
// Create a fake server just so we have an instance to refer to. |
||||
// The server won't actually be used at all. |
||||
server = new Server() |
||||
{ |
||||
Ports = { { "localhost", 0, ServerCredentials.Insecure } } |
||||
}; |
||||
server.Start(); |
||||
|
||||
fakeCall = new FakeNativeCall(); |
||||
asyncCallServer = new AsyncCallServer<string, string>( |
||||
Marshallers.StringMarshaller.Serializer, Marshallers.StringMarshaller.Deserializer, |
||||
environment, |
||||
server); |
||||
asyncCallServer.InitializeForTesting(fakeCall); |
||||
} |
||||
|
||||
[TearDown] |
||||
public void Cleanup() |
||||
{ |
||||
server.ShutdownAsync().Wait(); |
||||
GrpcEnvironment.Release(); |
||||
} |
||||
|
||||
[Test] |
||||
public void CancelNotificationAfterStartDisposes() |
||||
{ |
||||
var finishedTask = asyncCallServer.ServerSideCallAsync(); |
||||
var requestStream = new ServerRequestStream<string, string>(asyncCallServer); |
||||
|
||||
// Finishing requestStream is needed for dispose to happen. |
||||
var moveNextTask = requestStream.MoveNext(); |
||||
fakeCall.ReceivedMessageHandler(true, null); |
||||
Assert.IsFalse(moveNextTask.Result); |
||||
|
||||
fakeCall.ReceivedCloseOnServerHandler(true, cancelled: true); |
||||
AssertFinished(asyncCallServer, fakeCall, finishedTask); |
||||
} |
||||
|
||||
[Test] |
||||
public void ReadAfterCancelNotificationCanSucceed() |
||||
{ |
||||
var finishedTask = asyncCallServer.ServerSideCallAsync(); |
||||
var requestStream = new ServerRequestStream<string, string>(asyncCallServer); |
||||
|
||||
fakeCall.ReceivedCloseOnServerHandler(true, cancelled: true); |
||||
|
||||
// Check that startin a read after cancel notification has been processed is legal. |
||||
var moveNextTask = requestStream.MoveNext(); |
||||
fakeCall.ReceivedMessageHandler(true, null); |
||||
Assert.IsFalse(moveNextTask.Result); |
||||
|
||||
AssertFinished(asyncCallServer, fakeCall, finishedTask); |
||||
} |
||||
|
||||
[Test] |
||||
public void ReadCompletionFailureClosesRequestStream() |
||||
{ |
||||
var finishedTask = asyncCallServer.ServerSideCallAsync(); |
||||
var requestStream = new ServerRequestStream<string, string>(asyncCallServer); |
||||
|
||||
// if a read completion's success==false, the request stream will silently finish |
||||
// and we rely on C core cancelling the call. |
||||
var moveNextTask = requestStream.MoveNext(); |
||||
fakeCall.ReceivedMessageHandler(false, null); |
||||
Assert.IsFalse(moveNextTask.Result); |
||||
|
||||
fakeCall.ReceivedCloseOnServerHandler(true, cancelled: true); |
||||
AssertFinished(asyncCallServer, fakeCall, finishedTask); |
||||
} |
||||
|
||||
[Test] |
||||
public void WriteAfterCancelNotificationFails() |
||||
{ |
||||
var finishedTask = asyncCallServer.ServerSideCallAsync(); |
||||
var requestStream = new ServerRequestStream<string, string>(asyncCallServer); |
||||
var responseStream = new ServerResponseStream<string, string>(asyncCallServer); |
||||
|
||||
fakeCall.ReceivedCloseOnServerHandler(true, cancelled: true); |
||||
|
||||
// TODO(jtattermusch): should we throw a different exception type instead? |
||||
Assert.Throws(typeof(InvalidOperationException), () => responseStream.WriteAsync("request1")); |
||||
|
||||
// Finishing requestStream is needed for dispose to happen. |
||||
var moveNextTask = requestStream.MoveNext(); |
||||
fakeCall.ReceivedMessageHandler(true, null); |
||||
Assert.IsFalse(moveNextTask.Result); |
||||
|
||||
AssertFinished(asyncCallServer, fakeCall, finishedTask); |
||||
} |
||||
|
||||
[Test] |
||||
public void WriteCompletionFailureThrows() |
||||
{ |
||||
var finishedTask = asyncCallServer.ServerSideCallAsync(); |
||||
var requestStream = new ServerRequestStream<string, string>(asyncCallServer); |
||||
var responseStream = new ServerResponseStream<string, string>(asyncCallServer); |
||||
|
||||
var writeTask = responseStream.WriteAsync("request1"); |
||||
fakeCall.SendCompletionHandler(false); |
||||
// TODO(jtattermusch): should we throw a different exception type instead? |
||||
Assert.ThrowsAsync(typeof(InvalidOperationException), async () => await writeTask); |
||||
|
||||
// Finishing requestStream is needed for dispose to happen. |
||||
var moveNextTask = requestStream.MoveNext(); |
||||
fakeCall.ReceivedMessageHandler(true, null); |
||||
Assert.IsFalse(moveNextTask.Result); |
||||
|
||||
fakeCall.ReceivedCloseOnServerHandler(true, cancelled: true); |
||||
|
||||
AssertFinished(asyncCallServer, fakeCall, finishedTask); |
||||
} |
||||
|
||||
[Test] |
||||
public void WriteAndWriteStatusCanRunConcurrently() |
||||
{ |
||||
var finishedTask = asyncCallServer.ServerSideCallAsync(); |
||||
var requestStream = new ServerRequestStream<string, string>(asyncCallServer); |
||||
var responseStream = new ServerResponseStream<string, string>(asyncCallServer); |
||||
|
||||
var writeTask = responseStream.WriteAsync("request1"); |
||||
var writeStatusTask = asyncCallServer.SendStatusFromServerAsync(Status.DefaultSuccess, new Metadata()); |
||||
|
||||
fakeCall.SendCompletionHandler(true); |
||||
fakeCall.SendStatusFromServerHandler(true); |
||||
|
||||
Assert.DoesNotThrowAsync(async () => await writeTask); |
||||
Assert.DoesNotThrowAsync(async () => await writeStatusTask); |
||||
|
||||
// Finishing requestStream is needed for dispose to happen. |
||||
var moveNextTask = requestStream.MoveNext(); |
||||
fakeCall.ReceivedMessageHandler(true, null); |
||||
Assert.IsFalse(moveNextTask.Result); |
||||
|
||||
fakeCall.ReceivedCloseOnServerHandler(true, cancelled: true); |
||||
|
||||
AssertFinished(asyncCallServer, fakeCall, finishedTask); |
||||
} |
||||
|
||||
static void AssertFinished(AsyncCallServer<string, string> asyncCallServer, FakeNativeCall fakeCall, Task finishedTask) |
||||
{ |
||||
Assert.IsTrue(fakeCall.IsDisposed); |
||||
Assert.IsTrue(finishedTask.IsCompleted); |
||||
Assert.DoesNotThrow(() => finishedTask.Wait()); |
||||
} |
||||
} |
||||
} |
@ -0,0 +1,183 @@ |
||||
#region Copyright notice and license |
||||
|
||||
// Copyright 2015, Google Inc. |
||||
// All rights reserved. |
||||
// |
||||
// Redistribution and use in source and binary forms, with or without |
||||
// modification, are permitted provided that the following conditions are |
||||
// met: |
||||
// |
||||
// * Redistributions of source code must retain the above copyright |
||||
// notice, this list of conditions and the following disclaimer. |
||||
// * Redistributions in binary form must reproduce the above |
||||
// copyright notice, this list of conditions and the following disclaimer |
||||
// in the documentation and/or other materials provided with the |
||||
// distribution. |
||||
// * Neither the name of Google Inc. nor the names of its |
||||
// contributors may be used to endorse or promote products derived from |
||||
// this software without specific prior written permission. |
||||
// |
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
#endregion |
||||
|
||||
using System; |
||||
using System.Collections.Generic; |
||||
using System.Runtime.InteropServices; |
||||
using System.Threading.Tasks; |
||||
|
||||
using Grpc.Core.Internal; |
||||
using NUnit.Framework; |
||||
|
||||
namespace Grpc.Core.Internal.Tests |
||||
{ |
||||
/// <summary> |
||||
/// For testing purposes. |
||||
/// </summary> |
||||
internal class FakeNativeCall : INativeCall |
||||
{ |
||||
public UnaryResponseClientHandler UnaryResponseClientHandler |
||||
{ |
||||
get; |
||||
set; |
||||
} |
||||
|
||||
public ReceivedStatusOnClientHandler ReceivedStatusOnClientHandler |
||||
{ |
||||
get; |
||||
set; |
||||
} |
||||
|
||||
public ReceivedMessageHandler ReceivedMessageHandler |
||||
{ |
||||
get; |
||||
set; |
||||
} |
||||
|
||||
public ReceivedResponseHeadersHandler ReceivedResponseHeadersHandler |
||||
{ |
||||
get; |
||||
set; |
||||
} |
||||
|
||||
public SendCompletionHandler SendCompletionHandler |
||||
{ |
||||
get; |
||||
set; |
||||
} |
||||
|
||||
public SendCompletionHandler SendStatusFromServerHandler |
||||
{ |
||||
get; |
||||
set; |
||||
} |
||||
|
||||
public ReceivedCloseOnServerHandler ReceivedCloseOnServerHandler |
||||
{ |
||||
get; |
||||
set; |
||||
} |
||||
|
||||
public bool IsCancelled |
||||
{ |
||||
get; |
||||
set; |
||||
} |
||||
|
||||
public bool IsDisposed |
||||
{ |
||||
get; |
||||
set; |
||||
} |
||||
|
||||
public void Cancel() |
||||
{ |
||||
IsCancelled = true; |
||||
} |
||||
|
||||
public void CancelWithStatus(Status status) |
||||
{ |
||||
IsCancelled = true; |
||||
} |
||||
|
||||
public string GetPeer() |
||||
{ |
||||
return "PEER"; |
||||
} |
||||
|
||||
public void StartUnary(UnaryResponseClientHandler callback, byte[] payload, MetadataArraySafeHandle metadataArray, WriteFlags writeFlags) |
||||
{ |
||||
UnaryResponseClientHandler = callback; |
||||
} |
||||
|
||||
public void StartUnary(BatchContextSafeHandle ctx, byte[] payload, MetadataArraySafeHandle metadataArray, WriteFlags writeFlags) |
||||
{ |
||||
throw new NotImplementedException(); |
||||
} |
||||
|
||||
public void StartClientStreaming(UnaryResponseClientHandler callback, MetadataArraySafeHandle metadataArray) |
||||
{ |
||||
UnaryResponseClientHandler = callback; |
||||
} |
||||
|
||||
public void StartServerStreaming(ReceivedStatusOnClientHandler callback, byte[] payload, MetadataArraySafeHandle metadataArray, WriteFlags writeFlags) |
||||
{ |
||||
ReceivedStatusOnClientHandler = callback; |
||||
} |
||||
|
||||
public void StartDuplexStreaming(ReceivedStatusOnClientHandler callback, MetadataArraySafeHandle metadataArray) |
||||
{ |
||||
ReceivedStatusOnClientHandler = callback; |
||||
} |
||||
|
||||
public void StartReceiveMessage(ReceivedMessageHandler callback) |
||||
{ |
||||
ReceivedMessageHandler = callback; |
||||
} |
||||
|
||||
public void StartReceiveInitialMetadata(ReceivedResponseHeadersHandler callback) |
||||
{ |
||||
ReceivedResponseHeadersHandler = callback; |
||||
} |
||||
|
||||
public void StartSendInitialMetadata(SendCompletionHandler callback, MetadataArraySafeHandle metadataArray) |
||||
{ |
||||
SendCompletionHandler = callback; |
||||
} |
||||
|
||||
public void StartSendMessage(SendCompletionHandler callback, byte[] payload, WriteFlags writeFlags, bool sendEmptyInitialMetadata) |
||||
{ |
||||
SendCompletionHandler = callback; |
||||
} |
||||
|
||||
public void StartSendCloseFromClient(SendCompletionHandler callback) |
||||
{ |
||||
SendCompletionHandler = callback; |
||||
} |
||||
|
||||
public void StartSendStatusFromServer(SendCompletionHandler callback, Status status, MetadataArraySafeHandle metadataArray, bool sendEmptyInitialMetadata) |
||||
{ |
||||
SendStatusFromServerHandler = callback; |
||||
} |
||||
|
||||
public void StartServerSide(ReceivedCloseOnServerHandler callback) |
||||
{ |
||||
ReceivedCloseOnServerHandler = callback; |
||||
} |
||||
|
||||
public void Dispose() |
||||
{ |
||||
IsDisposed = true; |
||||
} |
||||
} |
||||
} |
Loading…
Reference in new issue