Convert our unit tests and perf harness to use native entry-points (#50)

AaronRobinsonMSFT · Jan 26, 2024 · f6e4b6c · f6e4b6c
1 parent 56371fb
commit f6e4b6c
Show file tree

Hide file tree

Showing 34 changed files with 1,489 additions and 1,366 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -29,6 +29,9 @@ jobs:
       with:
         dotnet-version: '8.0.x'
         dotnet-quality: 'preview'
+
+    - name: List dotnet information
+      run: dotnet --info
 
     - name: Build Vendored Dependencies
       if: ${{ !matrix.use-vendored-libs }}
@@ -46,13 +49,8 @@ jobs:
         cmake -S . -B artifacts -DCMAKE_BUILD_TYPE=${{ matrix.flavor }} -DINCLUDE_VENDORED_LIBS=${{ matrix.use-vendored-libs }}
         cmake --build artifacts --config ${{ matrix.flavor }} --target install
 
-    - name: Build Managed Test Components
-      run: dotnet build --configuration ${{ matrix.flavor }}
-      working-directory: ./test
-
-    - name: Run Unit Tests
-      run: dotnet test --configuration ${{ matrix.flavor }} --logger trx --results-directory "TestResults-${{ matrix.os }}-${{ matrix.flavor }}"
-      working-directory: ./test/Regression.UnitTests
+    - name: Run Tests
+      run: ctest --test-dir artifacts --output-on-failure -C ${{ matrix.flavor }}
 
     # - name: Upload Test Results
     #   if: always()

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -16,5 +16,8 @@ include_directories(src/inc)
 include_directories(src/inc/external) # Hiding the "external" subdirectory due to uses of <...> in cor.h.
 
 add_subdirectory(src/)
+
+enable_testing()
+
 add_subdirectory(test/)
 
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,22 +1,12 @@
 <Project>
     <PropertyGroup>
-        <Configuration Condition="'$(Configuration)' == ''">Debug</Configuration>
-    </PropertyGroup>
-
-    <PropertyGroup>
-        <RepoDir>$(MSBuildThisFileDirectory)</RepoDir>
-        <BaseArtifactsPath>$(RepoDir)artifacts</BaseArtifactsPath>
-        <ArtifactsDir>$(BaseArtifactsPath)/$(Configuration)/</ArtifactsDir>
-
-        <BaseIntermediateOutputPath>$(ArtifactsDir)obj/$(MSBuildProjectName)</BaseIntermediateOutputPath>
-        <BaseOutputPath>$(ArtifactsDir)bin/$(MSBuildProjectName)</BaseOutputPath>
+        <UseArtifactsOutput>true</UseArtifactsOutput>
+        <ArtifactsPath>$(MSBuildThisFileDirectory)/artifacts/managed</ArtifactsPath>
 
         <!-- Define the intermediate and output paths so the configuration isn't appended -->
-        <IntermediateOutputPath>$(BaseIntermediateOutputPath)</IntermediateOutputPath>
-        <OutputPath>$(BaseOutputPath)</OutputPath>
         <NativeOutputPath Condition="$([MSBuild]::IsOSPlatform('Windows'))">$(BaseArtifactsPath)/bin</NativeOutputPath>
         <NativeOutputPath Condition="!$([MSBuild]::IsOSPlatform('Windows'))">$(BaseArtifactsPath)/lib</NativeOutputPath>
 
-        <TargetFrameworkLatest>net8.0</TargetFrameworkLatest>
+        <TargetFramework>net8.0</TargetFramework>
     </PropertyGroup>
 </Project>
diff --git a/src/inc/internal/dnmd_platform.hpp b/src/inc/internal/dnmd_platform.hpp
@@ -13,6 +13,14 @@
 
 #endif // !BUILD_WINDOWS
 
+// Machine code masks for native (R2R) images
+// See pedecoder.h in CoreCLR
+#define IMAGE_FILE_MACHINE_OS_MASK_APPLE 0x4644
+#define IMAGE_FILE_MACHINE_OS_MASK_FREEBSD 0xADC4
+#define IMAGE_FILE_MACHINE_OS_MASK_LINUX 0x7B79
+#define IMAGE_FILE_MACHINE_OS_MASK_NETBSD 0x1993
+#define IMAGE_FILE_MACHINE_OS_MASK_SUN 0x1992
+
 #include <cstdlib>
 #include <cstdint>
 

diff --git a/src/inc/internal/dnmd_tools_platform.hpp b/src/inc/internal/dnmd_tools_platform.hpp
@@ -5,6 +5,7 @@
 #include <fstream>
 #include <stdexcept>
 #include <array>
+#include <cstring>
 
 #include "dnmd_platform.hpp"
 #include "span.hpp"
@@ -85,6 +86,33 @@ inline bool write_out_file(char const* file, malloc_span<uint8_t> b)
     return true;
 }
 
+inline bool find_pe_image_bitness(uint16_t machine, uint8_t& bitness)
+{
+#define MAKE_MACHINE_CASE(x) \
+    case ((x) ^ IMAGE_FILE_MACHINE_OS_MASK_APPLE): \
+    case ((x) ^ IMAGE_FILE_MACHINE_OS_MASK_FREEBSD): \
+    case ((x) ^ IMAGE_FILE_MACHINE_OS_MASK_LINUX): \
+    case ((x) ^ IMAGE_FILE_MACHINE_OS_MASK_NETBSD): \
+    case ((x) ^ IMAGE_FILE_MACHINE_OS_MASK_SUN): \
+    case (x)
+
+    switch (machine)
+    {
+    MAKE_MACHINE_CASE(IMAGE_FILE_MACHINE_I386):
+    MAKE_MACHINE_CASE(IMAGE_FILE_MACHINE_ARM):
+        bitness = 32;
+        return true;
+    MAKE_MACHINE_CASE(IMAGE_FILE_MACHINE_AMD64):
+    MAKE_MACHINE_CASE(IMAGE_FILE_MACHINE_ARM64):
+        bitness = 64;
+        return true;
+    default:
+        return false;
+    }
+
+#undef MAKE_MACHINE_CASE
+}
+
 inline bool get_metadata_from_pe(malloc_span<uint8_t>& b)
 {
     if (b.size() < sizeof(IMAGE_DOS_HEADER))
@@ -111,8 +139,13 @@ inline bool get_metadata_from_pe(malloc_span<uint8_t>& b)
     uint16_t section_header_count;
     uint8_t* section_header_begin;
     auto nt_header_any = (PIMAGE_NT_HEADERS)(b + dos_header->e_lfanew);
-    if (nt_header_any->FileHeader.Machine == IMAGE_FILE_MACHINE_AMD64
-        || nt_header_any->FileHeader.Machine == IMAGE_FILE_MACHINE_ARM64)
+    uint16_t machine = nt_header_any->FileHeader.Machine;
+
+    uint8_t bitness;
+    if (!find_pe_image_bitness(machine, bitness))
+        return false;
+
+    if (bitness == 64)
     {
         auto nt_header64 = (PIMAGE_NT_HEADERS64)nt_header_any;
         if (remaining_pe_size < sizeof(*nt_header64))
@@ -122,8 +155,7 @@ inline bool get_metadata_from_pe(malloc_span<uint8_t>& b)
         section_header_begin = (uint8_t*)&nt_header64[1];
         dotnet_dir = &nt_header64->OptionalHeader.DataDirectory[IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR];
     }
-    else if (nt_header_any->FileHeader.Machine == IMAGE_FILE_MACHINE_I386
-             || nt_header_any->FileHeader.Machine == IMAGE_FILE_MACHINE_ARM)
+    else if (bitness == 32)
     {
         auto nt_header32 = (PIMAGE_NT_HEADERS32)nt_header_any;
         if (remaining_pe_size < sizeof(*nt_header32))

diff --git a/src/interfaces/metadataimport.cpp b/src/interfaces/metadataimport.cpp
@@ -2727,7 +2727,7 @@ HRESULT STDMETHODCALLTYPE MetadataImportRO::GetCustomAttributeByName(
     mdcursor_t cursor;
     uint32_t count;
     if (!md_create_cursor(_md_ptr.get(), mdtid_CustomAttribute, &cursor, &count))
-        return CLDB_E_RECORD_NOTFOUND;
+        return S_FALSE; // If no custom attributes are defined, treat it the same as if the attribute is not found.
 
     char buffer[1024];
     pal::StringConvert<WCHAR, char> cvt{ szName, buffer };

diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -1,4 +1,40 @@
 # Configure the compiler
 include(../configure.cmake)
+include(FindNetHost.cmake)
 
-add_subdirectory(regnative/)
+if (POLICY CMP0135)
+  cmake_policy(SET CMP0135 NEW) # Set timestamps in downloaded archives to the time of download.
+endif()
+
+include(FetchContent)
+FetchContent_Declare(
+  googletest
+  GIT_REPOSITORY
+  https://github.com/google/googletest.git
+  GIT_TAG
+  v1.14.0
+)
+# For Windows: Prevent overriding the parent project's compiler/linker settings
+set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+set(INSTALL_GTEST OFF CACHE BOOL "" FORCE)
+
+FetchContent_Declare(
+  benchmark
+  GIT_REPOSITORY
+  https://github.com/google/benchmark.git
+  GIT_TAG
+  v1.8.3
+)
+
+# Don't build the tests for the benchmark library.
+set(BENCHMARK_ENABLE_TESTING OFF CACHE BOOL "" FORCE)
+set(BENCHMARK_ENABLE_INSTALL OFF CACHE BOOL "" FORCE)
+FetchContent_MakeAvailable(googletest benchmark)
+
+include(GoogleTest)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+add_subdirectory(regpal)
+add_subdirectory(regperf)
+add_subdirectory(regtest)
diff --git a/test/DNMD.Tests.sln b/test/DNMD.Tests.sln
@@ -3,10 +3,6 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.5.33026.144
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Regression.UnitTests", "Regression.UnitTests\Regression.UnitTests.csproj", "{D5105B2A-6016-4B1C-A46B-5A841AE5AD26}"
-EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Regression.Performance", "Regression.Performance\Regression.Performance.csproj", "{3ED137D0-B5A2-4309-BDA5-BD9DE3FFC752}"
-EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Regression.TargetAssembly", "Regression.TargetAssembly\Regression.TargetAssembly.ilproj", "{D3BEEF3D-C137-49AC-96DD-E5B93E2F4C21}"
 EndProject
 Global
@@ -15,14 +11,6 @@ Global
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{D5105B2A-6016-4B1C-A46B-5A841AE5AD26}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{D5105B2A-6016-4B1C-A46B-5A841AE5AD26}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{D5105B2A-6016-4B1C-A46B-5A841AE5AD26}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{D5105B2A-6016-4B1C-A46B-5A841AE5AD26}.Release|Any CPU.Build.0 = Release|Any CPU
-		{3ED137D0-B5A2-4309-BDA5-BD9DE3FFC752}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{3ED137D0-B5A2-4309-BDA5-BD9DE3FFC752}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{3ED137D0-B5A2-4309-BDA5-BD9DE3FFC752}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{3ED137D0-B5A2-4309-BDA5-BD9DE3FFC752}.Release|Any CPU.Build.0 = Release|Any CPU
 		{D3BEEF3D-C137-49AC-96DD-E5B93E2F4C21}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{D3BEEF3D-C137-49AC-96DD-E5B93E2F4C21}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{D3BEEF3D-C137-49AC-96DD-E5B93E2F4C21}.Release|Any CPU.ActiveCfg = Release|Any CPU

diff --git a/test/FindNetHost.cmake b/test/FindNetHost.cmake
@@ -0,0 +1,22 @@
+execute_process(
+    COMMAND ${CMAKE_COMMAND} -E env DOTNET_NOLOGO=1 dotnet msbuild FindNetHostDir.proj -t:OutputNetHostDir -nologo
+    OUTPUT_VARIABLE NET_HOST_DIR
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    COMMAND_ERROR_IS_FATAL ANY
+    WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR})
+
+string(STRIP ${NET_HOST_DIR} NET_HOST_DIR)
+
+if (WIN32)
+    add_library(nethost IMPORTED SHARED)
+    set_target_properties(nethost PROPERTIES
+        IMPORTED_LOCATION ${NET_HOST_DIR}/nethost.dll
+        IMPORTED_IMPLIB ${NET_HOST_DIR}/nethost.lib)
+else()
+    add_library(nethost IMPORTED STATIC)
+    target_compile_definitions(nethost INTERFACE NETHOST_USE_AS_STATIC)
+    set_target_properties(nethost PROPERTIES
+        IMPORTED_LOCATION ${NET_HOST_DIR}/libnethost.a)
+endif()
+
+target_include_directories(nethost INTERFACE ${NET_HOST_DIR})
diff --git a/test/FindNetHostDir.proj b/test/FindNetHostDir.proj
@@ -0,0 +1,5 @@
+<Project Sdk="Microsoft.NET.Sdk" DefaultTargets="OutputNetHostDir">
+    <Target Name="OutputNetHostDir">
+        <Message Text="$(NetCoreTargetingPackRoot)/Microsoft.NETCore.App.Host.$(NETCoreSdkRuntimeIdentifier)/$(BundledNETCoreAppPackageVersion)/runtimes/$(NETCoreSdkRuntimeIdentifier)/native" Importance="high" />
+    </Target>
+</Project>
diff --git a/test/Regression.Performance/Program.cs b/test/Regression.Performance/Program.cs
diff --git a/test/Regression.Performance/Regression.Performance.csproj b/test/Regression.Performance/Regression.Performance.csproj
diff --git a/test/Regression.TargetAssembly/Regression.TargetAssembly.ilproj b/test/Regression.TargetAssembly/Regression.TargetAssembly.ilproj
@@ -1,6 +1,5 @@
 <Project Sdk="Microsoft.NET.Sdk.IL">
   <PropertyGroup>
-    <TargetFramework>$(TargetFrameworkLatest)</TargetFramework>
     <OutputType>Library</OutputType>
     <EnableDefaultCompileItems>false</EnableDefaultCompileItems>
   </PropertyGroup>