ReportPortal.XUnit.V3 1.0.0

ReportPortal integration for xUnit v3

Important Note about xUnit v3 Custom Reporters

According to xUnit v3 documentation, custom runner reporters are only supported by the in-process console runner. This means:

• Custom reporters work only when directly running the test project (by directly invoking the test project .exe or when using dotnet run)
• Custom reporters are not supported by multi-assembly runners like:
  • xunit.v3.runner.console
  • xunit.v3.runner.msbuild
  • xunit.runner.visualstudio (which means they don't work with dotnet test or Test Explorer)

This is a limitation of xUnit v3's design, where test projects are stand-alone executables.

Installation

Install ReportPortal.XUnit.V3 NuGet package in your xUnit v3 test project.

Configuration

Add ReportPortal.json file to the test project.

{
  "$schema": "https://raw.githubusercontent.com/reportportal/agent-dotnet-xunit.v3/main/ReportPortal.config.schema",
  "enabled": true,
  "server": {
    "url": "https://rp.epam.com/api/v1/",
    "project": "default_project",
    "apiKey": "<your_rp_api_key_here>"
  },
  "launch": {
    "name": "XUnit Demo Launch",
    "description": "this is description",
    "debugMode": false,
    "attributes": [ "t1", "os:win10" ]
  }
}

Read more about configuration of other available options and alternative ways how to provide options.

Important Limitations

⚠️ The following methods of running tests will not work with the ReportPortal reporter due to xUnit v3 limitations:

• dotnet test
• dotnet vstest
• vstest.console.exe
• Visual Studio Test Explorer
• xunit.v3.runner.console.exe

This is because these runners do not support custom reporters in xUnit v3.

Additional Resources

• xUnit v3 Documentation
• ReportPortal Documentation

Integrating Logger Frameworks with xUnit v3

You can integrate various logging frameworks with ReportPortal:

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

See here for more information on how to improve your logging experience with attachments or nested steps.

Useful Extensions

• Skippable marks skipped tests as No Defect automatically
• SourceBack adds piece of test code where test was failed
• Insider brings more reporting capabilities without coding like methods invocation as nested steps

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.