Skip to main content

TestApp

Struct TestApp 

Source
pub struct TestApp { /* private fields */ }
Expand description

In-memory test application backed by an Axum router.

TestApp drives requests through the router with Tower’s in-memory service path, so no TCP listener is started. Use it for handler, middleware, module, and provider integration tests.

use axum::{Json, Router, routing::get};
use http::StatusCode;
use nidus_testing::TestApp;
use serde_json::json;

async fn health() -> Json<serde_json::Value> {
    Json(json!({ "ok": true }))
}

#[tokio::test]
async fn health_returns_json() {
    let app = TestApp::from_router(
        Router::new().route("/health", get(health)),
    );

    let response = app.get("/health").send().await;
    response.assert_status(StatusCode::OK);
    response.assert_json(json!({ "ok": true }));
}

Implementations§

Source§

impl TestApp

Source

pub fn bootstrap<M>() -> Result<TestAppBuilder>
where M: Module,

Creates a test application builder after validating a root Nidus module.

Source

pub fn bootstrap_with_router<M>(router: Router) -> Result<TestAppBuilder>
where M: Module,

Creates a test application builder with a router after validating a root Nidus module.

Source

pub fn bootstrap_with_modules<M, I>(modules: I) -> Result<TestAppBuilder>
where M: Module, I: IntoIterator<Item = ModuleDefinition>,

Creates a test application builder after validating an explicit module graph.

Source

pub fn bootstrap_with_modules_and_router<M, I>( modules: I, router: Router, ) -> Result<TestAppBuilder>
where M: Module, I: IntoIterator<Item = ModuleDefinition>,

Creates a test application builder with a router after validating an explicit module graph.

Source

pub fn from_router(router: Router) -> Self

Creates a test application from an Axum router.

This is the shortest path for HTTP-only tests. It installs an empty Nidus container extension so handlers that need the container can still extract it.

Source

pub fn builder(router: Router) -> TestAppBuilder

Creates a configurable test application builder.

Source

pub fn get(&self, path: impl Into<String>) -> TestRequest

Starts a GET request.

Source

pub fn post(&self, path: impl Into<String>) -> TestRequest

Starts a POST request.

Source

pub fn put(&self, path: impl Into<String>) -> TestRequest

Starts a PUT request.

Source

pub fn patch(&self, path: impl Into<String>) -> TestRequest

Starts a PATCH request.

Source

pub fn delete(&self, path: impl Into<String>) -> TestRequest

Starts a DELETE request.

Source

pub fn request(&self, method: Method, path: impl Into<String>) -> TestRequest

Starts a request with an arbitrary HTTP method.

The returned TestRequest can set headers, query parameters, and body content before TestRequest::send executes it against the in-memory router.

Source

pub fn resolve<T>(&self) -> Result<Arc<T>>
where T: Send + Sync + 'static,

Resolves a provider from the test container.

Source

pub fn request_scope(&self) -> RequestScope<'_>

Creates a request scope for resolving request-lifetime providers in tests.

Source

pub fn config(&self) -> &Config

Returns test configuration overrides.

Source

pub async fn shutdown(&self) -> Result<()>

Runs registered test shutdown lifecycle hooks.

Trait Implementations§

Source§

impl Clone for TestApp

Source§

fn clone(&self) -> TestApp

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Provider for T
where T: Send + Sync + 'static,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more