-
Notifications
You must be signed in to change notification settings - Fork 368
/
DirectiveTests.cs
376 lines (302 loc) · 10.4 KB
/
DirectiveTests.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
// 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.CommandLine;
using System.CommandLine.Invocation;
using System.CommandLine.NamingConventionBinder;
using System.Linq;
using System.Threading.Tasks;
using FluentAssertions;
using Microsoft.DotNet.Interactive.Commands;
using Microsoft.DotNet.Interactive.CSharp;
using Microsoft.DotNet.Interactive.Events;
using Microsoft.DotNet.Interactive.Formatting;
using Microsoft.DotNet.Interactive.Jupyter;
using Microsoft.DotNet.Interactive.Tests.Utility;
using Microsoft.DotNet.Interactive.Utility;
using Pocket;
using Pocket.For.Xunit;
using Xunit;
using Xunit.Abstractions;
namespace Microsoft.DotNet.Interactive.Tests;
[LogToPocketLogger(FileNameEnvironmentVariable = "POCKETLOGGER_LOG_PATH")]
public class DirectiveTests : IDisposable
{
private readonly CompositeDisposable _disposables = new();
public DirectiveTests(ITestOutputHelper output)
{
_disposables.Add(output.SubscribeToPocketLogger());
}
public void Dispose()
{
_disposables.Dispose();
}
[Fact]
public void Directives_may_be_prefixed_with_hash()
{
using var kernel = new CompositeKernel();
kernel
.Invoking(k => k.AddDirective(new Command("#hello")))
.Should()
.NotThrow();
}
[Theory]
[InlineData("{")]
[InlineData(";")]
[InlineData("a")]
[InlineData("1")]
public void Directives_may_not_begin_with_(string value)
{
using var kernel = new CompositeKernel();
kernel
.Invoking(k => k.AddDirective(new Command($"{value}hello")))
.Should()
.Throw<ArgumentException>()
.Which
.Message
.Should()
.Be($"Invalid directive name \"{value}hello\". Directives must begin with \"#\".");
}
[Theory]
[InlineData("{")]
[InlineData(";")]
[InlineData("a")]
[InlineData("1")]
public void Directives_may_not_have_aliases_that_begin_with_(string value)
{
using var kernel = new CompositeKernel();
var command = new Command("#!this-is-fine");
command.AddAlias($"{value}hello");
kernel
.Invoking(k =>
{
kernel.AddDirective(command);
})
.Should()
.Throw<ArgumentException>()
.Which
.Message
.Should()
.Be($"Invalid directive name \"{value}hello\". Directives must begin with \"#\".");
}
[Fact]
public async Task Directive_handlers_are_invoked_in_the_order_in_which_they_occur_in_the_code_submission()
{
using var kernel = new CSharpKernel();
var events = kernel.KernelEvents.ToSubscribedList();
kernel.AddDirective(new Command("#!increment")
{
Handler = CommandHandler.Create(async (InvocationContext ctx) =>
{
var context = ctx.GetService<KernelInvocationContext>();
await context.HandlingKernel.SubmitCodeAsync("i++;");
})
});
await kernel.SubmitCodeAsync(@"
var i = 0;
#!increment
i");
events
.Should()
.ContainSingle<ReturnValueProduced>()
.Which
.Value
.Should()
.Be(1);
}
[Fact]
public async Task Directive_parse_errors_are_displayed()
{
var command = new Command("#!oops")
{
new Argument<string>()
};
using var kernel = new CSharpKernel();
kernel.AddDirective(command);
var events = kernel.KernelEvents.ToSubscribedList();
await kernel.SubmitCodeAsync("#!oops");
events.Should()
.ContainSingle<CommandFailed>()
.Which
.Message
.Should()
.Be("Required argument missing for command: '#!oops'.");
}
[Fact]
public async Task Directive_parse_errors_prevent_code_submission_from_being_run()
{
var command = new Command("#!x")
{
new Argument<string>()
};
using var kernel = new CSharpKernel();
kernel.AddDirective(command);
var events = kernel.KernelEvents.ToSubscribedList();
await kernel.SubmitCodeAsync("#!x\n123");
events.Should().NotContain(e => e is ReturnValueProduced);
events.Last().Should().BeOfType<CommandFailed>();
}
[Theory] // https://github.com/dotnet/interactive/issues/2085
[InlineData("[|#!unknown|]\n123")]
[InlineData("// first line\n[|#!unknown|]\n123")]
public async Task Unrecognized_directives_result_in_errors(string markedUpCode)
{
MarkupTestFile.GetPositionAndSpan(markedUpCode, out var code, out var pos, out var span);
MarkupTestFile.GetLine(markedUpCode, span.Value.Start, out var line);
var startPos = new LinePosition(line, span.Value.Start);
var endPos = new LinePosition(line, span.Value.End + 1);
var expectedPos = new LinePositionSpan(startPos, endPos);
using var kernel = new CSharpKernel();
var events = kernel.KernelEvents.ToSubscribedList();
await kernel.SubmitCodeAsync(code);
events.Should().NotContain(e => e is ReturnValueProduced);
events.Should()
.ContainSingle<DiagnosticsProduced>()
.Which
.Diagnostics
.Should()
.ContainSingle()
.Which
.LinePositionSpan
.Should()
.BeEquivalentTo(expectedPos);
events.Last().Should().BeOfType<CommandFailed>();
}
[Fact]
public void Directives_with_duplicate_aliases_are_not_allowed()
{
using var kernel = new CompositeKernel();
kernel.AddDirective(new Command("#!dupe"));
kernel.Invoking(k => k.AddDirective(new Command("#!dupe")))
.Should()
.Throw<ArgumentException>()
.Which
.Message
.Should()
.Be("Alias \'#!dupe\' is already in use.");
}
[Fact]
public async Task OnComplete_can_be_used_to_act_on_completion_of_commands()
{
var onCompleteWasCalled = false;
using var kernel = new FakeKernel();
kernel.AddDirective(new Command("#!wrap")
{
Handler = CommandHandler.Create((InvocationContext ctx) =>
{
var c = ctx.GetService<KernelInvocationContext>();
c.OnComplete(context =>
{
onCompleteWasCalled = true;
});
return Task.CompletedTask;
})
});
await kernel.SubmitCodeAsync("#!wrap");
onCompleteWasCalled.Should().BeTrue();
}
[Fact]
public async Task OnComplete_can_be_used_to_publish_events_before_context_is_completed()
{
using var kernel = new FakeKernel();
kernel.AddDirective(new Command("#!wrap")
{
Handler = CommandHandler.Create((InvocationContext ctx) =>
{
var c = ctx.GetService<KernelInvocationContext>();
c.Display("hello!");
c.OnComplete(context =>
{
context.Display("goodbye!");
});
return Task.CompletedTask;
})
});
var result = await kernel.SubmitCodeAsync("#!wrap");
result.Events
.OfType<DisplayedValueProduced>()
.Select(e => e.Value)
.Should()
.BeEquivalentSequenceTo("hello!", "goodbye!");
}
[Theory]
[InlineData("csharp")]
[InlineData(".NET")]
public async Task Directives_can_display_help(string kernelName)
{
var cSharpKernel = new CSharpKernel().UseDefaultMagicCommands();
using var compositeKernel = new CompositeKernel
{
cSharpKernel
};
var command = new Command("#!hello")
{
new Option<bool>("--loudness")
};
var kernel = compositeKernel.FindKernelByName(kernelName);
kernel.AddDirective(command);
using var events = compositeKernel.KernelEvents.ToSubscribedList();
await compositeKernel.SubmitCodeAsync("#!hello -h");
events.Should()
.ContainSingle<StandardOutputValueProduced>()
.Which
.FormattedValues
.Should()
.ContainSingle(v => v.MimeType == PlainTextFormatter.MimeType)
.Which
.Value
.Should()
.ContainAll("Usage", "#!hello", "[options]", "--loudness");
events.Should()
.NotContainErrors();
}
[Fact]
public async Task New_directives_can_be_added_after_older_ones_have_been_evaluated()
{
using var kernel = new CompositeKernel { new CSharpKernel() };
using var events = kernel.KernelEvents.ToSubscribedList();
var oneWasCalled = false;
var twoWasCalled = false;
kernel.AddDirective(new Command("#!one")
{
Handler = CommandHandler.Create(() => oneWasCalled = true)
});
await kernel.SubmitCodeAsync("#!one\n123");
events.Should().NotContainErrors();
kernel.AddDirective(new Command("#!two")
{
Handler = CommandHandler.Create(() => twoWasCalled = true)
});
await kernel.SubmitCodeAsync("#!two\n123");
events.Should().NotContainErrors();
oneWasCalled.Should().BeTrue();
twoWasCalled.Should().BeTrue();
}
[Fact]
public async Task DirectiveCommand_is_not_referenced_by_KernelEvent_Command()
{
using var kernel = new FakeKernel();
kernel.AddDirective(new Command("#!test")
{
Handler = CommandHandler.Create((InvocationContext ctx) =>
{
var context = ctx.GetService<KernelInvocationContext>();
context.Display("goodbye!");
return Task.CompletedTask;
})
});
if (kernel is null)
{
throw new ArgumentNullException(nameof(kernel));
}
var submitCode = new SubmitCode("#!test");
var result = await kernel.SendAsync(submitCode);
result.Events
.Should()
.ContainSingle<DisplayedValueProduced>()
.Which
.Command
.Should()
.Be(submitCode);
}
}