buffrs 0.13.2

Modern protobuf package management
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

use super::*;

#[derive(Debug, Clone, Copy)]
pub struct LibPackage;

impl Rule for LibPackage {
    fn rule_info(&self) -> &'static str {
        "Make sure that lib packages don't contain service definitions."
    }

    fn check_package(&mut self, package: &Package) -> Violations {
        let package_name = &package.name;
        package
            .entities
            .iter()
            .filter_map(|(name, entity)| {
                if let Entity::Service(_) = entity {
                    let message = violation::Message {
                        message: format!("{name} is a service definition but {package_name} is a lib type package and thus shouldn't contain services."),
                        help: "It's best to keep packages containing services separate from packages containing messages and enums.".into(),
                    };
                    Some(self.to_violation(message))
                } else {
                    None
                }
            })
            .collect()
    }
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeMap;

    use super::*;

    #[test]
    fn should_complain_about_service_defs() {
        let entities = {
            let mut ret: BTreeMap<String, Entity> = BTreeMap::new();
            ret.insert("service A".into(), Entity::Service(Service {}));
            ret.insert("service B".into(), Entity::Service(Service {}));

            ret
        };

        let package = Package {
            name: "my package".into(),
            files: vec!["ignored.proto".into()],
            entities,
        };

        let violations = LibPackage.check_package(&package);

        let help = "It's best to keep packages containing services separate from packages containing messages and enums.";
        let violation_1 = Violation {
            rule: "LibPackage".into(),
            level: Level::Error,
            message: violation::Message {
                message: "service A is a service definition but my package is a lib type package and thus shouldn't contain services.".into(),
                help: help.into(),
            },
            location: Default::default(),
            info: LibPackage.rule_info().into(),
        };
        let violation_2 = Violation {
            message: violation::Message {
                message: "service B is a service definition but my package is a lib type package and thus shouldn't contain services.".into(),
                help: help.into(),
            },
            ..violation_1.clone()
        };

        assert_eq!(violations, vec![violation_1, violation_2]);
    }
}