Escape control chars in strings

citizenmatt · citizenmatt · commit 34b685ea8d9d · 2014-07-23T16:00:17.000+01:00
Causes issues with xml serialisation of messages between ReSharper and the external test runner. This was already handled by xunit1, since it used xml to serialise between AppDomains. Serialises interfaces and raw strings now, so no longer needs to escape strings. Fixes #10
diff --git a/resharper/src/xunitcontrib.runner.resharper.provider/UnitTestElementFactory.cs b/resharper/src/xunitcontrib.runner.resharper.provider/UnitTestElementFactory.cs
@@ -7,6 +7,7 @@
 using JetBrains.ReSharper.UnitTestFramework.Elements;
 using Xunit.Sdk;
 using JetBrains.Util;
+using XunitContrib.Runner.ReSharper.RemoteRunner;
 
 namespace XunitContrib.Runner.ReSharper.UnitTestProvider
 {
@@ -143,7 +144,8 @@ public XunitTestTheoryElement GetOrCreateTestTheory(IProject project, XunitTestM
         private static string GetTestTheoryShortName(string theoryName, XunitTestMethodElement methodElement)
         {
             var prefix = methodElement.TypeName.FullName + ".";
-            return theoryName.StartsWith(prefix) ? theoryName.Substring(prefix.Length) : theoryName;
+            var name = theoryName.StartsWith(prefix) ? theoryName.Substring(prefix.Length) : theoryName;
+            return DisplayNameUtil.Escape(name);
         }
 
         private static string GetTestTheoryId(XunitTestMethodElement methodElement, string shortName)
diff --git a/resharper/src/xunitcontrib.runner.resharper.runner/DisplayNameUtil.cs b/resharper/src/xunitcontrib.runner.resharper.runner/DisplayNameUtil.cs
@@ -0,0 +1,50 @@
+﻿using System;
+using System.Text;
+
+namespace XunitContrib.Runner.ReSharper.RemoteRunner
+{
+    public class DisplayNameUtil
+    {
+        public static string Escape(string name)
+        {
+            var sb = new StringBuilder();
+            foreach (var c in name)
+                sb.Append(EscapeControlChar(c));
+
+            return sb.ToString();
+        }
+
+        private static string EscapeControlChar(char c)
+        {
+            switch (c)
+            {
+                case '\0':
+                    return "\\0";
+                case '\a':
+                    return "\\a";
+                case '\b':
+                    return "\\b";
+                case '\f':
+                    return "\\f";
+                case '\n':
+                    return "\\n";
+                case '\r':
+                    return "\\r";
+                case '\t':
+                    return "\\t";
+                case '\v':
+                    return "\\v";
+
+                case '\x0085':
+                case '\x2028':
+                case '\x2029':
+                    return string.Format("\\x{0:X4}", (ushort)c);
+
+                default:
+                    return char.IsControl(c) || (ushort)c > 128
+                             ? String.Format("\\x{0:X4}", (ushort)c)
+                             : c.ToString();
+            }
+        }
+    }
+}
diff --git a/resharper/src/xunitcontrib.runner.resharper.runner/TaskProvider.cs b/resharper/src/xunitcontrib.runner.resharper.runner/TaskProvider.cs
@@ -102,7 +102,8 @@ public TheoryTaskInfo GetTheoryTask(string name, string type, string method)
         private static string GetTheoryShortName(string name, string type)
         {
             var prefix = type + ".";
-            return name.StartsWith(prefix) ? name.Substring(prefix.Length) : name;
+            var shortName = name.StartsWith(prefix) ? name.Substring(prefix.Length) : name;
+            return DisplayNameUtil.Escape(shortName);
         }
 
         private static bool IsTheory(string name, string type, string method)
diff --git a/resharper/src/xunitcontrib.runner.resharper.runner/xunitcontrib.runner.resharper.runner.8.2.csproj b/resharper/src/xunitcontrib.runner.resharper.runner/xunitcontrib.runner.resharper.runner.8.2.csproj
@@ -55,6 +55,7 @@
       <Link>Properties\ProductInfo.ReSharper.8.2.cs</Link>
     </Compile>
     <Compile Include="AttributeNames.cs" />
+    <Compile Include="DisplayNameUtil.cs" />
     <Compile Include="ISetTempFolderPathStrategy.cs" />
     <Compile Include="ISimpleClientController.cs" />
     <Compile Include="ISimpleRemoteTaskServer.cs" />
diff --git a/resharper/test/data/Runner/Gold/EscapedDataAttributeStrings.cs b/resharper/test/data/Runner/Gold/EscapedDataAttributeStrings.cs
@@ -0,0 +1,19 @@
+using Xunit;
+using Xunit.Extensions;
+
+namespace Foo
+{
+    public class PassingTheory
+    {
+        [Theory]
+        [InlineData("$ \\ \b \f \n \r \t \v")]
+        public void TestMethod(string value)
+        {
+        }
+    }
+}
+
+// xunit2 doesn't define Xunit.Extensions
+namespace Xunit.Extensions
+{
+}
diff --git a/resharper/test/data/Runner/Gold/EscapedDataAttributeStrings.xunit1.dll.gold b/resharper/test/data/Runner/Gold/EscapedDataAttributeStrings.xunit1.dll.gold
@@ -0,0 +1,14 @@
+﻿<task-start />
+<task-start><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" /></task-start>
+<cache-folder />
+<task-start><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" Explicitly="False" /></task-start>
+<task-start><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" Explicitly="False" Dynamic="False" /></task-start>
+<task-create><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" TheoryName="TestMethod(value: &quot;$ \ \x8 \xC \n \r \t \xB&quot;)" /></task-create>
+<task-start><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" TheoryName="TestMethod(value: &quot;$ \ \x8 \xC \n \r \t \xB&quot;)" /></task-start>
+<task-duration><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" TheoryName="TestMethod(value: &quot;$ \ \x8 \xC \n \r \t \xB&quot;)" /></task-duration>
+<task-finish result="Success"><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" TheoryName="TestMethod(value: &quot;$ \ \x8 \xC \n \r \t \xB&quot;)" /><message /></task-finish>
+<task-duration><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" Explicitly="False" Dynamic="False" /></task-duration>
+<task-finish result="Success"><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" Explicitly="False" Dynamic="False" /><message /></task-finish>
+<task-duration><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" Explicitly="False" /></task-duration>
+<task-finish result="Success"><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" Explicitly="False" /><message /></task-finish>
+<task-finish result="Success" />
diff --git a/resharper/test/data/Runner/Gold/EscapedDataAttributeStrings.xunit2.dll.gold b/resharper/test/data/Runner/Gold/EscapedDataAttributeStrings.xunit2.dll.gold
@@ -0,0 +1,14 @@
+﻿<task-start />
+<task-start><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" /></task-start>
+<cache-folder />
+<task-start><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" Explicitly="False" /></task-start>
+<task-start><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" Explicitly="False" Dynamic="False" /></task-start>
+<task-create><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" TheoryName="TestMethod(value: &quot;$ \ \b \f \n \r \t \v&quot;)" /></task-create>
+<task-start><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" TheoryName="TestMethod(value: &quot;$ \ \b \f \n \r \t \v&quot;)" /></task-start>
+<task-duration><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" TheoryName="TestMethod(value: &quot;$ \ \b \f \n \r \t \v&quot;)" /></task-duration>
+<task-finish result="Success"><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" TheoryName="TestMethod(value: &quot;$ \ \b \f \n \r \t \v&quot;)" /><message /></task-finish>
+<task-duration><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" Explicitly="False" Dynamic="False" /></task-duration>
+<task-finish result="Success"><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" MethodName="TestMethod" Explicitly="False" Dynamic="False" /><message /></task-finish>
+<task-duration><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" Explicitly="False" /></task-duration>
+<task-finish result="Success"><task runnerID="xUnit" ProjectId="697F5F53-AEB2-4284-AA79-90E7368C55E6" TypeName="Foo.PassingTheory" Explicitly="False" /><message /></task-finish>
+<task-finish result="Success" />
diff --git a/resharper/test/src/tests/AcceptanceTests/Runner/OrderedFactGoldTests.cs b/resharper/test/src/tests/AcceptanceTests/Runner/OrderedFactGoldTests.cs
@@ -46,5 +46,11 @@ public void TestAmbiguouslyNamedTestMethods()
             // TODO: This misses a test to continue running next class. Ordering.
             DoOneTestWithStrictOrdering("AmbiguouslyNamedTestMethods");
         }
+
+        [Test]
+        public void TestEscapedStringsInDataAttributes()
+        {
+            DoOneTestWithStrictOrdering("EscapedDataAttributeStrings");
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`using JetBrains.ReSharper.UnitTestFramework.Elements;`
`8`	`8`	`using Xunit.Sdk;`
`9`	`9`	`using JetBrains.Util;`
	`10`	`+using XunitContrib.Runner.ReSharper.RemoteRunner;`
`10`	`11`
`11`	`12`	`namespace XunitContrib.Runner.ReSharper.UnitTestProvider`
`12`	`13`	`{`
`@@ -143,7 +144,8 @@ public XunitTestTheoryElement GetOrCreateTestTheory(IProject project, XunitTestM`
`143`	`144`	`private static string GetTestTheoryShortName(string theoryName, XunitTestMethodElement methodElement)`
`144`	`145`	`{`
`145`	`146`	`var prefix = methodElement.TypeName.FullName + ".";`
`146`		`- return theoryName.StartsWith(prefix) ? theoryName.Substring(prefix.Length) : theoryName;`
	`147`	`+ var name = theoryName.StartsWith(prefix) ? theoryName.Substring(prefix.Length) : theoryName;`
	`148`	`+ return DisplayNameUtil.Escape(name);`
`147`	`149`	`}`
`148`	`150`
`149`	`151`	`private static string GetTestTheoryId(XunitTestMethodElement methodElement, string shortName)`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,8 @@ public TheoryTaskInfo GetTheoryTask(string name, string type, string method)`
`102`	`102`	`private static string GetTheoryShortName(string name, string type)`
`103`	`103`	`{`
`104`	`104`	`var prefix = type + ".";`
`105`		`- return name.StartsWith(prefix) ? name.Substring(prefix.Length) : name;`
	`105`	`+ var shortName = name.StartsWith(prefix) ? name.Substring(prefix.Length) : name;`
	`106`	`+ return DisplayNameUtil.Escape(shortName);`
`106`	`107`	`}`
`107`	`108`
`108`	`109`	`private static bool IsTheory(string name, string type, string method)`
Original file line number	Diff line number	Diff line change
`@@ -46,5 +46,11 @@ public void TestAmbiguouslyNamedTestMethods()`
`46`	`46`	`// TODO: This misses a test to continue running next class. Ordering.`
`47`	`47`	`DoOneTestWithStrictOrdering("AmbiguouslyNamedTestMethods");`
`48`	`48`	`}`
	`49`	`+`
	`50`	`+ [Test]`
	`51`	`+ public void TestEscapedStringsInDataAttributes()`
	`52`	`+ {`
	`53`	`+ DoOneTestWithStrictOrdering("EscapedDataAttributeStrings");`
	`54`	`+ }`
`49`	`55`	`}`
`50`	`56`	`}`