Getting Started

Welcome to the documentation source for developers.

Quick Start

A default set of all tools are ready to use under the static class Tools.

/// <summary>Verifies that the tools integrate together.</summary>
[Fact]
public void Tools_IntegrationWorks()
{
    DataSample original = Tools.Randomizer.Create<DataSample>();
    DataSample variant = Tools.Mutator.Variant(original);
    DataSample dupe = Tools.Duplicator.Copy(original);

    Tools.Asserter.Is(original, dupe);
    Tools.Asserter.IsNot(original, variant);

    Fake<DataSample> faked = Tools.Faker.Mock<DataSample>();
    faked.Setup(
        d => d.HasNested(dupe),
        Behavior.Returns(true, Times.Once));

    Tools.Asserter.Is(true, faked.Dummy.HasNested(original),
        "Value equality did not work for args.");

    faked.Verify(Times.Once);
}

The tools are designed to cover many common scenarios including immutable classes, classes with private fields, and classes with static factories instead of constructors.

Customization

In case the default behavior is not enough, each tool can be customized for individual needs by creating your own instances. Additionally, interfaces have been provided for data classes to properly behave with the tools instead. Visit any tool’s page to be guided on either route.

Although each tool can be created and customized on a per test basis, the global tools can be modified via a ‘ModuleInitializer’:

[ModuleInitializer]
internal static void ModifyTools()
{
    Tools.Source = ToolSet.CreateViaSeed(100);

    Tools.Randomizer.AddHint(new StringCreateHint());
}

This way, any customization changes are picked up throughout your code.