colonylib 0.6.0

A library implementing the Colony metadata framework on Autonomi
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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
use std::fs;

mod common;
use colonylib::pod::UpdateList;
use common::create_test_datastore;

#[test]
fn test_json_update_list_creation() {
    let (datastore, _temp_dir) = create_test_datastore();

    // Initially, the update list should be empty
    let update_list = datastore.get_update_list().unwrap();
    assert!(update_list.pods.is_empty());
    assert!(update_list.remove.pointers.is_empty());
    assert!(update_list.remove.scratchpads.is_empty());
}

#[test]
fn test_append_pod_to_update_list() {
    let (datastore, _temp_dir) = create_test_datastore();

    let pod_address = "test_pod_address_123";

    // Add a pod to the update list
    datastore.append_update_list(pod_address).unwrap();

    // Verify it was added
    let update_list = datastore.get_update_list().unwrap();
    assert!(update_list.pods.contains_key(pod_address));
    assert_eq!(update_list.pods[pod_address].len(), 0); // Should start with empty scratchpad list
}

#[test]
fn test_add_scratchpad_to_pod() {
    let (datastore, _temp_dir) = create_test_datastore();

    let pod_address = "test_pod_address_456";
    let scratchpad_address = "test_scratchpad_address_789";

    // Add a pod and then add a scratchpad to it
    datastore.append_update_list(pod_address).unwrap();
    datastore
        .add_scratchpad_to_pod(pod_address, scratchpad_address)
        .unwrap();

    // Verify the scratchpad was added
    let update_list = datastore.get_update_list().unwrap();
    assert!(update_list.pods.contains_key(pod_address));
    assert!(update_list.pods[pod_address].contains(&scratchpad_address.to_string()));
}

#[test]
fn test_append_pointer_removal() {
    let (datastore, _temp_dir) = create_test_datastore();

    let pointer_address = "test_pointer_address_abc";

    // Add a pointer for removal
    datastore
        .append_removal_list(pointer_address, "pointer")
        .unwrap();

    // Verify it was added to the removal list
    let update_list = datastore.get_update_list().unwrap();
    assert!(
        update_list
            .remove
            .pointers
            .contains(&pointer_address.to_string())
    );
}

#[test]
fn test_append_scratchpad_removal() {
    let (datastore, _temp_dir) = create_test_datastore();

    let scratchpad_address = "test_scratchpad_address_def";

    // Add a scratchpad for removal
    datastore
        .append_removal_list(scratchpad_address, "scratchpad")
        .unwrap();

    // Verify it was added to the removal list
    let update_list = datastore.get_update_list().unwrap();
    assert!(
        update_list
            .remove
            .scratchpads
            .contains(&scratchpad_address.to_string())
    );
}

#[test]
fn test_invalid_removal_type() {
    let (datastore, _temp_dir) = create_test_datastore();

    let address = "test_address_invalid";

    // Try to add with invalid type
    let result = datastore.append_removal_list(address, "invalid_type");
    assert!(result.is_err());
}

#[test]
fn test_duplicate_pod_entries() {
    let (datastore, _temp_dir) = create_test_datastore();

    let pod_address = "duplicate_pod_address";

    // Add the same pod multiple times
    datastore.append_update_list(pod_address).unwrap();
    datastore.append_update_list(pod_address).unwrap();
    datastore.append_update_list(pod_address).unwrap();

    // Should only appear once
    let update_list = datastore.get_update_list().unwrap();
    assert_eq!(update_list.pods.len(), 1);
    assert!(update_list.pods.contains_key(pod_address));
}

#[test]
fn test_duplicate_removal_entries() {
    let (datastore, _temp_dir) = create_test_datastore();

    let pointer_address = "duplicate_pointer_address";
    let scratchpad_address = "duplicate_scratchpad_address";

    // Add the same addresses for removal multiple times
    datastore
        .append_removal_list(pointer_address, "pointer")
        .unwrap();
    datastore
        .append_removal_list(pointer_address, "pointer")
        .unwrap();
    datastore
        .append_removal_list(scratchpad_address, "scratchpad")
        .unwrap();
    datastore
        .append_removal_list(scratchpad_address, "scratchpad")
        .unwrap();

    // Should only appear once each
    let update_list = datastore.get_update_list().unwrap();
    assert_eq!(update_list.remove.pointers.len(), 1);
    assert_eq!(update_list.remove.scratchpads.len(), 1);
    assert!(
        update_list
            .remove
            .pointers
            .contains(&pointer_address.to_string())
    );
    assert!(
        update_list
            .remove
            .scratchpads
            .contains(&scratchpad_address.to_string())
    );
}

#[test]
fn test_clear_update_list() {
    let (datastore, _temp_dir) = create_test_datastore();

    let pod_address = "test_pod_clear";
    let pointer_address = "test_pointer_clear";
    let scratchpad_address = "test_scratchpad_clear";

    // Add some entries
    datastore.append_update_list(pod_address).unwrap();
    datastore
        .append_removal_list(pointer_address, "pointer")
        .unwrap();
    datastore
        .append_removal_list(scratchpad_address, "scratchpad")
        .unwrap();

    // Verify they were added
    let update_list = datastore.get_update_list().unwrap();
    assert!(!update_list.pods.is_empty());
    assert!(!update_list.remove.pointers.is_empty());
    assert!(!update_list.remove.scratchpads.is_empty());

    // Clear the list
    datastore.clear_update_list().unwrap();

    // Verify it's empty
    let update_list = datastore.get_update_list().unwrap();
    assert!(update_list.pods.is_empty());
    assert!(update_list.remove.pointers.is_empty());
    assert!(update_list.remove.scratchpads.is_empty());
}

#[test]
fn test_json_file_format() {
    let (datastore, _temp_dir) = create_test_datastore();

    let pod_address = "test_pod_json";
    let scratchpad_address = "test_scratchpad_json";
    let pointer_address = "test_pointer_json";
    let removal_scratchpad = "test_removal_scratchpad";

    // Add various entries
    datastore.append_update_list(pod_address).unwrap();
    datastore
        .add_scratchpad_to_pod(pod_address, scratchpad_address)
        .unwrap();
    datastore
        .append_removal_list(pointer_address, "pointer")
        .unwrap();
    datastore
        .append_removal_list(removal_scratchpad, "scratchpad")
        .unwrap();

    // Read the JSON file directly and verify its structure
    let update_list_path = datastore.get_update_list_path();
    assert!(update_list_path.exists());
    assert!(update_list_path.extension().unwrap() == "json");

    let content = fs::read_to_string(update_list_path).unwrap();
    let parsed: UpdateList = serde_json::from_str(&content).unwrap();

    // Verify the structure matches what we expect
    assert!(parsed.pods.contains_key(pod_address));
    assert!(parsed.pods[pod_address].contains(&scratchpad_address.to_string()));
    assert!(
        parsed
            .remove
            .pointers
            .contains(&pointer_address.to_string())
    );
    assert!(
        parsed
            .remove
            .scratchpads
            .contains(&removal_scratchpad.to_string())
    );
}

#[test]
fn test_migration_from_empty_file() {
    let (datastore, _temp_dir) = create_test_datastore();

    // Create an empty update list file (simulating old format or empty file)
    let update_list_path = datastore.get_update_list_path();
    fs::write(&update_list_path, "").unwrap();

    // Should be able to read it as empty JSON structure
    let update_list = datastore.get_update_list().unwrap();
    assert!(update_list.pods.is_empty());
    assert!(update_list.remove.pointers.is_empty());
    assert!(update_list.remove.scratchpads.is_empty());
}

#[test]
fn test_complex_update_list_scenario() {
    let (datastore, _temp_dir) = create_test_datastore();

    // Create a complex scenario with multiple pods and removals
    let pod1 = "pod_address_1";
    let pod2 = "pod_address_2";
    let scratchpad1 = "scratchpad_1";
    let scratchpad2 = "scratchpad_2";
    let scratchpad3 = "scratchpad_3";
    let remove_pointer = "remove_pointer_1";
    let remove_scratchpad = "remove_scratchpad_1";

    // Add pods and scratchpads
    datastore.append_update_list(pod1).unwrap();
    datastore.append_update_list(pod2).unwrap();
    datastore.add_scratchpad_to_pod(pod1, scratchpad1).unwrap();
    datastore.add_scratchpad_to_pod(pod1, scratchpad2).unwrap();
    datastore.add_scratchpad_to_pod(pod2, scratchpad3).unwrap();

    // Add removals
    datastore
        .append_removal_list(remove_pointer, "pointer")
        .unwrap();
    datastore
        .append_removal_list(remove_scratchpad, "scratchpad")
        .unwrap();

    // Verify the complete structure
    let update_list = datastore.get_update_list().unwrap();

    // Check pods
    assert_eq!(update_list.pods.len(), 2);
    assert_eq!(update_list.pods[pod1].len(), 2);
    assert_eq!(update_list.pods[pod2].len(), 1);
    assert!(update_list.pods[pod1].contains(&scratchpad1.to_string()));
    assert!(update_list.pods[pod1].contains(&scratchpad2.to_string()));
    assert!(update_list.pods[pod2].contains(&scratchpad3.to_string()));

    // Check removals
    assert_eq!(update_list.remove.pointers.len(), 1);
    assert_eq!(update_list.remove.scratchpads.len(), 1);
    assert!(
        update_list
            .remove
            .pointers
            .contains(&remove_pointer.to_string())
    );
    assert!(
        update_list
            .remove
            .scratchpads
            .contains(&remove_scratchpad.to_string())
    );
}

#[test]
fn test_cross_removal_pod_to_pointer_removal() {
    let (datastore, _temp_dir) = create_test_datastore();

    let pod_address = "test_cross_removal_pod";

    // First add pod to update list
    datastore.append_update_list(pod_address).unwrap();

    // Verify it's in the pods section
    let update_list = datastore.get_update_list().unwrap();
    assert!(update_list.pods.contains_key(pod_address));
    assert!(update_list.remove.pointers.is_empty());

    // Now add the same address to pointer removal list
    datastore
        .append_removal_list(pod_address, "pointer")
        .unwrap();

    // Verify it's moved from pods to pointer removal
    let update_list = datastore.get_update_list().unwrap();
    assert!(!update_list.pods.contains_key(pod_address));
    assert!(
        update_list
            .remove
            .pointers
            .contains(&pod_address.to_string())
    );
}

#[test]
fn test_cross_removal_pointer_removal_to_pod() {
    let (datastore, _temp_dir) = create_test_datastore();

    let pod_address = "test_cross_removal_pointer";

    // First add pointer to removal list
    datastore
        .append_removal_list(pod_address, "pointer")
        .unwrap();

    // Verify it's in the pointer removal section
    let update_list = datastore.get_update_list().unwrap();
    assert!(
        update_list
            .remove
            .pointers
            .contains(&pod_address.to_string())
    );
    assert!(!update_list.pods.contains_key(pod_address));

    // Now add the same address to pods update list
    datastore.append_update_list(pod_address).unwrap();

    // Verify it's moved from pointer removal to pods
    let update_list = datastore.get_update_list().unwrap();
    assert!(update_list.pods.contains_key(pod_address));
    assert!(
        !update_list
            .remove
            .pointers
            .contains(&pod_address.to_string())
    );
}

#[test]
fn test_cross_removal_scratchpad_to_removal() {
    let (datastore, _temp_dir) = create_test_datastore();

    let pod_address = "test_cross_removal_scratchpad_pod";
    let scratchpad_address = "test_cross_removal_scratchpad";

    // First add pod and scratchpad to update list
    datastore.append_update_list(pod_address).unwrap();
    datastore
        .add_scratchpad_to_pod(pod_address, scratchpad_address)
        .unwrap();

    // Verify scratchpad is in the pod's scratchpad list
    let update_list = datastore.get_update_list().unwrap();
    assert!(update_list.pods[pod_address].contains(&scratchpad_address.to_string()));
    assert!(update_list.remove.scratchpads.is_empty());

    // Now add the scratchpad to removal list
    datastore
        .append_removal_list(scratchpad_address, "scratchpad")
        .unwrap();

    // Verify it's moved from pod's scratchpad list to scratchpad removal
    let update_list = datastore.get_update_list().unwrap();
    assert!(!update_list.pods[pod_address].contains(&scratchpad_address.to_string()));
    assert!(
        update_list
            .remove
            .scratchpads
            .contains(&scratchpad_address.to_string())
    );
}

#[test]
fn test_cross_removal_scratchpad_removal_to_pod() {
    let (datastore, _temp_dir) = create_test_datastore();

    let pod_address = "test_cross_removal_scratchpad_pod2";
    let scratchpad_address = "test_cross_removal_scratchpad2";

    // First add scratchpad to removal list
    datastore
        .append_removal_list(scratchpad_address, "scratchpad")
        .unwrap();

    // Verify it's in the scratchpad removal section
    let update_list = datastore.get_update_list().unwrap();
    assert!(
        update_list
            .remove
            .scratchpads
            .contains(&scratchpad_address.to_string())
    );

    // Now add the scratchpad to a pod's update list
    datastore
        .add_scratchpad_to_pod(pod_address, scratchpad_address)
        .unwrap();

    // Verify it's moved from scratchpad removal to pod's scratchpad list
    let update_list = datastore.get_update_list().unwrap();
    assert!(update_list.pods.contains_key(pod_address));
    assert!(update_list.pods[pod_address].contains(&scratchpad_address.to_string()));
    assert!(
        !update_list
            .remove
            .scratchpads
            .contains(&scratchpad_address.to_string())
    );
}

#[test]
fn test_update_list_comparison_with_free_addresses() {
    let (datastore, _temp_dir) = create_test_datastore();

    // Create some test addresses
    let pod_address1 = "pod_address_1";
    let pod_address2 = "pod_address_2";
    let scratchpad_address1 = "scratchpad_address_1";
    let scratchpad_address2 = "scratchpad_address_2";
    let scratchpad_address3 = "scratchpad_address_3";

    // Add pods and scratchpads to update list
    datastore.append_update_list(pod_address1).unwrap();
    datastore
        .add_scratchpad_to_pod(pod_address1, scratchpad_address1)
        .unwrap();
    datastore
        .add_scratchpad_to_pod(pod_address1, scratchpad_address2)
        .unwrap();

    datastore.append_update_list(pod_address2).unwrap();
    datastore
        .add_scratchpad_to_pod(pod_address2, scratchpad_address3)
        .unwrap();

    // Verify the update list structure
    let update_list = datastore.get_update_list().unwrap();
    assert_eq!(update_list.pods.len(), 2);
    assert!(update_list.pods.contains_key(pod_address1));
    assert!(update_list.pods.contains_key(pod_address2));
    assert_eq!(update_list.pods[pod_address1].len(), 2);
    assert_eq!(update_list.pods[pod_address2].len(), 1);

    // Verify specific scratchpad associations
    assert!(update_list.pods[pod_address1].contains(&scratchpad_address1.to_string()));
    assert!(update_list.pods[pod_address1].contains(&scratchpad_address2.to_string()));
    assert!(update_list.pods[pod_address2].contains(&scratchpad_address3.to_string()));
}