TestRift.NUnit 0.6.0

TestRift.NUnit

TestRift.NUnit streams NUnit test run events (logs, status, stack traces, attachments) to the TestRift Server and enables a real-time web UI for browsing and analysis.

Experimental

TestRift is currently in an experimental phase. APIs, configuration, and data formats may change at any time without notice.

Required: TestRift Server

You need the server available before your tests execute. You can either run it yourself or let the plugin auto-start it.

• Server repo: testrift/testrift-server
• Run locally (manual):

pip install testrift-server
testrift-server

• Auto-start: set autoStartServer.enabled: true in TestRiftNUnit.yaml.
  • To start the server with a specific server config file, set autoStartServer.serverYaml (passed as TESTRIFT_SERVER_YAML).
  • To automatically restart the server when the config changes, set autoStartServer.restartOnConfigChange: true (starts the server with --restart-on-config).

Install (NuGet)

dotnet add package TestRift.NUnit

Basic usage

Add the attribute and run hooks:

using TestRift.NUnit;

[assembly: TRLogger]

[SetUpFixture]
public class MyRunHooks : RunHooks
{
}

Configuration

Create a TestRiftNUnit.yaml file to configure the plugin (server connection, run metadata, grouping, and optional URL files).

The config is discovered from either:

• TESTRIFT_NUNIT_YAML (filesystem path), or
• ./TestRiftNUnit.yaml in the current working directory.

All string fields support ${env:VAR_NAME} expansion (missing variables expand to an empty string), which is useful in CI.

Example TestRiftNUnit.yaml:

autoStartServer:
  enabled: true
  serverYaml: TestRiftServer.yaml
  restartOnConfigChange: true
serverUrl: http://localhost:8080

runName: CI run ${env:GITHUB_RUN_NUMBER}
runId: ${env:GITHUB_RUN_ID}

metadata:
  - name: Firmware
    value: ${env:FIRMWARE_BRANCH}
  - name: CI
    value: ${env:GITHUB_RUN_ID}
    url: ${env:GITHUB_SERVER_URL}/${env:GITHUB_REPOSITORY}/actions/runs/${env:GITHUB_RUN_ID}

group:
  name: ${env:PRODUCT}
  metadata:
    - name: Branch
      value: ${env:BRANCH}

urlFiles:
  runUrlFile: test_run_url.txt
  groupUrlFile: test_group_url.txt

Notes:

• autoStartServerYaml is resolved relative to the directory containing TestRiftNUnit.yaml (so you can keep both files together).

Links

• Repository: https://github.com/testrift/testrift-nunit
• Protocol reference: https://github.com/testrift/testrift-server/blob/main/docs/websocket_protocol.md
• Config reference: https://github.com/testrift/testrift-nunit/blob/main/docs/config.md