ferroclass 0.11.0

Hierarchical inventory management tool (reclass compatible)
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
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
// SPDX-FileCopyrightText: 2026 Michael Jansen <mike@michael-jansen.biz>
// SPDX-License-Identifier: MPL-2.0

use crate::inventory::Inventory;
use crate::inventory::applications::Applications;
use crate::inventory::elements::{Class, Node};
use crate::inventory::interpolation;
use crate::inventory::inv_query;
use crate::inventory::options::MergeConfig;
use crate::inventory::value::{
    ClassList, Environment, ParametersType, Value, contains_interpolation,
};
use snafu::Snafu;
use std::collections::HashSet;
use std::rc::Rc;

#[derive(Debug, Snafu)]
pub enum Error {
    #[snafu(display("class '{class_name}' not found"))]
    ClassNotFound { class_name: String },
    #[snafu(display("class name '{class_name}' could not be resolved"))]
    ClassNameResolveError {
        class_name: String,
        source: interpolation::Error,
    },
    #[snafu(transparent)]
    Interpolation { source: interpolation::Error },
    #[snafu(transparent)]
    ValueMerge {
        source: crate::inventory::value_merge::Error,
    },
}

#[derive(Debug, Clone)]
struct MergeAccumulator {
    classes: Vec<String>,
    applications: Applications,
    environment: Environment,
    parameters: ParametersType,
    exports: ParametersType,
}

impl MergeAccumulator {
    fn new() -> Self {
        Self {
            classes: Vec::new(),
            applications: Applications::new(),
            environment: Environment::default(),
            parameters: ParametersType::default(),
            exports: ParametersType::default(),
        }
    }
}

fn merge_unique_classes(into: &mut Vec<String>, from: &[String]) {
    for c in from {
        if !into.contains(c) {
            into.push(c.clone());
        }
    }
}

fn merge_environments(parent: &Environment, child: &Environment) -> Environment {
    if !child.is_empty() {
        child.clone()
    } else if !parent.is_empty() {
        parent.clone()
    } else {
        Environment::default()
    }
}

fn merge_parameters(
    parent: &ParametersType,
    child: &ParametersType,
    config: &MergeConfig,
) -> Result<ParametersType, Error> {
    crate::inventory::value_merge::merge_hash_direct(parent, child, config)
        .map_err(|source| Error::ValueMerge { source })
}

fn merge_descent_into(
    acc: &mut MergeAccumulator,
    descent: &MergeAccumulator,
    class_name: &str,
    config: &MergeConfig,
) -> Result<(), Error> {
    merge_unique_classes(&mut acc.classes, &descent.classes);
    if !acc.classes.contains(&class_name.to_string()) {
        acc.classes.push(class_name.to_string());
    }
    acc.environment = merge_environments(&acc.environment, &descent.environment);
    acc.applications.merge_unique(&descent.applications);
    acc.parameters = merge_parameters(&acc.parameters, &descent.parameters, config)?;
    acc.exports = merge_parameters(&acc.exports, &descent.exports, config)?;
    Ok(())
}

fn merge_entity_fields(
    acc: &mut MergeAccumulator,
    classes: &ClassList,
    applications: &Applications,
    environment: &Environment,
    parameters: &ParametersType,
    exports: &ParametersType,
    config: &MergeConfig,
) -> Result<(), Error> {
    merge_unique_classes(&mut acc.classes, classes);
    acc.environment = merge_environments(&acc.environment, environment);
    acc.applications.merge_unique(applications);
    acc.parameters = merge_parameters(&acc.parameters, parameters, config)?;
    acc.exports = merge_parameters(&acc.exports, exports, config)?;
    Ok(())
}

fn interpolate_class_name(
    class_name: &str,
    parameters: &ParametersType,
    config: &MergeConfig,
) -> Result<String, Error> {
    let mut value = Value::String(class_name.to_string());
    value.detect_references();
    interpolation::interpolate(&mut value, parameters, config).map_err(|source| {
        Error::ClassNameResolveError {
            class_name: class_name.to_string(),
            source,
        }
    })?;
    Ok(value.value_to_string())
}

fn resolve_class_name(
    class_name: &str,
    entity_name: &str,
    parameters: &ParametersType,
    config: &MergeConfig,
) -> Result<String, Error> {
    let resolved = crate::inventory::elements::inheritance_chain::resolve_relative_class_name(
        class_name,
        entity_name,
    );
    if contains_interpolation(&resolved) {
        interpolate_class_name(&resolved, parameters, config)
    } else {
        Ok(resolved)
    }
}

fn recurse_class(
    inventory: &Inventory,
    class: &Class,
    merge_base: Option<MergeAccumulator>,
    seen: &mut HashSet<String>,
    merge_config: &MergeConfig,
) -> Result<MergeAccumulator, Error> {
    let mut acc = merge_base.unwrap_or_else(MergeAccumulator::new);

    for class_name in class.classes() {
        let resolved = resolve_class_name(class_name, class.name(), &acc.parameters, merge_config)?;

        if seen.contains(&resolved) {
            continue;
        }

        let parent_class = match inventory.get_class(&resolved) {
            Some(c) => c,
            None => {
                if merge_config.should_ignore_class(&resolved) {
                    if merge_config.ignore_class_notfound_warning {
                        tracing::warn!("Class not found: '{}'. Skipped!", resolved);
                    }
                    continue;
                }
                return Err(Error::ClassNotFound {
                    class_name: resolved.clone(),
                });
            }
        };

        let descent = recurse_class(inventory, parent_class, None, seen, merge_config)?;

        merge_descent_into(&mut acc, &descent, &resolved, merge_config)?;
        seen.insert(resolved);
    }

    merge_entity_fields(
        &mut acc,
        class.classes(),
        class.applications(),
        class.environment(),
        class.parameters(),
        class.exports(),
        merge_config,
    )?;

    Ok(acc)
}

pub(crate) fn merge_node(
    inventory: &Inventory,
    node: &Node,
    extra_classes: &[String],
    merge_config: &MergeConfig,
    input_data: Option<&ParametersType>,
) -> Result<Node, Error> {
    merge_node_impl(
        inventory,
        node,
        extra_classes,
        merge_config,
        None,
        input_data,
    )
}

pub(crate) fn merge_node_with_inventory(
    inventory: &Inventory,
    node: &Node,
    extra_classes: &[String],
    merge_config: &MergeConfig,
    inv_map: &inv_query::InventoryMap,
    input_data: Option<&ParametersType>,
) -> Result<Node, Error> {
    merge_node_impl(
        inventory,
        node,
        extra_classes,
        merge_config,
        Some(inv_map),
        input_data,
    )
}

fn merge_node_impl(
    inventory: &Inventory,
    node: &Node,
    extra_classes: &[String],
    merge_config: &MergeConfig,
    inv_map: Option<&inv_query::InventoryMap>,
    input_data: Option<&ParametersType>,
) -> Result<Node, Error> {
    let environment = node.environment().clone();

    let mut seen: HashSet<String> = HashSet::new();
    let mut base_acc = MergeAccumulator::new();

    for class_name in extra_classes {
        let resolved =
            resolve_class_name(class_name, node.name(), &base_acc.parameters, merge_config)?;
        if seen.contains(&resolved) {
            continue;
        }
        let class = match inventory.get_class(&resolved) {
            Some(c) => c,
            None => {
                if merge_config.should_ignore_class(&resolved) {
                    if merge_config.ignore_class_notfound_warning {
                        tracing::warn!("Class not found: '{}'. Skipped!", resolved);
                    }
                    continue;
                }
                return Err(Error::ClassNotFound {
                    class_name: resolved.clone(),
                });
            }
        };
        let descent = recurse_class(inventory, class, None, &mut seen, merge_config)?;

        merge_descent_into(&mut base_acc, &descent, &resolved, merge_config)?;
        seen.insert(resolved);
    }

    if let Some(data) = input_data {
        let merged = merge_parameters(&base_acc.parameters, data, merge_config)?;
        base_acc.parameters = merged;
    }

    if merge_config.automatic_parameters {
        let auto_params = crate::inventory::create_automatic_parameters(node.name(), &environment);
        let merged = merge_parameters(&base_acc.parameters, &auto_params, merge_config)?;
        base_acc.parameters = merged;
    }

    let mut seen_phase2 = seen;
    let mut node_acc = base_acc;

    for class_name in node.classes() {
        let resolved =
            resolve_class_name(class_name, node.name(), &node_acc.parameters, merge_config)?;

        if seen_phase2.contains(&resolved) {
            continue;
        }

        let class = match inventory.get_class(&resolved) {
            Some(c) => c,
            None => {
                if merge_config.should_ignore_class(&resolved) {
                    if merge_config.ignore_class_notfound_warning {
                        tracing::warn!("Class not found: '{}'. Skipped!", resolved);
                    }
                    continue;
                }
                return Err(Error::ClassNotFound {
                    class_name: resolved.clone(),
                });
            }
        };

        let descent = recurse_class(inventory, class, None, &mut seen_phase2, merge_config)?;

        merge_descent_into(&mut node_acc, &descent, &resolved, merge_config)?;
        seen_phase2.insert(resolved);
    }

    merge_entity_fields(
        &mut node_acc,
        node.classes(),
        node.applications(),
        node.environment(),
        node.parameters(),
        node.exports(),
        merge_config,
    )?;

    let mut result = node.clone();
    if !node_acc.environment.is_empty() {
        *result.environment_mut() = node_acc.environment.clone();
    }
    *result.classes_mut() = node_acc.classes;
    *result.applications_mut() = node_acc.applications;
    *result.parameters_mut() = node_acc.parameters;

    let params = std::mem::take(result.parameters_mut());
    let params_rc = Rc::new(params);
    let mut params_value = Value::Hash(Rc::clone(&params_rc));
    let params = &*params_rc;

    let params_result = if let Some(inv) = inv_map {
        interpolation::interpolate_with_inventory(
            &mut params_value,
            params,
            merge_config,
            inv,
            result.environment(),
        )
    } else {
        interpolation::interpolate(&mut params_value, params, merge_config)
    };

    let exports = std::mem::take(&mut node_acc.exports);
    let mut exports_value = Value::Hash(Rc::new(exports));
    let exports_result = if let Some(inv) = inv_map {
        interpolation::interpolate_with_inventory(
            &mut exports_value,
            params,
            merge_config,
            inv,
            result.environment(),
        )
    } else {
        interpolation::interpolate(&mut exports_value, params, merge_config)
    };

    match (params_result, exports_result) {
        (Ok(()), Ok(())) => {}
        (Err(e), Ok(())) => {
            return Err(Error::Interpolation { source: e });
        }
        (Ok(()), Err(e)) => {
            return Err(Error::Interpolation { source: e });
        }
        (Err(params_err), Err(exports_err)) => match (params_err, exports_err) {
            (
                interpolation::Error::ResolveErrorList {
                    errors: mut combined,
                },
                interpolation::Error::ResolveErrorList { errors: el },
            ) => {
                combined.merge(el);
                return Err(Error::Interpolation {
                    source: interpolation::Error::ResolveErrorList { errors: combined },
                });
            }
            (params_err, _) => {
                return Err(Error::Interpolation { source: params_err });
            }
        },
    }

    match params_value {
        Value::Hash(h) => {
            *result.parameters_mut() = Rc::try_unwrap(h).unwrap_or_else(|rc| (*rc).clone());
        }
        _ => unreachable!("interpolation of Hash should return Hash"),
    }

    match exports_value {
        Value::Hash(h) => {
            *result.exports_mut() = Rc::try_unwrap(h).unwrap_or_else(|rc| (*rc).clone());
        }
        _ => unreachable!("interpolation of Hash should return Hash"),
    }

    Ok(result)
}

pub(crate) fn merge_class(
    inventory: &Inventory,
    class: &Class,
    merge_config: &MergeConfig,
) -> Result<Class, Error> {
    let mut seen: HashSet<String> = HashSet::new();

    let acc = recurse_class(inventory, class, None, &mut seen, merge_config)?;

    let mut result = Class::new(class.name().to_string())
        .environment(acc.environment)
        .classes(acc.classes)
        .applications(acc.applications)
        .parameters(acc.parameters)
        .exports(acc.exports)
        .build();

    if let Some(uri) = class.uri() {
        result.set_uri(uri.to_string());
    }

    Ok(result)
}