anicca 0.1.0

Libary and CLI to diff two OpenAPI description documents
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

pub(crate) mod common;
pub(crate) mod content;
pub(crate) mod media_type;
pub(crate) mod operations;
pub(crate) mod parameter;
pub(crate) mod parameters;
pub(crate) mod path_items;
pub(crate) mod paths;
pub(crate) mod request_body;
pub(crate) mod response;
pub(crate) mod responses;
pub(crate) mod schema;

use crate::openapi::OpenAPI;
use common::StringDiff;
use paths::PathsDiff;
use serde::Serialize;
use std::path::PathBuf;
use thiserror::Error;

/// DiffError enumerates all possible errors returned by this library.
#[derive(Error, Debug)]
pub enum DiffError {
    /// Represents an unsupported feature by this library.
    #[error("Unsupported feature: {0}")]
    UnsupportedFeature(String),

    /// Represents all cases of `std::io::Error`.
    #[error(transparent)]
    IOError(#[from] std::io::Error),

    /// Represents all cases of `serde_json::Error`.
    #[error(transparent)]
    SerdeError(#[from] serde_yaml::Error),
}

#[derive(Debug, Serialize)]
pub struct Diff {
    pub version: Option<StringDiff>,
    pub paths: PathsDiff,
}

pub fn diff_files(base: PathBuf, head: PathBuf) -> Result<Diff, DiffError> {
    let base_contents = std::fs::read_to_string(base)?;
    let head_contents = std::fs::read_to_string(head)?;
    let base_openapi: OpenAPI = serde_yaml::from_str(&base_contents)?;
    let head_openapi: OpenAPI = serde_yaml::from_str(&head_contents)?;
    diff(base_openapi, head_openapi)
}

pub fn diff(base: OpenAPI, head: OpenAPI) -> Result<Diff, DiffError> {
    let version_diff = StringDiff::from_strings(base.openapi, head.openapi);
    let paths_diff = PathsDiff::from_paths(&base.paths, &head.paths)?;
    Ok(Diff {
        version: version_diff,
        paths: paths_diff,
    })
}

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

    #[test]
    fn from_json_files() {
        let diff = diff_files(
            PathBuf::from("fixtures/pet-store.json"),
            PathBuf::from("fixtures/pet-store-changed.json"),
        )
        .expect("Failed to diff JSON");

        let version_change = diff.version.unwrap();

        assert_eq!("3.0.0", version_change.from);
        assert_eq!("3.1.0", version_change.to);
    }

    #[test]
    fn from_yaml_files() {
        let diff = diff_files(
            PathBuf::from("fixtures/pet-store.yaml"),
            PathBuf::from("fixtures/pet-store-changed.yaml"),
        )
        .expect("Failed to diff JSON");

        let version_change = diff.version.unwrap();

        assert_eq!("3.0.0", version_change.from);
        assert_eq!("3.1.0", version_change.to);
    }

    #[test]
    fn openapi_version_change() {
        let mut base = OpenAPI::default();
        base.openapi = String::from("3.0.0");
        let mut head = OpenAPI::default();
        head.openapi = String::from("4.0.0");

        let result = diff(base, head);
        let diff = result.expect("Failed to diff");

        let version_change = diff.version.unwrap();

        assert_eq!("3.0.0", version_change.from);
        assert_eq!("4.0.0", version_change.to);
    }
}