5

在 C# 5 中，他们引入了Caller Info 属性。很明显，有用的应用程序之一是日志记录。事实上，他们给出的例子正是：

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上面的示例。我不能像上面那样简单地创建和验证我的模拟。我收到的编译器错误是：

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

解决此问题的唯一方法是It.IsAny<T>在 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",
              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>黑客。我可以编写单元测试，运行一个红绿循环，一切都很好，直到有人尝试修改它。然后，有人可以来修改我的实现以包含错误的参数，并且测试仍然会通过。

解决方案

根据 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"));
4

2 回答 2

1

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

 var stackFrame = new System.Diagnostics.StackFrame(1, true);
 var fileName = stackFrame.GetFileName();
 var lineNumber = stackFrame.GetFileLineNumber();
 var callerMethod = stackFrame.GetMethod();
于 2013-09-09T20:25:11.547 回答
1

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

logger.Verify(log => log.Info("DoIt was called",
    It.Is<string>(callerMemberName => callerMemberName == "ExpectedCallerMemberName"), ..., ...));
于 2016-04-25T04:39:34.207 回答