Partial subs with nsubstitute

Finally got the hang of partial s(t)ubs with nsubstitute. The key is that the original method is called when setting up the sub. To avoid this use argument matchers and the DoNotCallBase() method.

// sample class to test nsubstitute
public class TestMe
{
    // property
    public virtual string Text { 
        get { throw new Exception(); } 
    }
    // parameterless returning method
    public virtual TestMe Copy() { 
        throw new Exception(); 
    }
    // void method with parameter
    public virtual void DoSomething(int index) { 
        throw new Exception(); 
    }
    // returning method with parameter
    public virtual object ReturnSomething(int index) { 
        throw new Exception(); 
    }
}

Property

To test/setup the property to return something and not throw an exception you can use this code.

[Fact]
public void SubStitute_TestMe_Text() {
    var ignoreMe = default(string);
    var expectedString = "hello world";
    var fakeTestMe = Substitute.ForPartsOf<TestMe>();
    // call the property get by assigning the value to some variable
    fakeTestMe.When(x => ignoreMe = x.Text).DoNotCallBase();
    fakeTestMe.Text.Returns<string>(expectedString);
    Assert.Equal(expectedString, fakeTestMe.Text);
}

Parameterless returning method

This looks like the get property, except it is a (real) method. See code below for setup.

[Fact]
public void SubStitute_TestMe_Copy() {
    var fakeTestMe = Substitute.ForPartsOf<TestMe>();
    fakeTestMe.When(x => x.Copy()).DoNotCallBase();
    fakeTestMe.Copy().Returns(fakeTestMe);
    Assert.Same(fakeTestMe, fakeTestMe.Copy());
}

Void method with parameter

For the setup use a parameter matcher. This prevents the real code from executing in the When setup.

[Fact]
public void SubStitute_TestMe_DoSomething() {
    var someRandomNumber = 1234;
    var fakeTestMe = Substitute.ForPartsOf<TestMe>();
    fakeTestMe.When(x => x.DoSomething(Arg.Any<int>()))
              .DoNotCallBase();
    fakeTestMe.DoSomething(someRandomNumber);
}

Returning method with parameter

Last flavor. Setup the return for the method.

[Fact]
public void SubStitute_TestMe_ReturnSomething() {
    var someRandomNumber = 98273;
    var fakeTestMe = Substitute.ForPartsOf<TestMe>();
    fakeTestMe.When(x => x.ReturnSomething(Arg.Any<int>()))
              .DoNotCallBase();
    fakeTestMe.ReturnSomething(Arg.Any<int>())
              .ReturnsForAnyArgs(DateTime.Now); // boxing of struct
    Assert.NotNull(fakeTestMe.ReturnSomething(someRandomNumber));
}

References

Partial subs and test spies on github

About erictummers

My work as a recruited developer changes almost every month. I like challenges and sharing the solutions with others. On my blog I’ll mostly post about my work, but expect an occasional home project, productivity tip and tooling review.
This entry was posted in Test and tagged , , . Bookmark the permalink.

2 Responses to Partial subs with nsubstitute

  1. harouny says:

    Thanks for that dude

  2. Pingback: How to use NSubstitute and/or AutoFixture to test a concrete class | DL-UAT

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s