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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use std::cell::RefCell;

use crate::checker::{ValidationIssue, ValidationIssuer};
use crate::core::{DiffResult, MapDiff};
use crate::path_pointer::{PathPointer, PointerAncestor};
use crate::schema_diff::{
    MayBeRefDiff, MediaTypeDiff, OperationDiff, ResponseDiff, SchemaDiff,
};
use crate::visitor::DiffVisitor;

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

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

    fn visit_responses(
        &self,
        pointer: &PathPointer,
        _: &'s DiffResult<MapDiff<MayBeRefDiff<ResponseDiff>>>,
    ) -> bool {
        pointer.is_updated()
    }

    fn visit_media_types(
        &self,
        pointer: &PathPointer,
        _: &'s DiffResult<MapDiff<MediaTypeDiff>>,
    ) -> bool {
        pointer.is_updated()
    }

    fn visit_media_type(
        &self,
        pointer: &PathPointer,
        _: &'s DiffResult<MediaTypeDiff>,
    ) -> bool {
        pointer.is_updated()
    }

    fn visit_schema(
        &self,
        pointer: &PathPointer,
        _: &'s DiffResult<SchemaDiff>,
    ) -> bool {
        if pointer.ancestor(PointerAncestor::schema()).is_removed() {
            return false;
        }

        if pointer
            .ancestor(PointerAncestor::schema_property())
            .is_removed()
        {
            self.pointers.borrow_mut().push(pointer.clone());
            return false;
        }

        pointer.is_updated()
    }
}

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

impl<'s> ValidationIssuer<'s> for RemovedResponsePropertyCheck {
    fn id(&self) -> &'static str {
        "removed-response-property"
    }

    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::removed_response_property_check::RemovedResponsePropertyCheck;
    use crate::checker::ValidationIssuer;
    use crate::get_schema_diff;
    use crate::schema::HttpSchema;
    use crate::schemas::openapi303::schema::OpenApi303;

    #[test]
    fn test_removed_response_property_check() {
        let src_schema: HttpSchema = serde_json::from_str::<OpenApi303>(include_str!(
            "../../data/checks/removed-response-property/schema-with-responses.json"
        ))
        .unwrap()
        .into();

        let tgt_schema: HttpSchema = serde_json::from_str::<OpenApi303>(include_str!(
            "../../data/checks/removed-response-property/schema-with-responses-altered.json"
        ))
        .unwrap()
        .into();

        let diff = get_schema_diff(src_schema, tgt_schema);

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

        assert_eq!(issues.len(), 3);
        // replaced with `shortname` property
        assert_eq!(
            issues.get(0).unwrap().path.get_path(),
            "paths//test/post/responses/200/content/application/json/schema/properties/description",
        );
        //removed
        assert_eq!(
            issues.get(1).unwrap().path.get_path(),
            "paths//test/post/responses/200/content/application/json/schema/properties/settings/properties/s2",
        );
        // parent schema type changed from "object" to "string"
        assert_eq!(
            issues.get(2).unwrap().path.get_path(),
            "paths//test/put/responses/200/content/application/json/schema/properties/id",
        );
    }
}