compose_yml 0.0.59

Parse, manipulate and serialize docker-compose.yml in a strongly-typed fashion
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

//! Support for validating a `docker-compose.yml` file against the official
//! schema.

use lazy_static::lazy_static;
use std::ops::Deref;
use url::Url;

use super::File;
use crate::errors::*;

/// Schema for `docker-compose.yml` version 2.0.
const COMPOSE_2_0_SCHEMA_STR: &str = include_str!("config_schema_v2.0.json");

/// Schema for `docker-compose.yml` version 2.1.
const COMPOSE_2_1_SCHEMA_STR: &str = include_str!("config_schema_v2.1.json");

/// Schema for `docker-compose.yml` version 2.2.
const COMPOSE_2_2_SCHEMA_STR: &str = include_str!("config_schema_v2.2.json");

/// Schema for `docker-compose.yml` version 2.3.
const COMPOSE_2_3_SCHEMA_STR: &str = include_str!("config_schema_v2.3.json");

/// Schema for `docker-compose.yml` version 2.4.
const COMPOSE_2_4_SCHEMA_STR: &str = include_str!("config_schema_v2.4.json");

/// Load and parse a built-in JSON file, panicking if it contains invalid
/// JSON.
fn load_schema_json(json: &'static str) -> serde_json::Value {
    match serde_json::from_str(json) {
        Ok(value) => value,
        Err(err) => panic!("cannot parse built-in schema: {}", err),
    }
}

lazy_static! {
    /// Parsed schema for `docker-compose.yml` version 2.0.
    static ref COMPOSE_2_0_SCHEMA: serde_json::Value =
    load_schema_json(COMPOSE_2_0_SCHEMA_STR);

    /// Parsed schema for `docker-compose.yml` version 2.1.
    static ref COMPOSE_2_1_SCHEMA: serde_json::Value =
    load_schema_json(COMPOSE_2_1_SCHEMA_STR);

    /// Parsed schema for `docker-compose.yml` version 2.2.
    static ref COMPOSE_2_2_SCHEMA: serde_json::Value =
    load_schema_json(COMPOSE_2_2_SCHEMA_STR);

    /// Parsed schema for `docker-compose.yml` version 2.3.
    static ref COMPOSE_2_3_SCHEMA: serde_json::Value =
    load_schema_json(COMPOSE_2_3_SCHEMA_STR);

    /// Parsed schema for `docker-compose.yml` version 2.4.
    static ref COMPOSE_2_4_SCHEMA: serde_json::Value =
    load_schema_json(COMPOSE_2_4_SCHEMA_STR);
}

/// Validate a `File` against the official JSON schema provided by
/// `docker-compose`.
pub fn validate_file(file: &File) -> Result<()> {
    let schema_value = match &file.version[..] {
        "2" => COMPOSE_2_0_SCHEMA.deref(),
        "2.1" => COMPOSE_2_1_SCHEMA.deref(),
        "2.2" => COMPOSE_2_2_SCHEMA.deref(),
        "2.3" => COMPOSE_2_3_SCHEMA.deref(),
        "2.4" => COMPOSE_2_4_SCHEMA.deref(),
        vers => return Err(Error::UnsupportedVersion(vers.to_owned())),
    };

    let mut scope = valico::json_schema::Scope::new();
    let id = Url::parse("http://example.com/config_schema.json")
        .expect("internal schema URL should be valid");
    let schema_result =
        scope.compile_and_return_with_id(&id, schema_value.clone(), false);
    let schema = match schema_result {
        Ok(schema) => schema,
        Err(err) => panic!("cannot parse built-in schema: {:?}", err),
    };

    let value = serde_json::to_value(&file).map_err(Error::validation_failed)?;
    let validation_state = schema.validate(&value);
    if validation_state.is_strictly_valid() {
        Ok(())
    } else {
        Err(Error::validation_failed(Error::does_not_conform_to_schema(
            validation_state,
        )))
    }
}