arrow-zerobus-sdk-wrapper 0.8.1

Cross-platform Rust SDK wrapper for Databricks Zerobus with Python bindings
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
//! Unit tests for Protobuf descriptor validation
//!
//! Tests for validate_protobuf_descriptor function to ensure security
//! and prevent malicious or malformed descriptors

use arrow_zerobus_sdk_wrapper::wrapper::conversion;
use arrow_zerobus_sdk_wrapper::ZerobusError;
use prost_types::{
    field_descriptor_proto::{Label, Type},
    DescriptorProto, FieldDescriptorProto,
};

fn create_valid_descriptor() -> DescriptorProto {
    DescriptorProto {
        name: Some("TestMessage".to_string()),
        field: vec![
            FieldDescriptorProto {
                name: Some("id".to_string()),
                number: Some(1),
                label: Some(Label::Optional as i32),
                r#type: Some(Type::Int64 as i32),
                type_name: None,
                extendee: None,
                default_value: None,
                oneof_index: None,
                json_name: None,
                options: None,
                proto3_optional: None,
            },
            FieldDescriptorProto {
                name: Some("name".to_string()),
                number: Some(2),
                label: Some(Label::Optional as i32),
                r#type: Some(Type::String as i32),
                type_name: None,
                extendee: None,
                default_value: None,
                oneof_index: None,
                json_name: None,
                options: None,
                proto3_optional: None,
            },
        ],
        extension: vec![],
        nested_type: vec![],
        enum_type: vec![],
        extension_range: vec![],
        oneof_decl: vec![],
        options: None,
        reserved_range: vec![],
        reserved_name: vec![],
    }
}

#[test]
fn test_validate_descriptor_valid_cases() {
    // Test that valid descriptors are accepted
    let descriptor = create_valid_descriptor();
    let result = conversion::validate_protobuf_descriptor(&descriptor);
    assert!(result.is_ok(), "Valid descriptor should be accepted");
}

#[test]
fn test_validate_descriptor_max_nesting_depth() {
    // Create descriptor with 11 levels of nesting (exceeds max of 10)
    let mut descriptor = create_valid_descriptor();
    
    // Build 11 levels of nested types
    let mut current = &mut descriptor;
    for depth in 0..11 {
        let nested = DescriptorProto {
            name: Some(format!("NestedLevel{}", depth)),
            field: vec![],
            extension: vec![],
            nested_type: vec![],
            enum_type: vec![],
            extension_range: vec![],
            oneof_decl: vec![],
            options: None,
            reserved_range: vec![],
            reserved_name: vec![],
        };
        current.nested_type.push(nested);
        if let Some(last) = current.nested_type.last_mut() {
            current = last;
        }
    }
    
    let result = conversion::validate_protobuf_descriptor(&descriptor);
    assert!(
        result.is_err(),
        "Descriptor with 11 levels of nesting should be rejected"
    );
    
    if let Err(ZerobusError::ConfigurationError(msg)) = result {
        assert!(
            msg.contains("nesting depth"),
            "Error message should mention nesting depth: {}",
            msg
        );
    } else {
        panic!("Expected ConfigurationError, got: {:?}", result);
    }
}

#[test]
fn test_validate_descriptor_max_fields() {
    // Create descriptor with 2001 fields (exceeds max of 2000 - Zerobus limit)
    let mut descriptor = create_valid_descriptor();
    
    // Add 2001 fields
    descriptor.field.clear();
    for i in 1..=2001 {
        descriptor.field.push(FieldDescriptorProto {
            name: Some(format!("field_{}", i)),
            number: Some(i),
            label: Some(Label::Optional as i32),
            r#type: Some(Type::Int32 as i32),
            type_name: None,
            extendee: None,
            default_value: None,
            oneof_index: None,
            json_name: None,
            options: None,
            proto3_optional: None,
        });
    }
    
    let result = conversion::validate_protobuf_descriptor(&descriptor);
    assert!(
        result.is_err(),
        "Descriptor with 2001 fields should be rejected"
    );
    
    if let Err(ZerobusError::ConfigurationError(msg)) = result {
        assert!(
            msg.contains("field count"),
            "Error message should mention field count: {}",
            msg
        );
        assert!(
            msg.contains("2000"),
            "Error message should mention the limit of 2000: {}",
            msg
        );
    } else {
        panic!("Expected ConfigurationError, got: {:?}", result);
    }
}

#[test]
fn test_validate_descriptor_max_fields_at_limit() {
    // Create descriptor with exactly 2000 fields (at Zerobus limit)
    let mut descriptor = create_valid_descriptor();
    
    // Add 2000 fields
    descriptor.field.clear();
    for i in 1..=2000 {
        descriptor.field.push(FieldDescriptorProto {
            name: Some(format!("field_{}", i)),
            number: Some(i),
            label: Some(Label::Optional as i32),
            r#type: Some(Type::Int32 as i32),
            type_name: None,
            extendee: None,
            default_value: None,
            oneof_index: None,
            json_name: None,
            options: None,
            proto3_optional: None,
        });
    }
    
    let result = conversion::validate_protobuf_descriptor(&descriptor);
    assert!(
        result.is_ok(),
        "Descriptor with exactly 2000 fields should be accepted"
    );
}

#[test]
fn test_validate_descriptor_invalid_field_number_too_low() {
    // Test field number < 1 (invalid)
    let mut descriptor = create_valid_descriptor();
    descriptor.field.push(FieldDescriptorProto {
        name: Some("invalid_field".to_string()),
        number: Some(0), // Invalid: must be >= 1
        label: Some(Label::Optional as i32),
        r#type: Some(Type::Int32 as i32),
        type_name: None,
        extendee: None,
        default_value: None,
        oneof_index: None,
        json_name: None,
        options: None,
        proto3_optional: None,
    });
    
    let result = conversion::validate_protobuf_descriptor(&descriptor);
    assert!(
        result.is_err(),
        "Descriptor with field number 0 should be rejected"
    );
    
    if let Err(ZerobusError::ConfigurationError(msg)) = result {
        assert!(
            msg.contains("field number"),
            "Error message should mention field number: {}",
            msg
        );
    } else {
        panic!("Expected ConfigurationError, got: {:?}", result);
    }
}

#[test]
fn test_validate_descriptor_invalid_field_number_too_high() {
    // Test field number > 536870911 (invalid)
    let mut descriptor = create_valid_descriptor();
    descriptor.field.push(FieldDescriptorProto {
        name: Some("invalid_field".to_string()),
        number: Some(536870912), // Invalid: exceeds max
        label: Some(Label::Optional as i32),
        r#type: Some(Type::Int32 as i32),
        type_name: None,
        extendee: None,
        default_value: None,
        oneof_index: None,
        json_name: None,
        options: None,
        proto3_optional: None,
    });
    
    let result = conversion::validate_protobuf_descriptor(&descriptor);
    assert!(
        result.is_err(),
        "Descriptor with field number 536870912 should be rejected"
    );
    
    if let Err(ZerobusError::ConfigurationError(msg)) = result {
        assert!(
            msg.contains("field number"),
            "Error message should mention field number: {}",
            msg
        );
    } else {
        panic!("Expected ConfigurationError, got: {:?}", result);
    }
}

#[test]
fn test_validate_descriptor_valid_field_numbers() {
    // Test valid field numbers at boundaries
    let mut descriptor = create_valid_descriptor();
    
    // Test minimum valid field number (1)
    descriptor.field.push(FieldDescriptorProto {
        name: Some("min_field".to_string()),
        number: Some(1),
        label: Some(Label::Optional as i32),
        r#type: Some(Type::Int32 as i32),
        type_name: None,
        extendee: None,
        default_value: None,
        oneof_index: None,
        json_name: None,
        options: None,
        proto3_optional: None,
    });
    
    // Test maximum valid field number (536870911)
    descriptor.field.push(FieldDescriptorProto {
        name: Some("max_field".to_string()),
        number: Some(536870911),
        label: Some(Label::Optional as i32),
        r#type: Some(Type::Int32 as i32),
        type_name: None,
        extendee: None,
        default_value: None,
        oneof_index: None,
        json_name: None,
        options: None,
        proto3_optional: None,
    });
    
    let result = conversion::validate_protobuf_descriptor(&descriptor);
    assert!(
        result.is_ok(),
        "Descriptor with valid field numbers (1 and 536870911) should be accepted"
    );
}

#[test]
fn test_validate_descriptor_nested_validation() {
    // Test that nested types are also validated
    let mut descriptor = create_valid_descriptor();
    
    // Add a nested type with invalid field number
    let nested = DescriptorProto {
        name: Some("NestedMessage".to_string()),
        field: vec![FieldDescriptorProto {
            name: Some("invalid_nested_field".to_string()),
            number: Some(0), // Invalid
            label: Some(Label::Optional as i32),
            r#type: Some(Type::Int32 as i32),
            type_name: None,
            extendee: None,
            default_value: None,
            oneof_index: None,
            json_name: None,
            options: None,
            proto3_optional: None,
        }],
        extension: vec![],
        nested_type: vec![],
        enum_type: vec![],
        extension_range: vec![],
        oneof_decl: vec![],
        options: None,
        reserved_range: vec![],
        reserved_name: vec![],
    };
    
    descriptor.nested_type.push(nested);
    
    let result = conversion::validate_protobuf_descriptor(&descriptor);
    assert!(
        result.is_err(),
        "Nested type with invalid field number should be rejected"
    );
}

#[test]
fn test_validate_descriptor_deeply_nested_valid() {
    // Test that valid deeply nested structures are accepted (up to max depth)
    let mut descriptor = create_valid_descriptor();
    
    // Build 10 levels of nested types (max allowed)
    let mut current = &mut descriptor;
    for depth in 0..10 {
        let nested = DescriptorProto {
            name: Some(format!("NestedLevel{}", depth)),
            field: vec![FieldDescriptorProto {
                name: Some(format!("field_{}", depth)),
                number: Some(1),
                label: Some(Label::Optional as i32),
                r#type: Some(Type::Int32 as i32),
                type_name: None,
                extendee: None,
                default_value: None,
                oneof_index: None,
                json_name: None,
                options: None,
                proto3_optional: None,
            }],
            extension: vec![],
            nested_type: vec![],
            enum_type: vec![],
            extension_range: vec![],
            oneof_decl: vec![],
            options: None,
            reserved_range: vec![],
            reserved_name: vec![],
        };
        current.nested_type.push(nested);
        if let Some(last) = current.nested_type.last_mut() {
            current = last;
        }
    }
    
    let result = conversion::validate_protobuf_descriptor(&descriptor);
    assert!(
        result.is_ok(),
        "Descriptor with 10 levels of nesting (max allowed) should be accepted"
    );
}

#[test]
fn test_validate_descriptor_exactly_max_fields() {
    // Test descriptor with exactly 1000 fields (max allowed)
    let mut descriptor = create_valid_descriptor();
    
    descriptor.field.clear();
    for i in 1..=1000 {
        descriptor.field.push(FieldDescriptorProto {
            name: Some(format!("field_{}", i)),
            number: Some(i),
            label: Some(Label::Optional as i32),
            r#type: Some(Type::Int32 as i32),
            type_name: None,
            extendee: None,
            default_value: None,
            oneof_index: None,
            json_name: None,
            options: None,
            proto3_optional: None,
        });
    }
    
    let result = conversion::validate_protobuf_descriptor(&descriptor);
    assert!(
        result.is_ok(),
        "Descriptor with exactly 1000 fields (max allowed) should be accepted"
    );
}