// // 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.Data.Common; using System.IO; using System.Threading; using System.Threading.Tasks; using Microsoft.SqlServer.Management.Common; using Microsoft.SqlServer.Management.SqlParser.Intellisense; using Microsoft.SqlTools.ServiceLayer.Connection; using Microsoft.SqlTools.ServiceLayer.LanguageServices; using Microsoft.SqlTools.ServiceLayer.Test.Common; using Microsoft.SqlTools.ServiceLayer.Workspace.Contracts; using Microsoft.SqlTools.Test.Utility; using Moq; using Xunit; using ConnectionType = Microsoft.SqlTools.ServiceLayer.Connection.ConnectionType; 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 string OwnerUri = "testFile1"; private const string ReturnTableFunctionName = "pd_returnTable"; private const string ReturnTableTableFunctionQuery = @" CREATE FUNCTION [dbo].[" + ReturnTableFunctionName + @"] () RETURNS TABLE AS RETURN ( select * from master.dbo.spt_monitor ); GO"; private const string AddTwoFunctionName = "pd_addTwo"; private const string AddTwoFunctionQuery = @" CREATE FUNCTION[dbo].[" + AddTwoFunctionName + @"](@number int) RETURNS int AS BEGIN RETURN @number + 2; END; GO"; private const string SsnTypeName = "pd_ssn"; private const string SsnTypeQuery = @" CREATE TYPE [dbo].[" + SsnTypeName + @"] FROM [varchar](11) NOT NULL GO"; private const string LocationTableTypeName = "pd_locationTableType"; private const string LocationTableTypeQuery = @" CREATE TYPE [dbo].[" + LocationTableTypeName + @"] AS TABLE( [LocationName] [varchar](50) NULL, [CostRate] [int] NULL ) GO"; private const string TestTableSynonymName = "pd_testTable"; private const string TestTableSynonymQuery = @" CREATE SYNONYM [dbo].[pd_testTable] FOR master.dbo.spt_monitor GO"; private const string TableValuedFunctionTypeName = "TableValuedFunction"; private const string ScalarValuedFunctionTypeName = "ScalarValuedFunction"; private const string UserDefinedDataTypeTypeName = "UserDefinedDataType"; private const string UserDefinedTableTypeTypeName = "UserDefinedTableType"; private const string SynonymTypeName = "Synonym"; private const string StoredProcedureTypeName = "StoredProcedure"; private const string ViewTypeName = "View"; private const string TableTypeName = "Table"; /// /// 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 async Task GetUnsupportedDefinitionErrorTest() { ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "objects"; string schemaName = "sys"; // When I try to get definition for 'Collation' DefinitionResult result = peekDefinition.GetDefinitionUsingDeclarationType(DeclarationType.Collation, "master.sys.objects", objectName, schemaName); // Then I expect non null result with error flag set 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"; Position position = new Position() { Line = 1, Character = 14 }; ScriptParseInfo scriptParseInfo = new ScriptParseInfo() { IsConnected = true }; Mock bindingContextMock = new Mock(); DefinitionResult result = peekDefinition.GetScript(scriptParseInfo.ParseResult, position, bindingContextMock.Object.MetadataDisplayInfoProvider, 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, t1, t2) => { timeoutResult = (DefinitionResult)timeoutOperation((IBindingContext)null); itemMock.Object.Result = timeoutResult; }) .Returns(() => itemMock.Object); TextDocumentPosition textDocument = new TextDocumentPosition { TextDocument = new TextDocumentIdentifier { Uri = OwnerUri }, Position = new Position { Line = 0, Character = 20 } }; TestConnectionResult connectionResult = TestObjects.InitLiveConnectionInfo(); ScriptFile scriptFile = connectionResult.ScriptFile; ConnectionInfo connInfo = connectionResult.ConnectionInfo; 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); } /// /// Test get definition for a scalar valued function object with active connection and explicit schema name. Expect non-null locations /// [Fact] public void GetScalarValuedFunctionDefinitionWithSchemaNameSuccessTest() { ExecuteAndValidatePeekTest(AddTwoFunctionQuery, AddTwoFunctionName, ScalarValuedFunctionTypeName); } private void ExecuteAndValidatePeekTest(string query, string objectName, string objectType, string schemaName = "dbo") { if (!string.IsNullOrEmpty(query)) { using (SqlTestDb testDb = SqlTestDb.CreateNew(TestServerType.OnPrem, query)) { ValidatePeekTest(testDb.DatabaseName, objectName, objectType, schemaName, true); } } else { ValidatePeekTest(null, objectName, objectType, schemaName, false); } } private void ValidatePeekTest(string databaseName, string objectName, string objectType, string schemaName, bool shouldReturnValidResult) { // Get live connectionInfo and serverConnection ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(databaseName); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); PeekDefinition.ScriptGetter sqlScriptGetter = null; switch (objectType) { case SynonymTypeName: sqlScriptGetter = peekDefinition.GetSynonymScripts; break; case ScalarValuedFunctionTypeName: sqlScriptGetter = peekDefinition.GetScalarValuedFunctionScripts; objectType = "Function"; break; case TableValuedFunctionTypeName: sqlScriptGetter = peekDefinition.GetTableValuedFunctionScripts; objectType = "Function"; break; case TableTypeName: sqlScriptGetter = peekDefinition.GetTableScripts; break; case ViewTypeName: sqlScriptGetter = peekDefinition.GetViewScripts; break; case StoredProcedureTypeName: sqlScriptGetter = peekDefinition.GetStoredProcedureScripts; break; case UserDefinedDataTypeTypeName: sqlScriptGetter = peekDefinition.GetUserDefinedDataTypeScripts; objectType = "Type"; break; case UserDefinedTableTypeTypeName: sqlScriptGetter = peekDefinition.GetUserDefinedTableTypeScripts; objectType = "Type"; break; } Location[] locations = peekDefinition.GetSqlObjectDefinition(sqlScriptGetter, objectName, schemaName, objectType); if (shouldReturnValidResult) { Assert.NotNull(locations); Cleanup(locations); } else { Assert.Null(locations); } } /// /// Test get definition for a table valued function object with active connection and explicit schema name. Expect non-null locations /// [Fact] public void GetTableValuedFunctionDefinitionWithSchemaNameSuccessTest() { ExecuteAndValidatePeekTest(ReturnTableTableFunctionQuery, ReturnTableFunctionName, TableValuedFunctionTypeName); } /// /// Test get definition for a scalar valued function object that doesn't exist with active connection. Expect null locations /// [Fact] public void GetScalarValuedFunctionDefinitionWithNonExistentFailureTest() { string objectName = "doesNotExist"; string schemaName = "dbo"; string objectType = ScalarValuedFunctionTypeName; ExecuteAndValidatePeekTest(null, objectName, objectType, schemaName); } /// /// Test get definition for a table valued function object that doesn't exist with active connection. Expect null locations /// [Fact] public void GetTableValuedFunctionDefinitionWithNonExistentObjectFailureTest() { string objectName = "doesNotExist"; string schemaName = "dbo"; string objectType = TableValuedFunctionTypeName; ExecuteAndValidatePeekTest(null, objectName, objectType, schemaName); } /// /// Test get definition for a scalar valued function object with active connection. Expect non-null locations /// [Fact] public void GetScalarValuedFunctionDefinitionWithoutSchemaNameSuccessTest() { ExecuteAndValidatePeekTest(AddTwoFunctionQuery, AddTwoFunctionName, ScalarValuedFunctionTypeName, null); } /// /// Test get definition for a table valued function object with active connection. Expect non-null locations /// [Fact] public void GetTableValuedFunctionDefinitionWithoutSchemaNameSuccessTest() { ExecuteAndValidatePeekTest(ReturnTableTableFunctionQuery, ReturnTableFunctionName, TableValuedFunctionTypeName, null); } /// /// Test get definition for a user defined data type object with active connection and explicit schema name. Expect non-null locations /// [Fact] public void GetUserDefinedDataTypeDefinitionWithSchemaNameSuccessTest() { ExecuteAndValidatePeekTest(SsnTypeQuery, SsnTypeName, UserDefinedDataTypeTypeName); } /// /// Test get definition for a user defined data type object with active connection. Expect non-null locations /// [Fact] public void GetUserDefinedDataTypeDefinitionWithoutSchemaNameSuccessTest() { ExecuteAndValidatePeekTest(SsnTypeQuery, SsnTypeName, UserDefinedDataTypeTypeName, null); } /// /// Test get definition for a user defined data type object that doesn't exist with active connection. Expect null locations /// [Fact] public void GetUserDefinedDataTypeDefinitionWithNonExistentFailureTest() { string objectName = "doesNotExist"; string schemaName = "dbo"; string objectType = UserDefinedDataTypeTypeName; ExecuteAndValidatePeekTest(null, objectName, objectType, schemaName); } /// /// Test get definition for a user defined table type object with active connection and explicit schema name. Expect non-null locations /// [Fact] public void GetUserDefinedTableTypeDefinitionWithSchemaNameSuccessTest() { ExecuteAndValidatePeekTest(LocationTableTypeQuery, LocationTableTypeName, UserDefinedTableTypeTypeName); } /// /// Test get definition for a user defined table type object with active connection. Expect non-null locations /// [Fact] public void GetUserDefinedTableTypeDefinitionWithoutSchemaNameSuccessTest() { ExecuteAndValidatePeekTest(LocationTableTypeQuery, LocationTableTypeName, UserDefinedTableTypeTypeName, null); } /// /// Test get definition for a user defined table type object that doesn't exist with active connection. Expect null locations /// [Fact] public void GetUserDefinedTableTypeDefinitionWithNonExistentFailureTest() { string objectName = "doesNotExist"; string schemaName = "dbo"; string objectType = UserDefinedTableTypeTypeName; ExecuteAndValidatePeekTest(null, objectName, objectType, schemaName); } /// /// Test get definition for a synonym object with active connection and explicit schema name. Expect non-null locations /// [Fact] public void GetSynonymDefinitionWithSchemaNameSuccessTest() { ExecuteAndValidatePeekTest(TestTableSynonymQuery, TestTableSynonymName, SynonymTypeName); } /// /// Test get definition for a Synonym object with active connection. Expect non-null locations /// [Fact] public void GetSynonymDefinitionWithoutSchemaNameSuccessTest() { ExecuteAndValidatePeekTest(TestTableSynonymQuery, TestTableSynonymName, SynonymTypeName, null); } /// /// Test get definition for a Synonym object that doesn't exist with active connection. Expect null locations /// [Fact] public void GetSynonymDefinitionWithNonExistentFailureTest() { string objectName = "doesNotExist"; string schemaName = "dbo"; string objectType = "Synonym"; ExecuteAndValidatePeekTest(null, objectName, objectType, schemaName); } /// /// Test get definition using declaration type for a view object with active connection /// Expect a non-null result with location /// [Fact] public void GetDefinitionUsingDeclarationTypeWithValidObjectTest() { ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "objects"; string schemaName = "sys"; DefinitionResult result = peekDefinition.GetDefinitionUsingDeclarationType(DeclarationType.View, "master.sys.objects", objectName, schemaName); Assert.NotNull(result); Assert.NotNull(result.Locations); Assert.False(result.IsErrorResult); Cleanup(result.Locations); } /// /// Test get definition using declaration type for a non existent view object with active connection /// Expect a non-null result with location /// [Fact] public void GetDefinitionUsingDeclarationTypeWithNonexistentObjectTest() { ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "doesNotExist"; string schemaName = "sys"; DefinitionResult result = peekDefinition.GetDefinitionUsingDeclarationType(DeclarationType.View, "master.sys.objects", objectName, schemaName); Assert.NotNull(result); Assert.True(result.IsErrorResult); } /// /// Test get definition using quickInfo text for a view object with active connection /// Expect a non-null result with location /// [Fact] public void GetDefinitionUsingQuickInfoTextWithValidObjectTest() { ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "objects"; string schemaName = "sys"; string quickInfoText = "view master.sys.objects"; DefinitionResult result = peekDefinition.GetDefinitionUsingQuickInfoText(quickInfoText, objectName, schemaName); Assert.NotNull(result); Assert.NotNull(result.Locations); Assert.False(result.IsErrorResult); Cleanup(result.Locations); } /// /// Test get definition using quickInfo text for a view object with active connection /// Expect a non-null result with location /// [Fact] public void GetDefinitionUsingQuickInfoTextWithNonexistentObjectTest() { ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); string objectName = "doesNotExist"; string schemaName = "sys"; string quickInfoText = "view master.sys.objects"; DefinitionResult result = peekDefinition.GetDefinitionUsingQuickInfoText(quickInfoText, objectName, schemaName); Assert.NotNull(result); Assert.True(result.IsErrorResult); } /// /// Test if peek definition default database name is the default server connection database name /// Given that there is no query connection /// Expect database name to be "master" /// [Fact] public void GetDatabaseWithNoQueryConnectionTest() { ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); DbConnection connection; //Check if query connection is present Assert.False(connInfo.TryGetConnection(ConnectionType.Query, out connection)); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); //Check if database name is the default server connection database name Assert.Equal(peekDefinition.Database.Name, "master"); } /// /// Test if the peek definition database name changes to the query connection database name /// Give that there is a query connection /// Expect database name to be query connection's database name /// [Fact] public void GetDatabaseWithQueryConnectionTest() { ConnectionInfo connInfo = TestObjects.InitLiveConnectionInfoForDefinition(); ServerConnection serverConnection = TestObjects.InitLiveServerConnectionForDefinition(connInfo); //Mock a query connection object var mockQueryConnection = new Mock { CallBase = true }; mockQueryConnection.SetupGet(x => x.Database).Returns("testdb"); connInfo.ConnectionTypeToConnectionMap[ConnectionType.Query] = mockQueryConnection.Object; DbConnection connection; //Check if query connection is present Assert.True(connInfo.TryGetConnection(ConnectionType.Query, out connection)); PeekDefinition peekDefinition = new PeekDefinition(serverConnection, connInfo); //Check if database name is the database name in the query connection Assert.Equal(peekDefinition.Database.Name, "testdb"); // remove mock from ConnectionInfo Assert.True(connInfo.ConnectionTypeToConnectionMap.TryRemove(ConnectionType.Query, out connection)); } /// /// 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) { } } } } }