-
Notifications
You must be signed in to change notification settings - Fork 367
/
CancelCommandTests.cs
266 lines (216 loc) · 7.97 KB
/
CancelCommandTests.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
// Copyright (c) .NET Foundation and contributors. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using System;
using System.Threading.Tasks;
using FluentAssertions;
using FluentAssertions.Extensions;
using Microsoft.DotNet.Interactive.Commands;
using Microsoft.DotNet.Interactive.Events;
using Microsoft.DotNet.Interactive.Tests.Utility;
using Microsoft.DotNet.Interactive.Utility;
using Xunit;
using Xunit.Abstractions;
namespace Microsoft.DotNet.Interactive.Tests;
#pragma warning disable xUnit1000
public class CancelCommandTests : LanguageKernelTestBase
{
public CancelCommandTests(ITestOutputHelper output) : base(output)
{
}
[Fact]
public async Task cancel_issues_CommandSucceeded()
{
using var kernel = CreateKernel()
.LogCommandsToPocketLogger()
.LogEventsToPocketLogger();
var cancelCommand = new Cancel();
var commandToCancel = new SubmitCode(@"
using Microsoft.DotNet.Interactive;
while(!KernelInvocationContext.Current.CancellationToken.IsCancellationRequested){ await Task.Delay(10); }", targetKernelName: "csharp");
var _ = kernel.SendAsync(commandToCancel);
await kernel.SendAsync(cancelCommand);
KernelEvents
.Should()
.ContainSingle<CommandSucceeded>(c => c.Command == cancelCommand);
}
[Fact]
public async Task new_commands_issued_after_cancel_are_executed()
{
// todo: this test is flaky and timeouts in CI
while (true)
{
using var kernel = CreateKernel()
.LogCommandsToPocketLogger()
.LogEventsToPocketLogger();
// make sure the deferred commands are flushed
await kernel.SubmitCodeAsync(" ");
var commandToCancel = new SubmitCode(@"
using Microsoft.DotNet.Interactive;
await Task.Delay(10);
while(!KernelInvocationContext.Current.CancellationToken.IsCancellationRequested){ await Task.Delay(10); }",
targetKernelName: "csharp");
var followingCommand = new SubmitCode("1");
try
{
var _ = kernel.SendAsync(commandToCancel);
await kernel.SendAsync(new Cancel()).Timeout(10.Seconds());
var result = await kernel.SendAsync(followingCommand).Timeout(10.Seconds());
result.Events
.Should()
.ContainSingle<CommandSucceeded>();
break;
}
catch (TimeoutException)
{
}
}
}
[Fact]
public async Task cancel_succeeds_when_there_is_command_in_progress_to_cancel()
{
using var kernel = CreateKernel();
var cancelCommand = new Cancel();
var results = await kernel.SendAsync(cancelCommand);
results.Events
.Should()
.ContainSingle<CommandSucceeded>(c => c.Command == cancelCommand);
}
[FactSkipWindows]
public async Task when_cancelling_command_it_reports_what_command_was_cancelled()
{
// todo: this test is flaky and timeouts in CI
while (true)
{
using var kernel = CreateKernel();
var cancelCommand = new Cancel();
var commandToCancel = new SubmitCode(@"
using Microsoft.DotNet.Interactive;
var cancellationToken = KernelInvocationContext.Current.CancellationToken;
while(!cancellationToken.IsCancellationRequested){
await Task.Delay(10);
}", targetKernelName: "csharp");
var resultForCommandToCancel = kernel.SendAsync(commandToCancel);
var result = await kernel.SendAsync(cancelCommand);
try
{
await resultForCommandToCancel.Timeout(10.Seconds());
result.Events.Should()
.ContainSingle<CommandCancelled>()
.Which
.CancelledCommand
.Should()
.Be(commandToCancel);
break;
}
catch (TimeoutException)
{
}
}
}
[Fact]
public async Task can_cancel_user_loop_using_CancellationToken()
{
// todo: this test is flaky and timeouts in CI
while (true)
{
using var kernel = CreateKernel();
var cancelCommand = new Cancel();
var commandToCancel = new SubmitCode(@"
using Microsoft.DotNet.Interactive;
var cancellationToken = KernelInvocationContext.Current.CancellationToken;
while(!cancellationToken.IsCancellationRequested){
await Task.Delay(10);
}", targetKernelName: "csharp");
try
{
var resultForCommandToCancel = kernel.SendAsync(commandToCancel);
await Task.Delay(200);
await kernel.SendAsync(cancelCommand).Timeout(10.Seconds());
var result = await resultForCommandToCancel.Timeout(10.Seconds());
result.Events
.Should()
.ContainSingle<CommandFailed>()
.Which
.Command
.Should()
.Be(commandToCancel);
break;
}
catch (TimeoutException)
{
}
}
}
[Fact]
public async Task can_cancel_user_code_when_commands_are_split()
{
// todo: this test is flaky and timeouts in CI
while (true)
{
using var kernel = CreateKernel();
var cancelCommand = new Cancel();
var commandToCancel = new SubmitCode(@"
#!csharp
using Microsoft.DotNet.Interactive;
var cancellationToken = KernelInvocationContext.Current.CancellationToken;
while(!cancellationToken.IsCancellationRequested){
await Task.Delay(10);
}");
try
{
var resultForCommandToCancel = kernel.SendAsync(commandToCancel);
await Task.Delay(200);
await kernel.SendAsync(cancelCommand).Timeout(10.Seconds());
var result = await resultForCommandToCancel.Timeout(10.Seconds());
result.Events
.Should()
.ContainSingle<CommandFailed>()
.Which
.Command
.Should()
.Be(commandToCancel);
break;
}
catch (TimeoutException)
{
}
}
}
[Fact]
public void user_code_can_react_to_cancel_command_using_KernelInvocationContext_cancellation_token()
{
using var kernel = CreateKernel();
var commandInProgress = new CancellableCommand();
var cancelSent = commandInProgress.Invoked.ContinueWith(async task =>
{
// once the cancellable command is running, send a Cancel
await kernel.SendAsync(new Cancel());
});
var _ = kernel.SendAsync(commandInProgress);
Task.WhenAll(cancelSent, commandInProgress.Cancelled)
.Wait(TimeSpan.FromSeconds(5));
}
public class CancellableCommand : KernelCommand
{
private readonly TaskCompletionSource _invoked = new();
private readonly TaskCompletionSource _cancelled = new();
public CancellableCommand(
string targetKernelName = null,
KernelCommand parent = null) : base(targetKernelName, parent)
{
// prevent NoSuitableKernelException by setting the handler
Handler = (command, context) => Task.CompletedTask;
}
public override async Task InvokeAsync(KernelInvocationContext context)
{
_invoked.SetResult();
context.CancellationToken.Register(() =>
{
_cancelled.SetResult();
});
await _cancelled.Task;
}
public Task Invoked => _invoked.Task;
public Task Cancelled => _cancelled.Task;
}
}