Skip to content

Latest commit

 

History

History
106 lines (58 loc) · 4.9 KB

windows-test-instructions.md

File metadata and controls

106 lines (58 loc) · 4.9 KB
Raw

Building and running tests on Windows

Building Tests       

To build the tests simply navigate to the tests directory above the repo and run,

C:\git\coreclr>build-test.cmd

Cleaning Tests

Note: Cleaning should be done before all tests to be sure that the test assets are initialized correctly. To do a clean build of the tests, in a clean command prompt, issue the following command:

C:\git\coreclr>build-test.cmd -rebuild

Building tests that will be precompiled

C:\git\coreclr>build-test.cmd crossgen

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

Building Other Priority Tests

C:\git\coreclr>build-test.cmd -priority=2

The number '2' is just an example. The default value (if no priority is specified) is 0. To clarify, if '2' is specified, all tests with CLRTestPriorty 0, 1 AND 2 will be built and consequently run.

Example

To run a clean, priority 1, crossgen test pass:

C:\git\coreclr>build-test.cmd -rebuild crossgen -priority=1

buildtest /? will list additional supported parameters.

Additionally, there is a Visual Studio solution, <repo_root>\tests\src\AllTestProjects.sln, where users can build a particular testcase, or all priority 0 testcases that are within it.

Building Individual Tests

Note: buildtest.cmd or build.cmd skipnative skipmscorlib needs to be run atleast once

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

  • Managed Test: You can invoke msbuild on the project directly from Visual Studio Command Prompt.

Running Tests

In a clean command prompt: <repo_root>\tests\runtest.cmd

runtest /? will list supported parameters.

This will generate the report named as TestRun_<arch>_<flavor>.html (e.g. TestRun_x64__release.html) in the current folder. It will also copy all the test dependencies to the folder passed at the command line.

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 the default the directory would be something like is <repo_root>\binaries\tests\x64\debug\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.

Rerunning a failed test

If you wish to re-run a failed test, please follow the following steps:

  1. Set an environment variable, CORE_ROOT, pointing to the path to product binaries that was passed to runtest.cmd. The command to set this environment variable is also specified in the test report for a failed test.
  2. Next, run the failed test, the command to which is also present in the test report for a failed test. It will be something like <repo_root>\binaries\tests\x64\debug\Exceptions\Finalization\Finalizer.cmd.

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

 <repo_root>\binaries\tests\x64\debug\Exceptions\Finalization\Finalizer.cmd -debug <debuggerFullPath>

Modifying a test

If test changes are needed, make the change and build the test project. This will binplace the binaries in test binaries folder (e.g. <repo_root>\binaries\tests\x64\debug\Exceptions\Finalization). At this point, follow the steps to re-run a failed test to re-run the modified test.

Authoring Tests (in VS)

  1. Use an existing test such as <repo_root>\tests\src\Exceptions\Finalization\Finalizer.csproj as a template and copy it to a new folder under <repo_root>\tests\src.
  2. Be sure that the AssemblyName has been removed (this causes confusion with the way tests are generally handled behind the scenes by the build system).
  3. Assign a CLRTestKind/CLRTestPriority.
  4. Add the project of the new test to <repo_root>\tests\src\AllTestProjects.sln in VS
  5. Add source files to this newly added project.
  6. Indicate the success of the test by returning 100.
  7. Add any other projects as a dependency, if needed.
  8. Build the test.
  9. Follow the steps to re-run a failed test to validate the new test.

Note:

  1. You can disable building of a test per architecture or configuration by using DisableProjectBuild tag in the project. for example:

<PropertyGroup>

 ``<DisableProjectBuild Condition=" '$(Platform)' == 'arm64' ">true</DisableProjectBuild>``

</PropertyGroup>

  1. To Add Nuget\MyGet Refernces use this (project.json)[https://github.com/dotnet/coreclr/blob/master/tests/src/Common/test_dependencies/project.json]

  2. To Build against the mscorlib facade add <ReferenceLocalMscorlib>true</ReferenceLocalMscorlib> to your project