|
// 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.
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.Completion;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Completion.Providers;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Shared.Extensions;
using Microsoft.CodeAnalysis.Test.Utilities;
using Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion.Data;
using Roslyn.Test.Utilities;
using Roslyn.Utilities;
using Xunit;
using RoslynTrigger = Microsoft.CodeAnalysis.Completion.CompletionTrigger;
namespace Microsoft.CodeAnalysis.Editor.CSharp.UnitTests.Completion.CompletionProviders;
[Trait(Traits.Feature, Traits.Features.Completion)]
public class CrefCompletionProviderTests : AbstractCSharpCompletionProviderTests
{
internal override Type GetCompletionProviderType()
=> typeof(CrefCompletionProvider);
private protected override async Task VerifyWorkerAsync(string code, int position, string expectedItemOrNull,
string expectedDescriptionOrNull, SourceCodeKind sourceCodeKind, bool usePreviousCharAsTrigger, char? deletedCharTrigger,
bool checkForAbsence, int? glyph, int? matchPriority, bool? hasSuggestionItem, string displayTextSuffix,
string displayTextPrefix, string? inlineDescription = null, bool? isComplexTextEdit = null,
List<CompletionFilter>? matchingFilters = null, CompletionItemFlags? flags = null,
CompletionOptions? options = null, bool skipSpeculation = false)
{
await VerifyAtPositionAsync(
code, position, usePreviousCharAsTrigger, deletedCharTrigger, expectedItemOrNull, expectedDescriptionOrNull, sourceCodeKind,
checkForAbsence, glyph, matchPriority, hasSuggestionItem, displayTextSuffix, displayTextPrefix, inlineDescription,
isComplexTextEdit, matchingFilters, flags, options);
await VerifyAtEndOfFileAsync(
code, position, usePreviousCharAsTrigger, deletedCharTrigger, expectedItemOrNull, expectedDescriptionOrNull, sourceCodeKind,
checkForAbsence, glyph, matchPriority, hasSuggestionItem, displayTextSuffix, displayTextPrefix, inlineDescription,
isComplexTextEdit, matchingFilters, flags, options);
// Items cannot be partially written if we're checking for their absence,
// or if we're verifying that the list will show up (without specifying an actual item)
if (!checkForAbsence && expectedItemOrNull != null)
{
await VerifyAtPosition_ItemPartiallyWrittenAsync(
code, position, usePreviousCharAsTrigger, deletedCharTrigger, expectedItemOrNull, expectedDescriptionOrNull,
sourceCodeKind, checkForAbsence, glyph, matchPriority, hasSuggestionItem, displayTextSuffix,
displayTextPrefix, inlineDescription, isComplexTextEdit, matchingFilters, flags: null, options);
await VerifyAtEndOfFile_ItemPartiallyWrittenAsync(
code, position, usePreviousCharAsTrigger, deletedCharTrigger, expectedItemOrNull, expectedDescriptionOrNull,
sourceCodeKind, checkForAbsence, glyph, matchPriority, hasSuggestionItem, displayTextSuffix,
displayTextPrefix, inlineDescription, isComplexTextEdit, matchingFilters, flags: null, options);
}
}
[Fact]
public async Task NameCref()
{
var text = """
using System;
namespace Goo
{
/// <see cref="$$"/>
class Program
{
}
}
""";
await VerifyItemExistsAsync(text, "AccessViolationException");
}
[Fact]
public async Task QualifiedCref()
{
var text = """
using System;
namespace Goo
{
class Program
{
/// <see cref="Program.$$"/>
void goo() { }
}
}
""";
await VerifyItemExistsAsync(text, "goo");
}
[Fact]
public async Task CrefArgumentList()
{
var text = """
using System;
namespace Goo
{
class Program
{
/// <see cref="Program.goo($$"/>
void goo(int i) { }
}
}
""";
await VerifyItemIsAbsentAsync(text, "goo(int)");
await VerifyItemExistsAsync(text, "int");
}
[Fact]
public async Task CrefTypeParameterInArgumentList()
{
var text = """
using System;
namespace Goo
{
class Program<T>
{
/// <see cref="Program{Q}.goo($$"/>
void goo(T i) { }
}
}
""";
await VerifyItemExistsAsync(text, "Q");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/530887")]
public async Task PrivateMember()
{
var text = """
using System;
namespace Goo
{
/// <see cref="C.$$"/>
class Program<T>
{
}
class C
{
private int Private;
public int Public;
}
}
""";
await VerifyItemExistsAsync(text, "Private");
}
[Fact]
public async Task AfterSingleQuote()
{
var text = """
using System;
namespace Goo
{
/// <see cref='$$'/>
class Program
{
}
}
""";
await VerifyItemExistsAsync(text, "Exception");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/531315")]
public async Task EscapePredefinedTypeName()
{
var text = """
using System;
/// <see cref="@vo$$"/>
class @void { }
""";
await VerifyItemExistsAsync(text, "@void");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/598159")]
[WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/531345")]
public async Task ShowParameterNames()
{
var text = """
/// <see cref="C.$$"/>
class C
{
void M(int x) { }
void M(ref long x) { }
void M<T>(T x) { }
}
""";
await VerifyItemExistsAsync(text, "M(int)");
await VerifyItemExistsAsync(text, "M(ref long)");
await VerifyItemExistsAsync(text, "M{T}(T)");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/531345")]
public async Task ShowTypeParameterNames()
{
var text = """
/// <see cref="C$$"/>
class C<TGoo>
{
void M(int x) { }
void M(long x) { }
void M(string x) { }
}
""";
await VerifyItemExistsAsync(text, "C{TGoo}");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/531156")]
public async Task ShowConstructors()
{
var text = """
using System;
/// <see cref="C.$$"/>
class C<T>
{
public C(int x) { }
public C() { }
public C(T x) { }
}
""";
await VerifyItemExistsAsync(text, "C()");
await VerifyItemExistsAsync(text, "C(T)");
await VerifyItemExistsAsync(text, "C(int)");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/598679")]
public async Task NoParamsModifier()
{
var text = """
/// <summary>
/// <see cref="C.$$"/>
/// </summary>
class C
{
void M(int x) { }
void M(params long[] x) { }
}
""";
await VerifyItemExistsAsync(text, "M(long[])");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/607773")]
public async Task UnqualifiedTypes()
{
var text = """
using System.Collections.Generic;
/// <see cref="List{T}.$$"/>
class C { }
""";
await VerifyItemExistsAsync(text, "Enumerator");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/607773")]
public async Task CommitUnqualifiedTypes()
{
var text = """
using System.Collections.Generic;
/// <see cref="List{T}.Enum$$"/>
class C { }
""";
var expected = """
using System.Collections.Generic;
/// <see cref="List{T}.Enumerator "/>
class C { }
""";
await VerifyProviderCommitAsync(text, "Enumerator", expected, ' ');
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/642285")]
public async Task SuggestOperators()
{
var text = """
class Test
{
/// <see cref="$$"/>
public static Test operator !(Test t)
{
return new Test();
}
public static int operator +(Test t1, Test t2) // Invoke FAR here on operator
{
return 1;
}
public static bool operator true(Test t)
{
return true;
}
public static bool operator false(Test t)
{
return false;
}
}
""";
await VerifyItemExistsAsync(text, "operator !(Test)");
await VerifyItemExistsAsync(text, "operator +(Test, Test)");
await VerifyItemExistsAsync(text, "operator true(Test)");
await VerifyItemExistsAsync(text, "operator false(Test)");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/641096")]
public async Task SuggestIndexers()
{
var text = """
/// <see cref="thi$$"/>
class Program
{
int[] arr;
public int this[int i]
{
get { return arr[i]; }
}
}
""";
await VerifyItemExistsAsync(text, "this[int]");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/531315")]
public async Task CommitEscapedPredefinedTypeName()
{
var text = """
using System;
/// <see cref="@vo$$"/>
class @void { }
""";
var expected = """
using System;
/// <see cref="@void "/>
class @void { }
""";
await VerifyProviderCommitAsync(text, "@void", expected, ' ');
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/598159")]
public async Task RefOutModifiers()
{
var text = """
/// <summary>
/// <see cref="C.$$"/>
/// </summary>
class C
{
void M(ref int x) { }
void M(out long x) { }
}
""";
await VerifyItemExistsAsync(text, "M(ref int)");
await VerifyItemExistsAsync(text, "M(out long)");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/673587")]
public async Task NestedNamespaces()
{
var text = """
namespace N
{
class C
{
void sub() { }
}
namespace N
{
class C
{ }
}
}
class Program
{
/// <summary>
/// <see cref="N.$$"/> // type N. here
/// </summary>
static void Main(string[] args)
{
}
}
""";
await VerifyItemExistsAsync(text, "N");
await VerifyItemExistsAsync(text, "C");
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/730338")]
public async Task PermitTypingTypeParameters()
{
var text = """
using System.Collections.Generic;
/// <see cref="List$$"/>
class C { }
""";
var expected = """
using System.Collections.Generic;
/// <see cref="List{"/>
class C { }
""";
await VerifyProviderCommitAsync(text, "List{T}", expected, '{');
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/730338")]
public async Task PermitTypingParameterTypes()
{
var text = """
using System.Collections.Generic;
/// <see cref="goo$$"/>
class C
{
public void goo(int x) { }
}
""";
var expected = """
using System.Collections.Generic;
/// <see cref="goo("/>
class C
{
public void goo(int x) { }
}
""";
await VerifyProviderCommitAsync(text, "goo(int)", expected, '(');
}
[Fact]
public async Task CrefCompletionSpeculatesOutsideTrivia()
{
var text = """
/// <see cref="$$
class C
{
}
""";
using var workspace = EditorTestWorkspace.Create(LanguageNames.CSharp, new CSharpCompilationOptions(OutputKind.ConsoleApplication), new CSharpParseOptions(), [text], composition: GetComposition());
var called = false;
var hostDocument = workspace.DocumentWithCursor;
var document = workspace.CurrentSolution.GetRequiredDocument(hostDocument.Id);
var service = GetCompletionService(document.Project);
var provider = Assert.IsType<CrefCompletionProvider>(service.GetTestAccessor().GetImportedAndBuiltInProviders(ImmutableHashSet<string>.Empty).Single());
provider.GetTestAccessor().SetSpeculativeNodeCallback(n =>
{
// asserts that we aren't be asked speculate on nodes inside documentation trivia.
// This verifies that the provider is asking for a speculative SemanticModel
// by walking to the node the documentation is attached to.
Contract.ThrowIfNull(n);
called = true;
var parent = n.GetAncestor<DocumentationCommentTriviaSyntax>();
Assert.Null(parent);
});
var completionList = await GetCompletionListAsync(service, document, hostDocument.CursorPosition!.Value, RoslynTrigger.Invoke);
Assert.True(called);
}
[Fact, WorkItem("http://vstfdevdiv:8080/DevDiv2/DevDiv/_workitems/edit/16060")]
public async Task SpecialTypeNames()
{
var text = """
using System;
/// <see cref="$$"/>
class C
{
public void goo(int x) { }
}
""";
await VerifyItemExistsAsync(text, "uint");
await VerifyItemExistsAsync(text, "UInt32");
}
[Fact]
public async Task NoSuggestionAfterEmptyCref()
{
var text = """
using System;
/// <see cref="" $$
class C
{
public void goo(int x) { }
}
""";
await VerifyNoItemsExistAsync(text);
}
[Fact, WorkItem("https://github.com/dotnet/roslyn/issues/23957")]
public async Task CRef_InParameter()
{
var text = """
using System;
class C
{
/// <see cref="C.My$$
public void MyMethod(in int x) { }
}
""";
await VerifyItemExistsAsync(text, "MyMethod(in int)");
}
[Fact]
public async Task CRef_RefReadonlyParameter()
{
var text = $$"""
using System;
class C
{
/// <see cref="C.My$$
public void MyMethod(ref readonly int x) { }
}
""";
await VerifyItemExistsAsync(text, "MyMethod(ref readonly int)");
}
[Fact, WorkItem("https://github.com/dotnet/roslyn/issues/22626")]
public async Task ValueTuple1()
{
var text = """
class C
{
/// <summary>
/// <seealso cref="M$$"/>
/// </summary>
public void M((string, int) stringAndInt) { }
}
""";
await VerifyItemExistsAsync(text, "M(ValueTuple{string, int})");
}
[Fact, WorkItem("https://github.com/dotnet/roslyn/issues/22626")]
public async Task ValueTuple2()
{
var text = """
class C
{
/// <summary>
/// <seealso cref="M$$"/>
/// </summary>
public void M((string s, int i) stringAndInt) { }
}
""";
await VerifyItemExistsAsync(text, "M(ValueTuple{string, int})");
}
[Fact, WorkItem("https://github.com/dotnet/roslyn/issues/43139")]
public async Task TestNonOverload1()
{
var text = """
class C
{
/// <summary>
/// <seealso cref="C.$$"/>
/// </summary>
public void M() { }
void Dispose() { }
}
""";
await VerifyItemExistsAsync(text, "Dispose");
}
[Fact, WorkItem("https://github.com/dotnet/roslyn/issues/43139")]
public async Task TestNonOverload2()
{
var text = """
class C
{
/// <summary>
/// <seealso cref="$$"/>
/// </summary>
public void M() { }
void Dispose() { }
}
""";
await VerifyItemExistsAsync(text, "Dispose");
}
[Fact, WorkItem("https://github.com/dotnet/roslyn/issues/43139")]
public async Task TestOverload1()
{
var text = """
class C
{
/// <summary>
/// <seealso cref="C.$$"/>
/// </summary>
public void M() { }
void Dispose() { }
void Dispose(bool b) { }
}
""";
await VerifyItemExistsAsync(text, "Dispose()");
await VerifyItemExistsAsync(text, "Dispose(bool)");
}
[Fact, WorkItem("https://github.com/dotnet/roslyn/issues/43139")]
public async Task TestOverload2()
{
var text = """
class C
{
/// <summary>
/// <seealso cref="$$"/>
/// </summary>
public void M() { }
void Dispose() { }
void Dispose(bool b) { }
}
""";
await VerifyItemExistsAsync(text, "Dispose()");
await VerifyItemExistsAsync(text, "Dispose(bool)");
}
}
|