Struct TestDatabase 

pub struct TestDatabase { /* private fields */ }

A disposable database for one test.

Lifetime model

A TestDatabase owns one Db handle. TestDatabase::sqlite_memory uses a single shared in-memory connection, so the database lives exactly as long as the last clone of the handle and every clone sees the same data.

TestDatabase::isolated opens a transaction, hands the closure a Db bound to it and always rolls back when the closure returns, so tests never observe each other’s writes. Because an in-memory database has one connection, the transaction holds it: use only the Db given to the closure inside it (querying the outer handle would wait forever), and do not keep clones of the transactional Db after the closure finishes.

Implementations

impl TestDatabase

pub fn from_db(db: Db) -> Self

Wrap an existing handle (any backend).

pub async fn sqlite_memory() -> Result<Self, TestDatabaseError>

Open a fresh shared in-memory SQLite database (single connection).

Errors

TestDatabaseError::Backend if the pool cannot be created.

pub fn db(&self) -> &Db

The underlying handle (cheap to clone).

pub fn into_db(self) -> Db

Consume the wrapper and return the handle.

pub fn with_signals(self, signals: Signals) -> Self

Attach signals so model signals fire for this database. Do this before cloning the handle out; it applies to this handle and later clones only.

pub async fn with_models( self, models: &[&ModelMeta], ) -> Result<Self, TestDatabaseError>

Create the tables (and indexes, constraints, M2M join tables) for models from their compiled metadata, as makemigrations + migrate would.

Errors

TestDatabaseError::Migration if DDL cannot be rendered for the backend, or TestDatabaseError::Orm if a statement fails.

pub async fn with_migrations( self, dir: impl AsRef<Path>, ) -> Result<Self, TestDatabaseError>

Apply every migration file found in dir.

Errors

TestDatabaseError::Migration for unreadable, inconsistent or failing migrations.

pub async fn isolated<F, Fut, T>(&self, f: F) -> Result<T, TestDatabaseError>

where F: FnOnce(Db) -> Fut, Fut: Future<Output = T>,

Run f inside a transaction that is always rolled back, returning f’s value. See the TestDatabase docs for the lifetime model.

Panics in f also discard the transaction.

Errors

TestDatabaseError::Orm if the transaction cannot begin or roll back.

Trait Implementations

impl Clone for TestDatabase

fn clone(&self) -> TestDatabase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TestDatabase

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.