// // Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. // using System; using System.IO; using System.Collections.Generic; using System.Threading; using System.Threading.Tasks; using System.Runtime.InteropServices; using Microsoft.SqlServer.Management.Common; using Microsoft.SqlServer.Management.SqlParser.Binder; using Microsoft.SqlServer.Management.SqlParser.Intellisense; using Microsoft.SqlServer.Management.SqlParser.MetadataProvider; using Microsoft.SqlServer.Management.SqlParser.Parser; using Microsoft.SqlTools.ServiceLayer.Connection; using Microsoft.SqlTools.ServiceLayer.Hosting.Protocol; using Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts; using Microsoft.SqlTools.ServiceLayer.LanguageServices; using Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts; using Microsoft.SqlTools.ServiceLayer.SqlContext; using Microsoft.SqlTools.ServiceLayer.QueryExecution; using Microsoft.SqlTools.ServiceLayer.Test.QueryExecution; using Microsoft.SqlTools.ServiceLayer.Workspace; using Microsoft.SqlTools.ServiceLayer.Workspace.Contracts; using Microsoft.SqlTools.Test.Utility; using Moq; using Xunit; using Location = Microsoft.SqlTools.ServiceLayer.Workspace.Contracts.Location; namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.LanguageServices { /// /// Tests for the language service peek definition/ go to definition feature /// public class PeekDefinitionTests { private const int TaskTimeout = 30000; private readonly string testScriptUri = TestObjects.ScriptUri; private readonly string testConnectionKey = "testdbcontextkey"; private Mock bindingQueue; private Mock> workspaceService; private Mock> requestContext; private Mock binder; private TextDocumentPosition textDocument; private const string OwnerUri = "testFile1"; /// /// Test get definition for a table object with active connection /// [Fact] public void GetValidTableDefinitionTest() { // Get live connectionInfo and serverConnection ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "spt_monitor"; string schemaName = null; string objectType = "TABLE"; // Get locations for valid table object Location[] locations = peekDefinition.GetSqlObjectDefinition(peekDefinition.GetTableScripts, objectName, schemaName, objectType); Assert.NotNull(locations); Cleanup(locations); } /// /// Test get definition for a invalid table object with active connection /// [Fact] public void GetTableDefinitionInvalidObjectTest() { // Get live connectionInfo and serverConnection ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "test_invalid"; string schemaName = null; string objectType = "TABLE"; // Get locations for invalid table object Location[] locations = peekDefinition.GetSqlObjectDefinition(peekDefinition.GetTableScripts, objectName, schemaName, objectType); Assert.Null(locations); } /// /// Test get definition for a valid table object with schema and active connection /// [Fact] public void GetTableDefinitionWithSchemaTest() { // Get live connectionInfo and serverConnection ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "spt_monitor"; string schemaName = "dbo"; string objectType = "TABLE"; // Get locations for valid table object with schema name Location[] locations = peekDefinition.GetSqlObjectDefinition(peekDefinition.GetTableScripts, objectName, schemaName, objectType); Assert.NotNull(locations); Cleanup(locations); } /// /// Test GetDefinition with an unsupported type(schema - dbo). Expect a error result. /// [Fact] public void GetUnsupportedDefinitionErrorTest() { ScriptFile scriptFile; TextDocumentPosition textDocument = new TextDocumentPosition { TextDocument = new TextDocumentIdentifier { Uri = OwnerUri }, Position = new Position { Line = 0, // test for 'dbo' Character = 16 } }; ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfo(out scriptFile); scriptFile.Contents = "select * from dbo.func ()"; var languageService = new LanguageService(); ScriptParseInfo scriptInfo = new ScriptParseInfo { IsConnected = true }; languageService.ScriptParseInfoMap.Add(OwnerUri, scriptInfo); // When I call the language service var result = languageService.GetDefinition(textDocument, scriptFile, connInfo); // Then I expect null locations and an error to be reported Assert.NotNull(result); Assert.True(result.IsErrorResult); } /// /// Get Definition for a object with no definition. Expect a error result /// [Fact] public void GetDefinitionWithNoResultsFoundError() { ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "from"; List declarations = new List(); DefinitionResult result = peekDefinition.GetScript(declarations, objectName, null); Assert.NotNull(result); Assert.True(result.IsErrorResult); Assert.Equal(SR.PeekDefinitionNoResultsError, result.Message); } /// /// Test GetDefinition with a forced timeout. Expect a error result. /// [Fact] public void GetDefinitionTimeoutTest() { // Given a binding queue that will automatically time out var languageService = new LanguageService(); Mock queueMock = new Mock(); languageService.BindingQueue = queueMock.Object; ManualResetEvent mre = new ManualResetEvent(true); // Do not block Mock itemMock = new Mock(); itemMock.Setup(i => i.ItemProcessed).Returns(mre); DefinitionResult timeoutResult = null; queueMock.Setup(q => q.QueueBindingOperation( It.IsAny(), It.IsAny>(), It.IsAny>(), It.IsAny(), It.IsAny())) .Callback, Func, int?, int?>( (key, bindOperation, timeoutOperation, blah, blah2) => { timeoutResult = (DefinitionResult) timeoutOperation((IBindingContext)null); itemMock.Object.Result = timeoutResult; }) .Returns(() => itemMock.Object); ScriptFile scriptFile; TextDocumentPosition textDocument = new TextDocumentPosition { TextDocument = new TextDocumentIdentifier { Uri = OwnerUri }, Position = new Position { Line = 0, Character = 20 } }; ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfo(out scriptFile); scriptFile.Contents = "select * from dbo.func ()"; ScriptParseInfo scriptInfo = new ScriptParseInfo { IsConnected = true }; languageService.ScriptParseInfoMap.Add(OwnerUri, scriptInfo); // When I call the language service var result = languageService.GetDefinition(textDocument, scriptFile, connInfo); // Then I expect null locations and an error to be reported Assert.NotNull(result); Assert.True(result.IsErrorResult); // Check timeout message Assert.Equal(SR.PeekDefinitionTimedoutError, result.Message); } /// /// Test get definition for a view object with active connection /// [Fact] public void GetValidViewDefinitionTest() { ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "objects"; string schemaName = "sys"; string objectType = "VIEW"; Location[] locations = peekDefinition.GetSqlObjectDefinition(peekDefinition.GetViewScripts, objectName, schemaName, objectType); Assert.NotNull(locations); Cleanup(locations); } /// /// Test get definition for an invalid view object with no schema name and with active connection /// [Fact] public void GetViewDefinitionInvalidObjectTest() { // Get live connectionInfo and serverConnection ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "objects"; string schemaName = null; string objectType = "VIEW"; Location[] locations = peekDefinition.GetSqlObjectDefinition(peekDefinition.GetViewScripts, objectName, schemaName, objectType); Assert.Null(locations); } /// /// Test get definition for a stored procedure object with active connection /// [Fact] public void GetStoredProcedureDefinitionTest() { // Get live connectionInfo and serverConnection ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "sp_MSrepl_startup"; string schemaName = "dbo"; string objectType = "PROCEDURE"; Location[] locations = peekDefinition.GetSqlObjectDefinition(peekDefinition.GetStoredProcedureScripts, objectName, schemaName, objectType); Assert.NotNull(locations); Cleanup(locations); } /// /// Test get definition for a stored procedure object that does not exist with active connection /// [Fact] public void GetStoredProcedureDefinitionFailureTest() { // Get live connectionInfo and serverConnection ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "SP2"; string schemaName = "dbo"; string objectType = "PROCEDURE"; Location[] locations = peekDefinition.GetSqlObjectDefinition(peekDefinition.GetStoredProcedureScripts, objectName, schemaName, objectType); Assert.Null(locations); } /// /// Test get definition for a stored procedure object with active connection and no schema /// [Fact] public void GetStoredProcedureDefinitionWithoutSchemaTest() { // Get live connectionInfo and serverConnection ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "sp_MSrepl_startup"; string schemaName = null; string objectType = "PROCEDURE"; Location[] locations = peekDefinition.GetSqlObjectDefinition(peekDefinition.GetStoredProcedureScripts, objectName, schemaName, objectType); Assert.NotNull(locations); Cleanup(locations); } /// /// Helper method to clean up script files /// private void Cleanup(Location[] locations) { Uri fileUri = new Uri(locations[0].Uri); if (File.Exists(fileUri.LocalPath)) { try { File.Delete(fileUri.LocalPath); } catch(Exception) { } } } } }