schemadoc-diff 0.1.20

OpenApi diff library and breaking changes detector
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

use std::cell::RefCell;

use crate::checker::{ValidationIssue, ValidationIssuer};
use crate::core::{DiffResult, VecDiff};
use crate::path_pointer::PathPointer;
use crate::schema_diff::{MayBeRefDiff, OperationDiff, ParameterDiff};

use crate::visitor::DiffVisitor;

pub struct AddedRequiredParameterCheck {
    pointers: RefCell<Vec<PathPointer>>,
}

impl<'s> DiffVisitor<'s> for AddedRequiredParameterCheck {
    fn visit_operation(
        &self,
        pointer: &PathPointer,
        _: &str,
        _: &'s DiffResult<OperationDiff>,
    ) -> bool {
        pointer.is_updated()
    }

    fn visit_parameters(
        &self,
        pointer: &PathPointer,
        _: &'s DiffResult<VecDiff<MayBeRefDiff<ParameterDiff>>>,
    ) -> bool {
        pointer.is_updated()
    }

    fn visit_parameter(
        &self,
        pointer: &PathPointer,
        parameter_diff_result: &'s DiffResult<ParameterDiff>,
    ) -> bool {
        // Parameter Must be UPSERTED
        if !pointer.is_upserted() {
            return false;
        }

        if let Some(parameter_diff) = parameter_diff_result.get() {
            if parameter_diff.required.is_upserted() {
                if let Some(required) = parameter_diff.required.get() {
                    if *required {
                        self.pointers.borrow_mut().push(pointer.clone())
                    }
                }
            }
        }

        false
    }
}

impl Default for AddedRequiredParameterCheck {
    fn default() -> Self {
        AddedRequiredParameterCheck {
            pointers: RefCell::new(vec![]),
        }
    }
}

impl<'s> ValidationIssuer<'s> for AddedRequiredParameterCheck {
    fn id(&self) -> &'static str {
        "added-required-parameter"
    }

    fn visitor(&self) -> &dyn DiffVisitor<'s> {
        self
    }

    fn issues(&self) -> Option<Vec<ValidationIssue>> {
        let pointers = std::mem::take(&mut *self.pointers.borrow_mut());

        let issues = pointers
            .into_iter()
            .map(|path| ValidationIssue::new(path, self.id(), true))
            .collect::<Vec<ValidationIssue>>();

        Some(issues)
    }
}

#[cfg(test)]
mod tests {
    use crate::checker::added_required_parameter_check::AddedRequiredParameterCheck;
    use crate::checker::ValidationIssuer;
    use crate::get_schema_diff;
    use crate::schema::HttpSchema;
    use crate::schemas::openapi303::schema::OpenApi303;

    #[test]
    fn test_added_required_parameter_check() {
        let src_schema: HttpSchema = serde_json::from_str::<OpenApi303>(include_str!(
            "../../data/checks/added-required-parameter/schema-with-parameters.json"
        ))
        .unwrap()
        .into();

        let tgt_schema: HttpSchema = serde_json::from_str::<OpenApi303>(include_str!(
            "../../data/checks/added-required-parameter/schema-with-update-parameters.json"
        ))
        .unwrap()
        .into();

        let diff = get_schema_diff(src_schema, tgt_schema);

        let checker = AddedRequiredParameterCheck::default();
        crate::visitor::dispatch_visitor(diff.get().unwrap(), &checker);
        let issues = checker.issues().unwrap();

        assert_eq!(issues.len(), 2);
        // `param4defaultToUpdate` updated to required=true
        assert_eq!(
            issues.get(0).unwrap().path.get_path(),
            "paths//test/get/parameters/1",
        );
        // `param6newRequired` added with required=true
        assert_eq!(
            issues.get(1).unwrap().path.get_path(),
            "paths//test/get/parameters/5",
        );
    }
}