TestSupport

sfo_sql::testing

Trait TestSupport 

Source 
pub trait TestSupport: Database {
    // Required methods
    fn test_context(
        args: &TestArgs,
    ) -> impl Future<Output = Result<TestContext<Self>, Error>> + Send;
    fn cleanup_test(
        db_name: &str,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn cleanup_test_dbs(    ) -> impl Future<Output = Result<Option<usize>, Error>> + Send + 'static;
    fn snapshot(
        conn: &mut Self::Connection,
    ) -> impl Future<Output = Result<FixtureSnapshot<Self>, Error>> + Send;

    // Provided method
    fn db_name(args: &TestArgs) -> String { ... }
}

Required Methods§

Source

fn test_context( args: &TestArgs, ) -> impl Future<Output = Result<TestContext<Self>, Error>> + Send

Get parameters to construct a Pool suitable for testing.

This Pool instance will behave somewhat specially:

  • all handles share a single global semaphore to avoid exceeding the connection limit on the database server.
  • each invocation results in a different temporary database.

The implementation may require DATABASE_URL to be set in order to manage databases. The user credentials it contains must have the privilege to create and drop databases.

Source

fn cleanup_test(db_name: &str) -> impl Future<Output = Result<(), Error>> + Send

Source

fn cleanup_test_dbs() -> impl Future<Output = Result<Option<usize>, Error>> + Send + 'static

Cleanup any test databases that are no longer in-use.

Returns a count of the databases deleted, if possible.

The implementation may require DATABASE_URL to be set in order to manage databases. The user credentials it contains must have the privilege to create and drop databases.

Source

fn snapshot( conn: &mut Self::Connection, ) -> impl Future<Output = Result<FixtureSnapshot<Self>, Error>> + Send

Take a snapshot of the current state of the database (data only).

This snapshot can then be used to generate test fixtures.

Provided Methods§

Source

fn db_name(args: &TestArgs) -> String

Generate a unique database name for the given test path.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§