单元测试 gwt-dispatch

Question

我正在尝试使用 JUnit 为 gwt-dispatch 服务编写一些单元测试。使用调试器单步执行测试时出现以下错误：

自定义提供程序中出现错误，com.google.inject.OutOfScopeException：无法访问限定范围的对象。要么我们当前不在 HTTP Servlet 请求中，要么您可能忘记应用 com.google.inject.servlet.GuiceFilter 作为此请求的 servlet 过滤器。

我将在这里稍微简化一下代码——希望我不会删除任何必要的东西。

import junit.framework.TestCase;
import net.customware.gwt.dispatch.client.standard.StandardDispatchService;

import com.google.inject.Guice;
import com.google.inject.Injector;
import com.google.inject.servlet.ServletModule;
...

public class LoggedInServiceTest extends TestCase {

Injector i;
StandardDispatchService service;

protected com.google.inject.Injector getInjector() {
    return Guice.createInjector(new ServletModule(),
            new TestServletModule(),
            new ActionsHandlerModule(),
            new TestDispatchModule(),
            new OpenIdGuiceModule());

}

public void setUp() throws Exception {
    i = getInjector();
    service = i.getInstance(StandardDispatchService.class);
}

public void testNotLoggedIn() {
    try {
        GetProjectsResult result = (GetProjectsResult) service.execute(new GetProjectsAction());
        result.getSizeOfResult();
    } catch (Exception e) {
        fail();
    }
}
}

服务请求确实应该通过 GuiceFilter，但看起来该过滤器尚未设置。

关于注册过滤器需要进行哪些其他设置有什么想法吗？

Answer 1

问题正是它所指出的。您正在尝试访问有作用域的对象，但您当前不在该作用域内。最有可能的是，您的测试向注入器询问 RequestScoped 对象或在注入依赖树中具有 RequestScoped 对象的对象，但测试没有执行任何操作进入范围。

在测试中绑定 GuiceFilter 没有帮助，因为您的测试并没有尝试通过 GuiceFilter 将 HttpServletRequest 发送到 servlet。

最好的选择是对代码进行单元测试。隔离地创建类，注入模拟。

假设您想要进行某种集成测试，您有三个选择：

1. 让您的测试安装一个名为 bindScope(RequestScoped.class, new FakeScope) 的测试模块。 FakeScope 类将实现 Scope 并具有进入和退出范围的方法。您可能必须使用您所依赖的对象的虚假实现来“播种”范围。请参阅 Guice CustomScopes wiki 页面。这是集成测试的最佳选择，恕我直言，
2. 使用 ServletScopes.scopeRequest (Javadoc) 在模拟请求范围内运行部分测试代码。这有点难看，因为您需要传递一个 Callable。
3. 进行完整的端到端测试。启动您的服务器并使用 Selenium 向其发送请求。通过这种方式很难获得良好的覆盖范围，因此我会将其留给您真正需要浏览器来测试的事情。

如果您正在测试的类间接依赖于 HttpServletRequest 或 HttpServletResponse，事情可能会变得有点混乱。正确设置这些类可能具有挑战性。大多数类不应直接或间接依赖于 servlet 类。如果情况并非如此，那么您要么做错了什么，要么需要找到一个好的操作框架，让您的大部分代码不依赖于这些类。

以下是方法 1 的示例，使用 Guice 中的 SimpleScope CustomScopes 维基页面：

public class LoggedInServiceTest extends TestCase {
  private final Provider<StandardDispatchService> serviceProvider;
  private final SimpleScope fakeRequestScope = new SimpleScope();
  private final HttpServletRequest request = new FakeHttpServletRequest();

  protected Injector createInjector() {
    return Guice.createInjector(new FakeRequestScopeModule(),
            new LoggedInServiceModule();
  }

  @Override
  protected void setUp() throws Exception {
    super.setUp();
    Injector injector = createInjector();
    scope.enter();
    serviceProvider = injector.getProvider(StandardDispatchService.class);
  }

  @Override
  protected void tearDown() throws Exception {
    fakeRequestScope.exit()
    super.tearDown();
  }

  public void testNotLoggedIn() {
    fakeRequestScope.enter();
    // fill in values of request
    fakeRequestScope.seed(FakeHttpServletRequest.class, request);

    StandardDispatchService service = serviceProvider.get();
    GetProjectsAction action = new GetProjectsAction();
    try {
        service.execute(action);
        fail();
    } catch (NotLoggedInException expected) {
    }
  }

  private class FakeRequestScopeModule extends AbstractModule() {
    @Override
    protected void configure() {
      bind(RequestScoped.class, fakeRequestScope);
      bind(HttpServletRequest.class)
          .to(FakeHttpServletRequest.class)
          .in(RequestScoped.class)
    }
  }
}

Answer 2

编写一个AppSession接口和两个实现：HttpAppSession和MockAppSession。
让您的服务器端处理程序依赖于 AppSession 而不是直接依赖于 HttpSession。

• 使用 Guice 将 HttpSession 注入 HttpAppSession。这是您将在生产中使用并实际运行您的应用程序的那个。在真实的 servlet 容器中。

• MockAppSession 不应依赖于 HttpSession、HttpServletRequest 或任何其他 Guice Http 范围。这就是您将在测试期间使用的那个。

现在，您的 Guice 模块应该注入一个 AppSession 实现，如下所示：

bind(AppSession.class).to(MockAppSession.class)
bind(MockAppSession.class).in(Singleton.class)

这将为您解决问题。