Augustus.Reqnroll 0.9.0

Augustus.Reqnroll

Reqnroll (BDD/Gherkin) integration for Augustus. Automatically organizes mock caches by scenario and places them next to your feature files.

Requires the Augustus core package (installed automatically as a dependency).

Quick Start

Register your simulator in a Reqnroll [Binding] hook. Augustus.Reqnroll automatically intercepts the scenario lifecycle to route cached responses into per-scenario subdirectories next to your feature files.

using Augustus.Extensions;
using Augustus.Reqnroll;
using Reqnroll;

[Binding]
public class Hooks
{
    private static APISimulator? _simulator;

    [BeforeTestRun]
    public static async Task BeforeTestRun()
    {
        _simulator = new Hooks().CreateStripeSimulator();

        AugustusReqnrollContext.Register(_simulator);
        await _simulator.StartAsync();
    }

    [AfterTestRun]
    public static async Task AfterTestRun()
    {
        AugustusReqnrollContext.Clear();
        if (_simulator is not null)
        {
            await _simulator.StopAsync();
            await _simulator.DisposeAsync();
            _simulator = null;
        }
    }
}

To use AI-generated responses, also install Augustus.AI and call _simulator.UseAI(...) before StartAsync.

Key Features

• Per-scenario cache isolation — each scenario gets its own cache directory, preventing collisions in parallel runs
• Automatic cache placement — mock files are stored next to your .feature files in a __mocks__ directory
• Zero configuration — register your simulator once and the Reqnroll hooks handle the rest
• Works with all response strategies — static, file-based, AI-generated, or proxy responses all cache correctly

Cache Directory Structure

Cached responses are organized automatically by API name and scenario:

Features/
  __mocks__/
    Stripe/
      Scenario_Name_1/
        {hash}.json
      Scenario_Name_2/
        {hash}.json
  MyFeature.feature

API

// Register a simulator (call in [BeforeTestRun])
AugustusReqnrollContext.Register(simulator);

// Retrieve a registered simulator by index
var sim = AugustusReqnrollContext.GetRegisteredSimulator(0);

// Clean up all registered simulators (call in [AfterTestRun])
AugustusReqnrollContext.Clear();

Related Packages

Documentation

Full documentation and examples: github.com/chrisjainsley/augustus