buffrs 0.13.0

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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

use super::*;

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

impl Rule for PackageHierarchy {
    fn rule_info(&self) -> &'static str {
        "Ensure declared package hierarchy is mirrored in folder structure."
    }

    fn check_package(&mut self, package: &Package) -> Violations {
        let expected_components = package
            .name
            .split('.')
            .skip(1) // first part is the root package name, which is not expected to be a subfolder of proto
            .collect::<Vec<_>>();

        let expected_path = {
            let mut ret: String = "proto".into();
            for part in &expected_components {
                ret.push('/');
                ret.push_str(part);
            }
            ret
        };

        if expected_components.is_empty() {
            return Default::default();
        }

        let expected_components = {
            let mut ret = expected_components;
            ret.reverse();

            ret
        };

        package
            .files
            .iter()
            .filter_map(|path| {
                if let Some(parent) = path.parent() {
                    let components = parent
                        .components()
                        .map(|c| String::from(c.as_os_str().to_string_lossy()))
                        .rev(); // work our way up

                    for (expected, component) in expected_components.iter().zip(components) {
                        if component != *expected {
                            return Some(self.to_violation(violation::Message {
                                message: format!("expected file {} to live in {}.", path.to_string_lossy(), &expected_path),
                                help: "Package names should be mirrored in folder structure, eg mypackage.subpackage should live in proto/subpackage.".into(),
                            }));
                        }
                    }

                    None
                } else {
                    None
                }
            })
            .collect::<Vec<_>>()
    }
}

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

    static EXPECTED_HELP: &str = "Package names should be mirrored in folder structure, eg mypackage.subpackage should live in proto/subpackage.";

    #[test]
    fn file_name_should_not_matter_with_no_subpackages() {
        let package = Package {
            name: "root".into(),
            files: vec!["proto/file_not_called_root.proto".into()],
            entities: Default::default(),
        };

        let result = PackageHierarchy.check_package(&package);
        assert!(result.is_empty());
    }

    #[test]
    fn file_name_should_not_matter_with_subpackages() {
        let package = Package {
            name: "mypackage.sub1.sub2".into(),
            files: vec!["proto/sub1/sub2/file.proto".into()],
            entities: Default::default(),
        };

        let result = PackageHierarchy.check_package(&package);
        assert!(result.is_empty());
    }

    #[test]
    fn should_enforce_hierarchy_on_1st_level() {
        let package = Package {
            name: "mypackage.subpackage".into(),
            files: vec!["proto/file.proto".into()],
            entities: Default::default(),
        };
        assert_eq!(
            PackageHierarchy.check_package(&package),
            &[Violation {
                rule: "PackageHierarchy".into(),
                level: Level::Error,
                message: violation::Message {
                    message: "expected file proto/file.proto to live in proto/subpackage.".into(),
                    help: EXPECTED_HELP.into(),
                },
                location: Default::default(),
                info: PackageHierarchy.rule_info().into(),
            }],
        );
    }

    #[test]
    fn should_complain_about_folder_name_mismatch() {
        let package = Package {
            name: "mypackage.subpackage".into(),
            files: vec!["proto/not_subpackage/file.proto".into()],
            entities: Default::default(),
        };
        assert_eq!(
            PackageHierarchy.check_package(&package),
            &[Violation {
                rule: "PackageHierarchy".into(),
                level: Level::Error,
                message: violation::Message {
                    message:
                        "expected file proto/not_subpackage/file.proto to live in proto/subpackage."
                            .into(),
                    help: EXPECTED_HELP.into(),
                },
                location: Default::default(),
                info: PackageHierarchy.rule_info().into(),
            }],
        );
    }

    #[test]
    fn should_check_each_file_of_a_package() {
        let package = Package {
            name: "mypackage.subpackage".into(),
            files: vec![
                "proto/subpackage/ok.proto".into(),
                "proto/not_subpackage/file.proto".into(),
                "proto/foo/bar/file.proto".into(),
            ],
            entities: Default::default(),
        };
        assert_eq!(
            PackageHierarchy.check_package(&package),
            &[
                Violation {
                    rule: "PackageHierarchy".into(),
                    level: Level::Error,
                    message: violation::Message {
                        message:
                            "expected file proto/not_subpackage/file.proto to live in proto/subpackage."
                                .into(),
                        help: EXPECTED_HELP.into(),
                    },
                    location: Default::default(),
                    info: PackageHierarchy.rule_info().into(),
                },
                Violation {
                    rule: "PackageHierarchy".into(),
                    level: Level::Error,
                    message: violation::Message {
                        message: "expected file proto/foo/bar/file.proto to live in proto/subpackage."
                            .into(),
                        help: EXPECTED_HELP.into(),
                    },
                    location: Default::default(),
                    info: PackageHierarchy.rule_info().into(),
                }
            ],
        );
    }
}