MockQueryable.Moq 7.0.3

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package MockQueryable.Moq --version 7.0.3                
NuGet\Install-Package MockQueryable.Moq -Version 7.0.3                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MockQueryable.Moq" Version="7.0.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MockQueryable.Moq --version 7.0.3                
#r "nuget: MockQueryable.Moq, 7.0.3"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MockQueryable.Moq as a Cake Addin
#addin nuget:?package=MockQueryable.Moq&version=7.0.3

// Install MockQueryable.Moq as a Cake Tool
#tool nuget:?package=MockQueryable.Moq&version=7.0.3                

MockQueryable

Build status Build status Downloads Downloads Downloads License

Build history

Extensions for mocking Entity Framework Core (EFCore) operations such ToListAsync, FirstOrDefaultAsync etc. by Moq, NSubstitute or FakeItEasy When writing tests for your application it is often desirable to avoid hitting the database. The extensions allow you to achieve this by creating a context – with behavior defined by your tests – that makes use of in-memory data.

When should I use it?

If you have something similar to the following code:

var query = _userRepository.GetQueryable();

await query.AnyAsync(x =>...)
await query.FirstOrDefaultAsync(x =>...)
query.CountAsync(x => ...)
query.ToListAsync()
//etc.

and you want to cover it by unit tests

How do I get started?

//1 - create a List<T> with test items
var users = new List<UserEntity>()
{
  new UserEntity{LastName = "ExistLastName", DateOfBirth = DateTime.Parse("01/20/2012")},
  ...
};

//2 - build mock by extension
var mock = users.BuildMock();

//3 - setup the mock as Queryable for Moq
_userRepository.Setup(x => x.GetQueryable()).Returns(mock);

//3 - setup the mock as Queryable for NSubstitute
_userRepository.GetQueryable().Returns(mock);

//3 - setup the mock as Queryable for FakeItEasy
A.CallTo(() => userRepository.GetQueryable()).Returns(mock);

Do you prefer DbSet?

//2 - build mock by extension
var mock = users.AsQueryable().BuildMockDbSet();

//3 - setup DbSet for Moq
var userRepository = new TestDbSetRepository(mock.Object);

//3 - setup DbSet for NSubstitute or FakeItEasy
var userRepository = new TestDbSetRepository(mock);

//3 - setup the mock as Queryable for FakeItEasy
A.CallTo(() => userRepository.GetQueryable()).Returns(mock);

Can I extend the mock object created by MockQueryable with custom logic?

MockQueryable creates for your tests a mock object based on in-memory data, but you can also add some custome logic to it.

var userId = Guid.NewGuid();
var users = new List<UserEntity>
{
    new UserEntity{Id = userId,LastName = "ExistLastName", DateOfBirth = DateTime.Parse("01/20/2012")},
   //etc. 
};
var mock = users.AsQueryable().BuildMockDbSet();

//Aditional setup for FindAsync
mock.Setup(x => x.FindAsync(userId)).ReturnsAsync((object[] ids) =>
{
    var id = (Guid)ids[0];
    return users.FirstOrDefault(x => x.Id == id);
});
var userRepository = new TestDbSetRepository(mock.Object);

//Execution FindAsync
var user = await ((DbSet<UserEntity>) userRepository.GetQueryable()).FindAsync(userId);

Check out the sample project

Where can I get it?

First, install NuGet.

If you are using Moq - then, install MockQueryable.Moq from the package manager console:

PM> Install-Package MockQueryable.Moq

If you are using NSubstitute - then, install MockQueryable.NSubstitute from the package manager console:

PM> Install-Package MockQueryable.NSubstitute

If you are using FakeItEasy - then, install MockQueryable.FakeItEasy from the package manager console:

PM> Install-Package MockQueryable.FakeItEasy

Can I use it with my favorite mock framework?

You can install MockQueryable.EntityFrameworkCore from the package manager console:

PM> Install-Package MockQueryable.EntityFrameworkCore

Downloads

or even MockQueryable.Core

PM> Install-Package MockQueryable.Core

Downloads

Then make your own extension for your favorite mock framework

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (7)

Showing the top 5 NuGet packages that depend on MockQueryable.Moq:

Package Downloads
Reo.Core.Testing

Package Description

Reo.Core.IntegrationTesting

Package Description

Zeesfam.NetLib

Package Description

Reo.Core.Testing.31

Package Description

TNArch.UnitTestSpecification.Core

Package Description

GitHub repositories (8)

Showing the top 5 popular GitHub repositories that depend on MockQueryable.Moq:

Repository Stars
simplcommerce/SimplCommerce
A simple, cross platform, modulith ecommerce system built on .NET
Ombi-app/Ombi
Want a Movie or TV Show on Plex/Emby/Jellyfin? Use Ombi!
CodeMazeBlog/CodeMazeGuides
The main repository for all the Code Maze guides
lkurzyniec/netcore-boilerplate
Boilerplate of API in .NET 8
Librum-Reader/Librum-Server
The Librum server
Version Downloads Last updated
7.0.4-beta 1,803 9/24/2024
7.0.3 203,175 9/2/2024
7.0.2 58,878 8/20/2024
7.0.1 1,193,023 3/7/2024
7.0.0 3,102,858 11/21/2022
6.0.1 3,604,304 3/28/2022
6.0.0 184,372 3/24/2022
5.0.2 232,853 3/24/2022
5.0.1 2,323,731 5/25/2021
5.0.0 1,140,756 11/12/2020
5.0.0-preview.7 29,171 7/28/2020
3.1.3 1,800,747 5/19/2020
3.1.2 133,770 4/17/2020
3.1.1 380,601 1/25/2020
3.0.2 44,079 12/20/2019
3.0.1 45,301 10/11/2019
3.0.0 14,644 9/30/2019
1.1.0 630,555 2/28/2019
1.0.4 47,253 1/29/2019
1.0.3 245,831 8/30/2018
1.0.2 74,572 1/17/2018
1.0.1 8,986 12/26/2017
1.0.0 15,012 12/26/2017

#80  Altered namespace for extension method to revert a breaking change - Thanks @StevePy