blvm-sdk 0.1.8

Bitcoin Commons software developer kit, governance infrastructure and composition framework for Bitcoin
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
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
//! Composition Framework Tests
//!
//! Tests for node composition, module registry, lifecycle, and configuration.

use blvm_sdk::composition::config::NodeMetadata;
use blvm_sdk::composition::schema::validate_config_schema;
use blvm_sdk::composition::validation::validate_composition;
use blvm_sdk::composition::{
    ModuleHealth, ModuleLifecycle, ModuleRegistry, ModuleSource, ModuleSpec, ModuleStatus,
    NetworkType, NodeComposer, NodeConfig, NodeSpec, NodeStatus, ValidationResult,
};
use std::collections::HashMap;
use tempfile::TempDir;

/// Test helper: Create a temporary directory for modules
fn create_temp_modules_dir() -> TempDir {
    tempfile::tempdir().unwrap()
}

// ============================================================================
// Phase 1: ModuleRegistry Tests
// ============================================================================

#[test]
fn test_module_registry_creation() {
    // Test creating a module registry
    let temp_dir = create_temp_modules_dir();
    let _registry = ModuleRegistry::new(temp_dir.path());

    // Registry should be created
    // Note: We can't easily test discovery without actual modules, but we can test structure
    // Registry is created successfully
    assert!(temp_dir.path().exists());
}

#[test]
fn test_module_registry_discover_modules() {
    // Test discovering modules (may be empty if no modules present)
    let temp_dir = create_temp_modules_dir();
    let mut registry = ModuleRegistry::new(temp_dir.path());

    let result = registry.discover_modules();
    // Should succeed even if no modules found
    assert!(result.is_ok());
}

#[test]
fn test_module_registry_get_module_not_found() {
    // Test getting non-existent module
    let temp_dir = create_temp_modules_dir();
    let registry = ModuleRegistry::new(temp_dir.path());

    let result = registry.get_module("nonexistent", None);
    assert!(result.is_err());
}

#[test]
fn test_module_registry_install_from_path() {
    // Test installing module from path
    let temp_dir = create_temp_modules_dir();
    let mut registry = ModuleRegistry::new(temp_dir.path());

    // Try to install from non-existent path (should fail)
    let source = ModuleSource::Path(temp_dir.path().join("nonexistent"));
    let result = registry.install_module(source);
    assert!(result.is_err());
}

// ============================================================================
// Phase 2: ModuleLifecycle Tests
// ============================================================================

#[test]
fn test_module_lifecycle_creation() {
    // Test creating a module lifecycle manager
    let temp_dir = create_temp_modules_dir();
    let registry = ModuleRegistry::new(temp_dir.path());
    let _lifecycle = ModuleLifecycle::new(registry);

    // Lifecycle should be created
    // Note: We can't easily test start/stop without actual modules
    // Lifecycle is created successfully
    assert!(temp_dir.path().exists());
}

// ============================================================================
// Phase 3: NodeConfig Tests
// ============================================================================

#[test]
fn test_node_config_default() {
    // Test default node metadata
    let metadata = NodeMetadata::default();

    assert_eq!(metadata.name, "custom-node");
    assert_eq!(metadata.network, "mainnet");
    assert!(metadata.version.is_none());
}

#[test]
fn test_node_config_creation() {
    // Test creating a node config
    let config = NodeConfig {
        node: NodeMetadata {
            name: "test-node".to_string(),
            version: Some("1.0.0".to_string()),
            network: "testnet".to_string(),
        },
        modules: HashMap::new(),
    };

    assert_eq!(config.node.name, "test-node");
    assert_eq!(config.node.network, "testnet");
}

#[test]
fn test_node_config_to_spec() {
    // Test converting config to spec
    let config = NodeConfig {
        node: NodeMetadata {
            name: "test-node".to_string(),
            version: Some("1.0.0".to_string()),
            network: "mainnet".to_string(),
        },
        modules: HashMap::new(),
    };

    let spec = config.to_spec().unwrap();
    assert_eq!(spec.name, "test-node");
    assert_eq!(spec.network, NetworkType::Mainnet);
}

#[test]
fn test_node_config_to_spec_testnet() {
    // Test converting testnet config to spec
    let config = NodeConfig {
        node: NodeMetadata {
            name: "test-node".to_string(),
            version: None,
            network: "testnet".to_string(),
        },
        modules: HashMap::new(),
    };

    let spec = config.to_spec().unwrap();
    assert_eq!(spec.network, NetworkType::Testnet);
}

#[test]
fn test_node_config_to_spec_regtest() {
    // Test converting regtest config to spec
    let config = NodeConfig {
        node: NodeMetadata {
            name: "test-node".to_string(),
            version: None,
            network: "regtest".to_string(),
        },
        modules: HashMap::new(),
    };

    let spec = config.to_spec().unwrap();
    assert_eq!(spec.network, NetworkType::Regtest);
}

#[test]
fn test_node_config_invalid_network() {
    // Test invalid network type
    let config = NodeConfig {
        node: NodeMetadata {
            name: "test-node".to_string(),
            version: None,
            network: "invalid".to_string(),
        },
        modules: HashMap::new(),
    };

    let result = config.to_spec();
    assert!(result.is_err());
}

// ============================================================================
// Phase 4: NodeSpec Tests
// ============================================================================

#[test]
fn test_node_spec_creation() {
    // Test creating a node spec
    let spec = NodeSpec {
        name: "test-node".to_string(),
        version: Some("1.0.0".to_string()),
        network: NetworkType::Mainnet,
        modules: vec![],
    };

    assert_eq!(spec.name, "test-node");
    assert_eq!(spec.network, NetworkType::Mainnet);
}

#[test]
fn test_node_spec_with_modules() {
    // Test node spec with modules
    let spec = NodeSpec {
        name: "test-node".to_string(),
        version: None,
        network: NetworkType::Testnet,
        modules: vec![
            ModuleSpec {
                name: "module1".to_string(),
                version: Some("1.0.0".to_string()),
                enabled: true,
                config: HashMap::new(),
            },
            ModuleSpec {
                name: "module2".to_string(),
                version: None,
                enabled: false,
                config: HashMap::new(),
            },
        ],
    };

    assert_eq!(spec.modules.len(), 2);
    assert!(spec.modules[0].enabled);
    assert!(!spec.modules[1].enabled);
}

// ============================================================================
// Phase 5: ModuleSpec Tests
// ============================================================================

#[test]
fn test_module_spec_creation() {
    // Test creating a module spec
    let module_spec = ModuleSpec {
        name: "test-module".to_string(),
        version: Some("1.0.0".to_string()),
        enabled: true,
        config: HashMap::new(),
    };

    assert_eq!(module_spec.name, "test-module");
    assert_eq!(module_spec.version, Some("1.0.0".to_string()));
    assert!(module_spec.enabled);
}

#[test]
fn test_module_spec_disabled() {
    // Test disabled module spec
    let module_spec = ModuleSpec {
        name: "test-module".to_string(),
        version: None,
        enabled: false,
        config: HashMap::new(),
    };

    assert!(!module_spec.enabled);
}

#[test]
fn test_module_spec_with_config() {
    // Test module spec with configuration
    let mut config = HashMap::new();
    config.insert("key1".to_string(), serde_json::json!("value1"));
    config.insert("key2".to_string(), serde_json::json!(42));

    let module_spec = ModuleSpec {
        name: "test-module".to_string(),
        version: None,
        enabled: true,
        config,
    };

    assert_eq!(module_spec.config.len(), 2);
}

// ============================================================================
// Phase 6: NetworkType Tests
// ============================================================================

#[test]
fn test_network_type_variants() {
    // Test all network type variants
    assert_eq!(NetworkType::Mainnet as u8, 0);
    assert_eq!(NetworkType::Testnet as u8, 1);
    assert_eq!(NetworkType::Regtest as u8, 2);
}

#[test]
fn test_network_type_equality() {
    // Test network type equality
    let mainnet1 = NetworkType::Mainnet;
    let mainnet2 = NetworkType::Mainnet;
    let testnet = NetworkType::Testnet;

    assert_eq!(mainnet1, mainnet2);
    assert_ne!(mainnet1, testnet);
}

// ============================================================================
// Phase 7: ModuleStatus Tests
// ============================================================================

#[test]
fn test_module_status_variants() {
    // Test module status variants
    let not_installed = ModuleStatus::NotInstalled;
    let stopped = ModuleStatus::Stopped;
    let running = ModuleStatus::Running;
    let error = ModuleStatus::Error("test error".to_string());

    assert_eq!(not_installed, ModuleStatus::NotInstalled);
    assert_eq!(stopped, ModuleStatus::Stopped);
    assert_eq!(running, ModuleStatus::Running);
    assert_eq!(error, ModuleStatus::Error("test error".to_string()));
}

#[test]
fn test_module_health_variants() {
    // Test module health variants
    let healthy = ModuleHealth::Healthy;
    let degraded = ModuleHealth::Degraded;
    let unhealthy = ModuleHealth::Unhealthy("test".to_string());
    let unknown = ModuleHealth::Unknown;

    assert_eq!(healthy, ModuleHealth::Healthy);
    assert_eq!(degraded, ModuleHealth::Degraded);
    assert_eq!(unhealthy, ModuleHealth::Unhealthy("test".to_string()));
    assert_eq!(unknown, ModuleHealth::Unknown);
}

#[test]
fn test_node_status_variants() {
    // Test node status variants
    let stopped = NodeStatus::Stopped;
    let starting = NodeStatus::Starting;
    let running = NodeStatus::Running;
    let error = NodeStatus::Error("test error".to_string());

    assert_eq!(stopped, NodeStatus::Stopped);
    assert_eq!(starting, NodeStatus::Starting);
    assert_eq!(running, NodeStatus::Running);
    assert_eq!(error, NodeStatus::Error("test error".to_string()));
}

// ============================================================================
// Phase 8: Schema Validation Tests
// ============================================================================

#[test]
fn test_validate_config_schema_valid() {
    // Test validating a valid config schema
    let config = NodeConfig {
        node: NodeMetadata {
            name: "test-node".to_string(),
            version: Some("1.0.0".to_string()),
            network: "mainnet".to_string(),
        },
        modules: HashMap::new(),
    };

    let result = validate_config_schema(&config).unwrap();
    assert!(result.valid);
    assert!(result.errors.is_empty());
}

#[test]
fn test_validate_config_schema_empty_name() {
    // Test validation fails with empty node name
    let config = NodeConfig {
        node: NodeMetadata {
            name: "".to_string(),
            version: None,
            network: "mainnet".to_string(),
        },
        modules: HashMap::new(),
    };

    let result = validate_config_schema(&config).unwrap();
    assert!(!result.valid);
    assert!(!result.errors.is_empty());
}

#[test]
fn test_validate_config_schema_invalid_network() {
    // Test validation fails with invalid network
    let config = NodeConfig {
        node: NodeMetadata {
            name: "test-node".to_string(),
            version: None,
            network: "invalid".to_string(),
        },
        modules: HashMap::new(),
    };

    let result = validate_config_schema(&config).unwrap();
    assert!(!result.valid);
    assert!(!result.errors.is_empty());
}

#[test]
fn test_validate_config_schema_module_warning() {
    // Test validation warns about missing module version
    use blvm_sdk::composition::config::ModuleConfig;
    let mut modules = HashMap::new();
    modules.insert(
        "test-module".to_string(),
        ModuleConfig {
            enabled: true,
            version: None,
            config: HashMap::new(),
        },
    );

    let config = NodeConfig {
        node: NodeMetadata {
            name: "test-node".to_string(),
            version: None,
            network: "mainnet".to_string(),
        },
        modules,
    };

    let result = validate_config_schema(&config).unwrap();
    assert!(result.valid);
    assert!(!result.warnings.is_empty());
}

// ============================================================================
// Phase 9: Composition Validation Tests
// ============================================================================

#[test]
fn test_validate_composition_empty() {
    // Test validating empty composition
    let temp_dir = create_temp_modules_dir();
    let registry = ModuleRegistry::new(temp_dir.path());

    let spec = NodeSpec {
        name: "test-node".to_string(),
        version: None,
        network: NetworkType::Mainnet,
        modules: vec![],
    };

    let result = validate_composition(&spec, &registry).unwrap();
    // Empty composition should be valid
    assert!(result.valid);
}

#[test]
fn test_validate_composition_nonexistent_module() {
    // Test validation fails with non-existent module
    let temp_dir = create_temp_modules_dir();
    let registry = ModuleRegistry::new(temp_dir.path());

    let spec = NodeSpec {
        name: "test-node".to_string(),
        version: None,
        network: NetworkType::Mainnet,
        modules: vec![ModuleSpec {
            name: "nonexistent".to_string(),
            version: None,
            enabled: true,
            config: HashMap::new(),
        }],
    };

    let result = validate_composition(&spec, &registry).unwrap();
    // Should fail because module doesn't exist
    assert!(!result.valid);
    assert!(!result.errors.is_empty());
}

#[test]
fn test_validate_composition_disabled_module() {
    // Test validation skips disabled modules
    let temp_dir = create_temp_modules_dir();
    let registry = ModuleRegistry::new(temp_dir.path());

    let spec = NodeSpec {
        name: "test-node".to_string(),
        version: None,
        network: NetworkType::Mainnet,
        modules: vec![ModuleSpec {
            name: "nonexistent".to_string(),
            version: None,
            enabled: false, // Disabled, should be skipped
            config: HashMap::new(),
        }],
    };

    let result = validate_composition(&spec, &registry).unwrap();
    // Should be valid because disabled module is skipped
    assert!(result.valid);
}

// ============================================================================
// Phase 10: NodeComposer Tests
// ============================================================================

#[test]
fn test_node_composer_creation() {
    // Test creating a node composer
    let temp_dir = create_temp_modules_dir();
    let composer = NodeComposer::new(temp_dir.path());

    // Composer should be created
    // Note: We can't easily test composition without actual modules
    assert!(composer
        .validate_composition(&NodeSpec {
            name: "test".to_string(),
            version: None,
            network: NetworkType::Mainnet,
            modules: vec![],
        })
        .is_ok());
}

#[test]
fn test_node_composer_validate_composition() {
    // Test validating composition via composer
    let temp_dir = create_temp_modules_dir();
    let composer = NodeComposer::new(temp_dir.path());

    let spec = NodeSpec {
        name: "test-node".to_string(),
        version: None,
        network: NetworkType::Mainnet,
        modules: vec![],
    };

    let result = composer.validate_composition(&spec).unwrap();
    assert!(result.valid);
}

// ============================================================================
// Phase 11: ModuleSource Tests
// ============================================================================

#[test]
fn test_module_source_path() {
    // Test ModuleSource::Path variant
    let temp_dir = create_temp_modules_dir();
    let source = ModuleSource::Path(temp_dir.path().to_path_buf());

    match source {
        ModuleSource::Path(path) => {
            assert_eq!(path, temp_dir.path());
        }
        _ => panic!("Expected Path variant"),
    }
}

#[test]
fn test_module_source_registry() {
    // Test ModuleSource::Registry variant
    let source = ModuleSource::Registry {
        url: "https://example.com/registry".to_string(),
        name: None,
    };

    match source {
        ModuleSource::Registry { url, name } => {
            assert_eq!(url, "https://example.com/registry");
            assert_eq!(name, None);
        }
        _ => panic!("Expected Registry variant"),
    }
}

#[test]
fn test_module_source_git() {
    // Test ModuleSource::Git variant
    let source = ModuleSource::Git {
        url: "https://github.com/example/repo".to_string(),
        tag: Some("v1.0.0".to_string()),
    };

    match source {
        ModuleSource::Git { url, tag } => {
            assert_eq!(url, "https://github.com/example/repo");
            assert_eq!(tag, Some("v1.0.0".to_string()));
        }
        _ => panic!("Expected Git variant"),
    }
}

// ============================================================================
// Phase 12: ValidationResult Tests
// ============================================================================

#[test]
fn test_validation_result_valid() {
    // Test valid validation result
    let result = ValidationResult {
        valid: true,
        errors: vec![],
        warnings: vec![],
        dependencies: vec![],
    };

    assert!(result.valid);
    assert!(result.errors.is_empty());
}

#[test]
fn test_validation_result_invalid() {
    // Test invalid validation result
    let result = ValidationResult {
        valid: false,
        errors: vec!["Error 1".to_string(), "Error 2".to_string()],
        warnings: vec!["Warning 1".to_string()],
        dependencies: vec![],
    };

    assert!(!result.valid);
    assert_eq!(result.errors.len(), 2);
    assert_eq!(result.warnings.len(), 1);
}