解决方案

Question

在C＃5中，他们介绍了Caller Info attributes。其中一个有用的应用程序很明显是日志记录。事实上，他们给出的例子就是：

public void TraceMessage(string message,
        [CallerMemberName] string memberName = "",
        [CallerFilePath] string sourceFilePath = "",
        [CallerLineNumber] int sourceLineNumber = 0)
{
    Trace.WriteLine("message: " + message);
    Trace.WriteLine("member name: " + memberName);
    Trace.WriteLine("source file path: " + sourceFilePath);
    Trace.WriteLine("source line number: " + sourceLineNumber);
}

我目前正在开发一个应用程序，我想在我的日志记录例程中介绍调用者信息的用法。假设我有一个相对简单的日志记录界面：

public interface ILogger
{
    void Info(String message);
}

通常情况下，我会使用Moq验证我想要的行为：

// Arrange
var logger = new Mock<ILogger>();
var sut = new SystemUnderTest(logger.Object);

// Act
sut.DoIt();

// Assert
logger.Verify(log => log.Info("DoIt was called"));

这一切都很好。现在我想修改我的日志记录界面，以便它接受调用者信息参数：

public interface ILogger
{
    void Info(String message, [CallerMemberName] string memberName = "",
                              [CallerFilePath] string sourceFilePath = "",
                              [CallerLineNumber] int sourceLineNumber = 0);
}

为简洁起见，您可以假设实现类似于上面的TraceMessage示例。我不能简单地创建和验证我的模拟如上所述。我收到的编译器错误是：

表达式树可能不包含使用的调用或调用可选参数

解决这个问题的唯一方法是在Moq中使用It.IsAny<T>匹配器：

// Arrange
var logger = new Mock<ILogger>();
var sut = new SystemUnderTest(logger.Object);

// Act
sut.DoIt();

// Assert
logger.Verify(log => log.Info("DoIt was called",
              It.IsAny<string>(), It.IsAny<String>(), It.IsAny<int>()));

不幸的是，我无法断言或验证呼叫网站看起来像我期望的那样：

public void DoIt()
{
    // do hard work
    _logger.Info("DoIt was called");
}

这让我想到了一个问题：如何在单元测试中验证来电者信息属性的行为？

我并不特别喜欢It.IsAny<T>黑客。我可以编写单元测试，运行一个红绿循环，一切都很好直到有人试图修改它。然后，有人可以来修改我的实现以包含错误的参数，测试仍然会通过。

解决方案

根据Herr Kater的回答，我能够使用以下方法将调用者信息包装到实用程序类中：

public CallerInfo GetCallerInformation()
{
    var frame = new StackFrame(2, true);

    return new CallerInfo
    {
        FileName = frame.GetFileName(),
        MethodName = frame.GetMethod().Name,
        LineNumber = frame.GetFileLineNumber()
    };
}

然后，我可以将此依赖项注入到我的代码中，并验证记录器实现是否正确使用它。如果他们正确使用日志记录，我的呼叫者现在可以正确测试。

// Arrange
var backingLog = new IMock<IBackingLog>();

var callerInfoUtility = new Mock<ICallerInfoUtility>();

var info = new CallerInfo { MethodName = "Test", FileName = "File", LineNumber = 123 };
callerInfoUtility.Setup(utility => utility.GetCallerInformation()).Returns(info);

var logger = new Logger(backingLog.Object, callerInfoUtility.Object);

// Act
logger.Log("test");

// Assert
logger.Verify(log => log.Info("test was called: Line 123 of Test in File"));

Answer 1

您可以从StackFrame对象中获取一些信息。

 var stackFrame = new System.Diagnostics.StackFrame(1, true);
 var fileName = stackFrame.GetFileName();
 var lineNumber = stackFrame.GetFileLineNumber();
 var callerMethod = stackFrame.GetMethod();

Answer 2

您可以使用It.IsAny<string>()来验证此参数的功能，而不是It.Is<string>(callerMemberName => callerMemberName == "ExpectedCallerMemberName")，如下所示：

logger.Verify(log => log.Info("DoIt was called",
    It.Is<string>(callerMemberName => callerMemberName == "ExpectedCallerMemberName"), ..., ...));

如何使用Caller Info属性进行TDD？

解决方案

2 个答案: