NCover Documentation

Please visit Covering MSTest for updated information.

If you're using the default unit testing tools that come with Visual Studio, then you're using MSTest. MSTest integrates well with Visual Studio, but if you don't have VS Team Edition and you want code coverage, you're out of luck unless you use NCover. Thankfully, using NCover to cover your MSTest tests is fairly straightforward.

The Essentials

If you know MSTest and MSBuild and you already have a working <!Exec /> task that runs your MSTest tests, then adding NCover on top of the process is easy. Using that same task, just change it to

<!Exec Command="$(NCoverPath)\NCover.Console.exe //x $(CoverageFilePath) $(MSTestExecCommand)" />

and you should be able to analyze the coverage in NCover Explorer, or create reports using NCover Reporting.

Covering Tests From The Command Line

The first step in running NCover and MSTest from the command line is to figure out where mstest.exe is installed. This is typically under the "Common7\IDE\" folder of your Visual Studio install, but to make sure you have the right path, you need to open a Visual Studio Command Prompt (Start Menu, Program Files, Microsoft Visual Studio, Visual Studio Tools, Visual Studio Command Prompt) and then type "where mstest" on the command line and hit enter. You should then see the full path to the mstest.exe executable, as shown in the image below.

Next, to cover your unit tests, you'll use a command line like the following:

ncover.console.exe //x mstest_coverage.nccov
    "C:\Program Files (x86)\Microsoft Visual Studio 9.0\Common7\IDE\MSTest.exe"

This tells NCover to cover mstest.exe running tests from two assemblies - TestAssembly1.dll and TestAssembly2.dll. It writes the coverage data to mstest_coverage.nccov.

If you're running NCover on a 64-bit machine, then MSTest is installed in the Program Files (x86) folder:

"C:\Program files (x86)\NCover\NCover.Console.exe" //x mstest_coverage.nccov
    "C:\Program Files (x86)\Microsoft Visual Studio 9.0\Common7\IDE\MSTest.exe"

Hey, that was easy! So how can you run tests through NCover Explorer?

Covering Tests From NCover Explorer

Now that you have a command line that works, it's easy to set up a project in NCover Explorer so you can run your tests and examine code coverage right away. Open NCover Explorer and create a new project by pressing Control-N. You should then see the Project Configuration window. Populate the fields with the information from the command you created in the previous step, as shown in the image below. Note that the Working Folder field should be the folder where your test assemblies are stored.

On a 64-bit Machine

If you're running NCover on a 64-bit machine, then you need to go to the NCover Path section and change the Path to NCover.Console field to the location of the 32-bit version of NCover, as was done in the screenshot below.

Finally, you should close the Project Configuration window and press the the green Run Coverage button to run NCover and start looking at coverage data!

Covering Tests From A Build Script

Well, now that you've set up a project in NCover Explorer, getting coverage from an automated build script is just a click away. Just press the Script Helper button in NCover Explorer's toolbar and select either the MSBuild NCover Task or the MSBuild Exec Task to have NCover Explorer generate the build script for you.

<!-- Generated by NCover Explorer at -->
<!Project DefaultTargets="Coverage" xmlns="" >

  <!-- TODO: Uncomment and add the full path to NCover.MSBuildTasks.dll if not in your path -->
  <!-- TODO: Alternatively, remove this line if you have copied the .dll to your MSBuild bin folder -->
  <!-- <!UsingTask TaskName="NCover.MSBuildTasks.NCover" AssemblyFile="NCover.MSBuildTasks.dll"/> -->
  <!Target Name="Coverage">
    <!NCover ToolPath="C:\program files (x86)\ncover"
            TestRunnerExe="C:\Program Files (x86)\Microsoft Visual Studio 9.0\Common7\IDE\MSTest.exe"
            ProjectName="run tests with mstest"    />

Just plug the coverage target or the NCover task into your build script wherever makes the most sense, and you're ready to integrate NCover into your build server.

If you still need technical assistance, we can help:

Submit A Support Ticket