如何在HttpModule中模拟事件

Question

我有一个简单的Http模块:

public class CustomLoggingModule : IHttpModule
    {
        public void Init(HttpApplication context)
        {
            context.BeginRequest += BeginRequest;

            context.EndRequest += EndRequest;
        }

        public void BeginRequest(object sender, EventArgs eventArgs)
        {
            //some code
        }

        public void EndRequest(object sender, EventArgs eventArgs)
        {
           //some
        }

        public void Dispose()
        {
        }
    }

我怎样才能对此进行单元测试？特别是如何模拟事件？谁能举一些简单的例子？

Answer 1

不确定为什么你决定在CustomLoggingModule中将依赖项硬连接为新的LogService()和新的HttpContextWrapper(HttpContext.Current).如果想要测试是否调用LogInfo()方法,如果可以外部化这些依赖项,那么可以更容易地注入,这样就可以注入存根/模拟版本等.

此外,您的问题并未声明您正在使用IOC容器.您可以向容器注册HttpModule,并在运行时提供外部依赖项.您的问题也没有声明使用isoloation/mock对象框架.因此,我将为您提供一个解决方案,您可以使用手写存根和模拟来验证是否调用了LogInfo方法.

为了实现这一点,我们需要稍微重构一下CustomLoggingModule,因此它变得更加可测试.

被测系统(SUT)

public class CustomLoggingModule : IHttpModule
{
    public ILogService LogService { get; set; }
    public Func<ILoggingHttpContextWrapper> LogginHttpContextWrapperDelegate { get; set; }

    public void Init(HttpApplication context) {
        context.BeginRequest += BeginRequest;
        context.EndRequest += EndRequest;
    }

    public CustomLoggingModule() {
        LogginHttpContextWrapperDelegate = () => new LoggingHttpContextWrapper();
    }

    public void BeginRequest(object sender, EventArgs eventArgs) {
        LogService.LogInfo(LogginHttpContextWrapperDelegate().HttpContextWrapper);
    }

    public void EndRequest(object sender, EventArgs eventArgs) {
        //some
    }

    public void Dispose(){ }
}

如上所述,我已经介绍了2个额外的属性 - ILogService,因此我可以提供一个Mocked版本和一个委托Func,它允许我存根 新的HttpContextWrapper(HttpContext.Current) ;

public interface ILoggingHttpContextWrapper {
    HttpContextWrapper HttpContextWrapper { get; }
}

public class LoggingHttpContextWrapper : ILoggingHttpContextWrapper
{
    public LoggingHttpContextWrapper() {
        HttpContextWrapper = new HttpContextWrapper(HttpContext.Current);
    }

    public HttpContextWrapper HttpContextWrapper { get; private set; }
}

然后你真正的ILogService

public interface ILogService {
   void LogInfo(HttpContextWrapper httpContextWrapper);
}

public class LogService : ILogService {
   public void LogInfo(HttpContextWrapper httpContextWrapper)
   {
        //real logger implementation    
   }
}

单元测试 :

您将创建一个MockLoggerService,因此您可以验证交互i,是否调用了LogInfo()方法等.您还需要一个存根的LoggingHttpContextWrapper来为SUT(System Under Test)/ CustomLoggingModule提供假的HttpContextWrapper.

public class StubLoggingHttpContextWrapper : ILoggingHttpContextWrapper
{
    public StubLoggingHttpContextWrapper(){}

    public HttpContextWrapper HttpContextWrapper { get; private set; }
}

public class MockLoggerService : ILogService
{
    public bool LogInfoMethodIsCalled = false;
    public void LogInfo(HttpContextWrapper httpContextWrapper) {
        LogInfoMethodIsCalled = true;
    }
}

MockLoggerService非常重要.它不是真正的记录器服务,但它是模拟版本.当我们做公共类MockLoggerService:ILogService时,这意味着我们为记录器服务提供了另一层间接,因此我们可以验证行为的交互.

您还注意到我提供了一个布尔变量来验证是否调用了LogInfo方法.这允许我从SUT调用此方法,并验证是否调用该方法.

现在你的单元测试可以实现如下.

    [TestMethod]
    public void CustomLoggingModule_BeginRequest_VerifyLogInfoMethodIsCalled()
    {
        var sut = new CustomLoggingModule();
        var loggerServiceMock = new MockLoggerService();
        var loggingHttpContextWrapperStub = new StubLoggingHttpContextWrapper();

        sut.LogService = loggerServiceMock;
        sut.LogginHttpContextWrapperDelegate = () => loggingHttpContextWrapperStub;

        sut.BeginRequest(new object(), new EventArgs());

        Assert.IsTrue(loggerServiceMock.LogInfoMethodIsCalled);
    }