Add portable pdb support for net46. (#856)

microsoft · Jun 15, 2017 · c70c0c8 · c70c0c8
1 parent 0eef86b
commit c70c0c8
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 33 deletions.
diff --git a/src/Microsoft.TestPlatform.ObjectModel/Microsoft.TestPlatform.ObjectModel.csproj b/src/Microsoft.TestPlatform.ObjectModel/Microsoft.TestPlatform.ObjectModel.csproj
diff --git a/src/Microsoft.TestPlatform.ObjectModel/Navigation/DiaSession.cs b/src/Microsoft.TestPlatform.ObjectModel/Navigation/DiaSession.cs
@@ -6,6 +6,8 @@ namespace Microsoft.VisualStudio.TestPlatform.ObjectModel
     using System.Diagnostics.CodeAnalysis;
 
     using Microsoft.VisualStudio.TestPlatform.ObjectModel.Navigation;
+    using System.IO;
+    using Microsoft.VisualStudio.TestPlatform.Utilities.Helpers;
 
     /// <summary>
     /// The class that enables us to get debug information from both managed and native binaries.
@@ -45,12 +47,7 @@ public DiaSession(string binaryPath)
         /// search path.
         /// </param>
         public DiaSession(string binaryPath, string searchPath)
-            :
-#if NET46
-            this(binaryPath, searchPath, new FullSymbolReader())
-#else
-            this(binaryPath, searchPath, new PortableSymbolReader())
-#endif
+            : this(binaryPath, searchPath, GetSymbolReader(binaryPath))
         {
         }
 
@@ -94,5 +91,24 @@ public INavigationData GetNavigationDataForMethod(string declaringTypeName, stri
             methodName = methodName.TrimEnd(TestNameStripChars);
             return this.symbolReader.GetNavigationData(declaringTypeName, methodName);
         }
+
+        private static ISymbolReader GetSymbolReader(string binaryPath)
+        {
+#if NET46
+            var pdbFilePath = Path.ChangeExtension(binaryPath, ".pdb");
+            using (var stream = new FileHelper().GetStream(pdbFilePath, FileMode.Open, FileAccess.Read))
+            {
+                if (PortablePdbReader.IsPortable(stream))
+                {
+                    return new PortableSymbolReader();
+                }
+
+                return new FullSymbolReader();
+            }
+#else
+            // We don't support full PDB files with .net core
+            return new PortableSymbolReader();
+#endif
+        }
     }
 }
diff --git a/src/Microsoft.TestPlatform.ObjectModel/Navigation/PortablePdbReader.cs b/src/Microsoft.TestPlatform.ObjectModel/Navigation/PortablePdbReader.cs
@@ -3,10 +3,8 @@
 
 namespace Microsoft.VisualStudio.TestPlatform.ObjectModel.Navigation
 {
-#if !NET46
     using System;
     using System.IO;
-    using System.Linq;
     using System.Reflection;
     using System.Reflection.Metadata;
     using System.Reflection.Metadata.Ecma335;
@@ -85,6 +83,24 @@ public DiaNavigationData GetDiaNavigationData(MethodInfo methodInfo)
             return this.GetDiaNavigationData(handle);
         }
 
+        /// <summary>
+        /// Checks gives stream is from portable pdb or not
+        /// </summary>
+        /// <param name="stream">
+        /// Stream.
+        /// </param>
+        /// <returns>
+        /// The <see cref="bool"/>.
+        /// </returns>
+        internal static bool IsPortable(Stream stream)
+        {
+            // First four bytes should be 'BSJB'
+            var result = (stream.ReadByte() == 'B') && (stream.ReadByte() == 'S') && (stream.ReadByte() == 'J')
+                         && (stream.ReadByte() == 'B');
+            stream.Position = 0;
+            return result;
+        }
+
         internal static MethodDebugInformationHandle GetMethodDebugInformationHandle(MethodInfo methodInfo)
         {
             var methodToken = (int)MethodInfoMethodTokenProperty.GetValue(methodInfo);
@@ -113,24 +129,6 @@ private static void GetMethodMinAndMaxLineNumber(
             }
         }
 
-        /// <summary>
-        /// Checks gives stream is from portable pdb or not
-        /// </summary>
-        /// <param name="stream">
-        /// Stream.
-        /// </param>
-        /// <returns>
-        /// The <see cref="bool"/>.
-        /// </returns>
-        private static bool IsPortable(Stream stream)
-        {
-            // First four bytes should be 'BSJB'
-            var result = (stream.ReadByte() == 'B') && (stream.ReadByte() == 'S') && (stream.ReadByte() == 'J')
-                         && (stream.ReadByte() == 'B');
-            stream.Position = 0;
-            return result;
-        }
-
         private DiaNavigationData GetDiaNavigationData(MethodDebugInformationHandle handle)
         {
             if (this.reader == null)
@@ -168,5 +166,4 @@ private string GetMethodFileName(MethodDebugInformation methodDebugDefinition)
             return fileName;
         }
     }
-#endif
 }
diff --git a/src/Microsoft.TestPlatform.ObjectModel/Navigation/PortableSymbolReader.cs b/src/Microsoft.TestPlatform.ObjectModel/Navigation/PortableSymbolReader.cs
@@ -3,13 +3,13 @@
 
 namespace Microsoft.VisualStudio.TestPlatform.ObjectModel.Navigation
 {
-#if !NET46
     using System;
     using System.Collections.Generic;
     using System.IO;
-    using System.Linq;
     using System.Reflection;
+#if !NET46
     using System.Runtime.Loader;
+#endif
 
     using Microsoft.VisualStudio.TestPlatform.Utilities.Helpers;
 
@@ -96,7 +96,11 @@ private void PopulateCacheForTypeAndMethodSymbols(string binaryPath)
                     // At this point, the assembly should be already loaded into the load context. We query for a reference to
                     // find the types and cache the symbol information. Let the loader follow default lookup order instead of
                     // forcing load from a specific path.
+#if NET46
+                    var asm = Assembly.Load(AssemblyName.GetAssemblyName(binaryPath));
+#else
                     var asm = Assembly.Load(AssemblyLoadContext.GetAssemblyName(binaryPath));
+#endif
 
                     foreach (var type in asm.GetTypes())
                     {
@@ -137,5 +141,4 @@ private void PopulateCacheForTypeAndMethodSymbols(string binaryPath)
             }
         }
     }
-#endif
 }
diff --git a/src/package/nuspec/TestPlatform.ObjectModel.nuspec b/src/package/nuspec/TestPlatform.ObjectModel.nuspec
@@ -15,13 +15,14 @@
     <dependencies>
       <group targetFramework="net46">
         <dependency id="System.Runtime.InteropServices.RuntimeInformation" version="[4.3.0, )" />
+        <dependency id="System.Reflection.Metadata" version="[1.3.0, )" />
       </group>
       <group targetFramework="netstandard1.5">
         <dependency id="NETStandard.Library" version="[1.6.1, )" />
         <dependency id="System.ComponentModel.EventBasedAsync" version="[4.3.0, )" />
         <dependency id="System.ComponentModel.TypeConverter" version="[4.3.0, )" />
         <dependency id="System.Reflection.TypeExtensions" version="[4.3.0, )" />
-        <dependency id="System.Reflection.Metadata" version="[1.4.2, )" />
+        <dependency id="System.Reflection.Metadata" version="[1.3.0, )" />
         <dependency id="System.Runtime.InteropServices.RuntimeInformation" version="[4.3.0, )" />
         <dependency id="System.Runtime.Loader" version="[4.3.0, )" />
         <dependency id="System.Runtime.Serialization.Primitives" version="[4.3.0, )" />

diff --git a/test/TestAssets/SimpleClassLibrary/SimpleClassLibrary.csproj b/test/TestAssets/SimpleClassLibrary/SimpleClassLibrary.csproj
@@ -8,8 +8,10 @@
   <PropertyGroup Condition="$(NetCoreAppTargetFrameWork) == 'true' ">
     <DebugType>portable</DebugType>
   </PropertyGroup>
-  <PropertyGroup Condition=" '$(TargetFramework)' == 'net46'">
+  <PropertyGroup Condition=" '$(TargetFramework)' == 'net46' and $(Configuration) == 'Debug'">
     <DebugType>full</DebugType>
   </PropertyGroup>
-
+  <PropertyGroup Condition=" '$(TargetFramework)' == 'net46' and $(Configuration) == 'Release'">
+    <DebugType>portable</DebugType>
+  </PropertyGroup>
 </Project>