Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update library testing docs page to reduce confusion #54324

Merged
merged 12 commits into from
Jun 23, 2021
65 changes: 41 additions & 24 deletions docs/workflow/testing/libraries/testing.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,71 @@
# Testing Libraries

We use the OSS testing framework [xunit](https://github.com/xunit/xunit).
## Full Build and Test Run

To build the tests and run them you can call the libraries build script. For libraries tests to work, you must have built the coreclr or mono runtime for them to run on.
These example commands automate the test run and all pre-requisite build steps in a single command from a clean enlistment.

**Examples**
- The following shows how to build only the tests but not run them:
- Run all tests - Builds clr in release, libs+tests in debug:
```
build.cmd/sh -subset libs.tests
build.cmd/sh -subset clr+libs+libs.tests -test -rc Release
```

- The following builds and runs all tests using clr:
- Run all tests - Builds Mono in release, libs+tests in debug:
```
build.cmd/sh -subset clr+libs.tests -test
build.cmd/sh -subset mono+libs+libs.tests -test -rc Release
```

- The following builds and runs all tests using mono:
- Run all tests - Build Mono and libs for x86 architecture in debug (choosing debug for runtime will run very slowly):
```
build.cmd/sh -subset mono+libs.tests -test
build.cmd/sh -subset mono+libs+libs.tests -test -arch x86
```

- The following builds and runs all tests in release configuration:
## Partial Build and Test Runs

Doing full build and test runs takes a long time and is very inefficient if you need to iterate on a change.
For greater control and efficiency individual parts of the build + testing workflow can be run in isolation.
See the [Building instructions](../../building/libraries/README.md) for more info on build options.

### Test Run Pre-requisites
Before any tests can run we need a complete build to run them on. This requires building (1) a runtime, and
(2) all the libraries. Examples:

- Build release clr + debug libraries
```
build.cmd/sh -subset libs.tests -test -c Release
build.cmd/sh -subset clr+libs -rc Release
```

- The following builds clr in release, libs in debug and runs all tests:
- Build release mono + debug libraries
```
build.cmd/sh -subset clr+libs+libs.tests -test -rc Release
build.cmd/sh -subset mono+libs -rc Release
```

- The following builds mono and libs for x86 architecture and runs all tests:
Building the `libs` subset or any of individual library projects automatically copies product binaries into the testhost folder
in the bin directory. This is where the tests will load the binaries from during the run. However System.Private.CorLib is an
exception - the build does not automatically copy it to the testhost folder. If you [rebuild System.Private.CoreLib](https://github.com/dotnet/runtime/blob/main/docs/workflow/building/libraries/README.md#iterating-on-systemprivatecorelib-changes) you must also build the `libs.pretest` subset to ensure S.P.C is copied before running tests.

### Running tests for all libraries

- Build and run all tests in release configuration.
```
build.cmd/sh -subset mono+libs+libs.tests -test -arch x86
build.cmd/sh -subset libs.tests -test -c Release
```

- The following example shows how to pass extra msbuild properties to ignore tests ignored in CI:
- Build the tests without running them
```
build.cmd/sh -subset libs.tests -test /p:WithoutCategories=IgnoreForCI
build.cmd/sh -subset libs.tests
```

Unless you specifiy `-testnobuild`, test assemblies are implicitly built when invoking the `Test` action.
- The following shows how to only test the libraries without building them
- Run the tests without building them
```
build.cmd/sh -subset libs.tests -test -testnobuild
```

## Running tests on the command line
- The following example shows how to pass extra msbuild properties to ignore tests ignored in CI.
```
build.cmd/sh -subset libs.tests -test /p:WithoutCategories=IgnoreForCI
```

To build tests you need to specify the `test` subset when invoking build.cmd/sh: `build.cmd/sh -subset libs.tests`.
### Running tests for a single library

The easiest (and recommended) way to build and run the tests for a specific library, is to invoke the `Test` target on that library:
```cmd
Expand All @@ -68,21 +85,21 @@ dotnet build /t:Test /p:TargetArchitecture=x86

There may be multiple projects in some directories so you may need to specify the path to a specific test project to get it to build and run the tests.

#### Running a single test on the command line
### Running a single test on the command line

To quickly run or debug a single test from the command line, set the XunitMethodName property, e.g.:
```cmd
dotnet build /t:Test /p:XunitMethodName={FullyQualifiedNamespace}.{ClassName}.{MethodName}
```

#### Running outer loop tests
### Running outer loop tests

To run all tests, including "outer loop" tests (which are typically slower and in some test suites less reliable, but which are more comprehensive):
```cmd
dotnet build /t:Test /p:Outerloop=true
```

#### Running tests on a different target framework
### Running tests on a different target framework

Each test project can potentially have multiple target frameworks. There are some tests that might be OS-specific, or might be testing an API that is available only on some target frameworks, so the `TargetFrameworks` property specifies the valid target frameworks. By default we will build and run only the default build target framework which is `net5.0`. The rest of the `TargetFrameworks` will need to be built and ran by specifying the `BuildTargetFramework` option, e.g.:
```cmd
Expand Down