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

// Copyright 2023 Helsing GmbH
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/// Parsed protocol buffer definitions.
mod data;
mod parse;
/// Rules for protocol buffer definitions.
mod rules;
/// Serde utilities.
pub(crate) mod serde;
mod violation;

pub use violation::*;

use std::path::Path;

use miette::IntoDiagnostic;

use self::parse::*;
use crate::manifest::PackageManifest;

/// Validates buffrs packages.
///
/// This allows running validations on top of buffrs packages.
pub struct Validator {
    parser: parse::Parser,
    manifest: PackageManifest,
}

impl Validator {
    /// Create new parser with a given root path.
    pub fn new(root: &Path, manifest: &PackageManifest) -> Self {
        Self {
            parser: Parser::new(root),
            manifest: manifest.clone(),
        }
    }

    /// Add file to be validated.
    pub fn input(&mut self, file: &Path) {
        self.parser.input(file);
    }

    /// Run validation.
    ///
    /// This produces a list of [`Violation`]. These implement the
    /// [`Diagnostic`](miette::Diagnostic) trait which gives them important metadata, such as the
    /// severity.
    pub fn validate(self) -> miette::Result<Violations> {
        let parsed = self.parser.parse().into_diagnostic()?;
        let mut rule_set = rules::all(&self.manifest);
        Ok(parsed.check(&mut rule_set))
    }
}

#[cfg(test)]
mod tests {
    #[test]
    fn can_parse_books() {
        use std::path::Path;
        let mut parser = super::Parser::new(Path::new("tests/data/parsing"));
        parser.input(std::path::Path::new("tests/data/parsing/books.proto"));
        let packages = parser.parse().unwrap();
        let expected = include_str!("../tests/data/parsing/books.json");
        let expected = serde_json::from_str(expected).unwrap();
        similar_asserts::assert_eq!(packages, expected);
    }

    #[test]
    fn can_parse_addressbook() {
        use std::path::Path;
        let mut parser = super::Parser::new(Path::new("tests/data/parsing"));
        parser.input(std::path::Path::new("tests/data/parsing/addressbook.proto"));
        let packages = parser.parse().unwrap();
        let expected = include_str!("../tests/data/parsing/addressbook.json");
        let expected = serde_json::from_str(expected).unwrap();
        similar_asserts::assert_eq!(packages, expected);
    }
}