matrix-sdk-test 0.17.0

Helpers to write tests for the Matrix SDK
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use ruma::{
    RoomId, UserId,
    power_levels::NotificationPowerLevelsKey,
    push::{
        Action, ConditionalPushRule, ConditionalPushRuleInit, EventMatchConditionData,
        NewConditionalPushRule, NewPushRule, NewSimplePushRule, PatternedPushRule,
        PatternedPushRuleInit, PredefinedContentRuleId, PredefinedOverrideRuleId, PushCondition,
        RuleKind, Ruleset, SenderNotificationPermissionConditionData, SoundTweakValue, Tweak,
    },
    user_id,
};

fn user_id() -> &'static UserId {
    user_id!("@user:matrix.org")
}

/// The ruleset containing the default spec push rules for the user
/// `@user:matrix.org`.
pub fn get_server_default_ruleset() -> Ruleset {
    Ruleset::server_default(user_id())
}

/// Build a new ruleset based on the server's default ruleset, by inserting a
/// list of rules
pub fn build_ruleset(rule_list: Vec<(RuleKind, &RoomId, bool)>) -> Ruleset {
    let mut ruleset = get_server_default_ruleset();
    for (kind, room_id, notify) in rule_list {
        let actions = if notify {
            vec![Action::Notify, Action::SetTweak(Tweak::Sound(SoundTweakValue::Default))]
        } else {
            vec![]
        };
        match kind {
            RuleKind::Room => {
                let new_rule = NewSimplePushRule::new(room_id.to_owned(), actions);
                ruleset.insert(NewPushRule::Room(new_rule), None, None).unwrap();
            }
            RuleKind::Override | RuleKind::Underride => {
                let new_rule = NewConditionalPushRule::new(
                    room_id.into(),
                    vec![PushCondition::EventMatch(EventMatchConditionData::new(
                        "room_id".to_owned(),
                        room_id.to_string(),
                    ))],
                    actions,
                );
                let new_push_rule = match kind {
                    RuleKind::Override => NewPushRule::Override(new_rule),
                    _ => NewPushRule::Underride(new_rule),
                };
                ruleset.insert(new_push_rule, None, None).unwrap();
            }
            _ => {}
        }
    }

    ruleset
}

/// The ruleset containing the default spec push rules and the legacy mention
/// rules for the user `@user:matrix.org`.
pub fn server_default_ruleset_with_legacy_mentions() -> Ruleset {
    let mut ruleset = get_server_default_ruleset();

    // In the tests we don't care about the order, so we just add them to the end of
    // the lists.
    ruleset.content.insert(contains_user_name_push_rule());
    ruleset.override_.insert(contains_display_name_push_rule());
    ruleset.override_.insert(room_notif_push_rule());

    ruleset
}

/// Room mention rule that was removed from the spec.
fn room_notif_push_rule() -> ConditionalPushRule {
    #[allow(deprecated)]
    ConditionalPushRuleInit {
        rule_id: PredefinedOverrideRuleId::RoomNotif.to_string(),
        default: true,
        enabled: true,
        conditions: vec![
            PushCondition::EventMatch(EventMatchConditionData::new(
                "content.body".into(),
                "@room".into(),
            )),
            PushCondition::SenderNotificationPermission(
                SenderNotificationPermissionConditionData::new(NotificationPowerLevelsKey::Room),
            ),
        ],
        actions: vec![Action::Notify],
    }
    .into()
}

/// User mention rule that was removed from the spec.
fn contains_user_name_push_rule() -> PatternedPushRule {
    #[allow(deprecated)]
    PatternedPushRuleInit {
        rule_id: PredefinedContentRuleId::ContainsUserName.to_string(),
        default: true,
        enabled: true,
        pattern: user_id().localpart().into(),
        actions: vec![Action::Notify],
    }
    .into()
}

/// User mention rule that was removed from the spec.
fn contains_display_name_push_rule() -> ConditionalPushRule {
    #[allow(deprecated)]
    ConditionalPushRuleInit {
        rule_id: PredefinedOverrideRuleId::ContainsDisplayName.to_string(),
        default: true,
        enabled: true,
        conditions: vec![PushCondition::ContainsDisplayName],
        actions: vec![Action::Notify],
    }
    .into()
}