Understanding assembly type from source #1529
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| namespace Microsoft.VisualStudio.TestPlatform.Common.Utilities | ||
| { | ||
| using System; | ||
| using System.IO; | ||
| using System.Reflection.PortableExecutable; | ||
|
|
||
| using Microsoft.VisualStudio.TestPlatform.ObjectModel; | ||
| using Microsoft.VisualStudio.TestPlatform.Utilities.Helpers; | ||
| using Microsoft.VisualStudio.TestPlatform.Utilities.Helpers.Interfaces; | ||
|
|
||
| public class PEReaderHelper | ||
| { | ||
| private readonly IFileHelper fileHelper; | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="PEReaderHelper"/> class. | ||
| /// </summary> | ||
| public PEReaderHelper() : this(new FileHelper()) | ||
| { | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="PEReaderHelper"/> class. | ||
| /// </summary> | ||
| /// <param name="fileHelper">File helper.</param> | ||
| public PEReaderHelper(FileHelper fileHelper) | ||
|
|
||
| { | ||
| this.fileHelper = fileHelper; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Determines assembly type from file. | ||
| /// </summary> | ||
| public AssemblyType GetAssemblyType(string filePath) | ||
| { | ||
| var assemblyType = AssemblyType.None; | ||
|
|
||
| try | ||
| { | ||
| using (var fileStream = fileHelper.GetStream(filePath, FileMode.Open, FileAccess.Read, FileShare.ReadWrite)) | ||
|
|
||
| using (var peReader = new PEReader(fileStream)) | ||
| { | ||
| // Resources for PEReader: | ||
| // 1. https://msdn.microsoft.com/library/windows/desktop/ms680547(v=vs.85).aspx?id=19509 | ||
| // 2. https://github.com/dotnet/corefx/tree/master/src/System.Reflection.Metadata | ||
|
|
||
| var peHeaders = peReader.PEHeaders; | ||
| var corHeader = peHeaders.CorHeader; | ||
| var corHeaderStartOffset = peHeaders.CorHeaderStartOffset; | ||
|
There was a problem hiding this comment. Add link to documentation in comment. |
||
|
|
||
| assemblyType = (corHeader != null && corHeaderStartOffset >= 0) ? | ||
|
There was a problem hiding this comment. can you point the documentation for how to determine if the assembly is managed or native There was a problem hiding this comment. Documentation links added in above lines |
||
| AssemblyType.Managed : | ||
| AssemblyType.Native; | ||
| } | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| EqtTrace.Warning("GetAssemblyTypeFromAssemblyMetadata: failed to determine assembly type: {0} for assembly: {1}", ex, filePath); | ||
|
There was a problem hiding this comment. Nit: Keep message prefix to Classname.Method name. |
||
| } | ||
|
|
||
| if (EqtTrace.IsInfoEnabled) | ||
| { | ||
| EqtTrace.Info("AssemblyMetadataProvider.GetAssemblyType: Determined assemblyType:'{0}' for source: '{1}'", assemblyType, filePath); | ||
|
There was a problem hiding this comment. Nit: change the class name. |
||
| } | ||
|
|
||
| return assemblyType; | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TestPlatformRoot Condition="$(TestPlatformRoot) == ''">..\..\</TestPlatformRoot> | ||
| <TestProject>true</TestProject> | ||
| </PropertyGroup> | ||
| <Import Project="$(TestPlatformRoot)scripts/build/TestPlatform.Settings.targets" /> | ||
| <PropertyGroup> | ||
| <TargetFrameworks>netcoreapp1.0;net451</TargetFrameworks> | ||
| <OutputType Condition=" '$(TargetFramework)' == 'netcoreapp2.0' ">Exe</OutputType> | ||
|
There was a problem hiding this comment. Nit: this line is not required. |
||
| <AssemblyName>Microsoft.TestPlatform.Common.PlatformTests</AssemblyName> | ||
| <EnableCodeAnalysis>true</EnableCodeAnalysis> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <ProjectReference Include="..\Microsoft.TestPlatform.TestUtilities\Microsoft.TestPlatform.TestUtilities.csproj" /> | ||
| <PackageReference Include="Microsoft.TestPlatform.TestAsset.NativeCPP"> | ||
| <Version>2.0.0</Version> | ||
|
There was a problem hiding this comment. Please never upload nupkg with same version after changing the content. It will leads to different behavior based on user nuget cache. There was a problem hiding this comment. Not doing in this as we are only using it this nuget. Will update if happens in future changes |
||
| </PackageReference> | ||
| </ItemGroup> | ||
| <ItemGroup Condition=" '$(TargetFramework)' == 'net451' "> | ||
| <Reference Include="System.Runtime" /> | ||
| <Reference Include="System" /> | ||
| <Reference Include="Microsoft.CSharp" /> | ||
| <Reference Include="System.Runtime.Serialization" /> | ||
| </ItemGroup> | ||
| <Import Project="$(TestPlatformRoot)scripts\build\TestPlatform.targets" /> | ||
| </Project> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| namespace TestPlatform.Common.UnitTests.Utilities | ||
| { | ||
| using Microsoft.TestPlatform.TestUtilities; | ||
| using Microsoft.VisualStudio.TestPlatform.Common.Utilities; | ||
| using Microsoft.VisualStudio.TestTools.UnitTesting; | ||
|
|
||
| [TestClass] | ||
| public class PEReaderHelperTests : IntegrationTestBase | ||
| { | ||
| private PEReaderHelper peReaderHelper; | ||
|
|
||
| public PEReaderHelperTests() | ||
| { | ||
| this.peReaderHelper = new PEReaderHelper(); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| [DataRow("net451")] | ||
| [DataRow("netcoreapp1.0")] | ||
| [DataRow("netcoreapp2.0")] | ||
| public void GetAssemblyTypeForManagedDll(string framework) | ||
| { | ||
| var assemblyPath = this.testEnvironment.GetTestAsset("SimpleTestProject3.dll", framework); | ||
| var assemblyType = this.peReaderHelper.GetAssemblyType(assemblyPath); | ||
|
|
||
| Assert.AreEqual(AssemblyType.Managed, assemblyType); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void GetAssemblyTypeForNativeDll() | ||
| { | ||
| var assemblyPath = $@"{this.testEnvironment.PackageDirectory}\microsoft.testplatform.testasset.nativecpp\2.0.0\contentFiles\any\any\Microsoft.TestPlatform.TestAsset.NativeCPP.dll"; | ||
| var assemblyType = this.peReaderHelper.GetAssemblyType(assemblyPath); | ||
|
|
||
| Assert.AreEqual(AssemblyType.Native, assemblyType); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void GetAssemblyTypeForManagedExe() | ||
| { | ||
| var assemblyPath = this.testEnvironment.GetTestAsset("ConsoleManagedApp.exe", "net451"); | ||
| var assemblyType = this.peReaderHelper.GetAssemblyType(assemblyPath); | ||
|
|
||
| Assert.AreEqual(AssemblyType.Managed, assemblyType); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| [DataRow("netcoreapp1.0")] | ||
| [DataRow("netcoreapp2.0")] | ||
| public void GetAssemblyTypeForNetCoreManagedExe(string framework) | ||
| { | ||
| var assemblyPath = this.testEnvironment.GetTestAsset("ConsoleManagedApp.dll", framework); | ||
| var assemblyType = this.peReaderHelper.GetAssemblyType(assemblyPath); | ||
|
|
||
| Assert.AreEqual(AssemblyType.Managed, assemblyType); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void GetAssemblyTypeForNativeExe() | ||
| { | ||
| var assemblyPath = $@"{this.testEnvironment.PackageDirectory}\microsoft.testplatform.testasset.nativecpp\2.0.0\contentFiles\any\any\Microsoft.TestPlatform.TestAsset.ConsoleNativeApp.exe"; | ||
| var assemblyType = this.peReaderHelper.GetAssemblyType(assemblyPath); | ||
|
|
||
| Assert.AreEqual(AssemblyType.Native, assemblyType); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void GetAssemblyTypeShouldReturnNoneInCaseOfError() | ||
| { | ||
| var assemblyType = this.peReaderHelper.GetAssemblyType("invalidFile.dll"); | ||
|
|
||
| Assert.AreEqual(AssemblyType.None, assemblyType); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| // ConsoleNativeApp.cpp : Defines the entry point for the console application. | ||
| // | ||
|
|
||
| #include "stdafx.h" | ||
|
|
||
|
|
||
| int main() | ||
| { | ||
| return 0; | ||
| } | ||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this class Singleton?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not required. Removed.