让我们看看Module.ApplicationEndRequest()方法中的以下语句:
context.Response.Write(builder.ToString());
从单元测试中执行此代码时,context.Response 是您在 MoqHttpContext.CreateBaseMocks() 中设置的模拟:
MockResponse = new Mock<HttpResponseBase>();
// ...
MockContext.Setup(ctx => ctx.Response).Returns(MockResponse.Object);
您不能指望您在模拟上调用Write() 方法,然后可以读回相同的数据。 Mock 是一个假对象。 Write() 方法的默认实现什么都不做,传递的数据只是丢失了。
要解决此问题,您可以在 Response 模拟上设置一个回调,它将传递的数据写入流,然后在读取时将其返回。你其实很接近它。
在MoqHttpContext 类中声明一个流,您将在其中保存数据:
public class MoqHttpContext
{
private readonly MemoryStream _outputStream = new MemoryStream();
// ...
}
然后在CreateBaseMocks() 方法中设置一个回调:
public MoqHttpContext CreateBaseMocks()
{
// ...
MockResponse = new Mock<HttpResponseBase>();
MockResponse.Setup(x => x.Write(It.IsAny<string>())).Callback<string>(s =>
{
var data = Encoding.ASCII.GetBytes(s);
_outputStream.Write(data, 0, data.Length);
_outputStream.Flush();
_outputStream.Position = 0;
});
// ...
}
您还应该删除在MoqHttpContextExtensions.StreamWrite() 中将inputStream 位置设置为0 的行,以便您在UnitTest1.TestMethod1() 中写入的html 数据被附加,而不是被覆盖:
public static HttpContextBase StreamWrite(this HttpContextBase httpContextBase, Stream inputStream, string text)
{
if (inputStream == null) inputStream = new MemoryStream();
var streamWriter = new StreamWriter(inputStream);
inputStream.Position = inputStream.Length;
streamWriter.Write(text);
streamWriter.Flush();
// Remove this line
//inputStream.Position = 0;
return httpContextBase;
}
就是这样。现在如果你在测试中检查responseRead的值,你会看到Http模块附加的数据在那里。
更新(修复过滤器问题)
当前代码存在 3 个不同的问题,阻碍了来自 UT 的过滤器的正确工作。
-
您尝试了一些模拟 Filter 属性的选项,但似乎没有一个是正确的。使用 Moq 模拟属性 getter 的正确方法是:
MockResponse.SetupGet(response => response.Filter).Returns(filter);
删除所有其他用于模拟response.Filter 的语句,但不要添加上述语句,这不是最终版本。
-
您在Module.ApplicationEndRequest() 方法中有以下检查:
if (context.Response.Filter is ResponseSniffer filter)
{
// ...
当执行 UT 时,context.Response.Filter 是 MemoryStream 而不是 ResponseSniffer。在 Module 构造函数中调用的 Setter:
context.Response.Filter = new ResponseSniffer(context.Response.Filter);
实际上不会影响Filter getter 返回的值,因为它是一个模拟,当前总是返回您使用SetupGet 设置的MemoryStream 的实例。要解决此问题,您实际上应该模拟属性行为:保存传递给 setter 的值并在 getter 中返回它。这是response.Filter 属性的最终设置:
Stream filter = new MemoryStream();
MockResponse.SetupSet(response => response.Filter = It.IsAny<Stream>()).Callback<Stream>(value => filter = value);
MockResponse.SetupGet(response => response.Filter).Returns(() => filter);
确保您已删除 response.Filter 属性的所有其他模拟。
-
您应该解决的最后一个问题 - 是来自 UT 的 Module 调用的顺序。目前顺序如下:
httpContext.StreamWrite(httpContext.Response.Filter, html);
// ...
var module = new Module();
module.PreRequestHandlerExecute(mockHttpContext.HttpContext());
但是PreRequestHandlerExecute 将Response.Filter 设置为ResponseSniffer 的实例。因此,当调用上面的httpContext.StreamWrite 时,httpContext.Response.Filter 实际上包含MemoryStream 的实例,而不是ResponseSniffer。因此,您应该做的最后一个修复是更改 UT 正文中的语句顺序:
// ...
var module = new Module();
module.PreRequestHandlerExecute(mockHttpContext.HttpContext());
httpContext.ResponseWrite(html);
httpContext.StreamWrite(httpContext.Response.Filter, html);
module.ApplicationBeginRequest(mockHttpContext.HttpContext());
module.ApplicationEndRequest(mockHttpContext.HttpContext());
// ...
更新(UT重新设计)
此时您的 UT 应该可以工作了。但是目前的测试非常繁琐。需要花费大量时间才能理解它为什么不起作用的事实证明了这一点。这样的测试很难维护和修复,随着时间的推移它们变得非常痛苦。
此外,它更像是集成测试而不是单元测试,因为它调用了几个具有不同功能的类 - ResponseSniffer 和 Module。
您应该强烈考虑重新设计当前测试。好的开始是对ResponseSniffer 和Module 类进行单独测试。
ResponseSniffer 最有价值的测试是验证写入数据是否注册在RecordStream:
[TestClass]
public class ResponseSnifferTests
{
[TestMethod]
public void Write_WritesDataToRecordStream()
{
// Arrange
var inData = new byte[] { 0x01 };
var target = new ResponseSniffer(Mock.Of<Stream>());
// Act
target.Write(inData, 0, inData.Length);
// Assert
target.RecordStream.Position = 0;
var outData = new byte[inData.Length];
int outSize = target.RecordStream.Read(outData, 0, outData.Length);
Assert.AreEqual(inData.Length, outSize);
CollectionAssert.AreEqual(inData, outData);
}
}
对于Module 类,应该进行几项检查:
-
PreRequestHandlerExecute() 将Response.Filter 设置为ResponseSniffer 的实例。
-
ApplicationBeginRequest() 将Stopwatch 添加到context.Items 字典中。
-
ApplicationEndRequest() 将请求信息写入响应。
UT 方法意味着在单独的测试中检查这些事实。以下是这 3 个测试的示例:
[TestClass]
public class ModuleTests
{
[TestMethod]
public void PreRequestHandlerExecuteShouldSetResponseSnifferAsFilter()
{
// Arrange
Stream filter = null;
Mock<HttpResponseBase> httpResponseMock = new Mock<HttpResponseBase>();
httpResponseMock.SetupSet(response => response.Filter = It.IsAny<Stream>()).Callback<Stream>(value => filter = value);
Mock<HttpContextBase> httpContextStub = new Mock<HttpContextBase>();
httpContextStub.SetupGet(x => x.Response).Returns(httpResponseMock.Object);
var target = new Module();
// Act
target.PreRequestHandlerExecute(httpContextStub.Object);
// Assert
Assert.IsNotNull(filter);
Assert.IsInstanceOfType(filter, typeof(ResponseSniffer));
}
[TestMethod]
public void ApplicationBeginRequestShouldStoreStopwatchInContextItems()
{
// Arrange
var items = new Dictionary<string, object>();
Mock<HttpContextBase> httpContextStub = new Mock<HttpContextBase>();
httpContextStub.SetupGet(x => x.Items).Returns(items);
var target = new Module();
// Act
target.ApplicationBeginRequest(httpContextStub.Object);
// Assert
Assert.IsTrue(items.ContainsKey("X-ResponseTime"));
Assert.IsInstanceOfType(items["X-ResponseTime"], typeof(Stopwatch));
}
[TestMethod]
public void ApplicationEndRequestShouldAddRequestInfoToResponse()
{
// Arrange
Mock<HttpRequestBase> httpRequestMock = new Mock<HttpRequestBase>();
httpRequestMock.SetupGet(x => x.FilePath).Returns("/test");
string writtenData = null;
Mock<HttpResponseBase> httpResponseMock = new Mock<HttpResponseBase>();
httpResponseMock.Setup(x => x.Write(It.IsAny<string>())).Callback<string>(s => writtenData = s);
Mock<HttpContextBase> httpContextStub = new Mock<HttpContextBase>();
httpContextStub.SetupGet(x => x.Request).Returns(httpRequestMock.Object);
httpContextStub.SetupGet(x => x.Response).Returns(httpResponseMock.Object);
httpContextStub.SetupGet(x => x.Items).Returns(new Dictionary<string, object> { ["X-ResponseTime"] = new Stopwatch() });
var target = new Module();
// Act
target.ApplicationEndRequest(httpContextStub.Object);
// Assert
Assert.IsTrue(Regex.IsMatch(writtenData, @"Response Size: \d+ bytes<br/>"));
Assert.IsTrue(Regex.IsMatch(writtenData, @"Module request time: \d+ ms"));
}
}
如您所见,测试非常简单明了。您不再需要那些带有大量模拟和助手的MoqHttpContext 和MoqHttpContextExtensions。另一个好处 - 如果某些测试被破坏,则更容易确定根本原因并修复它。
如果您不熟悉单元测试并且正在寻找有关它的良好信息来源,我强烈建议您阅读 Roy Osherove 的书 The Art of Unit Testing。