Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make guard against unmatchable matchers less strict to enable user-based wildcard matching #1202

Merged
merged 5 commits into from
Aug 23, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions src/Moq/MatcherFactory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,30 @@ public static Pair<IMatcher, Expression> CreateMatcher(Expression argument, Para
var convertExpression = (UnaryExpression)argument;
if (convertExpression.Method?.Name == "op_Implicit")
{
if (!parameter.ParameterType.IsAssignableFrom(convertExpression.Operand.Type) && convertExpression.Operand.IsMatch(out _))
if (convertExpression.IsMatch(out var match))
{
throw new ArgumentException(
string.Format(
Resources.ArgumentMatcherWillNeverMatch,
convertExpression.Operand.ToStringFixed(),
convertExpression.Operand.Type.GetFormattedName(),
parameter.ParameterType.GetFormattedName()));
Type foundType;

if (match.GetType().IsGenericType)
{
// If match type is `Match<int>`, foundType set to `int`
// Fix for https://github.com/moq/moq4/issues/1199
foundType = match.GetType().GenericTypeArguments[0];
}
else
{
foundType = convertExpression.Operand.Type;
}
Copy link
Contributor

@stakx stakx Aug 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Ideally, we wouldn't have any conditionals here. We ought to be able to simply ask the Match object directly what type of values it targets.

I also suspect that we currently don't have any tests covering this else block.

For both reasons, it'd be nice to simplify this whole ifelse block to something non-conditional, but this is more of a bonus—you can leave this code as is for now.)

Copy link
Contributor Author

@adamfk adamfk Aug 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't mind making a new ticket to clean it up. I'd like to get this in and working first.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you are willing to clean this up, then I say, let's do it now. (It should be a fairly trivial change, see my earlier comment over in the issue about adding some Type property to Match.)


if (!parameter.ParameterType.IsAssignableFrom(foundType))
{
throw new ArgumentException(
string.Format(
Resources.ArgumentMatcherWillNeverMatch,
convertExpression.Operand.ToStringFixed(),
convertExpression.Operand.Type.GetFormattedName(),
parameter.ParameterType.GetFormattedName()));
}
}
}
}
Expand Down
205 changes: 205 additions & 0 deletions tests/Moq.Tests/Matchers/AnyValueAttributeTests3.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,205 @@
using Xunit;
using System;

/// <summary>
/// Tests for https://github.com/moq/moq4/issues/1199
/// </summary>

namespace Moq.Tests.Matchers.Wildcard
{
using static AutoIsAny; // note using static to simplify syntax

/// <summary>
/// Helper class provided by user
/// </summary>
public abstract class AutoIsAny
{
public static AnyValue _
{
get
{
It.IsAny<object>(); // This allows it to work for interface types. It doesn't hit the implicit conversion guard, because no implicit conversion
// is required for interfaces. Implicit interface conversions also aren't allowed in C#.
// For non-interface types, the AnyValue implicit conversion below will overwrite `It.IsAny<object>()`
// with the appropriate `It.IsAny<T>()`.
return new AnyValue();
}
}
}

/// <summary>
/// Helper class provided by user. Interfaces implemented via IDE auto explicit interface implementation
/// or Roslyn analyzer/code fix.
/// </summary>
public class AnyValue : ISomeService
{
int ISomeService.Calc(int a, int b, int c, int d)
{
throw new NotImplementedException();
}

int ISomeService.DoSomething(ISomeService a, GearId b, int c)
{
throw new NotImplementedException();
}

int ISomeService.Echo(int a)
{
throw new NotImplementedException();
}

int ISomeService.UseAnimal(Animal a)
{
throw new NotImplementedException();
}

int ISomeService.UseDolphin(Dolphin a)
{
throw new NotImplementedException();
}

int ISomeService.UseInterface(ISomeService a)
{
throw new NotImplementedException();
}

public static implicit operator int(AnyValue _) => It.IsAny<int>();
public static implicit operator byte(AnyValue _) => It.IsAny<byte>();
public static implicit operator GearId(AnyValue _) => It.IsAny<GearId>();
public static implicit operator Animal(AnyValue _) => It.IsAny<Animal>();
public static implicit operator Dolphin(AnyValue _) => It.IsAny<Dolphin>();
}


public class Tests
{
Mock<ISomeService> mock;
ISomeService obj;

public Tests()
{
mock = new Mock<ISomeService>();
obj = mock.Object;
}

[Fact]
public void Echo_1Primitive()
{
mock.Setup(obj => obj.Echo(_)).Returns(777);
Assert.Equal(777, obj.Echo(1));
}

[Fact]
public void Calc_4Primitives()
{
mock.Setup(obj => obj.Calc(_, _, _, _)).Returns(999);
Assert.Equal(999, obj.Calc(1, 2, 3, 4));
}

[Fact]
public void UseInterface()
{
mock.Setup(obj => obj.UseInterface(_)).Returns(555);
Assert.Equal(555, obj.UseInterface(null));

var realService = new SomeService();
Assert.Equal(555, obj.UseInterface(realService));
}

[Fact]
public void DoSomething_MixedTypes()
{
mock.Setup(obj => obj.DoSomething(_, _, _)).Returns(444);
Assert.Equal(444, obj.DoSomething(null, GearId.Neutral, 1));
}

[Fact]
public void UseAnimal()
{
mock.Setup(obj => obj.UseAnimal(_)).Returns(777);
Assert.Equal(777, obj.UseAnimal(new Animal()));
Assert.Equal(777, obj.UseAnimal(new Dolphin()));
}

[Fact]
public void UseDolphin()
{
mock.Setup(obj => obj.UseDolphin(_)).Returns(888);
Assert.Equal(888, obj.UseDolphin(new Dolphin()));
}
}


/// <summary>
/// Example enum
/// </summary>
public enum GearId
{
Reverse,
Neutral,
Gear1,
}


/// <summary>
/// Example interface
/// </summary>
public interface ISomeService
{
int Echo(int a);
int Calc(int a, int b, int c, int d);
int UseInterface(ISomeService a);
int DoSomething(ISomeService a, GearId b, int c);
int UseAnimal(Animal a);
int UseDolphin(Dolphin a);
}


/// <summary>
/// just a class that implements interface
/// </summary>
public class SomeService : ISomeService
{
public int Calc(int a, int b, int c, int d)
{
throw new NotImplementedException();
}

public int DoSomething(ISomeService a, GearId b, int c)
{
throw new NotImplementedException();
}

public int Echo(int a)
{
throw new NotImplementedException();
}

public int UseAnimal(Animal a)
{
throw new NotImplementedException();
}

public int UseDolphin(Dolphin a)
{
throw new NotImplementedException();
}

public int UseInterface(ISomeService a)
{
throw new NotImplementedException();
}
}


public class Animal
{

}


public class Dolphin : Animal
{

}
}