summaryrefslogtreecommitdiff
path: root/Documentation/workflow
diff options
context:
space:
mode:
authorAaron Robinson <arobins@microsoft.com>2018-06-22 11:24:22 -0700
committerGitHub <noreply@github.com>2018-06-22 11:24:22 -0700
commit8aad994743a1332a21a56728799c293a21115050 (patch)
tree70698752da18b0b0c843ada6a57ac4a9b63ae9a7 /Documentation/workflow
parent75bd77f09d2221f8eae78e686ded8e510a569542 (diff)
downloadcoreclr-8aad994743a1332a21a56728799c293a21115050.tar.gz
coreclr-8aad994743a1332a21a56728799c293a21115050.tar.bz2
coreclr-8aad994743a1332a21a56728799c293a21115050.zip
Start moving testing documentation into a single location (#18598)
Start moving testing documentation into a single location Update `test-configuration.md` with more details on creating a test and requirements
Diffstat (limited to 'Documentation/workflow')
-rw-r--r--Documentation/workflow/RunningTests.md40
1 files changed, 36 insertions, 4 deletions
diff --git a/Documentation/workflow/RunningTests.md b/Documentation/workflow/RunningTests.md
index 65957f476d..b7d4d5d16b 100644
--- a/Documentation/workflow/RunningTests.md
+++ b/Documentation/workflow/RunningTests.md
@@ -1,10 +1,42 @@
-
# Running .NET Core Tests
-TODO - Incomplete.
+Details on test metadata can be found in [test-configuration.md](https://github.com/dotnet/coreclr/blob/master/Documentation/building/test-configuration.md).
+
+## Build All Tests
+
+1) Build the CoreCLR product
+ * [Unix](https://github.com/dotnet/coreclr/blob/master/Documentation/building/linux-instructions.md)
+ * [OSX](https://github.com/dotnet/coreclr/blob/master/Documentation/building/osx-instructions.md)
+ * [Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/building/windows-instructions.md)
+1) From the root directory run the following command:
+ * Non-Windows - `./build-test.sh`
+ * Windows - `build-test.cmd`
+ * Supply `-h` for usage flags
+
+### Examples
+
+* Build all tests priority `2` and higher
+ * `build-test.cmd -priority=2`
+
+## Build Individual Test
+
+Note: The CoreCLR must be built prior to building an individual test. See first step for building all tests.
+
+* Native Test: Build the generated CMake projects
+ * Projects are auto-generated when the `build-test.sh`/`build-test.cmd` script is run
+* Managed Test: Invoke MSBuild on the project directly
+ * Non-Windows - All of the necessary tools to build are under `coreclr/Tools`. It is possible to use `coreclr/Tools/MSBuild.dll` as you would normally use MSBuild with a few caveats. The `coreclr/Tools/msbuild.sh` script exists to make the call shorter.
+ * **Note:** Passing `/p:__BuildOs=`[`OSX`|`Linux`] is required. Otherwise the following error will occur: `error MSB4801: The task factory "CodeTaskFactory" could not be loaded because this version of MSBuild does not support it.`
+ * Windows - Use Visual Studio Developer command prompt
-See [Windows Instructions](../building/windows-test-instructions.md)
-See [Unix Instructions](../building/unix-test-instructions.md)
+### Examples
+* Using the `msbuild.sh` script
+ * `coreclr/Tools/msbuild.sh /maxcpucount coreclr/tests/src/JIT/CodeGenBringUpTests/Array1.csproj /p:__BuildType=Release /p:__BuildOS=OSX`
+* Calling `MSBuild.dll` directly
+ * `coreclr/Tools/dotnetcli/dotnet coreclr/Tools/MSBuild.dll /maxcpucount coreclr/tests/src/JIT/CodeGenBringUpTests/Array1.csproj /p:__BuildType=Release /p:__BuildOS=OSX`
+## Additional Documents
+* [Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/building/windows-test-instructions.md)
+* [Non-Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/building/unix-test-instructions.md) \ No newline at end of file