fedimint-testing-core 0.13.0-beta.0

fedimint-testing provides a basic utils for testing fedimint components
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

use anyhow::ensure;
use fedimint_client::db::{ClientConfigKey, ClientConfigKeyV0};
use fedimint_core::config::{ClientConfigV0, FederationId, GlobalClientConfigV0};
use fedimint_core::db::{Database, IDatabaseTransactionOpsCoreTyped};
use fedimint_core::module::CoreConsensusVersion;
use fedimint_core::module::registry::ModuleDecoderRegistry;
use fedimint_logging::TracingSetup;

use crate::db::{snapshot_db_migrations_with_decoders, validate_migrations_core_client};
/// Create a client database with version 0 data. The database produced is
/// not intended to be real data or semantically correct. It is only
/// intended to provide coverage when reading the database
/// in future code versions. This function should not be updated when
/// database keys/values change - instead a new function should be added
/// that creates a new database backup that can be tested.
async fn create_client_db_with_v0_data(db: Database) {
    let mut dbtx = db.begin_transaction().await;

    let federation_id = FederationId::dummy();

    let client_config_v0 = ClientConfigV0 {
        global: GlobalClientConfigV0 {
            api_endpoints: Default::default(),
            consensus_version: CoreConsensusVersion::new(0, 0),
            meta: Default::default(),
        },
        modules: Default::default(),
    };

    let client_config_key_v0 = ClientConfigKeyV0 { id: federation_id };

    dbtx.insert_new_entry(&client_config_key_v0, &client_config_v0)
        .await;

    dbtx.commit_tx().await;
}

#[tokio::test(flavor = "multi_thread")]
async fn snapshot_client_db_migrations() -> anyhow::Result<()> {
    snapshot_db_migrations_with_decoders(
        "fedimint-client",
        |db| {
            Box::pin(async {
                create_client_db_with_v0_data(db).await;
            })
        },
        ModuleDecoderRegistry::default(),
    )
    .await
}

#[tokio::test(flavor = "multi_thread")]
async fn test_client_db_migrations() -> anyhow::Result<()> {
    let _ = TracingSetup::default().init();

    validate_migrations_core_client("fedimint-client", |db| async move {
        let mut dbtx = db.begin_transaction_nc().await;
        // Checks that client config migrated to ClientConfig with broadcast_public_keys
        ensure!(
            dbtx.get_value(&ClientConfigKey).await.is_some(),
            "Client config migration to v0 failed"
        );

        Ok(())
    })
    .await?;

    Ok(())
}