Skip to main content

NUnit

ProtoTest.NUnit starts the host from a [SetUpFixture] and wraps each [ProtoTest] method in a ProtoTest context. It is the runner the repository's own sample suite uses.

Install​

dotnet add package ProtoTest.NUnit

ProtoTest targets .NET 8, 9 and 10. The dotnet new prototest template defaults to net10.0; pass -f net8.0 or -f net9.0 for an older runtime.

Enable it​

ProtoTestAssembly already carries [SetUpFixture] and owns [OneTimeSetUp] / [OneTimeTearDown]. Declare your own subclass — repeating [SetUpFixture] is harmless and makes the intent obvious.

using NUnit.Framework;
using ProtoTest.Core;
using ProtoTest.NUnit;
using ProtoTest.Rest;

[SetUpFixture]
public sealed class Setup : ProtoTestAssembly
{
    protected override void Configure(IProtoHostBuilder builder) =>
        builder.AddApplication("Api", app => app
            .AddRest(rest => rest.AddClient("Api")));
}
Namespace scoping

This is NUnit behaviour, not ProtoTest's: a [SetUpFixture] outside any namespace applies to the whole assembly, while one inside a namespace applies only to that namespace and its children. If tests in another namespace can't find the host, that's usually why.

Quick start​

[ProtoTest] derives from TestAttribute, so it replaces [Test]. It also implements NUnit's ITestAction, which is how the context starts before the body and completes after it.

using System.Net;
using NUnit.Framework;
using ProtoTest.Core;
using ProtoTest.NUnit;
using ProtoTest.Rest;

[TestFixture]
[Application("Api")]
public class OrderTests
{
    [ProtoTest]
    public async Task Orders_endpoint_responds()
    {
        using var response = await Proto.Context.Rest().GetAsync("/api/orders");
        response.Should.HaveHttpStatus(HttpStatusCode.OK);
    }
}

Per-test lifecycle​

BeforeTest resolves the method's attributes, evaluates its skip conditions, then starts the context with the fully qualified name from ProtoTestName.FromMethod; AfterTest maps NUnit's outcome and completes it. Both calls block on the host task (GetAwaiter().GetResult()), so NUnit is one of the two blocking adapters.

Outcomes​

NUnit statusProtoTest recordsWhy
PassedPassed
FailedFailederror type is NUnit.{Label} — or NUnit.Failed when NUnit reports no label
SkippedSkipped
InconclusiveSkippednothing was proven either way, so it reads like a skip
WarningPartialthe test ran and passed with warnings attached
anything elseUnknownthe status has no ProtoTest equivalent

Skipping​

BeforeTest evaluates the test's conditions before StartTestAsync; a skip calls Assert.Ignore(reason) and nothing is started, so no trace entry is written. [RequiresCapability], [RequiresInProcess] and [RequiresPlaywrightBrowser] all work this way. See Skip conditions.

Attachments​

Artifacts go to TestContext.AddTestAttachment(path, description), using the attachment's description or its name.

Parallel execution​

ProtoTest scopes its context per async flow, so NUnit's parallelism works. The sample suite runs fully parallel:

[assembly: LevelOfParallelism(8)]
[assembly: Parallelizable(ParallelScope.All)]
[assembly: FixtureLifeCycle(LifeCycle.InstancePerTestCase)]

Each test gets its own context and its own lane in the ProtoTrace run timeline.

Limits​

  • ITestAction is synchronous, so the host calls block — NUnit needs a synchronizing context.
  • [SetUpFixture] scoping is NUnit's own namespace rule; keep tests in or under the namespace of the setup class.
  • A skipped test is only reported by NUnit; ProtoTest records nothing for it.

Next​