nunit4teambuild Wiki & Documentation Rss Feed

Updated Wiki: Home

rbanks54 — Wed, 20 Feb 2013 04:46:31 GMT

Project Description
Add support for NUnit to TFS 2008 & 2010 Team Build so that your NUnit test results are visible in the build log and incorporated into the data warehouse for reporting.

Great for teams with an existing investment in NUnit tests, or those who prefer NUnit over other testing frameworks.

Update

In case it's not obvious, with the inclusion of the unit test adapters in Visual Studio 2012 and the ability to run those test adapters in the TFS2012 build engine this project is now considered as "done".

There won't be any updates for future versions of TFS and the code is considered stable for prior versions of TFS. Of course, pull requests will still be accepted if you find any problems in the code, but don't expect any new features or functionality.

Thnks for all the support this project has recieved over the years!

Quick Start Guide

To add support for NUnit to your build you need to follow a few simple steps:

Make sure NUnit is installed on your build server.
Unzip the files from the download and add them to source control in the same folder as your TFSBuild.proj
Update the NUnitTFS.exe.config file to point to your TFS server
Change your build script to run NUnit and then call the NUnitTFS utility (see the sample script for an idea of how this is done)
Run your build!

If it's all set up correctly the next time you build you should see your build logs looking something like this:

If you follow the sample script you'll also need to make sure you have the The MSBuild Community Tasks installed on your build server.

Version 1.0 required MSTest to be installed for publishing test results, but this is no longer a requirement as of version 1.1.

This release has been tested with NUnit 2.4.7, 2.4.8 and 2.5.2.

Support for TFS 2010 has been added with version 2.0.

For information on TFS2008 integration see the developer notes and http://www.mrkwatkins.co.uk/Blog/2009/07/25/Making-NUnit-Play-Nicely-With-Team-Foundation-Server.

For integration with TFS2010 Team Build have a look at this great post at heikura.info

UPDATE 25-Apr-2012: Source code converted to git to enable better collaboration. Feel free to submit your pull requests :-)

Updated Wiki: Home

rbanks54 — Tue, 24 Jul 2012 04:36:15 GMT

Make sure NUnit is installed on your build server.
Unzip the files from the download and add them to source control in the same folder as your TFSBuild.proj
Update the NUnitTFS.exe.config file to point to your TFS server
Change your build script to run NUnit and then call the NUnitTFS utility (see the sample script for an idea of how this is done)
Run your build!

Updated Wiki: Home

rbanks54 — Wed, 25 Apr 2012 11:45:57 GMT

Project Description
Add support for NUnit to TFS 2008's Team Build so that your NUnit test results are visible in the build log and incorporated into the data warehouse for reporting.

Great for teams with an existing investment in NUnit tests, or those who prefer NUnit over other testing frameworks.

To add support for NUnit to your build you need to follow a few simple steps:

Make sure NUnit is installed on your build server.
Unzip the files from the download and add them to source control in the same folder as your TFSBuild.proj
Update the NUnitTFS.exe.config file to point to your TFS server
Change your build script to run NUnit and then call the NUnitTFS utility (see the sample script for an idea of how this is done)
Run your build!

New Comment on "Documentation"

danderson00 — Wed, 19 Oct 2011 03:32:32 GMT

I've posted a step by step guide to implementing this on TFS 2010 - http://danderson00.blogspot.com/2011/10/running-nunit-tests-under-tfs-build.html.

Updated Wiki: Home

rbanks54 — Fri, 19 Nov 2010 00:55:31 GMT

Make sure NUnit is installed on your build server.
Unzip the files from the download and add them to source control in the same folder as your TFSBuild.proj
Update the NUnitTFS.exe.config file to point to your TFS server
Change your build script to run NUnit and then call the NUnitTFS utility (see the sample script for an idea of how this is done)
Run your build!

Updated Wiki: Home

rbanks54 — Fri, 19 Nov 2010 00:54:50 GMT

Make sure NUnit is installed on your build server.
Unzip the files from the download and add them to source control in the same folder as your TFSBuild.proj
Update the NUnitTFS.exe.config file to point to your TFS server
Change your build script to run NUnit and then call the NUnitTFS utility (see the sample script for an idea of how this is done)
Run your build!

If it's all set up correctly the next time you build you should see your build logs looking something like this:

If you follow the sample script you'll also need to make sure you have the The MSBuild Community Tasks installed on your build server.

Version 1.0 required MSTest to be installed for publishing test results, but this is no longer a requirement as of version 1.1.

This release has been tested with NUnit 2.4.7, 2.4.8 and 2.5.2.

Support for TFS 2010 has been added with version 2.0 but it is still at the alpha stage.

For more information see the developer notes and http://www.mrkwatkins.co.uk/Blog/2009/07/25/Making-NUnit-Play-Nicely-With-Team-Foundation-Server.

For steps to integrate with TFS2010 Team Build have a look at this great post at heikura.info

Updated Wiki: How it works

MrKWatkins — Sun, 23 May 2010 18:01:24 GMT

TFS 2008

The basic process NUnitTFS follows for TFS 2008 runs thus:

Transform NUnit output. An XSL transform is used to take the output from NUnit and transform it into MSTest's .trx format. This transformation generates a unique ID on the root attribute known as the run ID.
Add build information to .trx. An XML element called <Build> is added to the .trx file after the <Times> element. This has two attributes, flavor and platform, that contain details about the build.
Retrieve build ID from TFS. A call to the QueryBuilds method on the TFS's BuildServiceV2 web service is made to retrieve details about the build. From the returned information the unique ID for the build is extracted.
Retrieve the publish service version. A call to the GetVersion method on TFS's PublishTestResultsBuildService2V1 web service. Note that this version isn't used anywhere! The MSTest executable peformed this call when publishing test results so I thought I NUnitTFS had better do it too...
Call PrepareToPublish. The PrepareToPublish method on TFS's PublishTestResultsBuildService2V1 web service is called. We pass the build ID and run ID and TFS returns a directory (on the TFS server) to save the .trx file to.
Save the .trx file. The .trx file is saved in the directory TFS gave us. The name can be specified by the -outputFile command line parameter; the default value is NUnitOutput.trx.
Call PublishRun. The PublishRun method on TFS's PublishTestResultsBuildService2V1 web service is called. We pass the build ID, run ID and name of the file we've saved. TFS then grabs the file and imports it. If something goes wrong at this stage you'll normally get the incredibly helpful Publish_GeneralFailure error.

TFS 2010

The process has changed massively with TFS 2010. The main difference is that there is no copying files around the network; files are uploaded via a web request, which is much nicer. It also now seems to be the case that an XML file has to be uploaded for each test, which isn't ideal...

Transform NUnit output. An XSL transform is used to take the output from NUnit and transform it into MSTest's .trx format. This transformation generates a unique ID on the root attribute known as the run ID. Whilst TFS 2010 has a more 'objecty' approach (i.e. there is a lot more passing of details via SOAP objects) the code interally still works from this .trx file. This is so you can transform the NUnit (or other test framwork!) output however you want using the -x command line switch and a custom XSLT yet still get the file uploading.
Add build information to .trx. An XML element called <Build> is added to the .trx file after the <Times> element. This has two attributes, flavor and platform, that contain details about the build.
Retrieve build information from TFS. A call to the QueryBuilds method on the BuildServiceV3 web service (/Build/v3.0/BuildService.asmx) is made to retrieve details about the build. From the returned information we use the build's URI to link test runs to it.
Check test run doesn't exist. We now check that the test run doesn't already exist via a call to the QueryTestRunByTmiRunId method of the TestResults web service, (/TestManagement/v1.0/TestResults.asmx) passing in the run ID.
Get current user's details. Test runs have to be associated with a user so we make a call to the ReadIdentities method of the IdentityManagementServiceV3 web service (/Services/v3.0/IdentityManagementService.asmx) to get the TeamFoundationId for the current user. (i.e. whatever user your build server is running as)
Create test run. A test run is now created with a call to the CreateTestRun method on the TestResults web service. This is initially created with few details and a state of NotStarted.
Create test results. Basic details of the tests are pulled out of the .trx and test results are created for the run with a call to the CreateTestResults method of the TestResults web service.
Update test run with TMI run and assemblies. TFS 2010 requires an XML file called tmiRun.tr to be uploaded an attached to the test run, along with the assemblies being tested. tmiRun.tr is a stripped down version of the .trx file with the <TestDefinitions> and <Results> elements removed. We make a call to the UpdateTestRun method of the TestResults service, updating the state of the test run to InProgress and giving details of the files to be uploaded. We are given a series of attachment IDs in return. We then upload each attachment by POSTing the file to the file upload handler (/TestManagement/v1.0/AttachmentUpload.ashx) passing the test run details and attachment ID in the form data.
Update test results with details and tmiResult.tr. We then make a call to the UpdateTestResults method of the TestResults service, updating each test result to a state of Completed and including the outcome plus and error messages. We also give details of an attachment for each result, tmiResult.tr, which is another stripped down version of the .trx containing just the <TestDefinitions> and <Results> elements for that test result. TFS returns us some attachment IDs which we then use to upload all the tmiResult.tr_ files via the file upload handler.

Updated Wiki: How it works

MrKWatkins — Sun, 23 May 2010 17:43:57 GMT

TFS 2008

The basic process NUnitTFS follows for TFS 2008 runs thus:

Transform NUnit output. An XSL transform is used to take the output from NUnit and transform it into MSTest's .trx format. This transformation generates a unique ID on the root attribute known as the run ID.
Add build information to .trx. An XML element called <Build> is added to the .trx file after the <Times> element. This has two attributes, flavor and platform, that contain details about the build.
Retrieve build ID from TFS. A call to the QueryBuilds method on the TFS's BuildServiceV2 web service is made to retrieve details about the build. From the returned information the unique ID for the build is extracted.
Retrieve the publish service version. A call to the GetVersion method on TFS's PublishTestResultsBuildService2V1 web service. Note that this version isn't used anywhere! The MSTest executable peformed this call when publishing test results so I thought I NUnitTFS had better do it too...
Call PrepareToPublish. The PrepareToPublish method on TFS's PublishTestResultsBuildService2V1 web service is called. We pass the build ID and run ID and TFS returns a directory (on the TFS server) to save the .trx file to.
Save the .trx file. The .trx file is saved in the directory TFS gave us. The name can be specified by the -outputFile command line parameter; the default value is NUnitOutput.trx.
Call PublishRun. The PublishRun method on TFS's PublishTestResultsBuildService2V1 web service is called. We pass the build ID, run ID and name of the file we've saved. TFS then grabs the file and imports it. If something goes wrong at this stage you'll normally get the incredibly helpful Publish_GeneralFailure error.

TFS 2010

Transform NUnit output. An XSL transform is used to take the output from NUnit and transform it into MSTest's .trx format. This transformation generates a unique ID on the root attribute known as the run ID.
Add build information to .trx. An XML element called <Build> is added to the .trx file after the <Times> element. This has two attributes, flavor and platform, that contain details about the build.
Retrieve build information from TFS. A call to the QueryBuilds method on the BuildServiceV3 web service (/Build/v3.0/BuildService.asmx) is made to retrieve details about the build. From the returned information we use the build's URI to link test runs to it.
Check test run doesn't exist. We now check that the test run doesn't already exist via a call to the QueryTestRunByTmiRunId method of the TestResults web service, (/TestManagement/v1.0/TestResults.asmx) passing in the run ID.

Updated Wiki: Home

MrKWatkins — Sun, 23 May 2010 17:34:28 GMT

Make sure NUnit is installed on your build server.
Unzip the files from the download and add them to source control in the same folder as your TFSBuild.proj
Update the NUnitTFS.exe.config file to point to your TFS server
Change your build script to run NUnit and then call the NUnitTFS utility (see the sample script for an idea of how this is done)
Run your build!

If it's all set up correctly the next time you build you should see your build logs looking something like this:

If you follow the sample script you'll also need to make sure you have the The MSBuild Community Tasks installed on your build server.

Version 1.0 required MSTest to be installed for publishing test results, but this is no longer a requirement as of version 1.1.

This release has been tested with NUnit 2.4.7, 2.4.8 and 2.5.2.

Support for TFS 2010 has been added with version 2.0 but it is still at the alpha stage.

For more information see the developer notes and http://www.mrkwatkins.co.uk/Blog/2009/07/25/Making-NUnit-Play-Nicely-With-Team-Foundation-Server.

Updated Wiki: Home

MrKWatkins — Mon, 03 May 2010 10:19:19 GMT

Make sure NUnit is installed on your build server.
Unzip the files from the download and add them to source control in the same folder as your TFSBuild.proj
Update the NUnitTFS.exe.config file to point to your TFS server
Change your build script to run NUnit and then call the NUnitTFS utility (see the sample script for an idea of how this is done)
Run your build!

If it's all set up correctly the next time you build you should see your build logs looking something like this:

If you follow the sample script you'll also need to make sure you have the The MSBuild Community Tasks installed on your build server.

Version 1.0 required MSTest to be installed for publishing test results, but this is no longer a requirement as of version 1.1.

This release has been tested with NUnit 2.4.7, 2.4.8 and 2.5.2.

Note that NUnitTFS doesn't currently work with TFS 2010! Support for TFS 2010 is in progress.

For more information see the developer notes and http://www.mrkwatkins.co.uk/Blog/2009/07/25/Making-NUnit-Play-Nicely-With-Team-Foundation-Server.

Updated Wiki: Documentation

MrKWatkins — Sun, 28 Feb 2010 14:55:49 GMT

You might find the following resources helpful:

Updated Wiki: Documentation

MrKWatkins — Sun, 28 Feb 2010 14:55:34 GMT

You might find the following resources helpful if you're having problems with NUnitTFS:

Updated Wiki: How it works

MrKWatkins — Sun, 28 Feb 2010 14:45:23 GMT

The basic process NUnitTFS follows runs thus:

Transform NUnit output. An XSL transform is used to take the output from NUnit and transform it into MSTest's .trx format. This transformation generates a unique ID on the root attribute known as the run ID.
Add build information to .trx. An XML element called <Build> is added to the .trx file after the <Times> element. This has two attributes, flavor and platform, that contain details about the build.
Retrieve build ID from TFS. A call to the QueryBuilds method on the TFS's BuildServiceV2 web service is made to retrieve details about the build. From the returned information the unique ID for the build is extracted.
Retrieve the publish service version. A call to the GetVersion method on TFS's PublishTestResultsBuildService2V1 web service. Note that this version isn't used anywhere! The MSTest executable peformed this call when publishing test results so I thought I NUnitTFS had better do it too...
Call PrepareToPublish. The PrepareToPublish method on TFS's PublishTestResultsBuildService2V1 web service is called. We pass the build ID and run ID and TFS returns a directory (on the TFS server) to save the .trx file to.
Save the .trx file. The .trx file is saved in the directory TFS gave us. The name can be specified by the -outputFile command line parameter; the default value is NUnitOutput.trx.
Call PublishRun. The PublishRun method on TFS's PublishTestResultsBuildService2V1 web service is called. We pass the build ID, run ID and name of the file we've saved. TFS then grabs the file and imports it. If something goes wrong at this stage you'll normally get the incredibly helpful Publish_GeneralFailure error.

Updated Wiki: How it works

MrKWatkins — Sun, 28 Feb 2010 14:28:52 GMT

The basic process NUnitTFS follows runs thus:

Transform NUnit output. An XSL transform is used to take the output from NUnit and transform it into MSTest's .trx format.
Add build information to .trx. An XML element called <Build> is added to the .trx file after the <Times> element. This has two attributes, flavor and platform, that contain details about the build.
Retrieve build ID from TFS. A call to the QueryBuilds method on the TFS's BuildServiceV2 web service is made to retrieve details about the build. From the returned information the unique ID for the build is extracted.

Updated Wiki: How it works

MrKWatkins — Sun, 28 Feb 2010 14:16:11 GMT

The basic process NUnitTFS follows runs thus:

Updated Wiki: Documentation

MrKWatkins — Sun, 28 Feb 2010 14:15:03 GMT

You might find the following resources helpful if you're having problems with NUnitTFS:

How it works

New Comment on "sample script"

prasadrmarathe — Wed, 16 Dec 2009 08:15:17 GMT

how to see the n-unit test results in the test report. i mean the names of the test passed/failed.

New Comment on "developer notes"

prasadrmarathe — Wed, 16 Dec 2009 07:57:08 GMT

how to see the n-unit test results in the test report. i mean the names of the test passed/failes.

Updated Wiki: Home

MrKWatkins — Sat, 28 Nov 2009 20:00:28 GMT

Make sure NUnit is installed on your build server.
Unzip the files from the download and add them to source control in the same folder as your TFSBuild.proj
Update the NUnitTFS.exe.config file to point to your TFS server
Change your build script to run NUnit and then call the NUnitTFS utility (see the sample script for an idea of how this is done)
Run your build!

Updated Wiki: sample script

MrKWatkins — Wed, 05 Aug 2009 18:57:53 GMT

This is a sample script that you can include in your build process. Note that the use of the <BuildStep> tasks are optional and you can remove those if you desire.

<Target Name="AfterCompile">

<BuildStep TeamFoundationServerUrl="$(TeamFoundationServerUrl)" BuildUri="$(BuildUri)" Name="NUnitTestStep" Message="Running Nunit Tests">
<Output TaskParameter="Id" PropertyName="NUnitStepId" />
</BuildStep>


<ItemGroup>
<TestAssemblies Include="$(OutDir)\**\cs-*.dll" />
</ItemGroup>


<NUnit ContinueOnError="true" Assemblies="@(TestAssemblies)" OutputXmlFile="$(OutDir)nunit_results.xml" ToolPath="$(ProgramFiles)\Nunit 2.4.7\bin\">
<Output TaskParameter="ExitCode" PropertyName="NUnitResult" />
</NUnit>
<BuildStep Condition="'$(NUnitResult)'=='0'" TeamFoundationServerUrl="$(TeamFoundationServerUrl)" BuildUri="$(BuildUri)" Id="$(NUnitStepId)" Status="Succeeded" />
<BuildStep Condition="'$(NUnitResult)'!='0'" TeamFoundationServerUrl="$(TeamFoundationServerUrl)" BuildUri="$(BuildUri)" Id="$(NUnitStepId)" Status="Failed" />


<Exec Command=""$(MSBuildProjectDirectory)\NUnitTFS.exe" -n "$(OutDir)nunit_results.xml" -t "$(TeamProject)" -b "$(BuildNumber)" -f "%(ConfigurationToBuild.FlavorToBuild)" -p "%(ConfigurationToBuild.PlatformToBuild)" -x "$(MSBuildProjectDirectory)\NUnitToMSTest.xslt"" />


<Error Condition="'$(NUnitResult)'!='0'" Text="Unit Tests Failed" />
</Target>