Isolate Shared Test Code (#252)

The goal of this make sure that test code is correctly organized to ensure that test suites aren't dependent on each other. * UnitTests get their own project now (renaming Microsoft.SqlTools.ServiceLayer.Test to Microsoft.SqlTools.ServiceLayer.UnitTests) which is about 90% of the changes to the files. * IntegrationTests no longer depends on UnitTests, only Test.Common * Any shared components from TestObjects that spins up a "live" connection has been moved to IntegrationTests Utility/LiveConnectionHelper.cs * The dictionary-based mock file stream factory has been moved to Test.Common since it is used by UnitTests and IntegrationTests * Added a overload that doesn't take a dictionary for when we don't care about monitoring the storage (about 90% of the time) * The RunIf* wrapper methods have been moved to Test.Common * OwnerUri and StandardQuery constants have been moved to Test.Common Constants file * Updating to latest SDK version available at https://www.microsoft.com/net/core#windowscmd * Moving unit tests to unit test folder * Changing namespaces to UnitTests * Moving some constants and shared functionality into common project, making the UnitTests reference it * Unit tests are working! * Integration tests are working * Updating automated test runs * Fixing one last broken unit test * Exposing internals for other projects * Moving edit data tests to UnitTest project * Applying refactor fixes to unit tests * Fixing flaky test that wasn't awaiting completion
2026-01-14 01:25:40 -05:00 · 2017-03-02 13:00:31 -08:00
parent f9abe5f0bd
commit 1166778249
110 changed files with 700 additions and 764 deletions
--- a/test/Microsoft.SqlTools.ServiceLayer.UnitTests/LanguageServer/LanguageServiceTests.cs
+++ b/test/Microsoft.SqlTools.ServiceLayer.UnitTests/LanguageServer/LanguageServiceTests.cs
@@ -0,0 +1,220 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using Microsoft.SqlTools.ServiceLayer.LanguageServices;
+using Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion;
+using Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts;
+using Microsoft.SqlTools.ServiceLayer.UnitTests.Utility;
+using Microsoft.SqlTools.ServiceLayer.Workspace.Contracts;
+using Xunit;
+
+namespace Microsoft.SqlTools.ServiceLayer.UnitTests.LanguageServer
+{
+    /// <summary>
+    /// Tests for the ServiceHost Language Service tests
+    /// </summary>
+    public class LanguageServiceTests
+    {
+        /// <summary>
+        /// Verify that the latest SqlParser (2016 as of this writing) is used by default
+        /// </summary>
+        [Fact]
+        public void LatestSqlParserIsUsedByDefault()
+        {
+            // This should only parse correctly on SQL server 2016 or newer
+            const string sql2016Text = 
+                @"CREATE SECURITY POLICY [FederatedSecurityPolicy]" + "\r\n" +
+                @"ADD FILTER PREDICATE [rls].[fn_securitypredicate]([CustomerId])" + "\r\n" +   
+                @"ON [dbo].[Customer];";
+            
+            LanguageService service = TestObjects.GetTestLanguageService();
+
+            // parse
+            var scriptFile = new ScriptFile();
+            scriptFile.SetFileContents(sql2016Text);
+            ScriptFileMarker[] fileMarkers = service.GetSemanticMarkers(scriptFile);
+
+            // verify that no errors are detected
+            Assert.Equal(0, fileMarkers.Length);
+        }
+
+        /// <summary>
+        /// Verify that the SQL parser correctly detects errors in text
+        /// </summary>
+        [Fact]
+        public void ParseSelectStatementWithoutErrors()
+        {
+            // sql statement with no errors
+            const string sqlWithErrors = "SELECT * FROM sys.objects";
+
+            // get the test service 
+            LanguageService service = TestObjects.GetTestLanguageService();
+
+            // parse the sql statement
+            var scriptFile = new ScriptFile();
+            scriptFile.SetFileContents(sqlWithErrors);
+            ScriptFileMarker[] fileMarkers = service.GetSemanticMarkers(scriptFile);
+
+            // verify there are no errors
+            Assert.Equal(0, fileMarkers.Length);
+        }
+
+        /// <summary>
+        /// Verify that the SQL parser correctly detects errors in text
+        /// </summary>
+        [Fact]
+        public void ParseSelectStatementWithError()
+        {
+            // sql statement with errors
+            const string sqlWithErrors = "SELECT *** FROM sys.objects";
+
+            // get test service
+            LanguageService service = TestObjects.GetTestLanguageService();
+
+            // parse sql statement
+            var scriptFile = new ScriptFile();
+            scriptFile.SetFileContents(sqlWithErrors);
+            ScriptFileMarker[] fileMarkers = service.GetSemanticMarkers(scriptFile);
+
+            // verify there is one error
+            Assert.Equal(1, fileMarkers.Length);
+
+            // verify the position of the error
+            Assert.Equal(9, fileMarkers[0].ScriptRegion.StartColumnNumber);
+            Assert.Equal(1, fileMarkers[0].ScriptRegion.StartLineNumber);
+            Assert.Equal(10, fileMarkers[0].ScriptRegion.EndColumnNumber);
+            Assert.Equal(1, fileMarkers[0].ScriptRegion.EndLineNumber);
+        }
+
+        /// <summary>
+        /// Verify that the SQL parser correctly detects errors in text
+        /// </summary>
+        [Fact]
+        public void ParseMultilineSqlWithErrors()
+        {
+            // multiline sql with errors
+            const string sqlWithErrors = 
+                "SELECT *** FROM sys.objects;\n" +
+                "GO\n" +
+                "SELECT *** FROM sys.objects;\n";
+
+            // get test service
+            LanguageService service = TestObjects.GetTestLanguageService();
+
+            // parse sql
+            var scriptFile = new ScriptFile();
+            scriptFile.SetFileContents(sqlWithErrors);
+            ScriptFileMarker[] fileMarkers = service.GetSemanticMarkers(scriptFile);
+
+            // verify there are two errors
+            Assert.Equal(2, fileMarkers.Length);
+
+            // check position of first error
+            Assert.Equal(9, fileMarkers[0].ScriptRegion.StartColumnNumber);
+            Assert.Equal(1, fileMarkers[0].ScriptRegion.StartLineNumber);
+            Assert.Equal(10, fileMarkers[0].ScriptRegion.EndColumnNumber);
+            Assert.Equal(1, fileMarkers[0].ScriptRegion.EndLineNumber);
+
+            // check position of second error
+            Assert.Equal(9, fileMarkers[1].ScriptRegion.StartColumnNumber);
+            Assert.Equal(3, fileMarkers[1].ScriptRegion.StartLineNumber);
+            Assert.Equal(10, fileMarkers[1].ScriptRegion.EndColumnNumber);
+            Assert.Equal(3, fileMarkers[1].ScriptRegion.EndLineNumber);
+        }
+
+        /// <summary>
+        /// Verify that GetSignatureHelp returns null when the provided TextDocumentPosition
+        /// has no associated ScriptParseInfo.
+        /// </summary>
+        [Fact]
+        public void GetSignatureHelpReturnsNullIfParseInfoNotInitialized()
+        {
+            // Given service doesn't have parseinfo intialized for a document
+            const string docContent = "SELECT * FROM sys.objects";
+            LanguageService service = TestObjects.GetTestLanguageService();
+            var scriptFile = new ScriptFile();
+            scriptFile.SetFileContents(docContent);
+
+            // When requesting SignatureHelp
+            SignatureHelp signatureHelp = service.GetSignatureHelp(TestObjects.GetTestDocPosition(), scriptFile);
+            
+            // Then null is returned as no parse info can be used to find the signature
+            Assert.Null(signatureHelp);
+        }
+
+        [Fact]
+        public void EmptyCompletionListTest()
+        {           
+            Assert.Equal(AutoCompleteHelper.EmptyCompletionList.Length, 0);
+        }
+
+        [Fact]
+        public void SetWorkspaceServiceInstanceTest()
+        {           
+            AutoCompleteHelper.WorkspaceServiceInstance = null;
+            // workspace will be recreated if it's set to null
+            Assert.NotNull(AutoCompleteHelper.WorkspaceServiceInstance);
+        }
+
+        internal class TestScriptDocumentInfo : ScriptDocumentInfo
+        {
+            public TestScriptDocumentInfo(TextDocumentPosition textDocumentPosition, ScriptFile scriptFile, ScriptParseInfo scriptParseInfo, 
+                string tokenText = null)
+                :base(textDocumentPosition, scriptFile, scriptParseInfo)
+            {
+                this.tokenText = string.IsNullOrEmpty(tokenText) ? "doesntmatchanythingintheintellisensedefaultlist" : tokenText;
+            }
+
+            private string tokenText;
+            
+            public override string TokenText
+            {
+                get
+                {
+                    return this.tokenText;
+                }
+            }
+        }
+
+        [Fact]
+        public void GetDefaultCompletionListWithNoMatchesTest()
+        {           
+            var scriptFile = new ScriptFile();
+            scriptFile.SetFileContents("koko wants a bananas");
+
+            ScriptParseInfo scriptInfo = new ScriptParseInfo { IsConnected = false };
+
+            var scriptDocumentInfo = new TestScriptDocumentInfo(
+                new TextDocumentPosition()
+                {
+                    TextDocument = new TextDocumentIdentifier() {  Uri = TestObjects.ScriptUri  },
+                    Position = new Position() { Line = 0, Character = 0 }
+                }, scriptFile, scriptInfo);
+      
+            AutoCompleteHelper.GetDefaultCompletionItems(scriptDocumentInfo, false);
+
+        }
+
+        [Fact]
+        public void GetDefaultCompletionListWithMatchesTest()
+        {
+            var scriptFile = new ScriptFile();
+            scriptFile.SetFileContents("koko wants a bananas");
+
+            ScriptParseInfo scriptInfo = new ScriptParseInfo { IsConnected = false };
+
+            var scriptDocumentInfo = new TestScriptDocumentInfo(
+                new TextDocumentPosition()
+                {
+                    TextDocument = new TextDocumentIdentifier() { Uri = TestObjects.ScriptUri },
+                    Position = new Position() { Line = 0, Character = 0 }
+                }, scriptFile, scriptInfo, "all");
+
+            CompletionItem[] result = AutoCompleteHelper.GetDefaultCompletionItems(scriptDocumentInfo, false);
+            Assert.Equal(result.Length, 1);
+
+        }
+    }
+}