Installation

Install ReportPortal.NUnit NuGet package into your project with tests.

PS> Install-Package ReportPortal.NUnit

Note: Skip this section and start to configure the integration if you execute tests in Visual Studio Test Explorer (VS 15.9) with NUnit3TestAdapter package or via dotnet test. NUnit3TestAdapter 3.14.0 and ReportPortal.NUnit 3.7.0 starts to support .net core 2. Execute your netcore tests in Visual Studio Test Explorer, or via dotnet test or dotnet vstest.

To enable NUnit extension you have to add ReportPortal.addins file in the folder where NUnit Runner is located. The content of the file should contain line with relative path to the ReportPortal.NUnitExtension.dll. To read more about how NUnit is locating extensions please follow this.

Imagine you have the next folders structure:

C:
├── NUnitRunner
│   ├── nunit.console.exe
│   └── ReportPortal.addins
└── YourProject
    └── bin
        └── Debug
            ├── YourProject.Tests.dll
            └── ReportPortal.NUnitExtension.dll

To enable ReportPortal.Extension you need create a ReportPortal.addins file in the NUnitRunner folder with the following content:

../YourProject/bin/Debug/ReportPortal.NUnitExtension.dll

To verify installed extension just execute:

nunit3-console.exe --list-extensions

Configuration

Add ReportPortal.json file with configuration of the integration to test project. This file will be copied automatically to output folder during project building.

Example of config file:

{
  "$schema": "https://raw.githubusercontent.com/reportportal/agent-net-nunit/master/src/ReportPortal.NUnitExtension/ReportPortal.config.schema",
  "enabled": true,
  "server": {
    "url": "https://rp.epam.com",
    "project": "default_project",
    "apiKey": "aa19555c-c9ce-42eb-bb11-87757225d535"
  },
  "launch": {
    "name": "NUnit 3 Demo Launch",
    "description": "this is description",
    "debugMode": false,
    "attributes": [ "t1", "t2", "platform:x64" ]
  }
}

Discover more about configuration.

Customization

You can customize a test run in order to have a user-friendly report. Following customization is supported:

• update run/feature/test name
• update run/feature/test description
• add run/feature/test tags

Please note, test categories are added to tags and test description is added to description by default

Add a class that implements NUnit.Engine.ITestEventListener (from NUnit.Engine.Api package) to a project. Assume the class is implemented within the YourProject.Tests project. To enable your extension you need to add path to the project assembly to ReportPortal.addins file in the NUnitRunner folder with the following content (see folder structure above):

../YourProject/bin/Debug/YourProject.Tests.dll

Twelve handlers are available for event subscription that can be represented with following combination: [Before/After][Run/Suite/Test][Started/Finished]. The subscription is implemented in the constructor.

See deatils of the customization in the example

Integrate logger framework

• NLog
• log4net
• Serilog
• System.Diagnostics.TraceListener

And how you can improve your logging experience with attachments or nested steps.

Useful extensions

• SourceBack adds piece of test code where test was failed
• Insider brings more reporting capabilities without coding like methods invocation as nested steps

Example

Follow reportportal example-net-nunit repo to see the source of test project with Report Portal integration.

License

ReportPortal is licensed under Apache 2.0

We use Google Analytics for sending anonymous usage information as library's name/version and the agent's name/version when starting launch. This information might help us to improve integration with ReportPortal. Used by the ReportPortal team only and not for sharing with 3rd parties. You are able to turn off it if needed.