Objectivity.AutoFixture.XUnit2.AutoMoq
3.6.2
dotnet add package Objectivity.AutoFixture.XUnit2.AutoMoq --version 3.6.2
NuGet\Install-Package Objectivity.AutoFixture.XUnit2.AutoMoq -Version 3.6.2
<PackageReference Include="Objectivity.AutoFixture.XUnit2.AutoMoq" Version="3.6.2" />
paket add Objectivity.AutoFixture.XUnit2.AutoMoq --version 3.6.2
#r "nuget: Objectivity.AutoFixture.XUnit2.AutoMoq, 3.6.2"
// Install Objectivity.AutoFixture.XUnit2.AutoMoq as a Cake Addin #addin nuget:?package=Objectivity.AutoFixture.XUnit2.AutoMoq&version=3.6.2 // Install Objectivity.AutoFixture.XUnit2.AutoMoq as a Cake Tool #tool nuget:?package=Objectivity.AutoFixture.XUnit2.AutoMoq&version=3.6.2
Objectivity.AutoFixture.XUnit2.AutoMock
Accelerates preparation of mocked structures for unit tests under XUnit2 by configuring AutoFixture data generation to use a mocking library of your choice. Gracefully handles recursive structures by omitting recursions.
It provides the following mocking attributes:
- AutoMockData
- InlineAutoMockData
- MemberAutoMockData
Supported mocking libraries
Mocking library | Corresponding NuGet package |
---|---|
Moq | |
NSubstitute | |
FakeItEasy |
Attributes
AutoMockData
Provides auto-generated data specimens generated by AutoFixture with a mocking library as an extension to xUnit.net's Theory
attribute.
Arguments
- IgnoreVirtualMembers - disables generation of members marked as
virtual
; by default set tofalse
Example
[Theory]
[AutoMockData]
public void GivenCurrencyConverter_WhenConvertToPln_ThenMustReturnCorrectConvertedAmount(
string testCurrencySymbol,
[Frozen] ICurrencyExchangeProvider currencyProvider,
CurrencyConverter currencyConverter)
{
// Arrange
Mock.Get(currencyProvider)
.Setup(cp => cp.GetCurrencyExchangeRate(testCurrencySymbol))
.Returns(100M);
// Act
decimal result = currencyConverter.ConvertToPln(testCurrencySymbol, 100M);
// Assert
Assert.Equal(10000M, result);
}
InlineAutoMockData
Provides a data source for a Theory
, with the data coming from inline values combined with auto-generated data specimens generated by AutoFixture with a mocking library.
Arguments
- IgnoreVirtualMembers - disables generation of members marked as
virtual
; by default set tofalse
Example
[Theory]
[InlineAutoMockData("USD", 3, 10, 30)]
[InlineAutoMockData("EUR", 4, 20, 80)]
public void GivenCurrencyConverter_WhenConvertToPln_ThenMustReturnCorrectConvertedAmount(
string testCurrencySymbol,
decimal exchangeRate,
decimal currencyAmount,
decimal expectedPlnAmount,
[Frozen] ICurrencyExchangeProvider currencyProvider,
CurrencyConverter currencyConverter)
{
// Arrange
Mock.Get(currencyProvider)
.Setup(cp => cp.GetCurrencyExchangeRate(testCurrencySymbol))
.Returns(exchangeRate);
// Act
decimal result = currencyConverter.ConvertToPln(testCurrencySymbol, currencyAmount);
// Assert
Assert.Equal(expectedPlnAmount, result);
}
MemberAutoMockData
Provides a data source for a Theory
, with the data coming from one of the following sources:
- A static property
- A static field
- A static method (with parameters)
combined with auto-generated data specimens generated by AutoFixture with a mocking library.
The member must return something compatible with Enumerable<object[]>
with the test data.
Caution: The property is completely enumerated by .ToList() before any test is run. Hence it should return independent object sets.
Arguments
- IgnoreVirtualMembers - disables generation of members marked as
virtual
; by default set tofalse
- ShareFixture - indicates whether to share a
fixture
across all data items should be used or new one; by default set totrue
Example
public class CurrencyConverterFixture
{
public static IEnumerable<object[]> CurrencyConversionRatesWithResult()
{
return new List<object[]>
{
new object[] { "USD", 3M, 10M, 30M },
new object[] { "EUR", 4M, 20M, 80M }
};
}
}
[Theory]
[MemberAutoMockData("CurrencyConversionRatesWithResult", MemberType = typeof(CurrencyConverterFixture))]
public void GivenCurrencyConverter_WhenConvertToPln_ThenMustReturnCorrectConvertedAmount(
string testCurrencySymbol,
decimal exchangeRate,
decimal currencyAmount,
decimal expectedPlnAmount,
[Frozen] ICurrencyExchangeProvider currencyProvider,
CurrencyConverter currencyConverter)
{
// Arrange
Mock.Get(currencyProvider)
.Setup(cp => cp.GetCurrencyExchangeRate(testCurrencySymbol))
.Returns(exchangeRate);
// Act
decimal result = currencyConverter.ConvertToPln(testCurrencySymbol, currencyAmount);
// Assert
Assert.Equal(expectedPlnAmount, result);
}
IgnoreVirtualMembers
An attribute that can be applied to parameters in an AutoDataAttribute
-driven Theory
to indicate that the parameter value should not have virtual
properties populated when the IFixture
creates an instance of that type.
This attribute allows to disable the generation of members marked as virtual
on a decorated type wheres IgnoreVirtualMembers
arguments of mocking attributes mentioned above disable such a generation for all types created by IFixture
.
Caution: Order is important! Applying IgnoreVirtualMembers
attribute to the subsequent parameter makes preceding parameters of the same type to have virtual
properties populated and the particular parameter with the following ones of the same type to have virtual
properties unpopulated.
Example
public class User
{
public string Name { get; set; }
public virtual Address Address { get; set; }
}
[Theory]
[AutoData]
public void IgnoreVirtualMembersUsage(
User firstUser,
[IgnoreVirtualMembers] User secondUser,
User thirdUser)
{
Assert.NotNull(firstUser.Name);
Assert.NotNull(firstUser.Address);
Assert.NotNull(secondUser.Name);
Assert.Null(secondUser.Address);
Assert.NotNull(thirdUser.Name);
Assert.Null(thirdUser.Address);
}
CustomizeWith (borrowed from @devdigital)
An attribute that can be applied to parameters in an AutoDataAttribute
-driven Theory
to apply additional customization when the IFixture
creates an instance of that type.
Arguments
- IncludeParameterType - indicates whether attribute target parameter
Type
should included as a first argument when creating customization; by default set tofalse
Caution: Order is important! Applying CustomizeWith
attribute to the subsequent parameter makes preceding parameters of the same type to be created without specified customization and the particular parameter with the specified customization.
Example
public class LocalDatesCustomization : ICustomization
{
public void Customize(IFixture fixture)
{
fixture.Register(() => LocalDate.FromDateTime(fixture.Create<DateTime>()));
}
}
[Theory]
[InlineAutoMockData("USD")]
[InlineAutoMockData("EUR")]
public void GivenCurrencyConverter_WhenConvertToPlnAtParticularDay_ThenMustReturnCorrectConvertedAmount(
string testCurrencySymbol,
[CustomizeWith(typeof(LocalDatesCustomization))] LocalDate day,
[Frozen] ICurrencyExchangeProvider currencyProvider,
CurrencyConverter currencyConverter)
{
// Arrange
Mock.Get(currencyProvider)
.Setup(cp => cp.GetCurrencyExchangeRate(testCurrencySymbol, day))
.Returns(100M);
// Act
decimal result = currencyConverter.ConvertToPln(testCurrencySymbol, 100M, day);
// Assert
Assert.Equal(10000M, result);
}
CustomizeWith<T>
A generic version of the CustomizeWith
attribute has been introduced for ease of use. The same rules apply as for the non-generic version.
Example
public class EmptyCollectionCustomization : ICustomization
{
public EmptyCollectionCustomization(Type reflectedType)
{
this.ReflectedType = reflectedType;
}
public Type ReflectedType { get; }
public void Customize(IFixture fixture)
{
var emptyArray = Array.CreateInstance(this.ReflectedType.GenericTypeArguments.Single(), 0);
fixture.Customizations.Add(
new FilteringSpecimenBuilder(
new FixedBuilder(emptyArray),
new ExactTypeSpecification(this.ReflectedType)));
}
}
public sealed class EmptyCollectionAttribute : CustomizeWithAttribute<EmptyCollectionCustomization>
{
public EmptyCollectionAttribute()
{
this.IncludeParameterType = true;
}
}
[Theory]
[AutoData]
public void CustomizeWithAttributeUsage(
IList<string> firstStore,
[EmptyCollection] IList<string> secondStore,
IList<string> thirdStore,
IList<int?> fourthStore)
{
Assert.NotEmpty(firstStore);
Assert.Empty(secondStore);
Assert.Empty(thirdStore);
Assert.NotEmpty(fourthStore);
}
Data filtering attributes
The following attributes helps narrowing down data generation to specific values or omitting certain values.
For these attributes to work, they must be used in conjunction with other data generation attributes.
They can be applied to simple types and collections.
Except
An attribute ensuring that values from outside the specified list will be generated.
Example
[Theory]
[AutoData]
public void ExceptAttributeUsage(
[Except(DayOfWeek.Saturday, DayOfWeek.Sunday)] DayOfWeek workday)
{
Assert.True(workday is >= DayOfWeek.Monday and <= DayOfWeek.Friday);
}
PickFromRange
An attribute ensuring that only values from specified range will be generated.
Example
[Theory]
[AutoData]
public void RangeAttributeUsage(
[PickFromRange(11, 19)] int teenagerAge)
{
Assert.True(teenagerAge is > 11 and < 19);
}
PickNegative
An attribute ensuring that only negative values will be generated.
Caution: It will throw exception when being used on unsupported type or on the one which does not accept negative values.
Example
[Theory]
[AutoData]
public void NegativeAttributeUsage(
[PickNegative] int negativeNumber)
{
Assert.True(negativeNumber < 0);
}
PickFromValues
An attribute ensuring that only values from the specified list will be generated.
Example
[Theory]
[AutoData]
public void ValuesAttributeUsage(
[PickFromValues(DayOfWeek.Saturday, DayOfWeek.Sunday)] HashSet<DayOfWeek> weekend)
{
var weekendDays = new[] { DayOfWeek.Saturday, DayOfWeek.Sunday };
Assert.Equivalent(weekendDays, weekend);
}
Tips and tricks
Fixture injection
You can inject same instance of IFixture
to a test method by adding mentioned interface as an argument of test method.
[Theory]
[AutoMockData]
public void FixtureInjection(IFixture fixture)
{
Assert.NotNull(fixture);
}
IgnoreVirtualMembers issue
You should be aware that the CLR requires that interface methods be marked as virtual. Please look at the following example:
public interface IUser
{
string Name { get; set; }
User Substitute { get; set; }
}
public class User : IUser
{
public string Name { get; set; }
public virtual User Substitute { get; set; }
}
You can see than only Substitute
property has been explicitly marked as virtual
. In such situation the compiler will mark other properties as virtual
and sealed
. And finally AutoFixture will assign null
value to those properties when option IgnoreVirtualMembers
will be set to true
.
[Theory]
[AutoMockData(IgnoreVirtualMembers = true)]
public void IssueWithClassThatImplementsInterface(User user)
{
Assert.Null(user.Name);
Assert.Null(user.Substitute);
}
Badges
License | Code Coverage Map |
---|---|
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 is compatible. net48 is compatible. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.7.2
- AutoFixture (>= 4.18.1)
- AutoFixture.AutoMoq (>= 4.18.1)
- AutoFixture.Xunit2 (>= 4.18.1)
- Castle.Core (>= 5.1.1)
- JetBrains.Annotations (>= 2024.2.0)
- Moq (>= 4.18.4)
- xunit.abstractions (>= 2.0.3)
- xunit.core (>= 2.9.2)
- xunit.extensibility.core (>= 2.9.2)
- xunit.extensibility.execution (>= 2.9.2)
-
.NETFramework 4.8
- AutoFixture (>= 4.18.1)
- AutoFixture.AutoMoq (>= 4.18.1)
- AutoFixture.Xunit2 (>= 4.18.1)
- Castle.Core (>= 5.1.1)
- JetBrains.Annotations (>= 2024.2.0)
- Moq (>= 4.18.4)
- xunit.abstractions (>= 2.0.3)
- xunit.core (>= 2.9.2)
- xunit.extensibility.core (>= 2.9.2)
- xunit.extensibility.execution (>= 2.9.2)
-
.NETStandard 2.0
- AutoFixture (>= 4.18.1)
- AutoFixture.AutoMoq (>= 4.18.1)
- AutoFixture.Xunit2 (>= 4.18.1)
- Castle.Core (>= 5.1.1)
- JetBrains.Annotations (>= 2024.2.0)
- Moq (>= 4.18.4)
- xunit.abstractions (>= 2.0.3)
- xunit.core (>= 2.9.2)
- xunit.extensibility.core (>= 2.9.2)
- xunit.extensibility.execution (>= 2.9.2)
-
.NETStandard 2.1
- AutoFixture (>= 4.18.1)
- AutoFixture.AutoMoq (>= 4.18.1)
- AutoFixture.Xunit2 (>= 4.18.1)
- Castle.Core (>= 5.1.1)
- JetBrains.Annotations (>= 2024.2.0)
- Moq (>= 4.18.4)
- xunit.abstractions (>= 2.0.3)
- xunit.core (>= 2.9.2)
- xunit.extensibility.core (>= 2.9.2)
- xunit.extensibility.execution (>= 2.9.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
3.6.2 | 2,511 | 10/4/2024 |
3.6.1 | 45,764 | 12/12/2023 |
3.6.0 | 793 | 12/5/2023 |
3.5.1 | 5,613 | 10/13/2023 |
3.5.0 | 10,103 | 8/30/2023 |
3.4.1 | 25,038 | 4/3/2023 |
3.4.0 | 36,176 | 12/29/2022 |
3.3.3 | 112,541 | 9/16/2020 |
3.3.2 | 16,346 | 8/3/2020 |
3.3.1 | 36,313 | 10/29/2019 |
3.3.0 | 3,492 | 8/24/2019 |
3.2.0 | 18,607 | 3/5/2019 |
3.1.0 | 34,060 | 9/25/2018 |
3.0.67 | 2,257 | 9/17/2018 |
3.0.30 | 29,656 | 7/17/2018 |
3.0.25 | 2,256 | 7/17/2018 |
2.0.5 | 5,426 | 1/30/2018 |
2.0.0 | 1,352 | 1/9/2018 |
1.2.3 | 447 | 4/13/2023 |
1.1.2 | 2,554 | 1/23/2017 |
1.0.12 | 1,266 | 1/20/2017 |
1.0.8 | 1,285 | 1/20/2017 |