-
Notifications
You must be signed in to change notification settings - Fork 351
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support asynchronous invocation of IODataStreamListener.StreamDispose…
…dAsync method from ODataNotificationWriter class (#2079) * Support asynchronous invocation of IODataStreamListener.StreamDisposedAsync method from ODataNotificationWriter class * Make ODataNotificationWriter Dispose and DisposeAsync methods idempotent Co-authored-by: John Gathogo <[email protected]>
- Loading branch information
Showing
3 changed files
with
218 additions
and
10 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
161 changes: 161 additions & 0 deletions
161
test/FunctionalTests/Microsoft.OData.Core.Tests/ODataNotificationWriterTests.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,161 @@ | ||
| //--------------------------------------------------------------------- | ||
| // <copyright file="ODataNotificationWriterTests.cs" company="Microsoft"> | ||
| // Copyright (C) Microsoft Corporation. All rights reserved. See License.txt in the project root for license information. | ||
| // </copyright> | ||
| //--------------------------------------------------------------------- | ||
|
|
||
| using System; | ||
| using System.IO; | ||
| using System.Threading.Tasks; | ||
| using Xunit; | ||
|
|
||
| namespace Microsoft.OData.Tests | ||
| { | ||
| public class ODataNotificationWriterTests | ||
| { | ||
| private MemoryStream stream; | ||
| private TextWriter writer; | ||
| private IODataStreamListener streamListener; | ||
|
|
||
| public ODataNotificationWriterTests() | ||
| { | ||
| this.stream = new MemoryStream(); | ||
| this.writer = new StreamWriter(this.stream); | ||
| this.streamListener = new MockODataStreamListener(this.writer); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData(true, "StreamDisposed")] | ||
| [InlineData(false, "StreamDisposedAsync")] | ||
| public void NotificationWriterDisposeShouldInvokeStreamDisposed(bool synchronous, string expected) | ||
| { | ||
| // We care about the notification writer being disposed | ||
| // We don't care about the writer passed to the notification writer | ||
| using (var notificationWriter = new ODataNotificationWriter( | ||
| new StreamWriter(new MemoryStream()), | ||
| this.streamListener, | ||
| synchronous)) | ||
| { | ||
| } | ||
|
|
||
| var result = ReadStreamContents(); | ||
|
|
||
| Assert.Equal(expected, result); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData(true, "StreamDisposed")] | ||
| [InlineData(false, "StreamDisposedAsync")] | ||
| public void NotificationWriterDisposeShouldBeIdempotent(bool synchronous, string expected) | ||
| { | ||
| var notificationWriter = new ODataNotificationWriter( | ||
| new StreamWriter(new MemoryStream()), | ||
| this.streamListener, | ||
| synchronous); | ||
|
|
||
| // 1st call to Dispose | ||
| notificationWriter.Dispose(); | ||
| // 2nd call to Dispose | ||
| notificationWriter.Dispose(); | ||
|
|
||
| var result = ReadStreamContents(); | ||
|
|
||
| // StreamDisposed/StreamDisposeAsync was written only once | ||
| Assert.Equal(expected, result); | ||
| } | ||
|
|
||
| #if NETCOREAPP3_1 | ||
| [Fact] | ||
| public async Task NotificationWriterDisposeShouldInvokeStreamDisposedAsync() | ||
| { | ||
| await using (var notificationWriter = new ODataNotificationWriter( | ||
| new StreamWriter(new MemoryStream()), | ||
| this.streamListener)) // `synchronous` argument becomes irrelevant since we'll directly call DisposeAsync | ||
| { | ||
| } | ||
|
|
||
| var result = await this.ReadStreamContentsAsync(); | ||
|
|
||
| Assert.Equal("StreamDisposedAsync", result); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task NotificationWriterDisposeAsyncShouldBeIdempotent() | ||
| { | ||
| var notificationWriter = new ODataNotificationWriter( | ||
| new StreamWriter(new MemoryStream()), | ||
| this.streamListener); | ||
|
|
||
| // 1st call to DisposeAsync | ||
| await notificationWriter.DisposeAsync(); | ||
| // 2nd call to DisposeAsync | ||
| await notificationWriter.DisposeAsync(); | ||
|
|
||
| var result = await this.ReadStreamContentsAsync(); | ||
|
|
||
| // StreamDisposeAsync was written only once | ||
| Assert.Equal("StreamDisposedAsync", result); | ||
| } | ||
|
|
||
| #else | ||
| [Fact] | ||
| public async Task NotificationWriterDisposeShouldInvokeStreamDisposedAsync() | ||
| { | ||
| using (var notificationWriter = new ODataNotificationWriter( | ||
| new StreamWriter(new MemoryStream()), | ||
| this.streamListener, | ||
| /*synchronous*/ false)) | ||
| { | ||
| } | ||
|
|
||
| var result = await this.ReadStreamContentsAsync(); | ||
|
|
||
| Assert.Equal("StreamDisposedAsync", result); | ||
| } | ||
| #endif | ||
|
|
||
| private string ReadStreamContents() | ||
| { | ||
| this.stream.Position = 0; | ||
| return new StreamReader(this.stream).ReadToEnd(); | ||
| } | ||
|
|
||
| private Task<string> ReadStreamContentsAsync() | ||
| { | ||
| this.stream.Position = 0; | ||
| return new StreamReader(this.stream).ReadToEndAsync(); | ||
| } | ||
|
|
||
| private class MockODataStreamListener : IODataStreamListener | ||
| { | ||
| private TextWriter writer; | ||
|
|
||
| public MockODataStreamListener(TextWriter writer) | ||
| { | ||
| this.writer = writer; | ||
| } | ||
|
|
||
| public void StreamDisposed() | ||
| { | ||
| writer.Write("StreamDisposed"); | ||
| writer.Flush(); | ||
| } | ||
|
|
||
| public async Task StreamDisposedAsync() | ||
| { | ||
| await writer.WriteAsync("StreamDisposedAsync").ConfigureAwait(false); | ||
| await writer.FlushAsync().ConfigureAwait(false); | ||
| } | ||
|
|
||
| public void StreamRequested() | ||
| { | ||
| throw new NotImplementedException(); | ||
| } | ||
|
|
||
| public Task StreamRequestedAsync() | ||
| { | ||
| throw new NotImplementedException(); | ||
| } | ||
| } | ||
| } | ||
| } |