minikv 2.0.1

Distributed key-value and object store with Raft-replicated metadata, two-phase commit to volume servers, and write-ahead logs.
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

//! Cluster verification.
//!
//! Not implemented yet: a read-only verification is planned for 2.1.0. Until
//! then, [`verify_cluster`] returns an error and reports nothing.

use super::NotImplemented;
use crate::common::Result;

/// Checks that every replica of every key holds its blob and, when `deep` is
/// set, that the blob's BLAKE3 hash matches the key metadata.
///
/// Not implemented: always returns an error that names the planned release.
pub async fn verify_cluster(
    _coordinator_url: &str,
    _deep: bool,
    _concurrency: usize,
) -> Result<VerifyReport> {
    Err(NotImplemented::VERIFY.into())
}

/// Prepares a rolling upgrade of the cluster.
///
/// Not implemented, and no release plans it: always returns an error.
pub async fn prepare_seamless_upgrade(_coordinator_url: &str) -> Result<()> {
    Err(NotImplemented::UPGRADE.into())
}

/// Result of a cluster verification. Nothing produces it yet.
#[derive(Debug, serde::Serialize)]
pub struct VerifyReport {
    pub total_keys: usize,
    pub healthy: usize,
    pub under_replicated: usize,
    pub corrupted: usize,
    pub orphaned: usize,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn verify_and_upgrade_fail_instead_of_reporting() {
        let verify = verify_cluster("http://127.0.0.1:1", true, 4).await;
        assert_eq!(
            verify.unwrap_err().to_string(),
            "verify is not implemented (roadmap: 2.1.0)"
        );
        let upgrade = prepare_seamless_upgrade("http://127.0.0.1:1").await;
        assert_eq!(
            upgrade.unwrap_err().to_string(),
            "upgrade is not implemented (roadmap: unscheduled)"
        );
    }
}