jcoliz.FakeObjects 1.0.0-rc1

Fake Objects

This is a .NET Core 3.1 library for creating fake objects used in tests. It can be used in applications built on any version of .NET from Core 3.1 onward, including .NET 6.0.

Usage

Namespace

using jcoliz.FakeObjects;

Mark Up Classes

First, you'll need to tell the library which properties you want filled in on your fake objects. Do this by marking them "Editable(true)". In the example below, the library will only fill in values for the Name and Date properties.

using System.ComponentModel.DataAnnotations;

public class ModelItem
{
    public int ID { get; set; }

    [Editable(true)]
    public string Name { get; set; }

    [Editable(true)]
    public DateTime Date { get; set; }

    public string Details { get; set; }
}

Create objects

In its simplest form, you can simply make a number of objects. Each item will have a unique value in the editable fields, and default values in the others.

[TestMethod]
public void AddItems()
{
    // Given: A set of objects
    var items = FakeObjects<ModelItem>.Make(20);

    // When: Adding objects to the system
    respository.AddRange(items);

    // Then: The items were added
    var results = repository.GetItems();
    Assert.IsTrue(results.SequenceEqual(items));
}

Modify certain objects

Commonly, we want a subset of objects to have a certain property we're looking for. Each call to Make or Add creates another group, starting at zero. In this example, Group(1) will contain the 10 items with "test" appended to the name.

[TestMethod]
public void Search()
{
    // Given: A set of objects, where a subset has {word} in the name
    var word = "__test__";
    var items = FakeObjects<ModelItem>.Make(20).Add(10, x => x.Name += test);

    // And: The objects are in the repository
    respository.AddRange(items);

    // When: Searching for {word}
    var results = repository.Search(word);
    
    // Then: Only the objects with {word} are returned
    Assert.IsTrue(results.SequenceEqual(items.Group(1)));
}

Add objects to the system under test

Any time we are adding objects to the system under test during the "Given" phase of a test, it's a good time to use the "SaveTo()" feature. In this example, we implement IFakeObjectsSaveTarget directly in the test class. You can also implement it directly, for example in a mock repository of items.

using System.Collections;

[TestClass]
public class TestClass: IFakeObjectsSaveTarget
{
    public void AddRange(IEnumerable objects)
    {
        if (objects is IEnumerable<ModelItem> items)
        {
            repository.AddRange(items);
        }
        else
            throw new NotImplementedException();
    }

    [TestMethod]
    public void Search_V2()
    {
        // Given: A set of objects in the repository, where a subset has {word} in the name
        var word = "__test__";
        var items = FakeObjects<ModelItem>.Make(20).Add(10, x => x.Name += test).SaveTo(this);

        // When: Searching for {word}
        var results = repository.Search(word);
        
        // Then: Only the objects with {word} are returned
        Assert.IsTrue(results.SequenceEqual(items.Group(1)));
    }
}

And more!

Please review the full Usage docs for the complete reference of use cases.

Code of conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Please review the Code of conduct for more details.