Icon

You are viewing the documentation of TeamCity 9.x, which is not the most recently released version of TeamCity.
View this page in TeamCity 2018.x documentation or refer to the listing to choose the documentation corresponding to your TeamCity version.

 
Skip to end of metadata
Go to start of metadata

This  page describes how to use NUnit from MS build.

Working with NUnit Task in MSBuild Build

(warning)The information in this section is applicable if you are using NUnit prior to version 3.0. For later versions, refer to the section below.

This section assumes that you already have an MSBuild build script with a configured NUnit task in it, and want TeamCity to track test reports without making any changes to the existing build script. Otherwise, consider adding NUnit build runner as one of the steps for your build configuration.

In this section:

Using NUnitTeamCity task in MSBuild Build Script

TeamCity provides a custom NUnitTeamCity task compatible with the NUnit task from MSBuild Community tasks project. If you provide the NUnitTeamCity task in your build script, TeamCity will launch its own test runner based on the options specified within the task. Thus, you do not need to have any NUnit runner, because TeamCity will run the tests.

In order to correctly use the NUnitTeamCity task, perform the following steps:

  1. Make sure the teamcity_dotnet_nunitlauncher system property is accessible on build agents. Build agents running Windows should automatically detect these properties as environment variables.  If you need to set them manually, see defining agent specific properties for more information.
  2. Configure your MSBuild build script with NUnitTeamCity task using the following syntax:

The following attributes are supported by NUnitTeamCity task:

Property name

description

Platform

Execution mode on a x64 machine. Supported values are: x86, x64 and ANY.

RuntimeVersion

.NET Framework to use: v1.1, v2.0, v4.0, ANY. By default, the MSBuild runtime is used. Default is v2.0 for MSBuild 2.0 and 3.5. For MSBuild 4.0 default value is v4.0

IncludeCategory

As used in the NUnit task from MSBuild Community tasks project.

ExcludeCategory

As used in the NUnit task from MSBuild Community tasks project.

NUnitVersion

Version of NUnit to be used to run the tests. Supported NUnit versions: 2.2.102.4.12.4.62.4.72.4.82.5.02.5.22.5.32.5.42.5.52.5.62.5.72.5.82.5.92.5.102.6.02.6.1,2.6.22.6.3. For example, NUnit-2.2.10.

To use NUnit 3.0 and above, see the section below.

Addins

List of third-party NUnit addins to be used. For more information on using NUnit addins, refer to NUnit Addins Support page.

HaltIfTestFailed

True to fail task, if any test fails.

Assemblies

List of assemblies to run tests with.

RunProcessPerAssembly

Set true, if you want to run each assembly in a new process.

Icon

Example (part of the MSBuild build script):

Important Notes

  • Be sure to replace "." with "_" when using System Properties in MSBuild scripts. For example, use teamcity_dotnet_nunitlauncher_msbuild_task instead of teamcity.dotnet.nunitlauncher.msbuild.task
  • TeamCity also provides Visual Studio Solution Runner for  solution files of Microsoft Visual Studio 2005 and above. It allows you to use MSBuild-style wildcards for the assemblies to run unit tests on.

Examples

Run NUnit tests using specific NUnit runner version:

Run NUnit tests with custom addins with NUnit 2.4.6:

Run NUnit tests with custom addins with NUnit 2.4.6 in per-assembly mode:

Icon

To make a TeamCity independent build script, consider the following trick:

MSBuild Property TEAMCITY_VERSION is added to msbuild when started from TeamCity.

Working with NUnit 3.0

(warning) The information in this section is applicable if you are using NUnit  3.0 and above. For earlier versions of NUnit, refer to the section above.

 Starting from version 3.0, NUnit supports TeamCity natively, so there is no need to use a special task for MSBuild as it was done for the earlier NUnit versions. The simplest way is to run the NUnit console via the standard Exec task. For example: 

 

The NUnit console returns the number of failed tests as the positive exit code and, in case of the NUnit test infrastructure failure, as the negative exit code.

TeamCity controls the test execution progress, but the NUnit infrastructure exceptions may not allow TeamCity to collect the required information. That is why the IgnoreExitCode="True" attribute needs to be set, which will ignore the positive exit codes and will not interrupt the build due to several failed tests. The Error task will stop the build in case of the test infrastructure errors for the negative exit codes.

 

Besides the project file, you can define the MSBuild version and platform, the target, you can use profiles and other settings.



Icon

The MSBuild runner option Reduce test failure feedback time will not work out of the box in this case. To use this feature, configure the NUnit build step.

 Getting Started with NUnit contains details and more examples.


1 Comment

  1. For some cases it's worth starting NUnit tests runner per-assembly mode. To do this,
    use the following code:

    Use %(TestAssembly) instead of @(TestAssembly).