ic-dbms-api 0.9.0

Public API types for ic-dbms-canister. This crate provides shared types for interacting and implementing the ic-dbms-canister.
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103

use candid::CandidType;
use serde::{Deserialize, Serialize};

/// Arguments for initializing or updating an IC DBMS canister.
#[derive(Debug, CandidType, Serialize, Deserialize)]
pub enum IcDbmsCanisterArgs {
    Init(IcDbmsCanisterInitArgs),
    Upgrade(IcDbmsCanisterUpgradeArgs),
}

impl IcDbmsCanisterArgs {
    /// Unwraps the arguments as [`IcDbmsCanisterInitArgs`], or traps if it's not of that variant.
    pub fn unwrap_init(self) -> IcDbmsCanisterInitArgs {
        match self {
            IcDbmsCanisterArgs::Init(args) => args,
            _ => ic_cdk::trap("Expected IcDbmsCanisterArgs::Init"),
        }
    }

    /// Unwraps the arguments as [`IcDbmsCanisterUpgradeArgs`], or traps if it's not of that variant.
    pub fn unwrap_update(self) -> IcDbmsCanisterUpgradeArgs {
        match self {
            IcDbmsCanisterArgs::Upgrade(args) => args,
            _ => ic_cdk::trap("Expected IcDbmsCanisterArgs::Upgrade"),
        }
    }
}

#[derive(Debug, CandidType, Serialize, Deserialize)]
pub struct IcDbmsCanisterInitArgs {
    /// Initial admins to bootstrap the granular ACL with full perms
    /// (`admin` + `manage_acl` + `migrate` + every table perm). When
    /// `None` or empty, the deployer principal is used.
    pub allowed_principals: Option<Vec<candid::Principal>>,
}

#[derive(Debug, CandidType, Serialize, Deserialize)]
pub struct IcDbmsCanisterUpgradeArgs;

#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    fn test_unwrap_init_on_init_variant() {
        let principals = vec![candid::Principal::anonymous()];
        let args = IcDbmsCanisterArgs::Init(IcDbmsCanisterInitArgs {
            allowed_principals: Some(principals.clone()),
        });
        let init = args.unwrap_init();
        assert_eq!(init.allowed_principals, Some(principals));
    }

    #[test]
    fn test_unwrap_update_on_upgrade_variant() {
        let args = IcDbmsCanisterArgs::Upgrade(IcDbmsCanisterUpgradeArgs);
        let _upgrade = args.unwrap_update();
    }

    #[test]
    #[should_panic]
    fn test_unwrap_init_on_upgrade_variant_traps() {
        let args = IcDbmsCanisterArgs::Upgrade(IcDbmsCanisterUpgradeArgs);
        let _init = args.unwrap_init();
    }

    #[test]
    #[should_panic]
    fn test_unwrap_update_on_init_variant_traps() {
        let args = IcDbmsCanisterArgs::Init(IcDbmsCanisterInitArgs {
            allowed_principals: Some(vec![]),
        });
        let _upgrade = args.unwrap_update();
    }

    #[test]
    fn test_candid_roundtrip_init_args() {
        let args = IcDbmsCanisterArgs::Init(IcDbmsCanisterInitArgs {
            allowed_principals: Some(vec![candid::Principal::anonymous()]),
        });
        let encoded = candid::encode_one(&args).expect("failed to encode");
        let decoded: IcDbmsCanisterArgs = candid::decode_one(&encoded).expect("failed to decode");
        assert!(matches!(decoded, IcDbmsCanisterArgs::Init(_)));
    }

    #[test]
    fn test_init_args_default_allowed_is_none() {
        let args = IcDbmsCanisterArgs::Init(IcDbmsCanisterInitArgs {
            allowed_principals: None,
        });
        let init = args.unwrap_init();
        assert!(init.allowed_principals.is_none());
    }

    #[test]
    fn test_candid_roundtrip_upgrade_args() {
        let args = IcDbmsCanisterArgs::Upgrade(IcDbmsCanisterUpgradeArgs);
        let encoded = candid::encode_one(&args).expect("failed to encode");
        let decoded: IcDbmsCanisterArgs = candid::decode_one(&encoded).expect("failed to decode");
        assert!(matches!(decoded, IcDbmsCanisterArgs::Upgrade(_)));
    }
}