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

//! Mock implementations for Raft components
//!
//! Provides convenient builders and factory functions for creating
//! mock Raft instances with sensible defaults.
#![allow(dead_code)]

mod mock_node_builder;
mod mock_rpc;
mod mock_rpc_service;
mod snapshot;
mod stream;

pub use mock_node_builder::*;
pub use mock_rpc::*;
pub use mock_rpc_service::*;
pub use snapshot::*;

use d_engine_core::{MockTypeConfig, Raft, node_config};
use d_engine_proto::server::cluster::NodeMeta;
use tokio::sync::watch;

use crate::Node;

/// Create a mock Raft node for testing
///
/// Constructs a Node instance with mock components and optional peer metadata.
///
/// # Arguments
///
/// * `db_path` - Path for database configuration
/// * `shutdown_signal` - Watch receiver for graceful shutdown
/// * `peers_meta_option` - Optional list of peer node metadata
///
/// # Example
///
/// ```rust,ignore
/// use d_engine_server::test_utils::mock_node;
/// use tokio::sync::watch;
///
/// let (tx, rx) = watch::channel(());
/// let node = mock_node("/tmp/test_db", rx, None);
/// ```
pub fn mock_node(
    db_path: &str,
    shutdown_signal: watch::Receiver<()>,
    peers_meta_option: Option<Vec<NodeMeta>>,
) -> Node<MockTypeConfig> {
    let mut node_config = node_config(db_path);
    if let Some(peers_meta) = peers_meta_option {
        node_config.cluster.initial_cluster = peers_meta;
    }
    // Initializing Shutdown Signal
    // let (graceful_tx, graceful_rx) = watch::channel(());
    MockBuilder::new(shutdown_signal).with_node_config(node_config).build_node()
}

/// Create a mock Raft instance for testing
///
/// Constructs a Raft instance with all components mocked and optimized
/// for testing (e.g., batch threshold set to 0 for immediate replication).
///
/// # Arguments
///
/// * `db_path` - Path for database configuration
/// * `shutdown_signal` - Watch receiver for graceful shutdown
/// * `peers_meta_option` - Optional list of peer node metadata
///
/// # Example
///
/// ```rust,ignore
/// use d_engine_server::test_utils::mock_raft;
/// use tokio::sync::watch;
///
/// let (tx, rx) = watch::channel(());
/// let raft = mock_raft("/tmp/test_db", rx, None);
/// ```
pub fn mock_raft(
    db_path: &str,
    shutdown_signal: watch::Receiver<()>,
    peers_meta_option: Option<Vec<NodeMeta>>,
) -> Raft<MockTypeConfig> {
    let mut node_config = node_config(db_path);
    if let Some(peers_meta) = peers_meta_option {
        node_config.cluster.initial_cluster = peers_meta;
    }

    MockBuilder::new(shutdown_signal).with_node_config(node_config).build_raft()
}