Struct Play 

pub struct Play {
    client: Arc<PlayHttpClient>,
}

The Play test framework for E2E testing

Provides methods for creating scenes, executing queries, and managing test data with automatic cleanup.

Example

use bitwarden_test::play::{Play, SingleUserArgs, SingleUserScene};

#[tokio::test]
async fn test_user_login() {
    Play::builder()
        .run(|play| async move {
            let args = SingleUserArgs {
                email: "[email protected]".to_string(),
                verified: true,
                ..Default::default()
            };
            let scene = play.scene::<SingleUserScene>(&args).await.unwrap();

            // Use scene.get_mangled() to look up mangled values
            let client_id = scene.get_mangled("client_id");

            // Cleanup is automatic when run() completes
        })
        .await;
}

Fields

client: Arc<PlayHttpClient>

Implementations

impl Play

pub fn builder() -> PlayBuilder

Create a new Play builder

Use the builder to configure the Play instance and run tests with automatic cleanup.

Example

Play::builder()
    .run(|play| async move {
        // test code
    })
    .await;

fn new_internal(config: PlayConfig) -> Self

Internal constructor for creating Play instances

pub async fn scene<T>(&self, arguments: &T::Arguments) -> PlayResult<Scene<T>>

where T: SceneTemplate,

Create a new scene from template arguments

The scene data will be cleaned up when the enclosing run() completes.

pub async fn query<Q>(&self, arguments: &Q::Args) -> PlayResult<Q>

where Q: Query,

Execute a query

pub async fn clean(&self) -> PlayResult<()>

Clean all test data for this play_id

This is called automatically by PlayBuilder::run(), but can be called manually if needed.

pub fn play_id(&self) -> &str

Get the play_id for this instance

pub fn config(&self) -> &PlayConfig

Get the configuration

Trait Implementations

impl Clone for Play

fn clone(&self) -> Play

Returns a duplicate of the value.

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

Performs copy-assignment from source.