redoubt-alloc 0.1.0-rc.6

Allocation-locked Vec that guarantees no reallocation after sealing
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
// Copyright (c) 2025-2026 Federico Hoerth <memparanoid@gmail.com>
// SPDX-License-Identifier: GPL-3.0-only
// See LICENSE in the repository root for full license text.

use crate::RedoubtString;
use alloc::string::String;
use redoubt_zero::ZeroizationProbe;

// =============================================================================
// new()
// =============================================================================

#[test]
fn test_new() {
    let s = RedoubtString::new();

    assert_eq!(s.len(), 0);
    assert!(s.is_empty());
}

// =============================================================================
// with_capacity()
// =============================================================================

#[test]
fn test_with_capacity() {
    let s = RedoubtString::with_capacity(10);

    assert_eq!(s.len(), 0);
    assert!(s.capacity() >= 10);
}

// =============================================================================
// from_mut_string() / from_str()
// =============================================================================

#[test]
fn test_from_mut_string() {
    let mut data = String::from("hello");
    let s = RedoubtString::from_mut_string(&mut data);

    assert_eq!(s.as_str(), "hello");
    assert!(data.is_zeroized());
}

#[test]
fn test_from_str() {
    let s = RedoubtString::from_str("world");
    assert_eq!(s.as_str(), "world");
}

// =============================================================================
// len(), is_empty(), capacity()
// =============================================================================

// Tested implicitly in other tests

// =============================================================================
// extend_from_mut_string()
// =============================================================================

#[test]
fn test_extend_from_mut_string() {
    let mut dest = RedoubtString::new();
    let mut src = String::from("secret password");

    let original_len = src.len();
    dest.extend_from_mut_string(&mut src);

    // Data moved to dest
    assert_eq!(dest.as_str(), "secret password");
    assert_eq!(dest.len(), original_len);

    // Source zeroized and cleared
    assert!(src.is_zeroized());
    assert_eq!(src.len(), 0);
    assert!(src.is_empty());
}

#[test]
fn test_extend_from_mut_string_appends() {
    let mut dest = RedoubtString::new();
    dest.extend_from_str("prefix: ");

    let mut src = String::from("data");
    dest.extend_from_mut_string(&mut src);

    assert_eq!(dest.as_str(), "prefix: data");
    assert!(src.is_zeroized());
    assert_eq!(src.len(), 0);
}

#[test]
fn test_extend_from_mut_string_zeroizes_source() {
    let mut dest = RedoubtString::new();
    let mut src = String::from("sensitive_data_12345");

    dest.extend_from_mut_string(&mut src);

    // Source should be zeroized, empty and cleared
    assert!(src.is_zeroized());
    assert_eq!(src.len(), 0);
    assert!(src.is_empty());
}

#[test]
fn test_extend_from_mut_string_with_sufficient_capacity() {
    use redoubt_zero::ZeroizationProbe;

    // Create with large capacity
    let mut dest = RedoubtString::with_capacity(1000);
    let initial_capacity = dest.capacity();

    // Drain multiple small strings without exceeding capacity
    for _ in 0..10 {
        let mut src = alloc::string::String::from("data");
        dest.extend_from_mut_string(&mut src);

        // Verify source was zeroized
        assert!(src.is_zeroized());
        assert_eq!(src.len(), 0);

        // Verify capacity did NOT grow
        assert_eq!(dest.capacity(), initial_capacity);
    }

    // Final length should be 10 * 4 = 40 bytes
    assert_eq!(dest.len(), 40);
    assert_eq!(dest.capacity(), initial_capacity);
}

// =============================================================================
// replace_from_mut_string()
// =============================================================================

#[test]
fn test_replace_from_mut_string() {
    let mut dest = RedoubtString::new();
    dest.extend_from_str("old content");

    let mut src = String::from("new content");
    dest.replace_from_mut_string(&mut src);

    // Destination replaced (not appended)
    assert_eq!(dest.as_str(), "new content");

    // Source zeroized
    assert!(src.is_zeroized());
    assert!(src.is_empty());
}

// =============================================================================
// extend_from_str()
// =============================================================================

#[test]
fn test_extend_from_str() {
    let mut s = RedoubtString::new();
    s.extend_from_str("hello");

    assert_eq!(s.len(), 5);
    assert_eq!(s.as_str(), "hello");
}

#[test]
fn test_extend_from_str_appends() {
    let mut s = RedoubtString::new();
    s.extend_from_str("hello ");
    s.extend_from_str("world");

    assert_eq!(s.as_str(), "hello world");
}

#[test]
fn test_extend_from_str_grows_to_power_of_2() {
    let mut s = RedoubtString::new();

    // First extend: 0 β†’ next_power_of_two(5) = 8
    s.extend_from_str("hello");
    assert!(s.capacity() >= 8);

    // Add more to trigger growth
    s.extend_from_str(" world! This is a longer string");

    // Should have grown
    assert!(s.capacity() >= s.len());
}

#[test]
fn test_extend_from_str_chars() {
    let mut s = RedoubtString::new();
    s.extend_from_str("a");
    s.extend_from_str("b");
    s.extend_from_str("c");

    assert_eq!(s.as_str(), "abc");
}

#[test]
fn test_extend_from_str_emoji() {
    let mut s = RedoubtString::new();
    s.extend_from_str("πŸ¦€");
    s.extend_from_str("πŸ”’");
    s.extend_from_str("βœ…");

    assert_eq!(s.as_str(), "πŸ¦€πŸ”’βœ…");
}

#[test]
fn test_extend_from_str_redoubt_emoji() {
    let mut s = RedoubtString::new();
    s.extend_from_str("πŸ‡·πŸ‡ͺπŸ‡©πŸ‡΄πŸ‡ΊπŸ‡§πŸ‡Ή");

    assert_eq!(s.as_str(), "πŸ‡·πŸ‡ͺπŸ‡©πŸ‡΄πŸ‡ΊπŸ‡§πŸ‡Ή");
    assert_eq!(s.len(), 28);
}

#[test]
fn test_extend_from_str_utf8_handling() {
    let mut s = RedoubtString::new();
    s.extend_from_str("Hello δΈ–η•Œ πŸ¦€");

    assert_eq!(s.as_str(), "Hello δΈ–η•Œ πŸ¦€");
}

#[test]
fn test_extend_from_str_single_allocation() {
    let mut s = RedoubtString::new();

    // Extend a large string should do only ONE grow
    let large = "a".repeat(100);
    s.extend_from_str(&large);

    // Should grow to next_power_of_two(100) = 128
    assert_eq!(s.len(), 100);
    assert!(s.capacity() >= 128);
}

// =============================================================================
// clear()
// =============================================================================

#[test]
fn test_clear() {
    let mut s = RedoubtString::new();
    s.extend_from_str("data");

    s.clear();

    assert_eq!(s.len(), 0);
    assert!(s.is_empty());
}

// =============================================================================
// as_str()
// =============================================================================

#[test]
fn test_as_str() {
    let mut s = RedoubtString::new();
    s.extend_from_str("hello world");

    assert_eq!(s.as_str(), "hello world");
}

// =============================================================================
// as_mut_str()
// =============================================================================

#[test]
fn test_as_mut_str() {
    let mut s = RedoubtString::new();
    s.extend_from_str("hello");

    let str_mut = s.as_mut_str();
    str_mut.make_ascii_uppercase();

    assert_eq!(s.as_str(), "HELLO");
}

// =============================================================================
// as_string()
// =============================================================================

#[test]
fn test_as_string() {
    let mut s = RedoubtString::new();

    s.extend_from_str("hello world");

    let string_ref = s.as_string();

    assert_eq!(string_ref.as_str(), "hello world");
    assert_eq!(string_ref.len(), 11);
}

// =============================================================================
// as_mut_string()
// =============================================================================

#[test]
fn test_as_mut_string() {
    let mut s = RedoubtString::new();

    s.extend_from_str("secret data");

    let string_mut_ref = s.as_mut_string();
    string_mut_ref.push_str(" modified");

    assert_eq!(s.as_str(), "secret data modified");
}

#[test]
fn test_as_mut_string_drain() {
    let mut s1 = RedoubtString::new();
    s1.extend_from_str("destination");

    let mut s2 = RedoubtString::new();
    s2.extend_from_str("source");

    // Drain from s2 into s1 using as_mut_string
    let src_inner = s2.as_mut_string();
    s1.extend_from_mut_string(src_inner);

    assert_eq!(s1.as_str(), "destinationsource");
    assert_eq!(s2.len(), 0);
}

// =============================================================================
// Default
// =============================================================================

#[test]
fn test_default() {
    let s = RedoubtString::default();

    assert_eq!(s.len(), 0);
    assert!(s.is_empty());
    assert_eq!(s.capacity(), 0);
}

// =============================================================================
// Deref / DerefMut
// =============================================================================

#[test]
fn test_deref() {
    let mut s = RedoubtString::new();

    s.extend_from_str("test");

    // Deref to &str
    let str_ref: &str = &s;
    assert_eq!(str_ref, "test");

    // DerefMut to &mut str
    let str_mut: &mut str = &mut s;
    str_mut.make_ascii_uppercase();

    assert_eq!(s.as_str(), "TEST");
}

// =============================================================================
// PartialEq / Eq
// =============================================================================

#[test]
fn test_partial_eq_equal_strings() {
    let mut s1 = RedoubtString::new();
    s1.extend_from_str("hello world");

    let mut s2 = RedoubtString::new();
    s2.extend_from_str("hello world");

    assert_eq!(s1.as_str(), s2.as_str());
    assert!(s1 == s2);
}

#[test]
fn test_partial_eq_different_strings() {
    let mut s1 = RedoubtString::new();
    s1.extend_from_str("hello world");

    let mut s2 = RedoubtString::new();
    s2.extend_from_str("hello rust");

    assert_ne!(s1.as_str(), s2.as_str());
    assert!(s1 != s2);
}

#[test]
fn test_partial_eq_different_lengths() {
    let mut s1 = RedoubtString::new();
    s1.extend_from_str("hello");

    let mut s2 = RedoubtString::new();
    s2.extend_from_str("hello world");

    assert_ne!(s1.as_str(), s2.as_str());
    assert!(s1 != s2);
}

#[test]
fn test_partial_eq_empty_strings() {
    let s1 = RedoubtString::new();
    let s2 = RedoubtString::new();

    assert_eq!(s1.as_str(), s2.as_str());
    assert!(s1 == s2);
}

#[test]
fn test_partial_eq_with_unicode() {
    let mut s1 = RedoubtString::new();
    s1.extend_from_str("Hello δΈ–η•Œ πŸ¦€");

    let mut s2 = RedoubtString::new();
    s2.extend_from_str("Hello δΈ–η•Œ πŸ¦€");

    assert_eq!(s1.as_str(), s2.as_str());
    assert!(s1 == s2);
}

// =============================================================================
// Debug
// =============================================================================

#[test]
fn test_debug_redacted() {
    let mut s = RedoubtString::new();

    s.extend_from_str("secret password 123");

    let debug_output = format!("{:?}", s);

    assert!(debug_output.contains("RedoubtString"));
    assert!(debug_output.contains("REDACTED"));
    assert!(debug_output.contains("len"));
    assert!(debug_output.contains("capacity"));
    assert!(!debug_output.contains("secret"));
    assert!(!debug_output.contains("password"));
    assert!(!debug_output.contains("123"));
}