openraft 0.9.24

Advanced Raft consensus
Documentation
use std::sync::Arc;

use maplit::btreeset;
use pretty_assertions::assert_eq;

use crate::engine::testing::UTConfig;
use crate::engine::Command;
use crate::engine::Engine;
use crate::progress::Inflight;
use crate::progress::Progress;
use crate::raft_state::LogStateReader;
use crate::testing::log_id;
use crate::utime::UTime;
use crate::EffectiveMembership;
use crate::Membership;
use crate::MembershipState;
use crate::TokioInstant;
use crate::Vote;

fn m01() -> Membership<u64, ()> {
    Membership::<u64, ()>::new(vec![btreeset! {0,1}], None)
}

fn m123() -> Membership<u64, ()> {
    Membership::<u64, ()>::new(vec![btreeset! {1,2,3}], None)
}

fn eng() -> Engine<UTConfig> {
    let mut eng = Engine::default();
    eng.state.enable_validation(false); // Disable validation for incomplete state

    eng.config.id = 2;
    eng.state.vote = UTime::new(TokioInstant::now(), Vote::new_committed(2, 1));
    eng.state.membership_state = MembershipState::new(
        Arc::new(EffectiveMembership::new(Some(log_id(1, 1, 1)), m01())),
        Arc::new(EffectiveMembership::new(Some(log_id(2, 1, 3)), m123())),
    );

    eng
}

#[test]
fn test_update_matching_no_leader() -> anyhow::Result<()> {
    // There is no leader, it should panic.

    let res = std::panic::catch_unwind(move || {
        let mut eng = eng();
        eng.replication_handler().update_matching(3, 0, Some(log_id(1, 1, 2)));
    });
    tracing::info!("res: {:?}", res);
    assert!(res.is_err());

    Ok(())
}

#[test]
fn test_update_matching() -> anyhow::Result<()> {
    let mut eng = eng();
    eng.testing_new_leader();
    eng.output.take_commands();

    let mut rh = eng.replication_handler();
    let inflight_id_1 = {
        let prog_entry = rh.leader.progress.get_mut(&1).unwrap();
        prog_entry.inflight = Inflight::logs(Some(log_id(2, 1, 3)), Some(log_id(2, 1, 4)));
        prog_entry.inflight.get_id().unwrap()
    };
    let inflight_id_2 = {
        let prog_entry = rh.leader.progress.get_mut(&2).unwrap();
        prog_entry.inflight = Inflight::logs(Some(log_id(1, 1, 0)), Some(log_id(2, 1, 4)));
        prog_entry.inflight.get_id().unwrap()
    };
    let inflight_id_3 = {
        let prog_entry = rh.leader.progress.get_mut(&3).unwrap();
        prog_entry.inflight = Inflight::logs(Some(log_id(1, 1, 1)), Some(log_id(2, 1, 4)));
        prog_entry.inflight.get_id().unwrap()
    };

    // progress: None, None, (1,2)
    {
        rh.update_matching(3, inflight_id_3, Some(log_id(1, 1, 2)));
        assert_eq!(None, rh.state.committed());
        assert_eq!(0, rh.output.take_commands().len());
    }

    // progress: None, (2,1), (1,2); quorum-ed: (1,2), not at leader vote, not committed
    {
        rh.output.clear_commands();
        rh.update_matching(2, inflight_id_2, Some(log_id(2, 1, 1)));
        assert_eq!(None, rh.state.committed());
        assert_eq!(0, rh.output.take_commands().len());
    }

    // progress: None, (2,1), (2,3); committed: (2,1)
    {
        rh.output.clear_commands();
        rh.update_matching(3, inflight_id_3, Some(log_id(2, 1, 3)));
        assert_eq!(Some(&log_id(2, 1, 1)), rh.state.committed());
        assert_eq!(
            vec![
                Command::ReplicateCommitted {
                    committed: Some(log_id(2, 1, 1))
                },
                Command::Commit {
                    seq: 1,
                    already_committed: None,
                    upto: log_id(2, 1, 1)
                }
            ],
            rh.output.take_commands()
        );
    }

    // progress: (2,4), (2,1), (2,3); committed: (1,3)
    {
        rh.output.clear_commands();
        rh.update_matching(1, inflight_id_1, Some(log_id(2, 1, 4)));
        assert_eq!(Some(&log_id(2, 1, 3)), rh.state.committed());
        assert_eq!(
            vec![
                Command::ReplicateCommitted {
                    committed: Some(log_id(2, 1, 3))
                },
                Command::Commit {
                    seq: 2,
                    already_committed: Some(log_id(2, 1, 1)),
                    upto: log_id(2, 1, 3)
                }
            ],
            rh.output.take_commands()
        );
    }

    Ok(())
}