Skip to content

Latest commit

 

History

History
115 lines (69 loc) · 4.31 KB

windows-test-instructions.md

File metadata and controls

115 lines (69 loc) · 4.31 KB
Raw

Building and running tests on Windows

Building Tests

Building coreclr tests must be done using a specific script as follows:

src\tests\build.cmd

By default, the test build uses Release as the libraries configuration. To use a different configuration, set the LibrariesConfiguration property to the desired configuration. For example:

src\tests\build.cmd /p:LibrariesConfiguration=Debug

Building Precompiled Tests

src\tests\build.cmd crossgen

This will use crossgen.exe to precompile test executables before they are executed.

Building Specific Priority Tests

src\tests\build.cmd -priority=1

The above is an example of requesting that priority '1' and below be built. The default priority value is '0'. If '1' is specified, all tests with CLRTestPriorty 0 and 1 will be built and run.

Generating Core_Root

The src\tests\build.cmd script generates the Core_Root folder, which contains the test host (corerun), libraries, and coreclr product binaries necessary to run a test. To generate Core_Root without building the tests:

src\tests\build.cmd generatelayoutonly

The output will be at <repo_root>\artifacts\tests\coreclr\windows.<arch>.<configuration>\Tests\Core_Root. For example, the location for x64 checked would be: <repo_root>\artifacts\tests\coreclr\windows.x64.Checked\Tests\Core_Root

Examples

To build crossgen'd priority '0' and '1' tests:

src\tests\build.cmd crossgen -priority=1

To generate Core_Root for x86 release without building tests:

src\tests\build.cmd x86 Release generatelayoutonly

For additional supported parameters use the following:

src\tests\build.cmd -?

Building Individual Tests

Note: build.cmd skipmanaged [Any additional flags] needs to be run at least once if the individual test has native assets.

  • Native Test: Build the generated Visual Studio solution or makefile corresponding to test cmake file.

  • Managed Test: Use dotnet.cmd from the root of the repo on the test project directly.

In addition to the test assembly, this will generate a .cmd script next to the test assembly in the test's output folder. The test's output folder will be under <repo_root>\artifacts\tests\coreclr\windows.<arch>.<configuration> at a subpath based on the test's location in source.

Running Tests

Will list supported parameters.

src\tests\run.cmd /?

In order to run all of the tests using your checked build:

src\tests\run.cmd checked

This will generate a report named TestRun_<arch>_<flavor>.html (e.g. TestRun_windows_x64_Checked.html) in the subdirectory <repo_root>\artifacts\log. Any tests that failed will be listed in TestRunResults_windows_x64_Checked.err.

Investigating Test Failures

Upon completing a test run, you may find one or more tests have failed.

The output of the test will be available in Test reports directory, but by default the directory will be something like <repo_root>\artifacts\tests\coreclr\windows.x64.Checked\Reports\Exceptions\Finalization.

There are 2 files of interest:

  • Finalizer.output.txt - Contains all the information logged by the test.
  • Finalizer.error.txt - Contains the information reported by CoreRun.exe (which executed the test) when the test process crashes.

To re-run a failed test, follow the instructions for running individual tests. The test report for the failed test will contain the test command to run - for example, <repo_root>\artifacts\tests\coreclr\windows.x64.Checked\Exceptions\Finalization\Finalizer.cmd.

Running Individual Tests

After building an individual test, to run the test:

  1. Set the CORE_ROOT environment variable to the Core_Root folder.

  2. Run the test using the .cmd generated for the test.

If you wish to run the test under a debugger (e.g. WinDbg), append -debug <debuggerFullPath> to the test command.

Modifying a test

If test changes are needed, make the change, and re-build the test project. This will binplace the binaries in the test binaries folder (e.g. <repo_root>\artifacts\tests\coreclr\windows.x64.Checked\Exceptions\Finalization). Then re-run the test following the instructions above.