RUST web框架axum快速入门教程6之测试

本文主要讨论axum的测试，axum对于测试的支持还是比较完善的，我们可以测试状态码，HTTP头信息，响应体等内容，因为框架实现的原因，其实axum很依赖tower。

往期文章:

• https://youerning.top/post/axum/quickstart-1
• https://youerning.top/post/axum/quickstart-2
• https://youerning.top/post/axum/quickstart-3
• https://youerning.top/post/axum/quickstart-4
• https://youerning.top/post/axum/quickstart-5

本节Cargo.toml文件所用到的依赖

[dependencies]
axum = { version="0.6.20", features=["default", "headers"] }
axum-extra = { version = "0.8" }
tokio = { version = "1.0", features = ["full"] }
reqwest = { version="0.11.22", features=["json", "multipart"]}
serde = { version = "1.0", features = ["derive"] }
tower = { version = "0.4", features = ["util"] }
tower-http = { version = "0.4.0", features = ["full"] }
serde_json = "1.0.107"
askama = "0.12"
sqlx = { version = "0.7", features = [ "runtime-tokio", "postgres"] }
matchit = "0.7.3"
rand = "0.8.5"
http = "1.0.0"
hyper = "0.14.27"
mime = "0.3"

本文的所有代码都来自官方示例!!! 本文仅仅是翻译和整理，有兴趣的直接参考官方代码: https://github.com/tokio-rs/axum/tree/axum-v0.6.20/examples/testing

快速入门

最简单的方法就是比对状态码和响应内容，下面是来自官方示例的代码。

// https://youerning.top/post/axum/quickstart-6
use std::net::SocketAddr;

use axum::{
    extract::ConnectInfo,
    routing::{get, post},
    Json, Router,
};

#[tokio::main]
async fn main() {
    let addr = std::net::SocketAddr::from(([127, 0, 0, 1], 3000));

    axum::Server::bind(&addr)
        .serve(app().into_make_service())
        .await
        .unwrap();
}

/// 便于测试用例获取router实例
#[allow(dead_code)]
fn app() -> Router {
    Router::new()
        .route("/", get(|| async { "Hello, World!" }))
        .route(
            "/json",
            post(|payload: Json<serde_json::Value>| async move {
                Json(serde_json::json!({ "data": payload.0 }))
            }),
        )
        .route(
            "/requires-connect-into",
            get(|ConnectInfo(addr): ConnectInfo<SocketAddr>| async move { format!("Hi {addr}") }),
        )
}

#[cfg(test)]
mod tests {
    use super::*;
    use axum::{
        body::Body,
        extract::connect_info::MockConnectInfo,
        http::{self, Request, StatusCode},
    };
    use serde_json::{json, Value};
    use std::net::{SocketAddr, TcpListener};
    use tower::Service; // 实现了trait的对象要trait当前环境才能调用, 所以引用Service trait
    use tower::ServiceExt; // 提供`oneshot` 和 `ready`的便捷方法

    #[tokio::test]
    async fn hello_world() {
        let app = app();

        // 因为router本身就是一个Service对象，所以可以直接像其他Service对象那样调用, 这里使用的是ServiceExt提供的oneshot方法
        let response = app
            .oneshot(Request::builder().uri("/").body(Body::empty()).unwrap())
            .await
            .unwrap();

        // 检查状态码
        assert_eq!(response.status(), StatusCode::OK);

        // 检查响应内容
        let body = hyper::body::to_bytes(response.into_body()).await.unwrap();
        assert_eq!(&body[..], b"Hello, World!");
    }
}

虽然我喜欢贴完整代码，但是测试这部分还是只在上面这段代码的基础上仅贴对应的测试代码了。

测试JSON

这个没啥好说的。

#[tokio::test]
async fn json() {
    let app = app();

    let response = app
    .oneshot(
        Request::builder()
        .method(http::Method::POST)
        .uri("/json")
        .header(http::header::CONTENT_TYPE, mime::APPLICATION_JSON.as_ref())
        .body(Body::from(
            serde_json::to_vec(&json!([1, 2, 3, 4])).unwrap(),
        ))
        .unwrap(),
    )
    .await
    .unwrap();

    assert_eq!(response.status(), StatusCode::OK);

    let body = hyper::body::to_bytes(response.into_body()).await.unwrap();
    let body: Value = serde_json::from_slice(&body).unwrap();
    assert_eq!(body, json!({ "data": [1, 2, 3, 4] }));
}

测试404

一般情况下404都是没有响应内容的，至少axum的404 fallback是这样，如果是自己定义的404要谨慎决定是否判断响应内容为空。

#[tokio::test]
async fn not_found() {
    let app = app();

    let response = app
    .oneshot(
        Request::builder()
        .uri("/does-not-exist")
        .body(Body::empty())
        .unwrap(),
    )
    .await
    .unwrap();

    assert_eq!(response.status(), StatusCode::NOT_FOUND);
    let body = hyper::body::to_bytes(response.into_body()).await.unwrap();
    assert!(body.is_empty());
}

测试真实连接

感觉自己测试自己的时候用真实连接还是比较少的，除非是涉及本代码之外的组件才会这么测试。

#[tokio::test]
async fn the_real_deal() {
    // 测试的时候会真的监听端口并响应请求
    let listener = TcpListener::bind("127.0.0.1:13000".parse::<SocketAddr>().unwrap()).unwrap();
    let addr = listener.local_addr().unwrap();

    tokio::spawn(async move {
        axum::Server::from_tcp(listener)
        .unwrap()
        .serve(app().into_make_service())
        .await
        .unwrap();
    });

    let client = hyper::Client::new();

    let response = client
    .request(
        Request::builder()
        .uri(format!("http://{}", addr))
        .body(Body::empty())
        .unwrap(),
    )
    .await
    .unwrap();

    let body = hyper::body::to_bytes(response.into_body()).await.unwrap();
    assert_eq!(&body[..], b"Hello, World!");
}

测试多个请求

oneshot和ready的区别在于前者返回的OneShot对象只能调用一次，多于一次会panic。

#[tokio::test]
async fn multiple_request() {
    let mut app = app();

    let request = Request::builder().uri("/").body(Body::empty()).unwrap();
    let response = app.ready().await.unwrap().call(request).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);

    let request = Request::builder().uri("/").body(Body::empty()).unwrap();
    let response = app.ready().await.unwrap().call(request).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
}

使用MockConnectInfo

这个场景感觉比较偏门，是用来测试获取客户端连接信息的，比如客户端的请求IP和端口。

#[tokio::test]
async fn with_into_make_service_with_connect_info() {
    let mut app = app().layer(MockConnectInfo(SocketAddr::from(([0, 0, 0, 0], 3000))));

    let request = Request::builder()
    .uri("/requires-connect-into")
    .body(Body::empty())
    .unwrap();
    let response = app.ready().await.unwrap().call(request).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
}

这些测试代码我也没全部用过，大家用的时候来找对应的代码就行

小结

测试在开发过程还是比较重要的，足够全面的测试可以带来发布的信心，如果测试都通过了，那么线上出现错误的情况的可能性就比较小了，当然了，前提是测试足够全面。而且，用代码测试比人工测试要准确很多。

总结

axum应该是一个功能完备的web框架的，不过因为比较新，所以文档还没跟上，但是axum提供了比较多个examples, 大家可以自己查阅对应的代码找到示例代码，本系列文章很多代码都是从这里复制的。

参考链接

• https://docs.rs/axum/latest/axum/