Add client test for "textDocument/hover".

Author: tintoy

src/Client/Processes/NamedPipeServerProcess.cs

@@ -91,10 +91,10 @@ public override async Task Start()
         {
             ServerExitCompletion = new TaskCompletionSource<object>();
 
-            ServerInputStream = new NamedPipeServerStream(BaseName + "/in", PipeDirection.Out, 2, PipeTransmissionMode.Byte, PipeOptions.Asynchronous, inBufferSize: 1024, outBufferSize: 1024);
-            ServerOutputStream = new NamedPipeServerStream(BaseName + "/out", PipeDirection.In, 2, PipeTransmissionMode.Byte, PipeOptions.Asynchronous, inBufferSize: 1024, outBufferSize: 1024);
-            ClientInputStream = new NamedPipeClientStream(".", BaseName + "/out", PipeDirection.Out, PipeOptions.Asynchronous);
-            ClientOutputStream = new NamedPipeClientStream(".", BaseName + "/in", PipeDirection.In, PipeOptions.Asynchronous);
+            ServerInputStream = new NamedPipeServerStream(BaseName + "_in", PipeDirection.Out, 2, PipeTransmissionMode.Byte, PipeOptions.Asynchronous, inBufferSize: 1024, outBufferSize: 1024);
+            ServerOutputStream = new NamedPipeServerStream(BaseName + "_out", PipeDirection.In, 2, PipeTransmissionMode.Byte, PipeOptions.Asynchronous, inBufferSize: 1024, outBufferSize: 1024);
+            ClientInputStream = new NamedPipeClientStream(".", BaseName + "_out", PipeDirection.Out, PipeOptions.Asynchronous);
+            ClientOutputStream = new NamedPipeClientStream(".", BaseName + "_in", PipeDirection.In, PipeOptions.Asynchronous);
 
             // Ensure all pipes are connected before proceeding.
             await Task.WhenAll(

test/Client.Tests/ClientTests.cs

@@ -0,0 +1,144 @@
+using Microsoft.Extensions.Logging;
+using OmniSharp.Extensions.LanguageServer.Capabilities.Server;
+using OmniSharp.Extensions.LanguageServer.Models;
+using OmniSharp.Extensions.LanguageServerProtocol.Client.Dispatcher;
+using OmniSharp.Extensions.LanguageServerProtocol.Client.Protocol;
+using OmniSharp.Extensions.LanguageServerProtocol.Client.Utilities;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace OmniSharp.Extensions.LanguageServerProtocol.Client.Tests
+{
+    /// <summary>
+    ///     Tests for <see cref="LanguageClient"/>.
+    /// </summary>
+    public class ClientTests
+        : PipeServerTestBase
+    {
+        /// <summary>
+        ///     Create a new <see cref="LanguageClient"/> test suite.
+        /// </summary>
+        /// <param name="testOutput">
+        ///     Output for the current test.
+        /// </param>
+        public ClientTests(ITestOutputHelper testOutput)
+            : base(testOutput)
+        {
+        }
+
+        /// <summary>
+        ///     Get an absolute document path for use in tests.
+        /// </summary>
+        string AbsoluteDocumentPath => Path.DirectorySeparatorChar + "Foo.txt"; // Absolute path, cross-platform compatible.
+
+        /// <summary>
+        ///     The <see cref="LanguageClient"/> under test.
+        /// </summary>
+        LanguageClient LanguageClient { get; set; }
+
+        /// <summary>
+        ///     The server-side dispatcher.
+        /// </summary>
+        LspDispatcher ServerDispatcher { get; } = new LspDispatcher();
+
+        /// <summary>
+        ///     The server-side connection.
+        /// </summary>
+        LspConnection ServerConnection { get; set; }
+
+        /// <summary>
+        ///     Ensure that the language client can successfully request Hover information.
+        /// </summary>
+        [Fact(DisplayName = "Language client can successfully request hover info")]
+        public async Task Hover_Success()
+        {
+            await Connect();
+
+            const int line = 5;
+            const int column = 5;
+            var expectedHoverContent = new MarkedStringContainer("123", "456", "789");
+
+            ServerDispatcher.HandleRequest<TextDocumentPositionParams, Hover>("textDocument/hover", (request, cancellationToken) =>
+            {
+                Assert.NotNull(request.TextDocument);
+
+                Assert.Equal(AbsoluteDocumentPath,
+                    DocumentUri.GetFileSystemPath(request.TextDocument.Uri)
+                );
+
+                Assert.Equal(line, request.Position.Line);
+                Assert.Equal(column, request.Position.Character);
+
+                return Task.FromResult(new Hover
+                {
+                    Contents = expectedHoverContent,
+                    Range = new Range
+                    {
+                        Start = request.Position,
+                        End = request.Position
+                    }
+                });
+            });
+
+            Hover hover = await LanguageClient.TextDocument.Hover(AbsoluteDocumentPath, line, column);
+
+            Assert.NotNull(hover.Range);
+            Assert.NotNull(hover.Range.Start);
+            Assert.NotNull(hover.Range.End);
+
+            Assert.Equal(line, hover.Range.Start.Line);
+            Assert.Equal(column, hover.Range.Start.Character);
+
+            Assert.Equal(line, hover.Range.End.Line);
+            Assert.Equal(column, hover.Range.End.Character);
+
+            Assert.NotNull(hover.Contents);
+            Assert.Equal(expectedHoverContent.Select(markedString => markedString.Value),
+                hover.Contents.Select(
+                    markedString => markedString.Value
+                )
+            );
+        }
+
+        /// <summary>
+        ///     Connect the client and server.
+        /// </summary>
+        /// <param name="handleServerInitialize">
+        ///     Add standard handlers for server initialisation?
+        /// </param>
+        async Task Connect(bool handleServerInitialize = true)
+        {
+            ServerConnection = await CreateServerConnection();
+            ServerConnection.Connect(ServerDispatcher);
+
+            if (handleServerInitialize)
+                HandleServerInitialize();
+
+            LanguageClient = await CreateClient(initialize: true);
+        }
+
+        /// <summary>
+        ///     Add standard handlers for sever initialisation.
+        /// </summary>
+        void HandleServerInitialize()
+        {
+            ServerDispatcher.HandleRequest<InitializeParams, InitializeResult>("initialize", (request, cancellationToken) =>
+            {
+                return Task.FromResult(new InitializeResult
+                {
+                    Capabilities = new ServerCapabilities
+                    {
+                        HoverProvider = true
+                    }
+                });
+            });
+            ServerDispatcher.HandleEmptyNotification("initialized", () =>
+            {
+                Log.LogInformation("Server initialized.");
+            });
+        }
+    }
+}

test/Client.Tests/Logging/TestOutputLogger.cs

@@ -113,7 +113,16 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except
             if (exception != null)
                 message += "\n" + exception.ToString();
 
-            _testOutput.WriteLine(message);
+            try
+            {
+                _testOutput.WriteLine(message);
+            }
+            catch (InvalidOperationException)
+            {
+                // Test has already terminated.
+
+                System.Diagnostics.Debug.WriteLine(message);
+            }
         }
     }
 }