如何测试绑定到Tokio TcpStream的未来?

时间:2018-09-19 09:03:15

标签: rust future rust-tokio

我有一个未来,它将使用Framed将TCP流包装在LinesCodec中。

当我尝试将其包装在测试中时,我得到未来的阻塞大约有20%的时间,但是由于我在尝试连接的套接字上听不到任何内容,因此我希望总是得到错误:

thread 'tokio-runtime-worker-0' panicked at 'error: Os { code: 111, kind: ConnectionRefused, message: "Connection refused" }', src/lib.rs:35:24 note: Run with 'RUST_BACKTRACE=1' for a backtrace.

这是我使用的测试代码:

#[macro_use(try_ready)]
extern crate futures; // 0.1.24
extern crate tokio;   // 0.1.8

use std::io;
use std::net::SocketAddr;
use tokio::codec::{Framed, LinesCodec};
use tokio::net::TcpStream;
use tokio::prelude::*;

struct MyFuture {
    addr: SocketAddr,
}

impl Future for MyFuture {
    type Item = Framed<TcpStream, LinesCodec>;
    type Error = io::Error;
    fn poll(&mut self) -> Result<Async<Framed<TcpStream, LinesCodec>>, io::Error> {
        let strm = try_ready!(TcpStream::connect(&self.addr).poll());
        Ok(Async::Ready(Framed::new(strm, LinesCodec::new())))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::net::Shutdown;

    #[test]
    fn connect() {
        let addr: SocketAddr = "127.0.0.1:4222".parse().unwrap();
        let fut = MyFuture { addr: addr }
            .and_then(|f| {
                println!("connected");
                let cn = f.get_ref();
                cn.shutdown(Shutdown::Both)
            }).map_err(|e| panic!("error: {:?}", e));
        tokio::run(fut)
    }
}

playground

我已经看到了其他语言中的模式,其中测试二进制文件本身提供了一种异步返回结果的机制,但是还没有找到在Rust中使用类似机制的好方法。

3 个答案:

答案 0 :(得分:2)

测试异步代码的一种简单方法可能是为每个测试使用专用的运行时:启动它,等待将来完成,并在测试结束时关闭运行时。

#[test]
fn my_case() {

    // setup future f
    // ...

    tokio::run(f);
}

我不知道Rust生态系统中是否已经存在整合模式;请参阅this discussion,以了解对基于未来代码的测试支持的演变。

为什么您的代码无法按预期工作

当您调用poll()时,将查询Future来检查值是否可用。

如果没有可用的值,则会注册一个兴趣点,以便在发生可以解决未来的事情时再次调用poll()

调用您的MyFuture::poll()时:

  1. TcpStream::connect创建新的未来TcpStreamNew
  2. TcpStreamNew::poll仅在将来创建步骤1时立即一次被调用。
  3. 未来超出了范围,因此,下次调用MyFuture::poll时,您将永远无法解析先前创建的未来。

您已经注册了一个未来的权益,如果您在第一次轮询时未解决,则永远不会再询问(轮询)已解决的值或错误。

“不确定性”行为的原因是因为第一个poll有时会立即以ConnectionRefused错误解决,并且有时它会永远等待将来的连接事件或从未恢复的故障。

看看Tokio使用的mio::sys::unix::tcp::TcpStream

 impl TcpStream {
     pub fn connect(stream: net::TcpStream, addr: &SocketAddr) -> io::Result<TcpStream> {
         set_nonblock(stream.as_raw_fd())?;

         match stream.connect(addr) {
             Ok(..) => {}
             Err(ref e) if e.raw_os_error() == Some(libc::EINPROGRESS) => {}
             Err(e) => return Err(e),
         }

         Ok(TcpStream {
             inner: stream,
         })
     }

当您在非阻塞套接字上connect时,系统调用可能会立即连接/失败或返回EINPROGRESS,在这最后一种情况下,必须触发轮询以检索错误值。

答案 1 :(得分:1)

问题不在于测试,而在于实现。

此基于您的有效测试用例没有定制的未来实现,仅调用TcpStream::connect()。它可以按您的预期工作。

extern crate futures;
extern crate tokio;

#[cfg(test)]
mod tests {
    use super::*;
    use std::net::Shutdown;
    use std::net::SocketAddr;
    use tokio::net::TcpStream;
    use tokio::prelude::*;

    #[test]
    fn connect() {
        let addr: SocketAddr = "127.0.0.1:4222".parse().unwrap();
        let fut = TcpStream::connect(&addr)
            .and_then(|f| {
                println!("connected");
                f.shutdown(Shutdown::Both)
            }).map_err(|e| panic!("error: {:?}", e));
        tokio::run(fut)
    }
}

playground

您正在通过poll()方法一遍又一遍地连接到同一端点。那不是未来的运作方式。 poll()方法将被重复调用,期望在某个时候它将返回Ok(Async::Ready(..))Err(..)

如果每次调用poll()时都启动一个新的TCP连接,则不可能及时完成。

Here is a modified example that does what you expect

#[macro_use(try_ready)]
extern crate futures;
extern crate tokio;
use std::io;
use std::net::SocketAddr;
use tokio::codec::{Framed, LinesCodec};
use tokio::net::{ConnectFuture, TcpStream};
use tokio::prelude::*;

struct MyFuture {
    tcp: ConnectFuture,
}

impl MyFuture {
    fn new(addr: SocketAddr) -> MyFuture {
        MyFuture {
            tcp: TcpStream::connect(&addr),
        }
    }
}

impl Future for MyFuture {
    type Item = Framed<TcpStream, LinesCodec>;
    type Error = io::Error;

    fn poll(&mut self) -> Result<Async<Framed<TcpStream, LinesCodec>>, io::Error> {
        let strm = try_ready!(self.tcp.poll());
        Ok(Async::Ready(Framed::new(strm, LinesCodec::new())))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::net::Shutdown;

    #[test]
    fn connect() {
        let addr: SocketAddr = "127.0.0.1:4222".parse().unwrap();
        let fut = MyFuture::new(addr)
            .and_then(|f| {
                println!("connected");
                let cn = f.get_ref();
                cn.shutdown(Shutdown::Both)
            }).map_err(|e| panic!("error: {:?}", e));
        tokio::run(fut)
    }
}

不过,我不确定您打算做什么。我不能评论这是正确的方法。

答案 2 :(得分:0)

在某种程度上,您可以放入tokio的测试库来简化此操作。它在单元测试中支持async / await。

#[tokio::test]
async fn my_future_test() {
  let addr: SocketAddr = "127.0.0.1:4222".parse().unwrap();
  match MyFuture { addr }.poll().await {
    Ok(f) => assert!("something good")
    Err(e) => assert!("something bad")
  }
}

https://docs.rs/tokio/0.3.3/tokio/attr.test.html