bitwarden-test 3.0.0

Internal crate for the bitwarden crate. Do not use.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# Bitwarden Test

<div class="warning">
This crate should only be used in tests and should not be included in production builds.
</div>

Contains test utilities for Bitwarden.

## Play Framework

The Play framework provides scene-based E2E testing with automatic test isolation and cleanup. Using
the server side `SeederApi` to generate data.

### How It Works

1. Each `Play` instance generates a unique `play_id` (UUID)
2. All HTTP requests include an `x-play-id` header for server-side test isolation
3. Any db entry created through a request associated with an `x-play-id` (users, etc.) are saved as
   associated with that `play_id`
4. When the test closure completes, associated data is automatically cleaned up

### Usage

Use the `#[play_test]` macro for the most ergonomic experience:

```rust
use bitwarden_test::play::{play_test, Play, SingleUserArgs, SingleUserScene};

#[play_test]
async fn test_example(play: Play) {
    // Create a test user via the seeder API
    let args = SingleUserArgs {
        email: "test@example.com".to_string(),
        verified: true,
        ..Default::default()
    };
    let scene = play.scene::<SingleUserScene>(&args).await.unwrap();

    // Access user data from the scene result
    let user_id = &scene.result().user_id;
    let api_key = &scene.result().api_key;

    // Use mangled values for test isolation
    let email = scene.get_mangled("test@example.com");

    // Use credentials for testing...

    // Cleanup happens automatically when the test completes
}
```

Or use the builder pattern directly for more control:

```rust
use bitwarden_test::play::{Play, PlayConfig, SingleUserArgs, SingleUserScene};

#[tokio::test]
async fn test_example() {
    Play::builder()
        .config(PlayConfig::new("https://api", "https://identity", "http://seeder"))
        .run(|play| async move {
            let args = SingleUserArgs {
                email: "test@example.com".to_string(),
                verified: true,
                ..Default::default()
            };
            let scene = play.scene::<SingleUserScene>(&args).await.unwrap();

            // Use credentials for testing...
        })
        .await;
}
```

### Environment Variables

| Variable                 | Default                           | Description         |
| ------------------------ | --------------------------------- | ------------------- |
| `BITWARDEN_API_URL`      | `https://localhost:8080/api`      | Base API URL        |
| `BITWARDEN_IDENTITY_URL` | `https://localhost:8080/identity` | Identity server URL |
| `BITWARDEN_SEEDER_URL`   | `http://localhost:5047`           | Seeder API URL      |

### Running E2E Tests

E2E tests require a running Bitwarden server with the seeder API enabled:

```bash
cargo test -p bw --features integration
```