There are 2 ways to use ReportPortal with xUnit framework, it's depent on runner.

• Visual Studio Runner
• xunit.console.exe

This way is applicable if you use xunit with xunit.runner.visualstudio nuget package.

Install ReportPortal.XUnit nuget package in project with xunit tests.

Add ReportPortal.config.json file to the test project.

{
  "$schema": "https://raw.githubusercontent.com/reportportal/agent-net-xunit/master/src/ReportPortal.XUnitReporter/ReportPortal.config.schema",
  "enabled": true,
  "server": {
    "url": "https://rp.epam.com/api/v1/",
    "project": "default_project",
    "authentication": {
      "uuid": "aa19555c-c9ce-42eb-bb11-87757225d535"
    }
  },
  "launch": {
    "name": "XUnit Demo Launch",
    "description": "this is description",
    "debugMode": false,
    "tags": [ "t1", "t2" ]
  }
}

Now if you execute tests via dotnet test, or dotnet vstest, or vstest.console.exe, you should see real-time report.

If you execute tests with xunit.console.exe runner.

Download zip archive from the Releases tab and extract it into the folder with xunit.console.exe. After downloading zip file, make sure Windows didn't block it: right click on zip -> Properties -> Unblock.

2 files should be placed in the same folder:

• xunit.console.exe
• ReportPortal.XUnitReporter.dll

Note: Supports only xUnit v2.4. Awaiting issue with ability to use custom reporters.

To verify whether reporter is available, execute xunit.console.exe without parameters. -reportportal should be listed in Reporters section.

Configure connection with Report Portal server in ReportPortal.config.json file. Sample is already included in zip archive.

Just execute your tests as you do it usually. Test results are automatically will be sent during execution.

It's possible to override parameters via environment variables.

set reportportal_launch_name="My new launch name"
# execute tests

reportportal_ prefix is used for naming variables, and _ is used as delimeter. For example to override Server.Authentication.Uuid parameter, we need specify ReportPortal_Server_Authentication_Uuid in environment variables. To override launch tags we need specify ReportPortal_Launch_Tags with tag1;tag2 value (; used as separator for list of values).

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

By default xunit doesn't have capturing test output mechanism. To make log frameworks to put messages to ReportPortal, you have to declare ITestOutputHelper object in fixture class constructor, and attach ReportPortal to it.

class MyTests
{
  private ITestOutputHelper _output;

  void MyTests(ITestOutputHelper output)
  {
    _output = output.WithReportPortal();
  }

  [Fact]
  public void MyTest1()
  {
    _output.WriteLine("my message"); // this message goes to test output, will see it at the end of test
    ReportPortal.Shared.Log.Info("my message"); // this message goes immediately to Report Portal

    // or use log framework to produce messages
  }
}

Note: sometimes log messages might be lost if test actively is switching thread context. Currently it's impossible to track test context, please help us to do it.

var tasks = new List<Task>();
for (int i=0; i < 3; i++)
{
  tasks.Add(Task.Run(() => SomeMethod()));
}
Task.WaitAll(tasks.ToArray());

In this example we create 3 threads and execute SomeMethod() in parallel. The issue is if SomeMethod produces log messages - we will loose them. To help us not to lose context just attach ReportPortal one more time. New code looks like:

tasks.Add(Task.Run(() => { _output.WithReportPortal(); SomeMethod(); } ));

• SourceBack