config_value_file/
lib.rs

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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
// Copyright 2021 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#![warn(missing_docs)]

//! A library for creating configuration value files as described in [Fuchsia RFC-0127].
//!
//! [Fuchsia RFC-0127]: https://fuchsia.dev/fuchsia-src/contribute/governance/rfcs/0127_structured_configuration

pub mod field;

use crate::field::{config_value_from_json_value, FieldError};
use cm_rust::{ConfigDecl, ConfigValueSpec, ConfigValuesData};
use serde_json::Value as JsonValue;
use std::collections::BTreeMap;

/// Create a configuration value file from the compiled manifest's config declaration and a map of
/// configuration keys to JSON values.
// TODO(https://fxbug.dev/42167846) decide on a better interface than json values?
pub fn populate_value_file(
    config_decl: &ConfigDecl,
    mut json_values: BTreeMap<String, JsonValue>,
) -> Result<ConfigValuesData, FileError> {
    let values = config_decl
        .fields
        .iter()
        .map(|field| {
            let json_value = json_values
                .remove(&field.key)
                .ok_or_else(|| FileError::MissingValue { key: field.key.clone() })?;
            let value = config_value_from_json_value(&json_value, &field.type_)
                .map_err(|reason| FileError::InvalidField { key: field.key.clone(), reason })?;
            Ok(ConfigValueSpec { value })
        })
        .collect::<Result<Vec<ConfigValueSpec>, _>>()?;

    // we remove the definitions from the values map above, so any remaining keys are undefined
    // in the manifest
    if !json_values.is_empty() {
        return Err(FileError::ExtraValues { keys: json_values.into_keys().collect() });
    }

    Ok(ConfigValuesData { values, checksum: config_decl.checksum.clone() })
}

/// Error from working with a configuration value file.
#[derive(Debug, thiserror::Error, PartialEq)]
#[allow(missing_docs)]
pub enum FileError {
    #[error("Invalid config field `{key}`")]
    InvalidField {
        key: String,
        #[source]
        reason: FieldError,
    },

    #[error("`{key}` field in manifest does not have a value defined.")]
    MissingValue { key: String },

    #[error("Fields `{keys:?}` in value definition do not exist in manifest.")]
    ExtraValues { keys: Vec<String> },
}

#[cfg(test)]
mod tests {
    use super::field::JsonTy;
    use super::*;
    use cm_rust::{ConfigChecksum, ConfigSingleValue, ConfigValue, ConfigVectorValue};
    use fidl_fuchsia_component_config_ext::{config_decl, values_data};
    use serde_json::json;

    fn test_checksum() -> ConfigChecksum {
        // sha256("Back to the Fuchsia")
        ConfigChecksum::Sha256([
            0xb5, 0xf9, 0x33, 0xe8, 0x94, 0x56, 0x3a, 0xf9, 0x61, 0x39, 0xe5, 0x05, 0x79, 0x4b,
            0x88, 0xa5, 0x3e, 0xd4, 0xd1, 0x5c, 0x32, 0xe2, 0xb4, 0x49, 0x9e, 0x42, 0xeb, 0xa3,
            0x32, 0xb1, 0xf5, 0xbb,
        ])
    }

    #[test]
    fn basic_success() {
        let decl = config_decl! {
            ck@ test_checksum(),
            my_flag: { bool },
            my_uint8: { uint8 },
            my_uint16: { uint16 },
            my_uint32: { uint32 },
            my_uint64: { uint64 },
            my_int8: { int8 },
            my_int16: { int16 },
            my_int32: { int32 },
            my_int64: { int64 },
            my_string: { string, max_size: 100 },
            my_vector_of_flag: { vector, element: bool, max_count: 100 },
            my_vector_of_uint8: { vector, element: uint8, max_count: 100 },
            my_vector_of_uint16: { vector, element: uint16, max_count: 100 },
            my_vector_of_uint32: { vector, element: uint32, max_count: 100 },
            my_vector_of_uint64: { vector, element: uint64, max_count: 100 },
            my_vector_of_int8: { vector, element: int8, max_count: 100 },
            my_vector_of_int16: { vector, element: int16, max_count: 100 },
            my_vector_of_int32: { vector, element: int32, max_count: 100 },
            my_vector_of_int64: { vector, element: int64, max_count: 100 },
            my_vector_of_string: {
                vector,
                element: { string, max_size: 100 },
                max_count: 100
            },
        };

        let values: BTreeMap<String, serde_json::Value> = serde_json::from_value(json!({
            "my_flag": false,
            "my_uint8": 255u8,
            "my_uint16": 65535u16,
            "my_uint32": 4000000000u32,
            "my_uint64": 8000000000u64,
            "my_int8": -127i8,
            "my_int16": -32766i16,
            "my_int32": -2000000000i32,
            "my_int64": -4000000000i64,
            "my_string": "hello, world!",
            "my_vector_of_flag": [ true, false ],
            "my_vector_of_uint8": [ 1, 2, 3 ],
            "my_vector_of_uint16": [ 2, 3, 4 ],
            "my_vector_of_uint32": [ 3, 4, 5 ],
            "my_vector_of_uint64": [ 4, 5, 6 ],
            "my_vector_of_int8": [ -1, -2, 3 ],
            "my_vector_of_int16": [ -2, -3, 4 ],
            "my_vector_of_int32": [ -3, -4, 5 ],
            "my_vector_of_int64": [ -4, -5, 6 ],
            "my_vector_of_string": [ "hello, world!", "hello, again!" ],
        }))
        .unwrap();

        let expected = values_data![
            ck@ test_checksum(),
            ConfigValue::Single(ConfigSingleValue::Bool(false)),
            ConfigValue::Single(ConfigSingleValue::Uint8(255u8)),
            ConfigValue::Single(ConfigSingleValue::Uint16(65535u16)),
            ConfigValue::Single(ConfigSingleValue::Uint32(4000000000u32)),
            ConfigValue::Single(ConfigSingleValue::Uint64(8000000000u64)),
            ConfigValue::Single(ConfigSingleValue::Int8(-127i8)),
            ConfigValue::Single(ConfigSingleValue::Int16(-32766i16)),
            ConfigValue::Single(ConfigSingleValue::Int32(-2000000000i32)),
            ConfigValue::Single(ConfigSingleValue::Int64(-4000000000i64)),
            ConfigValue::Single(ConfigSingleValue::String("hello, world!".into())),
            ConfigValue::Vector(ConfigVectorValue::BoolVector(vec![true, false])),
            ConfigValue::Vector(ConfigVectorValue::Uint8Vector(vec![1, 2, 3])),
            ConfigValue::Vector(ConfigVectorValue::Uint16Vector(vec![2, 3, 4])),
            ConfigValue::Vector(ConfigVectorValue::Uint32Vector(vec![3, 4, 5])),
            ConfigValue::Vector(ConfigVectorValue::Uint64Vector(vec![4, 5, 6])),
            ConfigValue::Vector(ConfigVectorValue::Int8Vector(vec![-1, -2, 3])),
            ConfigValue::Vector(ConfigVectorValue::Int16Vector(vec![-2, -3, 4])),
            ConfigValue::Vector(ConfigVectorValue::Int32Vector(vec![-3, -4, 5])),
            ConfigValue::Vector(ConfigVectorValue::Int64Vector(vec![-4, -5, 6])),
            ConfigValue::Vector(ConfigVectorValue::StringVector(
                vec!["hello, world!".into(), "hello, again!".into()])
            ),
        ];

        let observed = populate_value_file(&decl, values).unwrap();
        assert_eq!(observed, expected);
    }

    #[test]
    fn invalid_field_is_correctly_identified() {
        let decl = config_decl! {
            ck@ test_checksum(),
            my_flag: { bool },
            my_uint8: { uint8 },
        };

        let values: BTreeMap<String, serde_json::Value> = serde_json::from_value(json!({
            "my_flag": false,
            "my_uint8": true,
        }))
        .unwrap();

        assert_eq!(
            populate_value_file(&decl, values).unwrap_err(),
            FileError::InvalidField {
                key: "my_uint8".to_string(),
                reason: FieldError::JsonTypeMismatch {
                    expected: JsonTy::Number,
                    received: JsonTy::Bool
                }
            }
        );
    }

    #[test]
    fn all_keys_must_be_defined() {
        let decl = config_decl! {
            ck@ test_checksum(),
            my_flag: { bool },
            my_uint8: { uint8 },
        };

        let values: BTreeMap<String, serde_json::Value> = serde_json::from_value(json!({
            "my_flag": false,
        }))
        .unwrap();

        assert_eq!(
            populate_value_file(&decl, values).unwrap_err(),
            FileError::MissingValue { key: "my_uint8".to_string() }
        );
    }

    #[test]
    fn no_extra_keys_can_be_defined() {
        let decl = config_decl! {
            ck@ test_checksum(),
            my_flag: { bool },
        };

        let values: BTreeMap<String, serde_json::Value> = serde_json::from_value(json!({
            "my_flag": false,
            "my_uint8": 1,
            "my_uint16": 2,
        }))
        .unwrap();

        assert_eq!(
            populate_value_file(&decl, values).unwrap_err(),
            FileError::ExtraValues { keys: vec!["my_uint16".into(), "my_uint8".into()] }
        );
    }
}