Class TinyBddXunitBase

Namespace

TinyBDD.Xunit

Assembly

TinyBDD.Xunit.dll

Base class for xUnit that initializes TinyBDD ambient context in the constructor and writes a Gherkin report when disposed at the end of the test.

[Feature("Unnamed Feature", null)]
public abstract class TinyBddXunitBase : TestBase, IAsyncLifetime

Inheritance

object

TestBase

TinyBddXunitBase

Implements

IAsyncLifetime

Inherited Members

TestBase.Scenario

TestBase.CleanUp()

TestBase.Given<T>(string, Func<T>)

TestBase.Given<T>(string, Func<ValueTask<T>>)

TestBase.Given<T>(string, Func<CancellationToken, ValueTask<T>>)

TestBase.Given<T>(string, Func<Task<T>>)

TestBase.Given<T>(string, Func<CancellationToken, Task<T>>)

TestBase.Given<T>(Func<T>)

TestBase.Given<T>(Func<ValueTask<T>>)

TestBase.Given<T>(Func<Task<T>>)

TestBase.Given<T>(Func<CancellationToken, Task<T>>)

TestBase.Given<T>(Func<CancellationToken, ValueTask<T>>)

TestBase.From()

TestBase.From(ScenarioContext)

TestBase.FeatureState

TestBase.FeatureSetupExecuted

TestBase.ConfigureFeatureSetup()

TestBase.ConfigureFeatureTeardown()

TestBase.ExecuteFeatureSetupAsync(CancellationToken)

TestBase.ExecuteFeatureTeardownAsync(CancellationToken)

TestBase.BackgroundState

TestBase.BackgroundExecuted

TestBase.ConfigureBackground()

TestBase.ExecuteBackgroundAsync(CancellationToken)

TestBase.GivenBackground<T>()

TestBase.GivenBackground<T>(string)

TestBase.GivenFeature<T>()

TestBase.GivenFeature<T>(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The constructor sets Current and wires an XunitTraitBridge. Xunit.IAsyncLifetime.InitializeAsync() executes any configured background steps. Xunit.IAsyncLifetime.DisposeAsync() emits a Gherkin report and clears the ambient context.

To configure background steps, override ConfigureBackground().

To configure feature-level setup/teardown, override ConfigureFeatureSetup() and ConfigureFeatureTeardown(). Feature setup runs once before the first test in the class, and feature teardown can be triggered manually via ExecuteFeatureTeardownExplicitlyAsync().

Constructors

TinyBddXunitBase(ITestOutputHelper)

Initializes the base with xUnit's Xunit.Abstractions.ITestOutputHelper and sets up TinyBDD context.

protected TinyBddXunitBase(ITestOutputHelper output)

Parameters

output ITestOutputHelper

Properties

Reporter

The reporter used to emit scenario output (e.g., Gherkin-style summaries) at cleanup. Framework-specific base classes should provide an appropriate implementation.

protected override IBddReporter Reporter { get; }

Property Value

IBddReporter

Methods

DisposeAsync()

Writes a Gherkin report and clears the ambient context.

public virtual Task DisposeAsync()

Returns

Task

ExecuteFeatureTeardownExplicitlyAsync()

Explicitly executes feature teardown. Call this from a manual cleanup method if needed.

protected Task ExecuteFeatureTeardownExplicitlyAsync()

Returns

Task

Remarks

Due to xUnit's per-test instance model, feature teardown cannot be automatically triggered. If you need guaranteed cleanup, consider using IClassFixture or manually calling this method from a static cleanup mechanism.

InitializeAsync()

Executes feature setup (once per class) and background steps (per test).

public virtual Task InitializeAsync()

Returns

Task