Soenneker.Utils.AutoBogus 2.1.80

Soenneker.Utils.AutoBogus

The .NET Autogenerator

This project is an automatic creator and populator for the fake data generator Bogus.

It's a replacement for the abandoned AutoBogus library.

The goals are to be fast, and support the latest types in .NET.

.NET 6+ is supported.

Installation

dotnet add package Soenneker.Utils.AutoBogus

Usage

• Create an AutoFaker instance:

var autoFaker = new AutoFaker();

• Call Generate<>() on any type you want:

var someRandomWord = autoFaker.Generate<string>();
var dictionary = autoFaker.Generate<Dictionary<int, string>>();
var order = autoFaker.Generate<Order>();

• Set a faker, configuration, rulesets, etc:

autoFaker.Config.Faker = new Faker("de");
autoFaker.Config.RecursiveDepth = 3;
...

• AutoFakerOverride can be used for type customization:

public class OrderOverride : AutoFakerOverride<Order>
{
    public override void Generate(AutoFakerOverrideContext context)
    {
        var target = (context.Instance as Order)!;
        target.Id = 123;
        
        // Faker is available
        target.Name = context.Faker.Random.Word();

        // AutoFaker is also available
        target.Customer = context.AutoFaker.Generate<Customer>();
     }
}

• Configuring AutoFakerOverride on the AutoFaker:

autoFaker.Config.Overrides = new AutoFakerOverrides();
autoFaker.Config.Overrides.Add(new OrderOverride());

Tips

• ⚠️ Instantiating a Bogus Faker takes a substantial amount of time (almost 1ms). An instance of AutoFaker will create one Faker. Thus, it's recommended that a single instance be used if possible.
• AutoFaker.GenerateStatic<>() is available, but should be avoided (as it creates a new AutoFaker/Faker on each call).

Notes

• This is a work in progress. Contribution is welcomed.

Benchmarks

Soenneker.Utils.AutoBogus

AutoBogus

Bogus