d-engine-server 0.2.3

Production-ready Raft consensus engine server and runtime
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
//! Unit tests for StandaloneEngine configuration validation

#[cfg(all(test, feature = "rocksdb"))]
mod standalone_server_tests {
    #[cfg(debug_assertions)]
    use std::time::Duration;

    use serial_test::serial;
    use tokio::sync::watch;

    use crate::api::StandaloneEngine;

    // Tests for run() method (reads CONFIG_PATH env var)

    #[tokio::test]
    #[cfg(debug_assertions)]
    #[serial]
    async fn test_run_with_config_path_env_valid() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("test_config.toml");
        let data_dir = temp_dir.path().join("data");

        // Create valid config with custom db_root_dir
        let config_content = format!(
            r#"
[cluster]
node_id = 1
db_root_dir = "{}"

[cluster.rpc]
listen_addr = "127.0.0.1:0"
"#,
            data_dir.display()
        );
        std::fs::write(&config_path, config_content).expect("Failed to write config");

        let (shutdown_tx, shutdown_rx) = watch::channel(());

        // Set CONFIG_PATH env var
        unsafe {
            std::env::set_var("CONFIG_PATH", config_path.to_str().unwrap());
        }

        // Spawn server in background
        let server_handle = tokio::spawn(async move { StandaloneEngine::run(shutdown_rx).await });

        // Give it time to start
        tokio::time::sleep(Duration::from_millis(100)).await;

        // Send shutdown signal
        let _ = shutdown_tx.send(());

        // Cleanup env var
        unsafe {
            std::env::remove_var("CONFIG_PATH");
        }

        // Wait for server to stop
        let result = tokio::time::timeout(Duration::from_secs(5), server_handle)
            .await
            .expect("Server should stop within timeout")
            .expect("Server task should not panic");

        assert!(
            result.is_ok(),
            "run() should succeed with valid CONFIG_PATH"
        );
    }

    #[tokio::test]
    #[cfg(debug_assertions)]
    #[serial]
    async fn test_run_with_config_path_env_nonexistent() {
        let (_shutdown_tx, shutdown_rx) = watch::channel(());

        // Set CONFIG_PATH to nonexistent file
        unsafe {
            std::env::set_var("CONFIG_PATH", "/nonexistent/config.toml");
        }

        let result = StandaloneEngine::run(shutdown_rx).await;

        unsafe {
            std::env::remove_var("CONFIG_PATH");
        }

        assert!(
            result.is_err(),
            "run() should fail with nonexistent CONFIG_PATH"
        );
    }

    #[tokio::test]
    #[cfg(debug_assertions)]
    #[serial(tmp_db)]
    async fn test_run_with_config_path_env_tmp_db_allows_in_debug() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("test_config.toml");

        // Clean up /tmp/db before test
        let _ = std::fs::remove_dir_all("/tmp/db");

        // Create config with /tmp/db
        let config_content = r#"
[cluster]
node_id = 1
db_root_dir = "/tmp/db"

[cluster.rpc]
listen_addr = "127.0.0.1:0"
"#;
        std::fs::write(&config_path, config_content).expect("Failed to write config");

        let (shutdown_tx, shutdown_rx) = watch::channel(());

        unsafe {
            std::env::set_var("CONFIG_PATH", config_path.to_str().unwrap());
        }

        // Spawn server in background
        let server_handle = tokio::spawn(async move { StandaloneEngine::run(shutdown_rx).await });

        // Give it time to start
        tokio::time::sleep(Duration::from_millis(100)).await;

        // Send shutdown signal
        let _ = shutdown_tx.send(());

        unsafe {
            std::env::remove_var("CONFIG_PATH");
        }

        // Wait for server to stop
        let result = tokio::time::timeout(Duration::from_secs(5), server_handle)
            .await
            .expect("Server should stop within timeout")
            .expect("Server task should not panic");

        // In debug mode, should succeed with warning
        assert!(
            result.is_ok(),
            "run() should allow /tmp/db in debug mode with CONFIG_PATH"
        );

        // Clean up after test
        let _ = std::fs::remove_dir_all("/tmp/db");
    }

    #[tokio::test]
    #[cfg(not(debug_assertions))]
    #[serial]
    async fn test_run_with_config_path_env_tmp_db_rejects_in_release() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("test_config.toml");

        // Create config with /tmp/db
        let config_content = r#"
[cluster]
node_id = 1
db_root_dir = "/tmp/db"

[cluster.rpc]
listen_addr = "127.0.0.1:0"
"#;
        std::fs::write(&config_path, config_content).expect("Failed to write config");

        let (_shutdown_tx, shutdown_rx) = watch::channel(());

        unsafe {
            std::env::set_var("CONFIG_PATH", config_path.to_str().unwrap());
        }

        // In release mode, should reject immediately
        let result = StandaloneEngine::run(shutdown_rx).await;

        unsafe {
            std::env::remove_var("CONFIG_PATH");
        }

        assert!(
            result.is_err(),
            "run() should reject /tmp/db in release mode with CONFIG_PATH"
        );

        if let Err(e) = result {
            let err_msg = format!("{:?}", e);
            assert!(err_msg.contains("/tmp/db") || err_msg.contains("db_root_dir"));
        }
    }

    #[tokio::test]
    #[cfg(debug_assertions)]
    #[serial(tmp_db)]
    async fn test_run_without_config_path_env_allows_in_debug() {
        // No CONFIG_PATH env var - uses default config with /tmp/db
        unsafe {
            std::env::remove_var("CONFIG_PATH");
        }

        // Clean up /tmp/db before test
        let _ = std::fs::remove_dir_all("/tmp/db");

        let (shutdown_tx, shutdown_rx) = watch::channel(());

        // Spawn server in background
        let server_handle = tokio::spawn(async move { StandaloneEngine::run(shutdown_rx).await });

        // Give it time to start
        tokio::time::sleep(Duration::from_millis(100)).await;

        // Send shutdown signal
        let _ = shutdown_tx.send(());

        // Wait for server to stop
        let result = tokio::time::timeout(Duration::from_secs(5), server_handle)
            .await
            .expect("Server should stop within timeout")
            .expect("Server task should not panic");

        assert!(
            result.is_ok(),
            "run() should allow default /tmp/db in debug mode without CONFIG_PATH"
        );

        // Clean up after test
        let _ = std::fs::remove_dir_all("/tmp/db");
    }

    #[tokio::test]
    #[cfg(not(debug_assertions))]
    #[serial]
    async fn test_run_without_config_path_env_rejects_in_release() {
        // No CONFIG_PATH env var - should reject default /tmp/db in release
        unsafe {
            std::env::remove_var("CONFIG_PATH");
        }

        let (_shutdown_tx, shutdown_rx) = watch::channel(());

        // In release mode, should reject immediately
        let result = StandaloneEngine::run(shutdown_rx).await;

        assert!(
            result.is_err(),
            "run() should reject default /tmp/db in release mode without CONFIG_PATH"
        );

        if let Err(e) = result {
            let err_msg = format!("{:?}", e);
            assert!(err_msg.contains("/tmp/db") || err_msg.contains("db_root_dir"));
        }
    }

    // Tests for run_with() method (explicit config path)

    #[tokio::test]
    #[cfg(debug_assertions)]
    #[serial]
    async fn test_run_with_default_db_root_dir_allows_in_debug() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("test_config.toml");

        // Clean up /tmp/db before test
        let _ = std::fs::remove_dir_all("/tmp/db");

        // Create config without db_root_dir (will use default /tmp/db)
        let config_content = r#"
[cluster]
node_id = 1

[cluster.rpc]
listen_addr = "127.0.0.1:0"
"#;
        std::fs::write(&config_path, config_content).expect("Failed to write config");

        let (shutdown_tx, shutdown_rx) = watch::channel(());

        // Spawn server in background
        let server_handle = tokio::spawn(async move {
            StandaloneEngine::run_with(config_path.to_str().unwrap(), shutdown_rx).await
        });

        // Give it time to start
        tokio::time::sleep(Duration::from_millis(100)).await;

        // Send shutdown signal
        let _ = shutdown_tx.send(());

        // Wait for server to stop
        let result = tokio::time::timeout(Duration::from_secs(5), server_handle)
            .await
            .expect("Server should stop within timeout")
            .expect("Server task should not panic");

        // In debug mode, should succeed (allows /tmp/db with warning)
        assert!(
            result.is_ok(),
            "run_with() should succeed in debug mode with default /tmp/db"
        );

        // Clean up after test
        let _ = std::fs::remove_dir_all("/tmp/db");
    }

    #[tokio::test]
    #[cfg(not(debug_assertions))]
    #[serial]
    async fn test_run_with_default_db_root_dir_rejects_in_release() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("test_config.toml");

        // Create config without db_root_dir (will use default /tmp/db)
        let config_content = r#"
[cluster]
node_id = 1

[cluster.rpc]
listen_addr = "127.0.0.1:0"
"#;
        std::fs::write(&config_path, config_content).expect("Failed to write config");

        let (_shutdown_tx, shutdown_rx) = watch::channel(());

        // In release mode, should reject /tmp/db immediately
        let result = StandaloneEngine::run_with(config_path.to_str().unwrap(), shutdown_rx).await;

        assert!(
            result.is_err(),
            "run_with() should reject /tmp/db in release mode"
        );

        if let Err(e) = result {
            let err_msg = format!("{:?}", e);
            assert!(err_msg.contains("/tmp/db") || err_msg.contains("db_root_dir"));
        }
    }

    #[tokio::test]
    #[cfg(debug_assertions)]
    async fn test_run_with_valid_config() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("test_config.toml");
        let data_dir = temp_dir.path().join("data");

        // Create valid config with custom db_root_dir
        let config_content = format!(
            r#"
[cluster]
node_id = 1
db_root_dir = "{}"

[cluster.rpc]
listen_addr = "127.0.0.1:0"

[raft]
heartbeat_interval_ms = 500
election_timeout_min_ms = 1500
election_timeout_max_ms = 3000
"#,
            data_dir.display()
        );
        std::fs::write(&config_path, config_content).expect("Failed to write config");

        let (shutdown_tx, shutdown_rx) = watch::channel(());

        // Spawn server in background
        let server_handle = tokio::spawn(async move {
            StandaloneEngine::run_with(config_path.to_str().unwrap(), shutdown_rx).await
        });

        // Give it time to start
        tokio::time::sleep(Duration::from_millis(100)).await;

        // Send shutdown signal
        let _ = shutdown_tx.send(());

        // Wait for server to stop
        let result = tokio::time::timeout(Duration::from_secs(5), server_handle)
            .await
            .expect("Server should stop within timeout")
            .expect("Server task should not panic");

        assert!(
            result.is_ok(),
            "run_with() should succeed with valid config"
        );
    }

    #[tokio::test]
    async fn test_run_with_nonexistent_config() {
        let (_shutdown_tx, shutdown_rx) = watch::channel(());

        let result = StandaloneEngine::run_with("/nonexistent/config.toml", shutdown_rx).await;

        assert!(
            result.is_err(),
            "run_with() should fail with nonexistent config"
        );
    }

    #[tokio::test]
    #[cfg(debug_assertions)]
    #[serial(tmp_db)]
    async fn test_run_with_tmp_db_allows_in_debug() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("test_config.toml");

        // Clean up /tmp/db before test
        let _ = std::fs::remove_dir_all("/tmp/db");

        // Create config with /tmp/db
        let config_content = r#"
[cluster]
node_id = 1
db_root_dir = "/tmp/db"

[cluster.rpc]
listen_addr = "127.0.0.1:0"
"#;
        std::fs::write(&config_path, config_content).expect("Failed to write config");

        let (shutdown_tx, shutdown_rx) = watch::channel(());

        // Spawn server in background
        let server_handle = tokio::spawn(async move {
            StandaloneEngine::run_with(config_path.to_str().unwrap(), shutdown_rx).await
        });

        // Give it time to start
        tokio::time::sleep(Duration::from_millis(100)).await;

        // Send shutdown signal
        let _ = shutdown_tx.send(());

        // Wait for server to stop
        let result = tokio::time::timeout(Duration::from_secs(5), server_handle)
            .await
            .expect("Server should stop within timeout")
            .expect("Server task should not panic");

        // In debug mode, should succeed with warning
        assert!(
            result.is_ok(),
            "run_with() should allow /tmp/db in debug mode"
        );

        // Clean up after test
        let _ = std::fs::remove_dir_all("/tmp/db");
    }

    #[tokio::test]
    #[cfg(not(debug_assertions))]
    #[serial]
    async fn test_run_with_tmp_db_rejects_in_release() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("test_config.toml");

        // Create config with /tmp/db
        let config_content = r#"
[cluster]
node_id = 1
db_root_dir = "/tmp/db"

[cluster.rpc]
listen_addr = "127.0.0.1:0"
"#;
        std::fs::write(&config_path, config_content).expect("Failed to write config");

        let (_shutdown_tx, shutdown_rx) = watch::channel(());

        // In release mode, should reject immediately
        let result = StandaloneEngine::run_with(config_path.to_str().unwrap(), shutdown_rx).await;

        assert!(
            result.is_err(),
            "run_with() should reject /tmp/db in release mode"
        );

        if let Err(e) = result {
            let err_msg = format!("{:?}", e);
            assert!(err_msg.contains("/tmp/db") || err_msg.contains("db_root_dir"));
        }
    }

    #[tokio::test]
    #[cfg(debug_assertions)]
    #[serial]
    async fn test_shutdown_signal_stops_server() {
        let temp_dir = tempfile::tempdir().expect("Failed to create temp dir");
        let config_path = temp_dir.path().join("test_config.toml");
        let data_dir = temp_dir.path().join("data");

        let config_content = format!(
            r#"
[cluster]
node_id = 1
db_root_dir = "{}"

[cluster.rpc]
listen_addr = "127.0.0.1:0"
"#,
            data_dir.display()
        );
        std::fs::write(&config_path, config_content).expect("Failed to write config");

        let (shutdown_tx, shutdown_rx) = watch::channel(());

        let server_handle = tokio::spawn(async move {
            StandaloneEngine::run_with(config_path.to_str().unwrap(), shutdown_rx).await
        });

        // Let server start
        tokio::time::sleep(Duration::from_millis(100)).await;

        // Send shutdown signal
        let send_result = shutdown_tx.send(());
        assert!(send_result.is_ok(), "Should send shutdown signal");

        // Server should stop gracefully
        let result = tokio::time::timeout(Duration::from_secs(5), server_handle)
            .await
            .expect("Server should stop within timeout");

        assert!(result.is_ok(), "Server task should not panic");
    }
}