Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thomas-girotto/MockGen

A C# mocking library based on source generators
https://github.com/thomas-girotto/MockGen

Last synced: about 1 month ago
JSON representation

A C# mocking library based on source generators

Awesome Lists containing this project

README 

        
# MockGen

MockGen was a try to build a .NET mock library based on source generators. It aims was to be the best mocking library in .net world by using source generators to offer the most powerful and straightforward API.



I was pretty happy with the syntax i came up with, until i realized that i cannot support mocking generic methods with the way i designed this lib, which makes it pretty useless! That was still fun though, if some people are curious or find a way to support generic methods i'd be glad to hear from you.



[![thomas-girotto](https://circleci.com/gh/thomas-girotto/MockGen.svg?style=svg)](https://app.circleci.com/pipelines/github/thomas-girotto/MockGen)



## How it works



Instead of generating test doubles at runtime by using dynamic proxy like [Moq](https://github.com/moq/moq4) or [NSubstitute](https://nsubstitute.github.io), MockGen use [source generators](https://devblogs.microsoft.com/dotnet/introducing-c-source-generators/) to generate *sources* of the test doubles which will be included in your test assembly.



That allow the following capabilities :

 - Exposing an API that really embrace the types you want to mock (no more object[] that are still present here and there in other libs, like in constructors argument when you want to mock a class and not an interface)

 - Navigate and setup a breakpoint inside the generated sources, which can be handy to understand why some calls didn't work as expected

 - Expose directly the calls with their parameters that were made on your mocked methods (reprensented as a list of tuples), and let you use your favorite assertion library to check them, instead of having assertions being part of the mocking library

 - Mock protected method

 - Have a nice API like nsubstitute (which i prefer compared to moq), but without the downsize of having all those extensions methods on object, which pop in your intellisense every time you enter a dot :)

 - It's a lot faster at runtime: See [Benchmark.md](Benchmark.md)



## Known Issues



### Lack support for generic methods

Yes, it's a shame and make this lib useless. I can't find a way to keep the syntax that i wanted in the first place and also include support for generic methods... I gave up :). 



## Install It



Reference MockGen in your csproj like this. It should be referenced as an analyzer.

```xml



```



## Quick look



```csharp

// MockG.Generate() Tell the compiler you want to generate a mock for IDependency.

// It returns an instance of Generate type.

// The compiler will generate an extension method 'New' on Generate type that will give you 

// the appropriate mock, and all the helper classes used under the hood.

// The known issue here is annoying as for the moment you may have to restart Visual Studio to be able to

// see the New method in your intellisense if it's the first time you're generating a mock for IDependency

var mock = MockG.Generate().New();



// Returns

mock.GetAge(Arg.Any).Returns(42); // Will return 42 for any parameter

mock.GetAge("My Daughter").Returns(5); // Will return 5 only if this parameter is given

mock.GetAge("My Daughter").Returns(5).AndExecute(_ => {})); // Also execute the given action when called

mock.GetAge(Arg.When(s => s.StartsWith("Grand"))).Returns(70); // Will return 70 only for parameters starting with "Grand"



// Exceptions

mock.GetAge("Lemmy Kilmister").Throws(); // Will throw a new instance of Exception

mock.GetAge("Lemmy Kilmister").Throws(new Exception("He's dead :(")); // Will throw this specifc exception



// Properties 

// For get/set properties, we need to differentiate getter config from setter config.

mock.GetSetProperty.Get.Returns(42); // Will always return 42

mock.GetSetProperty.Set(42).Execute(val => {}); // Execute given action when setting property to 42



// Task or ValueTask

// Even though GetAgeAsync returns a Task you can configure it directly with an int. Same with ValueTask

mock.GetAgeAsync(Arg.Any).Returns(1)



// Pass the mock to the sut

var sut = new MyServiceUnderTest(mock.Build()); // Build() returns the original type setup with mock behavior



// Assertions on calls 

Assert.Equal(2, mock.GetAge(Arg.Any).NumberOfCalls); // Number of calls to GetAge for any parameter

Assert.Equal(1, mock.GetAge("My Daughter").NumberOfCalls); // Number of calls to GetAge with "My Daughter" parameter

Assert.Equal(1, mock.GetAge(Arg.When(s => s.StartsWith("foo")).NumberOfCalls)); // Number of calls matching predicate



// Concrete class: you have access to constructor overloads and not only a params object[]

var mock = MockG.Generate().New(ctorParam1, ctorParam2);



// Out Parameters

// method we're mocking: 

// bool TryGetById(int id, out Model model) { ... }

mock.TryGetById(Arg.Any).Returns(true); // will returns true and set the out parameter with default value

mock.TryGetById(Arg.Any, (id) => new Model()).Returns(true); // will return true and set the out parameter with new Model()



```



## Closer look



Check the [sample project](https://github.com/thomas-girotto/MockGen/tree/master/sample/MockGen.Sample.Tests) for more details in how to use this lib.