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

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);
}

通常，我会使用最小起订量来验证我想要的行为：

// 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");
}

这让我想到了我的问题：如何在单元测试中验证 Caller Info 属性的行为？

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

---

解决方案

根据 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.Is<string>(callerMemberName => callerMemberName == "ExpectedCallerMemberName") 代替It.IsAny<string>() 来验证此参数的功能，如下所示：

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