如何测试 Hyper 服务器的 HTTP 处理函数？

Question

我的应用程序使用hyper框架通过HTTP提供一些数据。核心是一个处理函数，像这样：

struct HttpHandler {}

impl hyper::server::Handler for HttpHandler {
    fn handle(&self, req: hyper::server::Request, res: hyper::server::Response) {
        res.send(b"Hello").unwrap();
    }
}

Hyper会为每个HTTP请求调用此函数，提供Request req和Response res变量。

我想对我的handle函数进行单元测试，所以我调用该函数，提供一个Request和一个Response，并断言Response已被用于发送预期的数据（"Hello"）。

我正在尝试实例化一个Request和一个Response对象，以传递给handle函数。为此，需要创建几个依赖项。为此，我最终实现了一个模拟NetworkStream。

mod tests {
    use std::io;
    use std::io::prelude::*;
    use std::net::{IpAddr, Ipv4Addr, SocketAddr, SocketAddrV4};
    use std::time::Duration;
    use hyper::server::Handler;

    use super::*;

    struct MockNetworkStream {}

    impl Read for MockNetworkStream {
        fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
            Ok(1)
        }
    }

    impl Write for MockNetworkStream {
        fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
            Ok(1)
        }

        fn flush(&mut self) -> io::Result<()> {
            Ok(())
        }
    }

    impl hyper::net::NetworkStream for MockNetworkStream {
        fn peer_addr(&mut self) -> Result<SocketAddr, io::Error> {
            Ok(SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080)))
        }

        fn set_read_timeout(&self, dur: Option<Duration>) -> Result<(), io::Error> {
            Ok(())
        }

        fn set_write_timeout(&self, dur: Option<Duration>) -> Result<(), io::Error> {
            Ok(())
        }
    }

    #[test]
    fn test_handle() {
        let handler = HttpHandler {};

        let mut request_mock_network_stream = MockNetworkStream {};

        let mut reader = hyper::buffer::BufReader::new(&mut request_mock_network_stream as
                                                       &mut hyper::net::NetworkStream);

        let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);

        // The following fails with
        //    'tests::test_handle' panicked at 'called `Result::unwrap()` on an `Err` value: Header'
        let request = hyper::server::Request::new(&mut reader, socket).unwrap();

        let mut headers = hyper::header::Headers::new();
        let mut response_mock_network_stream = MockNetworkStream {};
        let response = hyper::server::Response::new(&mut response_mock_network_stream,
                                                    &mut headers);

        handler.handle(request, response);

        // I would like to do some assert like this:
        // assert_eq!(result, b"Hello");
    }
}

完整的可运行示例

然而，实例化Request会导致恐慌：

// The following fails with
//    'tests::test_handle' panicked at 'called `Result::unwrap()` on an `Err` value: Header'
let request = hyper::server::Request::new(&mut reader, socket).unwrap();

我的模拟设置中有哪些错误？有没有更简单的方法来测试这样一个处理程序函数而不需要那么多样板代码？

- pixelistik

---

这些Read和Write的实现不好... 这可能会导致其他问题。 - E net4

它看起来很丑，但你可以直接复制 MockStream 的内部实现。 - Shepmaster

Answer 1

请求解码器会期望获取到一个HTTP请求，这个请求是由读取器提供的。

但是您的读取器没有提供任何内容。显然，这将导致解析器失败。

- Matthieu M.

---

我理解了问题，谢谢。但是，如果我尝试 let request = hyper::server::Request::new(b"GET / HTTP/1.0\r\n\r\n", socket).unwrap();，编译器会抱怨类型不匹配：期望类型为 &mut hyper::buffer::BufReader<&mut hyper::net::NetworkStream + 'static>，但实际上得到的类型是 &'static [u8; 18]。我将尝试修改我的模拟数据以返回有效的HTTP数据。 - pixelistik

@pixelistik：是的，抱歉。看起来它比那更具体，我会删除这个建议。 - Matthieu M.

Answer 2

回答自己的问题，基于@Matthieu和@Shepmaster的输入。

我从Hyper代码中复制了MockStream实现，而不是构建自己的实现。

使用这个实现，我现在可以做到我想要的：检查我的HTTP响应是否包含预期的术语：

#[test]
fn test_handle() {
    let handler = HttpHandler {};

    // Create a minimal HTTP request
    let mut request_mock_network_stream = MockStream::with_input(b"GET / HTTP/1.0\r\n\r\n");

    let mut reader = hyper::buffer::BufReader::new(&mut request_mock_network_stream as
                                                   &mut hyper::net::NetworkStream);

    let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);

    let request = hyper::server::Request::new(&mut reader, socket).unwrap();

    let mut headers = hyper::header::Headers::new();
    let mut response_mock_network_stream = MockStream::new();

    {
        let response = hyper::server::Response::new(&mut response_mock_network_stream,
                                                    &mut headers);

        handler.handle(request, response);
    }

    let result = str::from_utf8(&response_mock_network_stream.write).unwrap();

    assert!(result.contains("Hello"));
}

完整可运行的代码

该链接提供了完整可运行的代码。

- pixelistik