From: Aaron Robinson <arobins@microsoft.com>
Date: Tue, 24 Jul 2018 01:40:17 +0000 (-0700)
Subject: Add root MSBuild targets for Interop managed test assets (dotnet/coreclr#19069)
X-Git-Tag: submit/tizen/20210909.063632~11030^2~4294
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=93e9db19accb64d59df8fd1f887d844e8404d7f3;p=platform%2Fupstream%2Fdotnet%2Fruntime.git

Add root MSBuild targets for Interop managed test assets (dotnet/coreclr#19069)

Add root CMake file for Interop native test assets

Commit migrated from https://github.com/dotnet/coreclr/commit/40286fc32e89c9eeda8b97d74cf0fb887469298b
---

diff --git a/src/coreclr/tests/src/Interop/CMakeLists.txt b/src/coreclr/tests/src/Interop/CMakeLists.txt
index ff103ea..28c53d0 100644
--- a/src/coreclr/tests/src/Interop/CMakeLists.txt
+++ b/src/coreclr/tests/src/Interop/CMakeLists.txt
@@ -8,6 +8,9 @@ if(WIN32)
     endif(CLR_CMAKE_HOST_ARCH STREQUAL arm)
 endif(WIN32)
 
+# Consumed by native test assets
+SET(CLR_INTEROP_TEST_ROOT ${CMAKE_CURRENT_SOURCE_DIR})
+
 include_directories(common)
 add_subdirectory(NativeCallable)
 add_subdirectory(PrimitiveMarshalling/Bool)
diff --git a/src/coreclr/tests/src/Interop/Interop.cmake b/src/coreclr/tests/src/Interop/Interop.cmake
new file mode 100644
index 0000000..64d3983
--- /dev/null
+++ b/src/coreclr/tests/src/Interop/Interop.cmake
@@ -0,0 +1 @@
+# Settings for all Interop native assets
\ No newline at end of file
diff --git a/src/coreclr/tests/src/Interop/Interop.settings.targets b/src/coreclr/tests/src/Interop/Interop.settings.targets
new file mode 100644
index 0000000..5f73303
--- /dev/null
+++ b/src/coreclr/tests/src/Interop/Interop.settings.targets
@@ -0,0 +1,15 @@
+<Project>
+  <!-- Properties for all Interop managed test assets -->
+  <PropertyGroup>
+    <TargetFramework>netcoreapp2.0</TargetFramework>
+  </PropertyGroup>
+
+  <!-- Environment properties -->
+  <PropertyGroup>
+  </PropertyGroup>
+
+  <!-- Required source files -->
+  <ItemGroup>
+    <Compile Include="$(MSBuildThisFileDirectory)\common\Assertion.cs"/>
+  </ItemGroup>
+</Project>
\ No newline at end of file
diff --git a/src/coreclr/tests/src/Interop/ReadMe.md b/src/coreclr/tests/src/Interop/ReadMe.md
new file mode 100644
index 0000000..4f400ea
--- /dev/null
+++ b/src/coreclr/tests/src/Interop/ReadMe.md
@@ -0,0 +1,68 @@
+# Interop Testing
+
+Testing Interop in the CoreCLR repo follows other tests in the repo and utilizes a series of small EXE projects that exercise a specific feature.
+
+See `Documentation/building/test-configuration.md` for details on how to create new tests.
+
+## Assets
+
+There should be no more than **1** project type per folder (i.e. a folder can contain a managed and native but no more than **1** of each).
+
+Ancillary source assets for all tests should be located in `Interop/common` and can be easily added to all managed tests via the `Interop.settings.targets` file or native tests via `Interop.cmake`.
+
+A common pattern for testing is using the `Assert` utilities found in the `CoreFX` repo. A copy of some of these utilities can be found at `Interop/common/Assertion.cs` and is included in all test projects by the `Interop.settings.targets` import. In order to use, add the following `using CoreFXTestLibrary;` in the relevant test file.
+
+### Managed
+
+Managed tests should be designed to use the [SDK style project](https://docs.microsoft.com/en-us/dotnet/core/tools/csproj) system provided by [`dotnet-cli`](https://github.com/dotnet/cli). In addition to the using the SDK style project, all managed projects should include the following:
+
+`<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), Interop.settings.targets))\Interop.settings.targets" />`
+
+The above import allows all managed projects to be maintained in a unified way.
+
+### Native
+
+Native test assets use [CMake](https://cmake.org/) and can leverage any of the product build assets. In addition to the use of CMake projects, all native projects should include the following:
+
+`include ("${CLR_INTEROP_TEST_ROOT}/Interop.cmake")`
+
+The above import allows all native projects to be maintained in a unified way.
+
+Native assets should be written in a manner that is as portable as possible across platforms (i.e. Windows, MacOS, Linux).
+
+**Note** Native assets are hard to get right and in many instances scenarios they test may not apply to all platforms. See details in `Documentation/building/test-configuration.md` about how to disable a tests for a specific platform.
+
+## Testing Areas
+
+Interop testing is divided into several areas.
+
+### P/Invoke
+
+The P/Invoke bucket represents tests that involve a [Platform Invoke](https://docs.microsoft.com/en-us/dotnet/standard/native-interop) scenario.
+
+Testing P/Invoke has two aspects:
+
+1) Marshaling types
+    * Primitives
+    * `Array`
+    * Structure
+    * Union
+    * `String`
+    * `Delegate`
+1) `DllImportAttribute`
+    * Attribute values
+    * Search paths
+
+### Marshal API
+
+The Marshal API surface area testing is traditionally done via unit testing and far better suited in the [CoreFX](https://github.com/dotnet/corefx/tree/master/src/System.Runtime.InteropServices/tests) repo. Cases where testing the API surface area requires native tests assets will be performed in the [CoreCLR](https://github.com/dotnet/coreclr/tree/master/tests/src/Interop) repo.
+
+## Common Task steps
+
+### Adding new native project
+1) Update `coreclr/tests/src/Interop/CMakeLists.txt` to include new test asset directory.
+1) Verify project builds by running `build-tests.cmd`/`build-tests.sh` from repo root.
+
+### Adding new managed project
+1) The build system automatically discovers managed test projects.
+1) Verify project builds by running `build-tests.cmd`/`build-tests.sh` from repo root.
\ No newline at end of file