-
Notifications
You must be signed in to change notification settings - Fork 4k
/
HoverTests.cs
532 lines (472 loc) · 17.1 KB
/
HoverTests.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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
#nullable disable
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.PooledObjects;
using Roslyn.Test.Utilities;
using Roslyn.Text.Adornments;
using Xunit;
using Xunit.Abstractions;
using LSP = Roslyn.LanguageServer.Protocol;
namespace Microsoft.CodeAnalysis.LanguageServer.UnitTests.Hover
{
public class HoverTests(ITestOutputHelper testOutputHelper) : AbstractLanguageServerProtocolTests(testOutputHelper)
{
[Theory, CombinatorialData]
public async Task TestGetHoverAsync(bool mutatingLspWorkspace)
{
var markup =
@"class A
{
/// <summary>
/// A great method
/// </summary>
/// <param name='i'>an int</param>
/// <returns>a string</returns>
private string {|caret:Method|}(int i)
{
}
}";
await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace, CapabilitiesWithVSExtensions);
var expectedLocation = testLspServer.GetLocations("caret").Single();
var results = await RunGetHoverAsync(testLspServer, expectedLocation).ConfigureAwait(false);
VerifyVSContent(results, $"string A.Method(int i)|A great method|{FeaturesResources.Returns_colon}| |a string");
}
[Theory, CombinatorialData]
public async Task TestGetHoverAsync_WithExceptions(bool mutatingLspWorkspace)
{
var markup =
@"class A
{
/// <summary>
/// A great method
/// </summary>
/// <exception cref='System.NullReferenceException'>
/// Oh no!
/// </exception>
private string {|caret:Method|}(int i)
{
}
}";
await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace, CapabilitiesWithVSExtensions);
var expectedLocation = testLspServer.GetLocations("caret").Single();
var results = await RunGetHoverAsync(testLspServer, expectedLocation).ConfigureAwait(false);
VerifyVSContent(results, $"string A.Method(int i)|A great method|{FeaturesResources.Exceptions_colon}| System.NullReferenceException");
}
[Theory, CombinatorialData]
public async Task TestGetHoverAsync_WithRemarks(bool mutatingLspWorkspace)
{
var markup =
@"class A
{
/// <summary>
/// A great method
/// </summary>
/// <remarks>
/// Remarks are cool too.
/// </remarks>
private string {|caret:Method|}(int i)
{
}
}";
await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace, CapabilitiesWithVSExtensions);
var expectedLocation = testLspServer.GetLocations("caret").Single();
var results = await RunGetHoverAsync(testLspServer, expectedLocation).ConfigureAwait(false);
VerifyVSContent(results, "string A.Method(int i)|A great method|Remarks are cool too.");
}
[Theory, CombinatorialData]
public async Task TestGetHoverAsync_WithList(bool mutatingLspWorkspace)
{
var markup =
@"class A
{
/// <summary>
/// A great method
/// <list type='bullet'>
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>
/// </summary>
private string {|caret:Method|}(int i)
{
}
}";
await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace, CapabilitiesWithVSExtensions);
var expectedLocation = testLspServer.GetLocations("caret").Single();
var results = await RunGetHoverAsync(testLspServer, expectedLocation).ConfigureAwait(false);
VerifyVSContent(results, "string A.Method(int i)|A great method|• |Item 1.|• |Item 2.");
}
[Theory, CombinatorialData]
public async Task TestGetHoverAsync_InvalidLocation(bool mutatingLspWorkspace)
{
var markup =
@"class A
{
/// <summary>
/// A great method
/// </summary>
/// <param name='i'>an int</param>
/// <returns>a string</returns>
private string Method(int i)
{
{|caret:|}
}
}";
await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace);
var results = await RunGetHoverAsync(testLspServer, testLspServer.GetLocations("caret").Single()).ConfigureAwait(false);
Assert.Null(results);
}
// Test that if we pass a project context along to hover, the right context is chosen. We are using hover
// as a general proxy to test that our context tracking works in all cases, although there's nothing specific
// about hover that needs to be different here compared to any other feature.
[Theory, CombinatorialData]
public async Task TestGetHoverWithProjectContexts(bool mutatingLspWorkspace)
{
var source = @"
using System;
#if NET472
class WithConstant
{
public const string Target = ""Target in net472"";
}
#else
class WithConstant
{
public const string Target = ""Target in netcoreapp3.1"";
}
#endif
class Program
{
static void Main(string[] args)
{
Console.WriteLine(WithConstant.{|caret:Target|});
}
}";
var workspaceXml =
$@"<Workspace>
<Project Language=""C#"" CommonReferences=""true"" AssemblyName=""Net472"" PreprocessorSymbols=""NET472"">
<Document FilePath=""C:\C.cs""><![CDATA[${source}]]></Document>
</Project>
<Project Language=""C#"" CommonReferences=""true"" AssemblyName=""NetCoreApp3"" PreprocessorSymbols=""NETCOREAPP3.1"">
<Document IsLinkFile=""true"" LinkFilePath=""C:\C.cs"" LinkAssemblyName=""Net472""></Document>
</Project>
</Workspace>";
await using var testLspServer = await CreateXmlTestLspServerAsync(workspaceXml, mutatingLspWorkspace, initializationOptions: new InitializationOptions { ClientCapabilities = CapabilitiesWithVSExtensions });
var location = testLspServer.GetLocations("caret").Single();
foreach (var project in testLspServer.GetCurrentSolution().Projects)
{
var result = await RunGetHoverAsync(testLspServer, location, project.Id);
var expectedConstant = project.Name == "Net472" ? "Target in net472" : "Target in netcoreapp3.1";
VerifyVSContent(result, $"({FeaturesResources.constant}) string WithConstant.Target = \"{expectedConstant}\"");
}
}
[Theory, CombinatorialData]
public async Task TestGetHoverAsync_UsingMarkupContent(bool mutatingLspWorkspace)
{
var markup =
@"class A
{
/// <summary>
/// A cref <see cref=""AMethod""/>
/// <br/>
/// <strong>strong text</strong>
/// <br/>
/// <em>italic text</em>
/// <br/>
/// <u>underline text</u>
/// <para>
/// <list type='bullet'>
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>
/// <a href = ""https://google.com"" > link text</a>
/// </para>
/// </summary>
/// <exception cref='System.NullReferenceException'>
/// Oh no!
/// </exception>
/// <param name='i'>an int</param>
/// <returns>a string</returns>
/// <remarks>
/// Remarks are cool too.
/// </remarks>
void {|caret:AMethod|}(int i)
{
}
}";
var clientCapabilities = new LSP.ClientCapabilities
{
TextDocument = new LSP.TextDocumentClientCapabilities { Hover = new LSP.HoverSetting { ContentFormat = [LSP.MarkupKind.Markdown] } }
};
await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace, clientCapabilities);
var expectedLocation = testLspServer.GetLocations("caret").Single();
var expectedMarkdown = @$"```csharp
void A.AMethod(int i)
```
A cref A\.AMethod\(int\)
**strong text**
_italic text_
<u>underline text</u>
• Item 1\.
• Item 2\.
[link text](https://google.com)
Remarks are cool too\.
{FeaturesResources.Returns_colon}
a string
{FeaturesResources.Exceptions_colon}
System\.NullReferenceException
";
var results = await RunGetHoverAsync(
testLspServer,
expectedLocation).ConfigureAwait(false);
Assert.Equal(expectedMarkdown, results.Contents.Fourth.Value);
}
[Theory, CombinatorialData]
public async Task TestGetHoverAsync_WithoutMarkdownClientSupport(bool mutatingLspWorkspace)
{
var markup =
@"class A
{
/// <summary>
/// A cref <see cref=""AMethod""/>
/// <br/>
/// <strong>strong text</strong>
/// <br/>
/// <em>italic text</em>
/// <br/>
/// <u>underline text</u>
/// <para>
/// <list type='bullet'>
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>
/// <a href = ""https://google.com"" > link text</a>
/// </para>
/// </summary>
/// <exception cref='System.NullReferenceException'>
/// Oh no!
/// </exception>
/// <param name='i'>an int</param>
/// <returns>a string</returns>
/// <remarks>
/// Remarks are cool too.
/// </remarks>
void {|caret:AMethod|}(int i)
{
}
}";
await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace);
var expectedLocation = testLspServer.GetLocations("caret").Single();
var expectedText = @$"void A.AMethod(int i)
A cref A.AMethod(int)
strong text
italic text
underline text
• Item 1.
• Item 2.
link text
Remarks are cool too.
{FeaturesResources.Returns_colon}
a string
{FeaturesResources.Exceptions_colon}
System.NullReferenceException
";
var results = await RunGetHoverAsync(
testLspServer,
expectedLocation).ConfigureAwait(false);
Assert.Equal(expectedText, results.Contents.Fourth.Value);
}
[Theory, CombinatorialData]
public async Task TestGetHoverAsync_UsingMarkupContentProperlyEscapes(bool mutatingLspWorkspace)
{
var markup =
@"class A
{
/// <summary>
/// Some {curly} [braces] and (parens)
/// <br/>
/// #Hashtag
/// <br/>
/// 1 + 1 - 1
/// <br/>
/// Period.
/// <br/>
/// Exclaim!
/// <br/>
/// <strong>strong\** text</strong>
/// <br/>
/// <em>italic_ **text**</em>
/// <br/>
/// <a href = ""https://google.com""> closing] link</a>
/// </summary>
void {|caret:AMethod|}(int i)
{
}
}";
var clientCapabilities = new LSP.ClientCapabilities
{
TextDocument = new LSP.TextDocumentClientCapabilities { Hover = new LSP.HoverSetting { ContentFormat = [LSP.MarkupKind.Markdown] } }
};
await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace, clientCapabilities);
var expectedLocation = testLspServer.GetLocations("caret").Single();
var expectedMarkdown = @"```csharp
void A.AMethod(int i)
```
Some \{curly\} \[braces\] and \(parens\)
\#Hashtag
1 \+ 1 \- 1
Period\.
Exclaim\!
**strong\\\*\* text**
_italic\_ \*\*text\*\*_
[closing\] link](https://google.com)
";
var results = await RunGetHoverAsync(
testLspServer,
expectedLocation).ConfigureAwait(false);
Assert.Equal(expectedMarkdown, results.Contents.Fourth.Value);
}
[Theory, CombinatorialData]
public async Task TestGetHoverAsync_UsingMarkupContentDoesNotEscapeCode(bool mutatingLspWorkspace)
{
var markup =
@"class A
{
/// <summary>
/// <c>
/// if (true) {
/// Console.WriteLine(""hello"");
/// }
/// </c>
/// </summary>
void {|caret:AMethod|}(int i)
{
}
}";
var clientCapabilities = new LSP.ClientCapabilities
{
TextDocument = new LSP.TextDocumentClientCapabilities { Hover = new LSP.HoverSetting { ContentFormat = [LSP.MarkupKind.Markdown] } }
};
await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace, clientCapabilities);
var expectedLocation = testLspServer.GetLocations("caret").Single();
var expectedMarkdown = @"```csharp
void A.AMethod(int i)
```
`if (true) { Console.WriteLine(""hello""); }`
";
var results = await RunGetHoverAsync(
testLspServer,
expectedLocation).ConfigureAwait(false);
Assert.Equal(expectedMarkdown, results.Contents.Fourth.Value);
}
[Theory, CombinatorialData, WorkItem("https://github.com/dotnet/roslyn/issues/75181")]
public async Task TestGetHoverAsync_UsingMarkupContentDoesNotEscapeCodeBlock(bool mutatingLspWorkspace)
{
var markup =
@"class A
{
/// <summary>
/// <code>
/// if (true) {
/// Console.WriteLine(""hello"");
/// }
/// </code>
/// </summary>
void {|caret:AMethod|}(int i)
{
}
}";
var clientCapabilities = new LSP.ClientCapabilities
{
TextDocument = new LSP.TextDocumentClientCapabilities { Hover = new LSP.HoverSetting { ContentFormat = [LSP.MarkupKind.Markdown] } }
};
await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace, clientCapabilities);
var expectedLocation = testLspServer.GetLocations("caret").Single();
var expectedMarkdown = @"```csharp
void A.AMethod(int i)
```
```text
if (true) {
Console.WriteLine(""hello"");
}
```
";
var results = await RunGetHoverAsync(
testLspServer,
expectedLocation).ConfigureAwait(false);
Assert.Equal(expectedMarkdown, results.Contents.Fourth.Value);
}
[Theory, CombinatorialData, WorkItem("https://github.com/dotnet/vscode-csharp/issues/6577")]
public async Task TestGetHoverAsync_UsesInlineCodeFencesInAwaitReturn(bool mutatingLspWorkspace)
{
var markup =
@"using System.Threading.Tasks;
class C
{
public async Task<string> DoAsync()
{
return {|caret:await|} DoAsync();
}
}";
var clientCapabilities = new LSP.ClientCapabilities
{
TextDocument = new LSP.TextDocumentClientCapabilities { Hover = new LSP.HoverSetting { ContentFormat = [LSP.MarkupKind.Markdown] } }
};
await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace, clientCapabilities);
var expectedLocation = testLspServer.GetLocations("caret").Single();
var expectedMarkdown = $@"{string.Format(FeaturesResources.Awaited_task_returns_0, "`class System.String`")}
";
var results = await RunGetHoverAsync(
testLspServer,
expectedLocation).ConfigureAwait(false);
Assert.Equal(expectedMarkdown, results.Contents.Fourth.Value);
}
private static async Task<LSP.Hover> RunGetHoverAsync(
TestLspServer testLspServer,
LSP.Location caret,
ProjectId projectContext = null)
{
return await testLspServer.ExecuteRequestAsync<LSP.TextDocumentPositionParams, LSP.Hover>(LSP.Methods.TextDocumentHoverName,
CreateTextDocumentPositionParams(caret, projectContext), CancellationToken.None);
}
private static void VerifyVSContent(LSP.Hover hover, string expectedContent)
{
var vsHover = Assert.IsType<LSP.VSInternalHover>(hover);
var containerElement = (ContainerElement)vsHover.RawContent;
using var _ = ArrayBuilder<ClassifiedTextElement>.GetInstance(out var classifiedTextElements);
GetClassifiedTextElements(containerElement, classifiedTextElements);
Assert.False(classifiedTextElements.SelectMany(classifiedTextElements => classifiedTextElements.Runs).Any(run => run.NavigationAction != null));
var content = string.Join("|", classifiedTextElements.Select(cte => string.Join(string.Empty, cte.Runs.Select(ctr => ctr.Text))));
Assert.Equal(expectedContent, content);
}
private static void GetClassifiedTextElements(ContainerElement container, ArrayBuilder<ClassifiedTextElement> classifiedTextElements)
{
foreach (var element in container.Elements)
{
if (element is ClassifiedTextElement classifiedTextElement)
{
classifiedTextElements.Add(classifiedTextElement);
}
else if (element is ContainerElement containerElement)
{
GetClassifiedTextElements(containerElement, classifiedTextElements);
}
}
}
}
}