iceoryx2 0.8.1

iceoryx2: Lock-Free Zero-Copy Interprocess Communication
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244

// Copyright (c) 2024 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

#[cfg(test)]
mod attribute {
    use iceoryx2::{
        prelude::{AttributeSet, AttributeSpecifier},
        service::attribute::{
            AttributeDefinitionError, AttributeVerificationError, AttributeVerifier,
        },
    };
    use iceoryx2_bb_elementary::CallbackProgression;
    use iceoryx2_bb_testing::assert_that;

    #[test]
    fn attribute_returns_correct_key_value() {
        let sut = AttributeVerifier::new()
            .require(&"key_1".try_into().unwrap(), &"value_1".try_into().unwrap())
            .unwrap();

        for entry in sut.required_attributes().iter() {
            assert_that!(&entry.key(), eq & "key_1");
            assert_that!(&entry.value(), eq & "value_1");
        }

        assert_that!(sut.required_attributes().iter(), len 1);
    }

    #[test]
    fn attribute_verifier_require_fails_when_it_exceeds_max_number_of_attributes() {
        let mut sut = AttributeVerifier::new();
        for n in 0..AttributeSet::capacity() {
            sut = sut
                .require(
                    &"key".try_into().unwrap(),
                    &n.to_string().as_str().try_into().unwrap(),
                )
                .unwrap();
        }

        assert_that!(sut.require(&"key".try_into().unwrap(), &"val".try_into().unwrap()).err(), eq Some(AttributeDefinitionError::ExceedsMaxSupportedAttributes));
    }

    #[test]
    fn attribute_verifier_require_key_fails_when_it_exceeds_max_number_of_attributes() {
        let mut sut = AttributeVerifier::new();
        for n in 0..AttributeSet::capacity() {
            sut = sut
                .require(
                    &"key".try_into().unwrap(),
                    &n.to_string().as_str().try_into().unwrap(),
                )
                .unwrap();
        }

        assert_that!(sut.require_key(&"key".try_into().unwrap()).err(), eq Some(AttributeDefinitionError::ExceedsMaxSupportedAttributes));
    }

    #[test]
    fn attribute_set_returns_correct_key_len() {
        let sut = AttributeVerifier::new()
            .require(&"key_1".try_into().unwrap(), &"value_1".try_into().unwrap())
            .unwrap()
            .require(&"key_1".try_into().unwrap(), &"value_2".try_into().unwrap())
            .unwrap();

        assert_that!(sut.required_attributes().number_of_key_values(&"key_1".try_into().unwrap()), eq 2);
        assert_that!(sut.required_attributes().number_of_key_values(&"key_2".try_into().unwrap()), eq 0);
    }

    #[test]
    fn attribute_set_returns_correct_value() {
        let sut = AttributeVerifier::new()
            .require(
                &"another_key".try_into().unwrap(),
                &"another_value_1".try_into().unwrap(),
            )
            .unwrap()
            .require(
                &"another_key".try_into().unwrap(),
                &"another_value_2".try_into().unwrap(),
            )
            .unwrap();

        assert_that!(
            sut.required_attributes()
                .key_value(&"another_key".try_into().unwrap(), 0),
            is_some
        );
        assert_that!(sut.required_attributes().key_value(&"another_key".try_into().unwrap(), 0).unwrap(), eq "another_value_1");
        assert_that!(
            sut.required_attributes()
                .key_value(&"another_key".try_into().unwrap(), 1),
            is_some
        );
        assert_that!(sut.required_attributes().key_value(&"another_key".try_into().unwrap(), 1).unwrap(), eq "another_value_2");
        assert_that!(sut.required_attributes().key_value(&"another_key".try_into().unwrap(), 2), eq None);
        assert_that!(sut.required_attributes().key_value(&"non_existing_key".try_into().unwrap(), 0), eq None);
    }

    #[test]
    fn attribute_set_get_key_value_works() {
        let sut = AttributeVerifier::new()
            .require(&"wild_ride".try_into().unwrap(), &"XXL".try_into().unwrap())
            .unwrap()
            .require(&"wild_ride".try_into().unwrap(), &"S".try_into().unwrap())
            .unwrap();

        let mut values = vec![];
        sut.required_attributes()
            .iter_key_values(&"wild_ride".try_into().unwrap(), |v| {
                values.push(v.to_string());
                CallbackProgression::Continue
            });

        assert_that!(values, contains String::from("XXL"));
        assert_that!(values, contains String::from("S"));
    }

    #[test]
    fn attribute_set_get_key_value_stops_on_request() {
        let sut = AttributeVerifier::new()
            .require(
                &"schwifty".try_into().unwrap(),
                &"brothers".try_into().unwrap(),
            )
            .unwrap()
            .require(
                &"schwifty".try_into().unwrap(),
                &"sisters".try_into().unwrap(),
            )
            .unwrap();

        let mut counter = 0;
        sut.required_attributes()
            .iter_key_values(&"schwifty".try_into().unwrap(), |_| {
                counter += 1;
                CallbackProgression::Stop
            });

        assert_that!(counter, eq 1);
    }

    #[test]
    fn attribute_set_get_key_value_no_callback_call_when_key_does_not_exist() {
        let sut = AttributeVerifier::new()
            .require(
                &"schwifler".try_into().unwrap(),
                &"brothers".try_into().unwrap(),
            )
            .unwrap()
            .require(
                &"schwifler".try_into().unwrap(),
                &"sisters".try_into().unwrap(),
            )
            .unwrap();

        let mut counter = 0;
        sut.required_attributes()
            .iter_key_values(&"does not exist".try_into().unwrap(), |_| {
                counter += 1;
                CallbackProgression::Stop
            });

        assert_that!(counter, eq 0);
    }

    #[test]
    fn attribute_set_verify_requirements_succeeds_when_compatible() {
        let sut_verifier = AttributeVerifier::new()
            .require(
                &"schwifler".try_into().unwrap(),
                &"brothers".try_into().unwrap(),
            )
            .unwrap();

        let sut_specifier = AttributeSpecifier::new()
            .define(
                &"schwifler".try_into().unwrap(),
                &"brothers".try_into().unwrap(),
            )
            .unwrap();

        assert_that!(
            sut_verifier.verify_requirements(sut_specifier.attributes()),
            is_ok
        );
    }

    #[test]
    fn attribute_set_verify_requirements_fails_when_value_is_wrong() {
        let sut_verifier = AttributeVerifier::new()
            .require(
                &"schwifler".try_into().unwrap(),
                &"brothers".try_into().unwrap(),
            )
            .unwrap();

        let sut_specifier = AttributeSpecifier::new()
            .define(
                &"schwifler".try_into().unwrap(),
                &"sisters".try_into().unwrap(),
            )
            .unwrap();

        assert_that!(
            sut_verifier.verify_requirements(sut_specifier.attributes()),
            eq Err(AttributeVerificationError::IncompatibleAttribute((
                "schwifler".try_into().unwrap(),
                "brothers".try_into().unwrap(),
            )))
        );
    }

    #[test]
    fn attribute_set_verify_requirements_fails_when_key_does_not_exist() {
        let sut_verifier = AttributeVerifier::new()
            .require_key(&"the toad toad toad".try_into().unwrap())
            .unwrap();

        let sut_specifier = AttributeSpecifier::new()
            .define(
                &"schwifler".try_into().unwrap(),
                &"sisters".try_into().unwrap(),
            )
            .unwrap();

        assert_that!(
            sut_verifier.verify_requirements(sut_specifier.attributes()),
            eq Err(AttributeVerificationError::NonExistingKey(
                "the toad toad toad".try_into().unwrap(),
            ))
        );
    }
}