risedev/config/
use_expander.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::collections::HashMap;
16
17use anyhow::{Result, anyhow};
18use itertools::Itertools;
19use yaml_rust::{Yaml, yaml};
20
21/// Expands `use: xxx` from the template.
22pub struct UseExpander {
23    template: HashMap<String, yaml::Hash>,
24}
25
26impl UseExpander {
27    pub fn new(template: &Yaml) -> Result<Self> {
28        let ytm = template
29            .as_hash()
30            .ok_or_else(|| anyhow!("template is not a hashmap"))?;
31        let mut template = HashMap::new();
32        for (k, v) in ytm {
33            let k = k
34                .as_str()
35                .ok_or_else(|| anyhow!("key {:?} is not a string", k))?;
36            let v = v
37                .as_hash()
38                .ok_or_else(|| anyhow!("expect value to be a hashmap"))?;
39            template.insert(k.to_owned(), v.clone());
40        }
41        Ok(Self { template })
42    }
43
44    /// Overrides values in `default` with values from `provided`.
45    fn merge(use_id: &str, default: &yaml::Hash, provided: &yaml::Hash) -> yaml::Hash {
46        let mut result = yaml::Hash::new();
47        // put `use` as the first element to make the generated yaml more readable.
48        result.insert(Yaml::String("use".into()), Yaml::String(use_id.into()));
49        result.extend(default.clone());
50        for (k, new_v) in provided {
51            match result.get_mut(k) {
52                Some(v) => {
53                    // update the value, but do not change the order.
54                    *v = new_v.clone()
55                }
56                None => {
57                    // For keys not defined in the template (optional keys), we just append them
58                    // here. It may be rejected later when deserializing to
59                    // specific `ServiceConfig` if it's invalid.
60                    result.insert(k.clone(), new_v.clone());
61                }
62            };
63        }
64        result
65    }
66
67    pub fn visit(&mut self, yaml: Yaml) -> Result<Yaml> {
68        let yaml = yaml
69            .as_vec()
70            .ok_or_else(|| anyhow!("expect an array for use"))?;
71        let array = yaml.iter().map(|item| {
72            let map = item
73                .as_hash()
74                .ok_or_else(|| anyhow!("expect a hashmap for use"))?;
75
76            let use_id_yaml = map
77                .get(&Yaml::String("use".into()))
78                .ok_or_else(|| anyhow!("expect `use` in hashmap"))?;
79            let use_id = use_id_yaml
80                .as_str()
81                .ok_or_else(|| anyhow!("expect `use` to be a string"))?;
82            let use_data = self
83                .template
84                .get(use_id)
85                .ok_or_else(|| anyhow!("use source {} not found", use_id))?;
86
87            if map.get(&Yaml::String("config-path".into())).is_some() {
88                return Err(anyhow!(
89                    "`config-path` should not be put inside a `use` step. \
90                            Put `config-path` as a property parallel to `steps` instead."
91                ));
92            }
93
94            Ok::<_, anyhow::Error>(Yaml::Hash(Self::merge(use_id, use_data, map)))
95        });
96        Ok(Yaml::Array(array.try_collect()?))
97    }
98}
99
100#[cfg(test)]
101mod tests {
102    use yaml_rust::YamlLoader;
103
104    use super::*;
105    #[test]
106    fn test_expand_use() {
107        let template = YamlLoader::load_from_str(
108            "
109test:
110  a: 2333
111  b: 23333
112test2:
113  a: 23333
114  b: 233333
115      ",
116        )
117        .unwrap()
118        .remove(0);
119
120        let use_expand = YamlLoader::load_from_str(
121            "
122- use: test
123  a: 23333
124  c: 23333
125- use: test2
126  d: 23333",
127        )
128        .unwrap()
129        .remove(0);
130
131        let expected_result = YamlLoader::load_from_str(
132            "
133- use: test
134  a: 23333
135  b: 23333
136  c: 23333
137- use: test2
138  a: 23333
139  b: 233333
140  d: 23333",
141        )
142        .unwrap()
143        .remove(0);
144
145        let mut visitor = UseExpander::new(&template).unwrap();
146
147        assert_eq!(visitor.visit(use_expand).unwrap(), expected_result);
148    }
149}
risedev/config/use_expander.rs

risedev/config/
use_expander.rs
