Skip to content

Fix/prepare rename #379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 3, 2020
Merged

Fix/prepare rename #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
066569c
Added tests for prepare rename
david-driscoll Oct 3, 2020
2d4d716
added rename test
david-driscoll Oct 3, 2020
583517b
Merge branch 'master' into fix/prepare-rename
mergify[bot] Oct 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions src/Protocol/Serialization/Converters/RangeOrPlaceholderRangeConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using System;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using OmniSharp.Extensions.LanguageServer.Protocol.Models;
using Range = OmniSharp.Extensions.LanguageServer.Protocol.Models.Range;

Expand All @@ -13,16 +14,29 @@ public override void WriteJson(JsonWriter writer, RangeOrPlaceholderRange value,
{
serializer.Serialize(writer, value.Range);
}
else
else if (value.IsPlaceholderRange)
{
serializer.Serialize(writer, value.PlaceholderRange);
}
else
{
writer.WriteNull();
}
}

public override RangeOrPlaceholderRange ReadJson(
JsonReader reader, Type objectType, RangeOrPlaceholderRange existingValue, bool hasExistingValue, JsonSerializer serializer
) => new RangeOrPlaceholderRange((Range) null);
)
{
if (reader.TokenType is JsonToken.StartObject)
{
var obj = JToken.ReadFrom(reader) as JObject;
return obj.ContainsKey("placeholder")
? new RangeOrPlaceholderRange(obj.ToObject<PlaceholderRange>())
: new RangeOrPlaceholderRange(obj.ToObject<Range>());
}

public override bool CanRead => false;
return null;
}
}
}
180 changes: 180 additions & 0 deletions test/Lsp.Tests/Integration/RenameTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
using System;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using FluentAssertions;
using NSubstitute;
using OmniSharp.Extensions.JsonRpc.Testing;
using OmniSharp.Extensions.LanguageProtocol.Testing;
using OmniSharp.Extensions.LanguageServer.Client;
using OmniSharp.Extensions.LanguageServer.Protocol;
using OmniSharp.Extensions.LanguageServer.Protocol.Document;
using OmniSharp.Extensions.LanguageServer.Protocol.Models;
using OmniSharp.Extensions.LanguageServer.Server;
using Serilog.Events;
using Xunit;
using Xunit.Abstractions;
using Range = OmniSharp.Extensions.LanguageServer.Protocol.Models.Range;

namespace Lsp.Tests.Integration
{
public class RenameTests : LanguageProtocolTestBase
{
private readonly Func<PrepareRenameParams, CancellationToken, Task<RangeOrPlaceholderRange>> _prepareRename;
private readonly Func<RenameParams, CancellationToken, Task<WorkspaceEdit>> _rename;

public RenameTests(ITestOutputHelper outputHelper) : base(new JsonRpcTestOptions().ConfigureForXUnit(outputHelper, LogEventLevel.Verbose))
{
_prepareRename = Substitute.For<Func<PrepareRenameParams, CancellationToken, Task<RangeOrPlaceholderRange>>>();
_rename = Substitute.For<Func<RenameParams, CancellationToken, Task<WorkspaceEdit>>>();
}

[Fact]
public async Task Should_Handle_Rename_With_No_Value()
{
_prepareRename.Invoke(Arg.Any<PrepareRenameParams>(), Arg.Any<CancellationToken>())
.Returns(
call => {
var pos = call.Arg<PrepareRenameParams>().Position;
return new RangeOrPlaceholderRange(
new Range(
pos,
( pos.Line, pos.Character + 2 )
)
);
}
);

_rename.Invoke(Arg.Any<RenameParams>(), Arg.Any<CancellationToken>())
.Returns(
new WorkspaceEdit() {
DocumentChanges = new Container<WorkspaceEditDocumentChange>(new WorkspaceEditDocumentChange(new CreateFile() {
Uri = DocumentUri.FromFileSystemPath("/abcd/create.cs")
}))
}
);

var (client, server) = await Initialize(ClientOptionsAction, ServerOptionsAction);

var result = await client.PrepareRename(
new PrepareRenameParams() {
Position = ( 1, 1 ),
TextDocument = DocumentUri.FromFileSystemPath("/abcd/file.cs")
},
CancellationToken
);

result.Should().NotBeNull();

var renameResponse = await client.RequestRename(
new RenameParams() {
Position = result.Range.Start,
NewName = "newname",
TextDocument = DocumentUri.FromFileSystemPath("/abcd/file.cs")
}
);

renameResponse.DocumentChanges.Should().HaveCount(1);
renameResponse.DocumentChanges.Should().Match(z => z.Any(x => x.IsCreateFile));
}

[Fact]
public async Task Should_Handle_Prepare_Rename_With_No_Value()
{
_prepareRename.Invoke(Arg.Any<PrepareRenameParams>(), Arg.Any<CancellationToken>())
.Returns(Task.FromResult<RangeOrPlaceholderRange>(null));
var (client, server) = await Initialize(ClientOptionsAction, ServerOptionsAction);

var result = await client.PrepareRename(
new PrepareRenameParams() {
Position = ( 1, 1 ),
TextDocument = DocumentUri.FromFileSystemPath("/abcd/file.cs")
},
CancellationToken
);

result.Should().BeNull();
}

[Fact]
public async Task Should_Handle_Prepare_Rename_With_Range()
{
_prepareRename.Invoke(Arg.Any<PrepareRenameParams>(), Arg.Any<CancellationToken>())
.Returns(
call => {
var pos = call.Arg<PrepareRenameParams>().Position;
return new RangeOrPlaceholderRange(
new Range(
pos,
( pos.Line, pos.Character + 2 )
)
);
}
);

var (client, server) = await Initialize(ClientOptionsAction, ServerOptionsAction);

var result = await client.PrepareRename(
new PrepareRenameParams() {
Position = ( 1, 1 ),
TextDocument = DocumentUri.FromFileSystemPath("/abcd/file.cs")
},
CancellationToken
);

result.IsRange.Should().BeTrue();
}

[Fact]
public async Task Should_Handle_Prepare_Rename_With_PlaceholderRange()
{
_prepareRename.Invoke(Arg.Any<PrepareRenameParams>(), Arg.Any<CancellationToken>())
.Returns(
call => {
var pos = call.Arg<PrepareRenameParams>().Position;
return new RangeOrPlaceholderRange(
new PlaceholderRange() {
Range =
new Range(
pos,
( pos.Line, pos.Character + 2 )
),
Placeholder = "Bogus"
}
);
}
);

var (client, server) = await Initialize(ClientOptionsAction, ServerOptionsAction);

var result = await client.PrepareRename(
new PrepareRenameParams() {
Position = ( 1, 1 ),
TextDocument = DocumentUri.FromFileSystemPath("/abcd/file.cs")
},
CancellationToken
);

result.IsPlaceholderRange.Should().BeTrue();
}

private void ServerOptionsAction(LanguageServerOptions obj)
{
obj.OnPrepareRename(
_prepareRename, new TextDocumentRegistrationOptions() {
DocumentSelector = DocumentSelector.ForLanguage("csharp")
}
);
obj.OnRename(
_rename, new RenameRegistrationOptions() {
DocumentSelector = DocumentSelector.ForLanguage("csharp"),
PrepareProvider = true
}
);
}

private void ClientOptionsAction(LanguageClientOptions obj)
{
}
}
}