cometbft-testgen 0.1.0-alpha.2

cometbft-testgen is a library and a small binary utility for generating CometBFT datastructures from minimal input (for testing purposes only). The library also contains some functionality to simplify running test batches.
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

use cometbft::validator;
use gumdrop::Options;
use serde::{Deserialize, Serialize};
use simple_error::*;

use crate::{
    helpers::*,
    validator::{generate_validators, Validator},
    Generator,
};

#[derive(Debug, Options, Serialize, Deserialize, Clone)]
pub struct ValidatorSet {
    #[options(
        parse(try_from_str = "parse_as::<Vec<Validator>>"),
        help = "validators (required)"
    )]
    pub validators: Option<Vec<Validator>>,
}

impl ValidatorSet {
    pub fn new(ids: Vec<&str>) -> Self {
        let validators = ids
            .iter()
            .map(|v| Validator::new(v).voting_power(50))
            .collect::<Vec<Validator>>();
        Self {
            validators: Some(validators),
        }
    }
}

impl std::str::FromStr for ValidatorSet {
    type Err = SimpleError;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let validator_set = match parse_as::<ValidatorSet>(s) {
            Ok(input) => input,
            Err(_) => ValidatorSet::new(vec![s]),
        };
        Ok(validator_set)
    }
}

impl Generator<validator::Set> for ValidatorSet {
    fn merge_with_default(self, default: Self) -> Self {
        ValidatorSet {
            validators: self.validators.or(default.validators),
        }
    }

    fn generate(&self) -> Result<validator::Set, SimpleError> {
        let vals = generate_validators(self.validators.as_ref().unwrap())?;
        Ok(validator::Set::without_proposer(vals))
    }
}

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

    #[test]
    fn test_validator_set() {
        let valset1 = ValidatorSet::new(vec!["a", "b", "c"]).generate().unwrap();
        let vals1 = vec![
            Validator::new("a").voting_power(50),
            Validator::new("b").voting_power(50),
            Validator::new("c").voting_power(50),
        ];
        let valset2 = validator::Set::without_proposer(generate_validators(&vals1).unwrap());

        assert_eq!(valset1.hash(), valset2.hash());

        let valset3 = ValidatorSet::new(vec!["b", "c", "a"]).generate().unwrap();

        assert_eq!(valset1.hash(), valset3.hash());

        let valset4 = ValidatorSet::new(vec!["c", "a"]).generate().unwrap();

        assert_ne!(valset4.hash(), valset3.hash());

        let vals2 = vec![
            Validator::new("a").voting_power(100),
            Validator::new("b"),
            Validator::new("c"),
        ];
        let valset5 = validator::Set::without_proposer(generate_validators(&vals2).unwrap());
        assert_ne!(valset2.hash(), valset5.hash());
    }
}