Swiss knife for your .NET dependencies
// specify where to store recordings with instance of TextWriter
using (var recorder = new Recorder(textWriter))
{
// for each of your external dependency get recordable instance
var storage = recorder.GetRecordingTarget(new RealStorage());
// setup your code and run it
var myImplementation = new MyCode(storage);
myImplementation.Execute();
}Later you can replay all interactions with external dependencies and replay them:
// specify the same source that you used to write recordings
using (var player = new Player(textReader))
{
// get an instance of dependency you'd like to replay:
// note: you don't need to provide its implementation!
var storage = player.GetReplayingTarget<IStorage>();
// setup your code and run it
var myImplementation = new MyCode(storage);
myImplementation.Execute();
}This ability is useful when you want to ensure that your changes won't change interactions with your dependencies. For more realistic example see Recording sample and its complement Replay sample.
Given Execute() method that throws but which is marked with [Restricted] attriubute in the interface as below:
public interface IDependency
{
void Acknowledge();
[Restricted]
void Execute();
}
public class ThrowingDependency : IDependency
{
public void Acknowledge()
{
Console.WriteLine($"Hello, I'm implementation of {GetType().Name}");
}
public void Execute()
{
throw new IOException();
}
}Using RestrictingProvider you can avoid calling undesired methods:
var restrictedObj = new RestrictingProvider(logger)
.GetRestrictedTarget<IDependency>(
new ThrowingDependency());
restrictedObj.Acknowledge();
restrictedObj.Execute();
Console.WriteLine("Reached end of execution");The above will produce the following output:
Hello, I'm implementation of ThrowingDependency
Reached end of execution
Note implementation of Acknowledge() is invoked, but not of Execute(). For more detailed example and interesting use cases visit documentation.