beltram / asserhttp

Fluent http assertions
Apache License 2.0
36 stars 3 forks source link

asserhttp

Fluent http response assertions


Crates.io version Crates.io version docs.rs docs Apache 2 ci coverage


A standard trait for doing fluent assertions over many http client response. Currently, supports actix-web, rocket, reqwest, hyper, axum, awc (Actix Web Client), surf, ureq and isahc.

Getting started

Add it to your Cargo.toml

asserhttp = { version = "0.6.1", features = ["reqwest"] }
#                             or features = ["hyper"]
#                             or features = ["actix"]
#                             or features = ["axum"]
#                             or features = ["actix-web-client"]
#                             or features = ["rocket"]
#                             or features = ["surf"]
#                             or features = ["ureq"]
#                             or features = ["isahc"]

Then use it in your tests, for example on actix-web,

use actix_web::{App, HttpResponse, test::{call_service, init_service, TestRequest}, web};
use asserhttp::*;

#[actix_web::test]
async fn sample_test() {
    let app = App::new().route("/", web::get().to(|| async { HttpResponse::Ok().body(json!({"a": "b"})) }));
    call_service(&mut init_service(app).await, TestRequest::get().to_request()).await
        .expect_status_ok()
        .expect_content_type_json()
        .expect_body_json_eq(json!({"a": "b"}));
}

or on reqwest

use reqwest;
use asserhttp::*;

#[tokio::test]
async fn my_test() {
    reqwest::get("http://localhost").await
        .expect_status_ok()
        .expect_content_type_json()
        .expect_body_json_eq(json!({"name": "jdoe"}));
}

Customize

You don't like the asserhttp methods name ? That's fine, you can define yours. Define you own trait and use asserhttp methods to define your own !

As simple as this:

asserhttp::asserhttp_customize!(MyHttpDsl);

pub trait MyHttpDsl<T>: asserhttp::Asserhttp<T> {
    fn is_status_ok(&mut self) -> &mut T {
        self.expect_status_ok()
    }
    fn is_json(&mut self) -> &mut T {
        self.expect_content_type_json()
    }
    fn has_body(&mut self) -> &mut T { self.expect_body_present() }
}

gRPC

Asserting gRPC is also supported with a tonic client. Simply turn on the tonic feature and use it like this:

use asserhttp::grpc::*;

#[tokio::main]
async fn main() {
    // success
    client.call_svc(tonic::Request::new(Payload)).await.expect_status_ok().expect_body(Payload);
    // error
    client.call_svc(tonic::Request::new(Payload)).await.expect_status_error(Code::NotFound);
}