模拟/测试 HTTP 获取请求

Question

我正在尝试为我的程序编写单元测试并使用模拟数据。我对如何拦截对 URL 的 HTTP Get 请求有点困惑。

我的程序调用我们 API 的 URL，并返回一个简单的 XML 文件。我希望测试不是从在线 API 获取 XML 文件，而是从我这里接收预定的 XML 文件，以便我可以将输出与预期输出进行比较，并确定一切是否正常。

我被指向 Mockito 并且已经看到了许多不同的示例，例如这个 SO 帖子，How to use mockito for testing a REST service?，但我不清楚如何设置它以及如何模拟数据（即，返回我自己的 xml每当调用 URL 时文件）。

我唯一能想到的是让另一个程序在 Tomcat 上本地运行，并在我的测试中传递一个特殊的 URL，该 URL 调用 Tomcat 上本地运行的程序，然后返回我想要测试的 xml 文件。但这似乎有点矫枉过正，我认为这是不可接受的。有人能指出我正确的方向吗？

private static InputStream getContent(String uri) {

    HttpURLConnection connection = null;

    try {
        URL url = new URL(uri);
        connection = (HttpURLConnection) url.openConnection();
        connection.setRequestMethod("GET");
        connection.setRequestProperty("Accept", "application/xml");

        return connection.getInputStream();
    } catch (MalformedURLException e) {
        LOGGER.error("internal error", e);
    } catch (IOException e) {
        LOGGER.error("internal error", e);
    } finally {
        if (connection != null) {
            connection.disconnect();
        }
    }

    return null;
}

如果有帮助，我正在使用 Spring Boot 和 Spring 框架的其他部分。

Answer 1

部分问题在于您没有将事物分解为接口。您需要将getContent 包装到一个接口中，并提供一个实现该接口的具体类。然后这个具体的类 需要传递到使用原始getContent 的任何类中。 （这本质上是依赖倒置。）您的代码最终会看起来像这样。

public interface IUrlStreamSource {
    InputStream getContent(String uri)
}

public class SimpleUrlStreamSource implements IUrlStreamSource {
    protected final Logger LOGGER;

    public SimpleUrlStreamSource(Logger LOGGER) {
      this.LOGGER = LOGGER;
    }

    // pulled out to allow test classes to provide
    // a version that returns mock objects
    protected URL stringToUrl(String uri) throws MalformedURLException {
        return new URL(uri);
    }

    public InputStream getContent(String uri) {

        HttpURLConnection connection = null;

        try {
            Url url = stringToUrl(uri);
            connection = (HttpURLConnection) url.openConnection();
            connection.setRequestMethod("GET");
            connection.setRequestProperty("Accept", "application/xml");

            return connection.getInputStream();
        } catch (MalformedURLException e) {
            LOGGER.error("internal error", e);
        } catch (IOException e) {
            LOGGER.error("internal error", e);
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }

        return null;
    }
}

现在使用静态getContent 的代码应该通过IUrlStreamSource 实例getContent()。然后，您向要测试模拟的对象提供 IUrlStreamSource 而不是 SimpleUrlStreamSource。

如果您想测试SimpleUrlStreamSource（但没有太多要测试的东西），那么您可以创建一个派生类，该派生类提供stringToUrl 的实现，该实现返回一个模拟（或引发异常）。

Answer 2

此处的其他答案建议您将代码重构为使用一种可以在测试期间替换的提供程序 - 这是更好的方法。

如果由于某种原因无法实现，您可以安装自定义 URLStreamHandlerFactory，它会拦截您想要“模拟”的 URL，并回退到不应被拦截的 URL 的标准实现。

请注意，这是不可逆的，因此您无法在安装后删除 InterceptingUrlStreamHandlerFactory - 摆脱它的唯一方法是重新启动 JVM。您可以在其中实现一个标志来禁用它并为所有查找返回null - 这将产生相同的结果。

URLInterceptionDemo.java：

public class URLInterceptionDemo {

    private static final String INTERCEPT_HOST = "dummy-host.com";

    public static void main(String[] args) throws IOException {
        // Install our own stream handler factory
        URL.setURLStreamHandlerFactory(new InterceptingUrlStreamHandlerFactory());

        // Fetch an intercepted URL
        printUrlContents(new URL("http://dummy-host.com/message.txt"));
        // Fetch another URL that shouldn't be intercepted
        printUrlContents(new URL("http://httpbin.org/user-agent"));
    }

    private static void printUrlContents(URL url) throws IOException {
        try(InputStream stream = url.openStream();
            BufferedReader reader = new BufferedReader(new InputStreamReader(stream))) {
            String line;
            while((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        }
    }

    private static class InterceptingUrlStreamHandlerFactory implements URLStreamHandlerFactory {

        @Override
        public URLStreamHandler createURLStreamHandler(final String protocol) {
            if("http".equalsIgnoreCase(protocol)) {
                // Intercept HTTP requests
                return new InterceptingHttpUrlStreamHandler();
            }
            return null;
        }
    }

    private static class InterceptingHttpUrlStreamHandler extends URLStreamHandler {

        @Override
        protected URLConnection openConnection(final URL u) throws IOException {
            if(INTERCEPT_HOST.equals(u.getHost())) {
                // This URL should be intercepted, return the file from the classpath
                return URLInterceptionDemo.class.getResource(u.getHost() + "/" + u.getPath()).openConnection();
            }
            // Fall back to the default handler, by passing the default handler here we won't end up
            // in the factory again - which would trigger infinite recursion
            return new URL(null, u.toString(), new sun.net.www.protocol.http.Handler()).openConnection();
        }
    }
}

dummy-host.com/message.txt：

Hello World!

运行时，这个应用会输出：

Hello World!
{
  "user-agent": "Java/1.8.0_45"
}

更改决定拦截哪些 URL 以及返回什么的标准非常容易。

Answer 3

答案取决于您要测试的内容。

如果需要测试InputStream的处理

如果getContent() 被一些处理InputStream 返回的数据的代码调用，并且您想测试处理代码如何处理特定的输入集，那么您需要创建一个接缝来启用测试。我只需将getContent() 移动到一个新类中，然后将该类注入到进行处理的类中：

public interface ContentSource {

  InputStream getContent(String uri);
}

您可以创建一个使用URL.openConnection() 的HttpContentSource（或者更好的是，Apache HttpClientcode）。

然后您将ContentSource 注入处理器：

public class Processor {
  private final ContentSource contentSource;

  @Inject
  public Processor(ContentSource contentSource) {
    this.contentSource = contentSource;
  }

  ...
}

Processor 中的代码可以使用模拟 ContentSource 进行测试。

如果您需要测试内容的提取

如果您想确保 getContent() 正常工作，您可以创建一个测试，启动一个轻量级内存中 HTTP 服务器来提供预期的内容，并让 getContent() 与该服务器通信。这似乎有点矫枉过正。

如果您需要使用假数据测试系统的大部分子集

如果您想确保端到端工作，请编写端到端系统测试。由于您表示您使用 Spring，因此您可以使用 Spring 将系统的各个部分连接在一起（或连接整个系统，但具有不同的属性）。你有两个选择

1. 让系统测试启动本地 HTTP 服务器，并在测试创建系统后，将其配置为与该服务器通信。有关启动 HTTP 服务器的方法，请参阅this question 的答案。

2. 配置 spring 以使用 ContentSource 的假实现。这会让你对所有东西都是端到端工作的信心稍微降低一些，但它会更快，更不容易出错。