Adding ProtocolVersion support to TestHost

Author: rynowak

src/Microsoft.Framework.TestHost.Client.Sources/TestHostWrapper.cs

@@ -34,6 +34,8 @@ public TestHostWrapper(string project, string dnx, bool debug)
             Output = new List<Message>();
         }
 
+        public int? ProtocolVersion { get; set; }
+
         public int? DTHPort { get; set; }
 
         private TcpClient Client { get; set; }
@@ -188,6 +190,32 @@ private void StartCommandAndWaitForResponse(string messageType, object payload,
                 using (var writer = new BinaryWriter(stream))
                 using (var reader = new BinaryReader(stream))
                 {
+                    // If we're using a ProtocolVersion then establish that with the TestHost
+                    if (ProtocolVersion.HasValue)
+                    {
+                        writer.Write(JsonConvert.SerializeObject(new Message()
+                        {
+                            MessageType = "ProtocolVersion",
+                            Payload = JToken.FromObject(new ProtocolVersionMessage()
+                            {
+                                Version = ProtocolVersion.Value,
+                            }),
+                        }));
+
+                        var message = JsonConvert.DeserializeObject<Message>(reader.ReadString());
+                        OnMessageReceived(this, message);
+
+                        if (message.MessageType == "ProtocolVersion")
+                        {
+                            ProtocolVersion = message.Payload?.ToObject<ProtocolVersionMessage>().Version;
+                        }
+                        else
+                        {
+                            throw new InvalidOperationException(
+                                $"Invalid ProtocolVersion response {message.MessageType}");
+                        }
+                    }
+
                     writer.Write(JsonConvert.SerializeObject(new Message
                     {
                         MessageType = messageType,

src/Microsoft.Framework.TestHost/Messages/ProtocolVersionMessage.cs

@@ -0,0 +1,10 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+namespace Microsoft.Framework.TestHost
+{
+    public class ProtocolVersionMessage
+    {
+        public int Version { get; set; }
+    }
+}

src/Microsoft.Framework.TestHost/Program.cs

@@ -8,6 +8,7 @@
 using System.Threading.Tasks;
 using Microsoft.Framework.Runtime;
 using Microsoft.Framework.Runtime.Common.CommandLine;
+using Newtonsoft.Json.Linq;
 
 namespace Microsoft.Framework.TestHost
 {
@@ -22,7 +23,9 @@ public Program(IServiceProvider services)
 
         public int Main(string[] args)
         {
-            var application = new CommandLineApplication();
+            // We want to allow unexpected args, in case future VS needs to pass anything in that we don't current.
+            // This will allow us to retain backwards compatibility.
+            var application = new CommandLineApplication(throwOnUnexpectedArg: false);
             application.HelpOption("-?|-h|--help");
 
             var env = (IApplicationEnvironment)_services.GetService(typeof(IApplicationEnvironment));
@@ -76,6 +79,31 @@ public int Main(string[] args)
                         }
 
                         var message = channel.ReadQueue.Take();
+
+                        // The message might be a request to negotiate protocol version. For now we only know
+                        // about version 1.
+                        if (message.MessageType == "ProtocolVersion")
+                        {
+                            var version = message.Payload?.ToObject<ProtocolVersionMessage>().Version;
+                            var supportedVersion = 1;
+                            Trace.TraceInformation(
+                                "[ReportingChannel]: Requested Version: {0} - Using Version: {1}",
+                                version,
+                                supportedVersion);
+
+                            channel.Send(new Message()
+                            {
+                                MessageType = "ProtocolVersion",
+                                Payload = JToken.FromObject(new ProtocolVersionMessage()
+                                {
+                                    Version = supportedVersion,
+                                }),
+                            });
+
+                            // Take the next message, which should be the command to execute.
+                            message = channel.ReadQueue.Take();
+                        }
+
                         if (message.MessageType == "TestDiscovery.Start")
                         {
                             var commandArgs = new List<string>()

test/Microsoft.Framework.TestHost.Tests/TestHostTest.cs

@@ -130,6 +130,81 @@ public async Task RunTest_ByUniqueName()
             Assert.Equal("TestExecution.Response", host.Output[host.Output.Count - 1].MessageType);
         }
 
+        [ConditionalFact]
+        [OSSkipCondition(OperatingSystems.Linux | OperatingSystems.MacOSX)]
+        public async Task RunTest_ByUniqueName_ProtocolVersion_MatchingVersion()
+        {
+            // Arrange
+            var host = new TestHostWrapper(_testProject);
+            host.ProtocolVersion = 1;
+
+            await host.StartAsync();
+
+            await host.ListTestsAsync();
+
+            var test = host.Output
+                .Where(m => m.MessageType == "TestDiscovery.TestFound")
+                .First()
+                .Payload.ToObject<Test>();
+
+            host.Output.Clear();
+
+            host = new TestHostWrapper(_testProject);
+            host.ProtocolVersion = 1;
+            await host.StartAsync();
+
+            // Act
+            var result = await host.RunTestsAsync(_testProject, test.FullyQualifiedName);
+
+            // Assert
+            Assert.Equal(0, result);
+
+            Assert.Equal(1, host.ProtocolVersion);
+
+            Assert.Equal(4, host.Output.Count);
+            Assert.Single(host.Output, m => m.MessageType == "ProtocolVersion");
+            Assert.Single(host.Output, m => TestStarted(m, test.DisplayName));
+            Assert.Single(host.Output, m => TestPassed(m, test.DisplayName));
+            Assert.Equal("TestExecution.Response", host.Output[host.Output.Count - 1].MessageType);
+        }
+
+        [ConditionalFact]
+        [OSSkipCondition(OperatingSystems.Linux | OperatingSystems.MacOSX)]
+        public async Task RunTest_ByUniqueName_ProtocolVersion_UnknownVersion()
+        {
+            // Arrange
+            var host = new TestHostWrapper(_testProject);
+            host.ProtocolVersion = 2;
+
+            await host.StartAsync();
+
+            await host.ListTestsAsync();
+
+            var test = host.Output
+                .Where(m => m.MessageType == "TestDiscovery.TestFound")
+                .First()
+                .Payload.ToObject<Test>();
+
+            host.Output.Clear();
+
+            host = new TestHostWrapper(_testProject);
+            host.ProtocolVersion = 2;
+            await host.StartAsync();
+
+            // Act
+            var result = await host.RunTestsAsync(_testProject, test.FullyQualifiedName);
+
+            // Assert
+            Assert.Equal(0, result);
+
+            Assert.Equal(1, host.ProtocolVersion);
+
+            Assert.Equal(4, host.Output.Count);
+            Assert.Single(host.Output, m => m.MessageType == "ProtocolVersion");
+            Assert.Single(host.Output, m => TestStarted(m, test.DisplayName));
+            Assert.Single(host.Output, m => TestPassed(m, test.DisplayName));
+            Assert.Equal("TestExecution.Response", host.Output[host.Output.Count - 1].MessageType);
+        }
 
         private static bool TestFound(Message message, string name)
         {

test/Microsoft.Framework.WebEncoders.Testing.Tests/Microsoft.Framework.WebEncoders.Testing.Tests.xproj

@@ -14,5 +14,8 @@
   <PropertyGroup>
     <SchemaVersion>2.0</SchemaVersion>
   </PropertyGroup>
+  <ItemGroup>
+    <Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
+  </ItemGroup>
   <Import Project="$(VSToolsPath)\DNX\Microsoft.DNX.targets" Condition="'$(VSToolsPath)' != ''" />
-</Project>
+</Project>

tools/Microsoft.Framework.TestHost.UI/Microsoft.Framework.TestHost.UI.csproj

@@ -67,6 +67,9 @@
     <Compile Include="..\..\src\Microsoft.Framework.TestHost\Messages\Message.cs">
       <Link>Message.cs</Link>
     </Compile>
+    <Compile Include="..\..\src\Microsoft.Framework.TestHost\Messages\ProtocolVersionMessage.cs">
+      <Link>ProtocolVersionMessage.cs</Link>
+    </Compile>
     <Compile Include="..\..\src\Microsoft.Framework.TestHost\Messages\RunTestsMessage.cs">
       <Link>RunTestsMessage.cs</Link>
     </Compile>