-
Notifications
You must be signed in to change notification settings - Fork 367
/
CompositeKernelTests.cs
584 lines (479 loc) · 18.5 KB
/
CompositeKernelTests.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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
// 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.Collections.Generic;
using System.CommandLine;
using System.CommandLine.Invocation;
using System.Linq;
using System.Threading.Tasks;
using FluentAssertions;
using FluentAssertions.Execution;
using Microsoft.DotNet.Interactive.Commands;
using Microsoft.DotNet.Interactive.CSharp;
using Microsoft.DotNet.Interactive.Events;
using Microsoft.DotNet.Interactive.FSharp;
using Microsoft.DotNet.Interactive.Tests.Utility;
using Pocket;
using Xunit;
using Xunit.Abstractions;
namespace Microsoft.DotNet.Interactive.Tests
{
public class CompositeKernelTests : IDisposable
{
private readonly CompositeDisposable _disposables = new();
public CompositeKernelTests(ITestOutputHelper output)
{
_disposables.Add(output.SubscribeToPocketLogger());
}
public void Dispose()
{
_disposables.Dispose();
}
[Fact]
public async Task Handling_kernel_can_be_specified_using_kernel_name_as_a_directive()
{
var cSharpKernel = new CSharpKernel();
var fSharpKernel = new FSharpKernel();
using var kernel = new CompositeKernel
{
cSharpKernel,
fSharpKernel,
};
kernel.DefaultKernelName = fSharpKernel.Name;
using var events = kernel.KernelEvents.ToSubscribedList();
var csharpCommand = new SubmitCode(@"
#!csharp
new [] {1,2,3}");
await kernel.SendAsync(csharpCommand);
var fsharpCommand = new SubmitCode(@"
#!fsharp
[1;2;3]");
await kernel.SendAsync(fsharpCommand);
events.Should()
.ContainSingle<CommandSucceeded>(e => e.Command == csharpCommand);
events.Should()
.ContainSingle<CommandSucceeded>(e => e.Command == fsharpCommand);
}
[Fact]
public async Task Handling_kernel_can_be_specified_using_kernel_alias_as_a_directive()
{
var cSharpKernel = new CSharpKernel();
var fSharpKernel = new FSharpKernel();
using var kernel = new CompositeKernel();
kernel.Add(cSharpKernel, new[] { "C#" });
kernel.Add(fSharpKernel, new[] { "F#" });
kernel.DefaultKernelName = fSharpKernel.Name;
using var events = kernel.KernelEvents.ToSubscribedList();
var csharpCommand = new SubmitCode(@"
#!C#
new [] {1,2,3}");
await kernel.SendAsync(csharpCommand);
var fsharpCommand = new SubmitCode(@"
#!F#
[1;2;3]");
await kernel.SendAsync(fsharpCommand);
events.Should()
.ContainSingle<CommandSucceeded>(e => e.Command == csharpCommand);
events.Should()
.ContainSingle<CommandSucceeded>(e => e.Command == fsharpCommand);
}
[Theory]
[InlineData("#!fake1", "fake1")]
[InlineData("#!fake1-alias", "fake1")]
[InlineData("#!fake2", "fake2")]
[InlineData("#!fake2-alias", "fake2")]
public async Task Action_directives_are_routed_by_kernel_chooser_directives(
string chooseKernelCommand,
string expectedInvokedOnKernelName)
{
var received = new List<string>();
using var compositeKernel = new CompositeKernel();
var fakeKernel1 = new FakeKernel("fake1");
fakeKernel1.AddDirective(new Command("#!hi")
{
Handler = CommandHandler.Create(() => { received.Add("fake1"); })
});
var fakeKernel2 = new FakeKernel("fake2");
fakeKernel2.AddDirective(new Command("#!hi")
{
Handler = CommandHandler.Create(() => { received.Add("fake2"); })
});
compositeKernel.Add(fakeKernel1, new[] { "fake1-alias" });
compositeKernel.Add(fakeKernel2, new[] { "fake2-alias" });
var result = await compositeKernel.SubmitCodeAsync($"{chooseKernelCommand}\n#!hi");
result.KernelEvents.ToSubscribedList().Should().NotContainErrors();
received
.Should()
.ContainSingle()
.Which
.Should()
.Be(expectedInvokedOnKernelName);
}
[Theory]
[InlineData(0)]
[InlineData(1)]
[InlineData(2)]
public async Task when_target_kernel_is_specified_and_not_found_then_command_fails(int kernelCount)
{
using var kernel = new CompositeKernel();
using var events = kernel.KernelEvents.ToSubscribedList();
foreach (var kernelName in Enumerable.Range(0, kernelCount).Select(i => $"kernel{i}"))
{
kernel.Add(new FakeKernel(kernelName));
}
await kernel.SendAsync(
new SubmitCode(
@"var x = 123;",
"unregistered kernel name"));
events.Should()
.ContainSingle<CommandFailed>(cf => cf.Exception is NoSuitableKernelException);
}
[Fact]
public void cannot_add_duplicated_named_kernels()
{
using var kernel = new CompositeKernel
{
new CSharpKernel()
};
kernel.Invoking(k => k.Add(new CSharpKernel()))
.Should()
.Throw<ArgumentException>()
.Which
.Message
.Should()
.Be("Alias '#!csharp' is already in use.");
}
[Fact]
public async Task can_handle_commands_targeting_composite_kernel_directly()
{
using var kernel = new CompositeKernel
{
new FakeKernel("fake")
{
Handle = (command, context) => Task.CompletedTask
}
};
using var events = kernel.KernelEvents.ToSubscribedList();
var submitCode = new SubmitCode("//command", kernel.Name)
{
Handler = (kernelCommand, context) => Task.CompletedTask
};
await kernel.SendAsync(submitCode);
events.Should()
.ContainSingle<CommandSucceeded>()
.Which
.Command
.Should()
.Be(submitCode);
}
[Fact]
public async Task commands_targeting_compositeKernel_are_not_routed_to_childKernels()
{
var receivedOnFakeKernel = new List<KernelCommand>();
using var kernel = new CompositeKernel
{
new FakeKernel("fake")
{
Handle = (kernelCommand, context) =>
{
receivedOnFakeKernel.Add(kernelCommand);
return Task.CompletedTask;
}
}
};
var submitCode = new SubmitCode("//command", kernel.Name);
await kernel.SendAsync(submitCode);
receivedOnFakeKernel.Should()
.BeEmpty();
}
[Fact]
public async Task Handling_kernel_can_be_specified_by_setting_the_kernel_name_in_the_command()
{
var receivedOnFakeKernel = new List<KernelCommand>();
using var kernel = new CompositeKernel
{
new CSharpKernel(),
new FakeKernel("fake")
{
Handle = (kernelCommand, context) =>
{
receivedOnFakeKernel.Add(kernelCommand);
return Task.CompletedTask;
}
}
};
await kernel.SendAsync(
new SubmitCode(
@"var x = 123;",
"csharp"));
await kernel.SendAsync(
new SubmitCode(
@"hello!",
"fake"));
await kernel.SendAsync(
new SubmitCode(
@"x",
"csharp"));
receivedOnFakeKernel
.Should()
.ContainSingle(c => c is SubmitCode)
.Which
.As<SubmitCode>()
.Code
.Should()
.Be("hello!");
}
[Fact]
public async Task Handling_kernel_can_be_specified_as_a_default()
{
var receivedOnFakeKernel = new List<KernelCommand>();
using var kernel = new CompositeKernel
{
new CSharpKernel(),
new FakeKernel("fake")
{
Handle = (command, context) =>
{
receivedOnFakeKernel.Add(command);
return Task.CompletedTask;
}
}
};
kernel.DefaultKernelName = "fake";
await kernel.SendAsync(
new SubmitCode(
@"hello!"));
receivedOnFakeKernel
.Should()
.ContainSingle(c => c is SubmitCode)
.Which
.As<SubmitCode>()
.Code
.Should()
.Be("hello!");
}
[Fact]
public async Task Handling_kernel_can_be_specified_as_a_default_via_an_alias()
{
var receivedOnFakeKernel = new List<KernelCommand>();
var fakeKernel = new FakeKernel("fake")
{
Handle = (command, context) =>
{
receivedOnFakeKernel.Add(command);
return Task.CompletedTask;
}
};
using var kernel = new CompositeKernel
{
new CSharpKernel()
};
kernel.Add(fakeKernel, new[] { "totally-fake" });
kernel.DefaultKernelName = "totally-fake";
await kernel.SendAsync(
new SubmitCode(
@"hello!"));
receivedOnFakeKernel
.Should()
.ContainSingle(c => c is SubmitCode)
.Which
.As<SubmitCode>()
.Code
.Should()
.Be("hello!");
}
[Fact]
public async Task When_no_default_kernel_is_specified_then_kernel_directives_can_be_used()
{
using var kernel = new CompositeKernel
{
new CSharpKernel(),
new FSharpKernel()
};
using var events = kernel.KernelEvents.ToSubscribedList();
await kernel.SubmitCodeAsync(@"
#!csharp
new [] {1,2,3}");
events.Should().NotContainErrors();
}
[Fact]
public void When_only_one_subkernel_is_present_then_default_kernel_name_returns_its_name()
{
using var kernel = new CompositeKernel
{
new CSharpKernel()
};
kernel.DefaultKernelName.Should().Be("csharp");
}
[Fact]
public async Task Events_published_by_child_kernel_are_visible_in_parent_kernel()
{
var subKernel = new CSharpKernel();
using var compositeKernel = new CompositeKernel
{
subKernel
};
var events = compositeKernel.KernelEvents.ToSubscribedList();
await subKernel.SendAsync(new SubmitCode("var x = 1;"));
events
.Select(e => e.GetType())
.Should()
.ContainInOrder(
typeof(CodeSubmissionReceived),
typeof(CompleteCodeSubmissionReceived),
typeof(CommandSucceeded));
}
[Fact]
public async Task Deferred_commands_on_composite_kernel_are_execute_on_first_submission()
{
var deferredCommandExecuted = false;
var subKernel = new CSharpKernel();
using var compositeKernel = new CompositeKernel
{
subKernel
};
compositeKernel.DefaultKernelName = subKernel.Name;
var deferred = new SubmitCode("placeholder")
{
Handler = (command, context) =>
{
deferredCommandExecuted = true;
return Task.CompletedTask;
}
};
compositeKernel.DeferCommand(deferred);
var events = compositeKernel.KernelEvents.ToSubscribedList();
await compositeKernel.SendAsync(new SubmitCode("var x = 1;", targetKernelName: subKernel.Name));
deferredCommandExecuted.Should().Be(true);
events
.Select(e => e.GetType())
.Should()
.ContainInOrder(
typeof(CodeSubmissionReceived),
typeof(CompleteCodeSubmissionReceived),
typeof(CommandSucceeded));
}
[Fact]
public async Task Deferred_commands_on_composite_kernel_can_use_directives()
{
var deferredCommandExecuted = false;
var subKernel = new CSharpKernel();
using var compositeKernel = new CompositeKernel
{
subKernel
};
var customDirective = new Command("#!customDirective")
{
Handler = CommandHandler.Create(() => { deferredCommandExecuted = true; })
};
compositeKernel.AddDirective(customDirective);
compositeKernel.DefaultKernelName = subKernel.Name;
var deferred = new SubmitCode("#!customDirective");
compositeKernel.DeferCommand(deferred);
var events = compositeKernel.KernelEvents.ToSubscribedList();
await compositeKernel.SendAsync(new SubmitCode("var x = 1;", targetKernelName: subKernel.Name));
deferredCommandExecuted.Should().Be(true);
events
.Select(e => e.GetType())
.Should()
.ContainInOrder(
typeof(CodeSubmissionReceived),
typeof(CompleteCodeSubmissionReceived),
typeof(CommandSucceeded));
}
[Fact]
public void Child_kernels_are_disposed_when_CompositeKernel_is_disposed()
{
var csharpKernelWasDisposed = false;
var fsharpKernelWasDisposed = false;
var csharpKernel = new CSharpKernel();
csharpKernel.RegisterForDisposal(() => csharpKernelWasDisposed = true);
var fsharpKernel = new FSharpKernel();
fsharpKernel.RegisterForDisposal(() => fsharpKernelWasDisposed = true);
var compositeKernel = new CompositeKernel
{
csharpKernel,
fsharpKernel
};
compositeKernel.Dispose();
csharpKernelWasDisposed.Should().BeTrue();
fsharpKernelWasDisposed.Should().BeTrue();
}
[Fact]
public void When_frontend_environment_is_set_then_it_is_also_assigned_to_child_kernels()
{
using var compositeKernel = new CompositeKernel
{
new CSharpKernel()
};
compositeKernel.FrontendEnvironment = new AutomationEnvironment();
compositeKernel
.ChildKernels
.OfType<Kernel>()
.Single()
.FrontendEnvironment
.Should()
.BeSameAs(compositeKernel.FrontendEnvironment);
}
[Fact]
public void When_child_kernel_is_added_then_its_frontend_environment_is_obtained_from_the_parent()
{
using var compositeKernel = new CompositeKernel();
compositeKernel.FrontendEnvironment = new AutomationEnvironment();
compositeKernel.Add(new CSharpKernel());
compositeKernel
.ChildKernels
.OfType<Kernel>()
.Single()
.FrontendEnvironment
.Should()
.BeSameAs(compositeKernel.FrontendEnvironment);
}
[Fact]
public async Task When_command_handler_registered_and_command_sent_then_handler_is_executed()
{
using var compositeKernel = new CompositeKernel();
CustomCommandTypes.FirstSubmission.MyCommand commandPassedToHandler = null;
KernelInvocationContext contextPassedToHandler = null;
compositeKernel.RegisterCommandHandler<CustomCommandTypes.FirstSubmission.MyCommand>(
(command, context) =>
{
commandPassedToHandler = command;
contextPassedToHandler = context;
return Task.CompletedTask;
});
var commandSentToKernel = new CustomCommandTypes.FirstSubmission.MyCommand("xyzzy");
await compositeKernel.SendAsync(commandSentToKernel);
commandPassedToHandler
.Should()
.BeSameAs(commandSentToKernel);
contextPassedToHandler
.Should()
.NotBeNull();
}
[Fact]
public async Task When_command_handler_registered_in_child_kernel_and_command_sent_to_parent_then_handler_is_executed()
{
using var compositeKernel = new CompositeKernel();
var childKernel = new FakeKernel();
compositeKernel.Add(childKernel);
CustomCommandTypes.FirstSubmission.MyCommand commandPassedToHandler = null;
KernelInvocationContext contextPassedToHandler = null;
childKernel.RegisterCommandHandler<CustomCommandTypes.FirstSubmission.MyCommand>(
(command, context) =>
{
commandPassedToHandler = command;
contextPassedToHandler = context;
return Task.CompletedTask;
});
var commandSentToCompositeKernel = new CustomCommandTypes.FirstSubmission.MyCommand("xyzzy");
await compositeKernel.SendAsync(commandSentToCompositeKernel);
commandPassedToHandler
.Should()
.BeSameAs(commandSentToCompositeKernel);
contextPassedToHandler
.Should()
.NotBeNull();
}
}
}