Merge pull request #1719 from Samirat/samirat/add_test_discovery

JoeRobich · web-flow · commit 32cfc54569c3 · 2020-05-19T13:52:00.000-07:00
Add test discovery and NoBuild option to test requests
diff --git a/src/OmniSharp.Abstractions/OmniSharpEndpoints.cs b/src/OmniSharp.Abstractions/OmniSharpEndpoints.cs
@@ -58,6 +58,7 @@ public static class V2
             public const string DebugTestsInContextGetStartInfo = "/v2/debugtestsincontext/getstartinfo";
             public const string DebugTestStop = "/v2/debugtest/stop";
             public const string DebugTestsInClassGetStartInfo = "/v2/debugtestsinclass/getstartinfo";
+            public const string DiscoverTests = "/v2/discovertests";
             public const string RunTestsInContext = "/v2/runtestsincontext";
 
             public const string BlockStructure = "/v2/blockstructure";
diff --git a/src/OmniSharp.DotNetTest/Models/BaseTestRequest.cs b/src/OmniSharp.DotNetTest/Models/BaseTestRequest.cs
@@ -1,16 +1,26 @@
-﻿using OmniSharp.Models;
+using OmniSharp.Models;
 
 namespace OmniSharp.DotNetTest.Models
 {
-    public class BaseTestClassRequest : Request
+    public class BaseTestRequest : Request
     {
-        public string[] MethodNames { get; set; }
         public string RunSettings { get; set; }
         public string TestFrameworkName { get; set; }
         
         /// <summary>
         /// e.g. .NETCoreApp, Version=2.0
         /// </summary>
         public string TargetFrameworkVersion { get; set; }
+        public bool NoBuild { get; set; } = false;
+    }
+
+    public class SingleTestRequest : BaseTestRequest
+    {
+        public string MethodName { get; set; }
+    }
+
+    public class MultiTestRequest : BaseTestRequest
+    {
+        public string[] MethodNames { get; set; }
     }
 }
diff --git a/src/OmniSharp.DotNetTest/Models/BaseTestsInContextRequest.cs b/src/OmniSharp.DotNetTest/Models/BaseTestsInContextRequest.cs
@@ -11,5 +11,7 @@ public abstract class BaseTestsInContextRequest : Request
         /// e.g. .NETCoreApp, Version=2.0
         /// </summary>
         public string? TargetFrameworkVersion { get; set; }
+        
+        public bool NoBuild { get; set; } = false;
     }
 }
diff --git a/src/OmniSharp.DotNetTest/Models/DebugTestClassGetStartInfoRequest.cs b/src/OmniSharp.DotNetTest/Models/DebugTestClassGetStartInfoRequest.cs
@@ -4,7 +4,7 @@
 namespace OmniSharp.DotNetTest.Models
 {
     [OmniSharpEndpoint(OmniSharpEndpoints.V2.DebugTestsInClassGetStartInfo, typeof(DebugTestClassGetStartInfoRequest), typeof(DebugTestGetStartInfoResponse))]
-    public class DebugTestClassGetStartInfoRequest :  BaseTestClassRequest
+    public class DebugTestClassGetStartInfoRequest :  MultiTestRequest
     {
     }
 }
diff --git a/src/OmniSharp.DotNetTest/Models/DebugTestGetStartInfoRequest.cs b/src/OmniSharp.DotNetTest/Models/DebugTestGetStartInfoRequest.cs
@@ -4,14 +4,7 @@
 namespace OmniSharp.DotNetTest.Models
 {
     [OmniSharpEndpoint(OmniSharpEndpoints.V2.DebugTestGetStartInfo, typeof(DebugTestGetStartInfoRequest), typeof(DebugTestGetStartInfoResponse))]
-    public class DebugTestGetStartInfoRequest : Request
+    public class DebugTestGetStartInfoRequest : SingleTestRequest
     {
-        public string MethodName { get; set; }
-        public string RunSettings { get; set; }
-        public string TestFrameworkName { get; set; }
-        /// <summary>
-        /// e.g. .NETCoreApp, Version=2.0
-        /// </summary>
-        public string TargetFrameworkVersion { get; set; }
     }
 }
diff --git a/src/OmniSharp.DotNetTest/Models/DiscoverTestsRequest.cs b/src/OmniSharp.DotNetTest/Models/DiscoverTestsRequest.cs
@@ -0,0 +1,10 @@
+using OmniSharp.Mef;
+using OmniSharp.Models;
+
+namespace OmniSharp.DotNetTest.Models
+{
+    [OmniSharpEndpoint(OmniSharpEndpoints.V2.DiscoverTests, typeof(DiscoverTestsRequest), typeof(DiscoverTestsResponse))]
+    public class DiscoverTestsRequest : BaseTestRequest
+    {
+    }
+}
diff --git a/src/OmniSharp.DotNetTest/Models/DiscoverTestsResponse.cs b/src/OmniSharp.DotNetTest/Models/DiscoverTestsResponse.cs
@@ -0,0 +1,20 @@
+namespace OmniSharp.DotNetTest.Models
+{
+    public class Test
+    {
+        public string FullyQualifiedName { get; set; }
+
+        public string DisplayName { get; set; }
+
+        public string Source { get; set; }
+        
+        public string CodeFilePath { get; set; }
+
+        public int LineNumber { get; set; }
+    }
+
+    public class DiscoverTestsResponse
+    {
+        public Test[] Tests { get; set; }
+    }
+}
diff --git a/src/OmniSharp.DotNetTest/Models/GetTestStartInfoRequest.cs b/src/OmniSharp.DotNetTest/Models/GetTestStartInfoRequest.cs
@@ -4,14 +4,7 @@
 namespace OmniSharp.DotNetTest.Models
 {
     [OmniSharpEndpoint(OmniSharpEndpoints.V2.GetTestStartInfo, typeof(GetTestStartInfoRequest), typeof(GetTestStartInfoResponse))]
-    public class GetTestStartInfoRequest : Request
+    public class GetTestStartInfoRequest : SingleTestRequest
     {
-        public string MethodName { get; set; }
-        public string RunSettings { get; set; }
-        public string TestFrameworkName { get; set; }
-        /// <summary>
-        /// e.g. .NETCoreApp, Version=2.0
-        /// </summary>
-        public string TargetFrameworkVersion { get; set; }
     }
 }
diff --git a/src/OmniSharp.DotNetTest/Models/RunTestInClassRequest.cs b/src/OmniSharp.DotNetTest/Models/RunTestInClassRequest.cs
@@ -4,7 +4,7 @@
 namespace OmniSharp.DotNetTest.Models
 {
     [OmniSharpEndpoint(OmniSharpEndpoints.V2.RunAllTestsInClass, typeof(RunTestsInClassRequest), typeof(RunTestResponse))]
-    public class RunTestsInClassRequest : BaseTestClassRequest
+    public class RunTestsInClassRequest : MultiTestRequest
     {
     }
 }
diff --git a/src/OmniSharp.DotNetTest/Models/RunTestRequest.cs b/src/OmniSharp.DotNetTest/Models/RunTestRequest.cs
@@ -4,14 +4,7 @@
 namespace OmniSharp.DotNetTest.Models
 {
     [OmniSharpEndpoint(OmniSharpEndpoints.V2.RunTest, typeof(RunTestRequest), typeof(RunTestResponse))]
-    public class RunTestRequest : Request
+    public class RunTestRequest : SingleTestRequest
     {
-        public string MethodName { get; set; }
-        public string RunSettings { get; set; }
-        public string TestFrameworkName { get; set; }
-        /// <summary>
-        /// e.g. .NETCoreApp, Version=2.0
-        /// </summary>
-        public string TargetFrameworkVersion { get; set; }
     }
 }
diff --git a/src/OmniSharp.DotNetTest/Services/BaseTestService.cs b/src/OmniSharp.DotNetTest/Services/BaseTestService.cs
@@ -19,11 +19,11 @@ protected BaseTestService(OmniSharpWorkspace workspace, IDotNetCliService dotNet
             LoggerFactory = loggerFactory;
         }
 
-        protected TestManager CreateTestManager(string fileName)
+        protected TestManager CreateTestManager(string fileName, bool noBuild)
         {
             var document = Workspace.GetDocument(fileName);
 
-            return TestManager.Start(document.Project, DotNetCli, EventEmitter, LoggerFactory);
+            return TestManager.Start(document.Project, DotNetCli, EventEmitter, LoggerFactory, noBuild);
         }
     }
 }
diff --git a/src/OmniSharp.DotNetTest/Services/BaseTestService`2.cs b/src/OmniSharp.DotNetTest/Services/BaseTestService`2.cs
@@ -1,6 +1,7 @@
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis;
 using Microsoft.Extensions.Logging;
+using OmniSharp.DotNetTest.Models;
 using OmniSharp.Eventing;
 using OmniSharp.Mef;
 using OmniSharp.Models;
@@ -10,7 +11,7 @@ namespace OmniSharp.DotNetTest.Services
 {
     [OmniSharpHandler(OmniSharpEndpoints.V2.GetTestStartInfo, LanguageNames.CSharp)]
     internal abstract class BaseTestService<TRequest, TResponse> : BaseTestService, IRequestHandler<TRequest, TResponse>
-        where TRequest: Request
+        where TRequest: BaseTestRequest
     {
         protected BaseTestService(OmniSharpWorkspace workspace, IDotNetCliService dotNetCli, IEventEmitter eventEmitter, ILoggerFactory loggerFactory)
             : base(workspace, dotNetCli, eventEmitter, loggerFactory)
@@ -21,8 +22,10 @@ protected BaseTestService(OmniSharpWorkspace workspace, IDotNetCliService dotNet
 
         public async Task<TResponse> Handle(TRequest request)
         {
-            using var testManager = CreateTestManager(request.FileName);
-            return await HandleRequest(request, testManager);
+            using (var testManager = CreateTestManager(request.FileName, request.NoBuild))
+            {
+                return await HandleRequest(request, testManager);
+            }
         }
     }
 }
diff --git a/src/OmniSharp.DotNetTest/Services/DebugTestClassService.cs b/src/OmniSharp.DotNetTest/Services/DebugTestClassService.cs
@@ -25,7 +25,7 @@ public DebugTestClassService(DebugSessionManager debugSessionManager, OmniSharpW
 
         public async Task<DebugTestGetStartInfoResponse> Handle(DebugTestClassGetStartInfoRequest request)
         {
-            var testManager = CreateTestManager(request.FileName);
+            var testManager = CreateTestManager(request.FileName, request.NoBuild);
             _debugSessionManager.StartSession(testManager);
 
             return await _debugSessionManager.DebugGetStartInfoAsync(request.MethodNames, request.RunSettings, request.TestFrameworkName, request.TargetFrameworkVersion, CancellationToken.None);
diff --git a/src/OmniSharp.DotNetTest/Services/DebugTestService.cs b/src/OmniSharp.DotNetTest/Services/DebugTestService.cs
@@ -31,7 +31,7 @@ public DebugTestService(DebugSessionManager debugSessionManager, OmniSharpWorksp
 
         public Task<DebugTestGetStartInfoResponse> Handle(DebugTestGetStartInfoRequest request)
         {
-            var testManager = CreateTestManager(request.FileName);
+            var testManager = CreateTestManager(request.FileName, request.NoBuild);
             if (testManager.IsConnected)
             {
                 //only if the test manager connected successfully, shall we proceed with the request
diff --git a/src/OmniSharp.DotNetTest/Services/DebugTestsInContextService.cs b/src/OmniSharp.DotNetTest/Services/DebugTestsInContextService.cs
@@ -55,7 +55,7 @@ public async Task<DebugTestGetStartInfoResponse> Handle(DebugTestsInContextGetSt
                 };
             }
 
-            testManager.Connect();
+            testManager.Connect(request.NoBuild);
 
             if (testManager.IsConnected)
             {
diff --git a/src/OmniSharp.DotNetTest/Services/DiscoverTestsService.cs b/src/OmniSharp.DotNetTest/Services/DiscoverTestsService.cs
@@ -0,0 +1,33 @@
+using System;
+using System.Composition;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.CodeAnalysis;
+using Microsoft.Extensions.Logging;
+using OmniSharp.DotNetTest.Models;
+using OmniSharp.Eventing;
+using OmniSharp.Mef;
+using OmniSharp.Services;
+
+namespace OmniSharp.DotNetTest.Services
+{
+    [OmniSharpHandler(OmniSharpEndpoints.V2.DiscoverTests, LanguageNames.CSharp)]
+    internal class DiscoverTestsService : BaseTestService<DiscoverTestsRequest, DiscoverTestsResponse>
+    {
+        [ImportingConstructor]
+        public DiscoverTestsService(OmniSharpWorkspace workspace, IDotNetCliService dotNetCli, IEventEmitter eventEmitter, ILoggerFactory loggerFactory)
+            : base(workspace, dotNetCli, eventEmitter, loggerFactory)
+        {
+        }
+
+        protected override async Task<DiscoverTestsResponse> HandleRequest(DiscoverTestsRequest request, TestManager testManager)
+        {
+            if (testManager.IsConnected)
+            {
+                return await testManager.DiscoverTestsAsync(request.RunSettings, request.TestFrameworkName, request.TargetFrameworkVersion, default(CancellationToken));
+            }
+            
+            throw new InvalidOperationException("The debugger could not be started");
+        }
+    }
+}
diff --git a/src/OmniSharp.DotNetTest/Services/RunTestsInContextService.cs b/src/OmniSharp.DotNetTest/Services/RunTestsInContextService.cs
@@ -48,7 +48,7 @@ public async Task<RunTestResponse> Handle(RunTestsInContextRequest request)
                 };
             }
 
-            testManager.Connect();
+            testManager.Connect(request.NoBuild);
 
             if (testManager.IsConnected)
             {
diff --git a/src/OmniSharp.DotNetTest/TestManager.cs b/src/OmniSharp.DotNetTest/TestManager.cs
@@ -50,10 +50,10 @@ protected TestManager(Project project, string workingDirectory, IDotNetCliServic
             Logger = logger ?? throw new ArgumentNullException(nameof(logger));
         }
 
-        public static TestManager Start(Project project, IDotNetCliService dotNetCli, IEventEmitter eventEmitter, ILoggerFactory loggerFactory)
+        public static TestManager Start(Project project, IDotNetCliService dotNetCli, IEventEmitter eventEmitter, ILoggerFactory loggerFactory, bool noBuild)
         {
             var manager = Create(project, dotNetCli, eventEmitter, loggerFactory);
-            manager.Connect();
+            manager.Connect(noBuild);
             return manager;
         }
 
@@ -82,6 +82,8 @@ public static TestManager Create(Project project, IDotNetCliService dotNetCli, I
 
         public abstract Task<RunTestResponse> RunTestAsync(string[] methodNames, string runSettings, string testFrameworkName, string targetFrameworkVersion, CancellationToken cancellationToken);
 
+        public abstract Task<DiscoverTestsResponse> DiscoverTestsAsync(string runSettings, string testFrameworkName, string targetFrameworkVersion, CancellationToken cancellationToken);
+        
         public abstract Task<GetTestStartInfoResponse> GetTestStartInfoAsync(string methodName, string runSettings, string testFrameworkName, string targetFrameworkVersion, CancellationToken cancellationToken);
 
         public abstract Task<DebugTestGetStartInfoResponse> DebugGetStartInfoAsync(string methodName, string runSettings, string testFrameworkName, string targetFrameworkVersion, CancellationToken cancellationToken);
@@ -90,20 +92,20 @@ public static TestManager Create(Project project, IDotNetCliService dotNetCli, I
 
         public abstract Task DebugLaunchAsync(CancellationToken cancellationToken);
 
-        protected virtual bool PrepareToConnect()
+        protected virtual bool PrepareToConnect(bool noBuild)
         {
             // Descendents can override.
             return true;
         }
 
-        internal void Connect()
+        internal void Connect(bool noBuild)
         {
             if (_isConnected)
             {
                 throw new InvalidOperationException("Already connected.");
             }
 
-            if (!PrepareToConnect())
+            if (!PrepareToConnect(noBuild))
             {
                 return;
             }
diff --git a/src/OmniSharp.DotNetTest/VSTestManager.cs b/src/OmniSharp.DotNetTest/VSTestManager.cs
@@ -80,8 +80,13 @@ protected override void VersionCheck()
             }
         }
 
-        protected override bool PrepareToConnect()
+        protected override bool PrepareToConnect(bool noBuild)
         {
+            if (noBuild)
+            {
+                return true;
+            }
+
             // The project must be built before we can test.
             var arguments = "build";
 
@@ -122,6 +127,22 @@ private static void VerifyTestFramework(string testFrameworkName)
             }
         }
 
+        public override async Task<DiscoverTestsResponse> DiscoverTestsAsync(string runSettings, string testFrameworkName, string targetFrameworkVersion, CancellationToken cancellationToken)
+        {
+            var testCases = await DiscoverTestsAsync(null, runSettings, targetFrameworkVersion, cancellationToken);
+            return new DiscoverTestsResponse
+            {
+                Tests = testCases.Select(o => new Test
+                {
+                    FullyQualifiedName = o.FullyQualifiedName,
+                    DisplayName = o.DisplayName,
+                    Source = o.Source,
+                    CodeFilePath = o.CodeFilePath,
+                    LineNumber = o.LineNumber
+                }).ToArray()
+            };
+        }
+
         public override async Task<GetTestStartInfoResponse> GetTestStartInfoAsync(string methodName, string runSettings, string testFrameworkName, string targetFrameworkVersion, CancellationToken cancellationToken)
         {
             VerifyTestFramework(testFrameworkName);
@@ -411,7 +432,11 @@ private async Task<TestCase[]> DiscoverTestsAsync(string[] methodNames, string r
 
             var testCases = new List<TestCase>();
             var done = false;
-            var hashset = new HashSet<string>(methodNames);
+            HashSet<string> hashset = null;
+            if (methodNames != null)
+            {
+                hashset = new HashSet<string>(methodNames);
+            }
 
             while (!done)
             {
@@ -429,14 +454,14 @@ private async Task<TestCase[]> DiscoverTestsAsync(string[] methodNames, string r
 
                     case MessageType.TestCasesFound:
                         var foundTestCases = message.DeserializePayload<TestCase[]>();
-                        testCases.AddRange(foundTestCases.Where(isInRequestedMethods));
+                        testCases.AddRange(methodNames != null ? foundTestCases.Where(isInRequestedMethods) : foundTestCases);
                         break;
 
                     case MessageType.DiscoveryComplete:
                         var lastDiscoveredTests = message.DeserializePayload<DiscoveryCompletePayload>().LastDiscoveredTests;
                         if (lastDiscoveredTests != null)
                         {
-                            testCases.AddRange(lastDiscoveredTests.Where(isInRequestedMethods));
+                            testCases.AddRange(methodNames != null ? lastDiscoveredTests.Where(isInRequestedMethods) : lastDiscoveredTests);
                         }
 
                         done = true;
diff --git a/tests/OmniSharp.DotNetTest.Tests/AbstractDiscoverTestFacts.cs b/tests/OmniSharp.DotNetTest.Tests/AbstractDiscoverTestFacts.cs
diff --git a/tests/OmniSharp.DotNetTest.Tests/DiscoverTestFacts.cs b/tests/OmniSharp.DotNetTest.Tests/DiscoverTestFacts.cs

Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,7 @@ public abstract class BaseTestsInContextRequest : Request`
`11`	`11`	`/// e.g. .NETCoreApp, Version=2.0`
`12`	`12`	`/// </summary>`
`13`	`13`	`public string? TargetFrameworkVersion { get; set; }`
	`14`	`+`
	`15`	`+ public bool NoBuild { get; set; } = false;`
`14`	`16`	`}`
`15`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`namespace OmniSharp.DotNetTest.Models`
`5`	`5`	`{`
`6`	`6`	`[OmniSharpEndpoint(OmniSharpEndpoints.V2.DebugTestsInClassGetStartInfo, typeof(DebugTestClassGetStartInfoRequest), typeof(DebugTestGetStartInfoResponse))]`
`7`		`- public class DebugTestClassGetStartInfoRequest : BaseTestClassRequest`
	`7`	`+ public class DebugTestClassGetStartInfoRequest : MultiTestRequest`
`8`	`8`	`{`
`9`	`9`	`}`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,14 +4,7 @@`
`4`	`4`	`namespace OmniSharp.DotNetTest.Models`
`5`	`5`	`{`
`6`	`6`	`[OmniSharpEndpoint(OmniSharpEndpoints.V2.DebugTestGetStartInfo, typeof(DebugTestGetStartInfoRequest), typeof(DebugTestGetStartInfoResponse))]`
`7`		`- public class DebugTestGetStartInfoRequest : Request`
	`7`	`+ public class DebugTestGetStartInfoRequest : SingleTestRequest`
`8`	`8`	`{`
`9`		`- public string MethodName { get; set; }`
`10`		`- public string RunSettings { get; set; }`
`11`		`- public string TestFrameworkName { get; set; }`
`12`		`- /// <summary>`
`13`		`- /// e.g. .NETCoreApp, Version=2.0`
`14`		`- /// </summary>`
`15`		`- public string TargetFrameworkVersion { get; set; }`
`16`	`9`	`}`
`17`	`10`	`}`