Skip to main content

NUnit

Testmo works with any test automation tool, including the popular NUnit unit testing framework for .NET. This quickstart guide provides an overview of how to report NUnit test automation results to Testmo.

Run NUnit & generate XML file

NUnit provides a feature to transform test results to JUnit-style XML files, which has become a standard format to exchange test results between tools and which Testmo also fully supports. Make sure to download the JUnit transform file published by the NUnit project.

> nunit3-console.exe YourTestAssembly.dll --result="results/test-results.xml;transform=nunit3-junit.xslt"

This will run your tests with NUnit and automatically write all test results to an XML file in the results directory. You can also configure a different directory or specify any additional regular NUnit command line options.

Submit test results to Testmo

To submit your test results to Testmo, you simply use our cross-platform testmo CLI tool. The CLI tool is distributed as an NPM package and is easy to install on any system. Simply install our official @testmo/testmo-cli NPM package:

> npm install -g @testmo/testmo-cli
> testmo -h

Usage: testmo [options] [command]
[...]

We can now send the NUnit test results to Testmo. To do this, make sure to generate an API key in Testmo from your profile page. The API key is used to authenticate with Testmo to send the results. We can then use the testmo CLI tool so submit our results (note that we first set the TESTMO_TOKEN variable, which the tool expects):

Windows
Linux
Multiple lines
> set TESTMO_TOKEN=********
> testmo automation:run:submit --instance https://<your-name>.testmo.net --project-id 1 --name "NUnit test run" --source "unittests" --results results/*.xml

On Linux, the command line uses a slightly different syntax to set a variable:

$ export TESTMO_TOKEN=********
$ testmo automation:run:submit --instance https://<your-name>.testmo.net --project-id 1 --name "NUnit test run" --source "unittests" --results results/*.xml

If you want to run the command with multiple lines to make it easier to read, use the following format on Windows:

> set TESTMO_TOKEN=********
> testmo automation:run:submit ^
  --instance https://<your-name>.testmo.net ^
  --project-id 1 ^
  --name "NUnit test run" ^
  --source "unittests" ^
  --results results/*.xml

And you can use the following format on Linux:

$ export TESTMO_TOKEN=********
$ testmo automation:run:submit \
  --instance https://<your-name>.testmo.net \
  --project-id 1 \
  --name "NUnit test run" \
  --source "unittests" \
  --results results/*.xml
See command output
Collecting log files ..
Found 1 result file with a total of 855 tests
Created new automation run (ID: 254)
Created new thread (ID: 608)
Sending tests to Testmo ..
Uploading: [|||||||||||||||||||||||||] 100% | ETA: 0s | 855/855 tests
Successfully sent tests and completed run
Marked the run as completed

That's it! 🎉 This will automatically analyze the XML result file, create a new test run in Testmo, submit all tests & results and mark the run as completed. There's no need to manually create any tests, map tests or IDs or build any custom API code. Everything is handled automatically for you.

➡️ Bonus: Launch NUnit with Testmo CLI

In the above example, we first launched NUnit to generate the XML file and then used our CLI tool to submit the results in a second step. As an improvement to the above example, we can ask our CLI tool to launch NUnit (testmo then starts and waits for NUnit to finish). This has the following additional benefits:

a) Capture full console output and send it to Testmo 

b) Accurately measure test times 

c) Record the NUnit exit code

Launch NUnit with CLI tool

We can ask our CLI tool to launch NUnit, so we can capture the console output and more:

> set TESTMO_TOKEN=********
> testmo automation:run:submit ^
  --instance https://<your-name>.testmo.net ^
  --project-id 1 ^
  --name "NUnit test run" ^
  --source "unittests" ^
  --results results/*.xml ^
  -- nunit3-console.exe YourTestAssembly.dll --result="results/test-results.xml;transform=nunit3-junit.xslt"
    ^ space!

The same command executed on Linux:

$ export TESTMO_TOKEN=********
$ testmo automation:run:submit \
  --instance https://<your-name>.testmo.net \
  --project-id 1 \
  --name "NUnit test run" \
  --source "unittests" \
  --results results/*.xml \
  -- nunit3-console.exe YourTestAssembly.dll --result="results/test-results.xml;transform=nunit3-junit.xslt"
    ^ space!

Also learn more and see other examples in the full Testmo CLI guide.

➡️ Bonus: Custom fields

Testmo also supports additional custom fields for test runs, threads and tests. You can learn more here:

NUnit does not yet directly support fields/properties per test, but Testmo can also parse and read fields/properties from the test output. And NUnit lets you specify the output it should write to the results XML file. So we can use Testmo's output property syntax to record any additional custom fields for our tests and submit these as fields to Testmo. Testmo supports many automation field types including strings, links, rich HTML, steps and attachment links.

Add custom fields with NUnit

To log additional fields for a test, simply use Testmo's output property syntax with NUnit's TextContext.Out writer.

using System;

namespace TestUserProfile
{
  public class CanUpdateUserEmail()
  {
    TestContext.Out.WriteLine("[[PROPERTY|author=Adrian]]");
    TestContext.Out.WriteLine("[[PROPERTY|language=english]]");
    TestContext.Out.WriteLine("[[PROPERTY|url:github=https://github.com/project/code.js]]");
    
    // Testmo also supports automation steps, including statuses & 
    // sub fields. This example uses multi-line properties.
    TestContext.Out.WriteLine("[[PROPERTY|step[passed]]]\nThe first step\n[[/PROPERTY]]");
    TestContext.Out.WriteLine("[[PROPERTY|step[passed]]]\nThe second step\n[[/PROPERTY]]");
    TestContext.Out.WriteLine("[[PROPERTY|step[failed]]]\nThe third step\n[[/PROPERTY]]");

    // You can also include attachment links for test artifacts
    TestContext.Out.WriteLine("[[PROPERTY|attachment=https://ci-server/browser.log]]");
    TestContext.Out.WriteLine("[[PROPERTY|attachment=https://ci-server/screenshot.png]]");

    // [..]
  }
}

You can learn more about fields and types supported by Testmo.

More resources & references

Now that you are familiar with submitting your NUnit test results to Testmo, you might also find the following additional examples, topics, and references useful for more advanced workflows.


 
Was this article helpful?