aqc-file-engine-core 0.1.0

Shared framework types and FileEngine trait for aqc-{domain}-engine crates.
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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
//! Shared merge machinery for file-engine requirements.
//!
//! Adapters emit plain engine requirements tagged with provenance. Engine merge
//! code composes those plain requirements into resolved values, while keeping
//! the collected assertions needed for precise findings.

use std::collections::{BTreeMap, BTreeSet};

use crate::toml_helpers::parse_version_tuple;
use crate::types::{ConfigScalar, Provenance};

/// One key on which policies irreconcilably disagree, with each value.
#[derive(Debug, Clone)]
pub struct ConflictEntry {
    /// The disagreeing key.
    pub key: String,
    /// Which composition rule found the conflict.
    pub reason: String,
    /// Each provenance paired with its value, rendered for display.
    pub contributors: Vec<(Provenance, String)>,
}

/// A composed requirement plus the policy assertions used to compose it.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ResolvedRequirement<Merged, A> {
    pub merged: Merged,
    pub collected: Vec<(Provenance, A)>,
}

/// Product requirement for collections of identifiable file items.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ItemRequirements<Item> {
    pub required: Vec<(Item, String)>,
    pub banned: Vec<(Item, String)>,
    pub closed: Option<String>,
}

impl<Item> Default for ItemRequirements<Item> {
    fn default() -> Self {
        Self {
            required: Vec::new(),
            banned: Vec::new(),
            closed: None,
        }
    }
}

/// Resolved item requirements with attribution on every member.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ResolvedItemRequirements<Item>
where
    Item: FileItemRequirement,
{
    pub required: BTreeMap<Item::Identity, ResolvedRequirement<Item, (Item, String)>>,
    pub banned: BTreeMap<Item::Identity, ResolvedRequirement<Item, String>>,
    pub closed_by: Vec<(Provenance, String)>,
}

impl<Item> Default for ResolvedItemRequirements<Item>
where
    Item: FileItemRequirement,
{
    fn default() -> Self {
        Self {
            required: BTreeMap::new(),
            banned: BTreeMap::new(),
            closed_by: Vec::new(),
        }
    }
}

/// A file-item requirement that can identify and compose matching policy input.
pub trait FileItemRequirement: Sized + Clone {
    type Identity: Ord + Clone;

    fn merge_identity(&self) -> Self::Identity;

    fn compose_item(
        key: &str,
        items: Vec<(Provenance, (Self, String))>,
        conflicts: &mut Vec<ConflictEntry>,
    ) -> Option<ResolvedRequirement<Self, (Self, String)>>;
}

/// Forbidden-glob requirement for collections where policy names a glob.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ForbiddenGlobRequirements<Glob> {
    pub globs: Vec<(Glob, String)>,
}

impl<Glob> Default for ForbiddenGlobRequirements<Glob> {
    fn default() -> Self {
        Self { globs: Vec::new() }
    }
}

/// Resolved glob forbids with attribution on each glob.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ResolvedForbiddenGlobRequirements<Glob>
where
    Glob: ForbiddenGlobRequirement,
{
    pub globs: BTreeMap<Glob::Identity, ResolvedRequirement<Glob, String>>,
}

impl<Glob> Default for ResolvedForbiddenGlobRequirements<Glob>
where
    Glob: ForbiddenGlobRequirement,
{
    fn default() -> Self {
        Self {
            globs: BTreeMap::new(),
        }
    }
}

/// A forbidden glob that can be deduped across policy input.
pub trait ForbiddenGlobRequirement: Sized + Clone {
    type Identity: Ord + Clone;

    fn merge_identity(&self) -> Self::Identity;

    fn render(&self) -> String;
}

/// Requirement for collections where the file key is the item identity.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct KeyedItem<Value> {
    pub file_key: String,
    pub value: Value,
}

/// Product requirement for list-like TOML fields.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct ListRequirements {
    pub contains: BTreeMap<String, String>,
    pub excludes: BTreeMap<String, String>,
    pub exact: Option<(Vec<String>, String)>,
}

/// Resolved list requirements with per-item and exact-list attribution.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct ResolvedListRequirements {
    pub contains: BTreeMap<String, ResolvedRequirement<(), String>>,
    pub excludes: BTreeMap<String, ResolvedRequirement<(), String>>,
    pub exact: Option<ResolvedRequirement<Vec<String>, (Vec<String>, String)>>,
}

/// Assertion types that compose several policy assertions into one value.
pub trait Resolve: Sized + Clone {
    type Merged: Clone;

    fn resolve(
        key: &str,
        items: Vec<(Provenance, Self)>,
        conflicts: &mut Vec<ConflictEntry>,
    ) -> Option<ResolvedRequirement<Self::Merged, Self>>;
}

/// Compose assertions keyed by field name.
pub fn resolve_map<K, A>(
    input: Vec<(Provenance, BTreeMap<K, A>)>,
    key_path: impl Fn(&K) -> String,
    conflicts: &mut Vec<ConflictEntry>,
) -> BTreeMap<K, ResolvedRequirement<A::Merged, A>>
where
    K: Ord + Clone,
    A: Resolve,
{
    let mut by_key: BTreeMap<K, Vec<(Provenance, A)>> = BTreeMap::new();
    for (prov, map) in input {
        for (key, assertion) in map {
            by_key
                .entry(key)
                .or_default()
                .push((prov.clone(), assertion));
        }
    }

    let mut out = BTreeMap::new();
    for (key, items) in by_key {
        if let Some(resolved) = A::resolve(&key_path(&key), items, conflicts) {
            let _ = out.insert(key, resolved);
        }
    }
    out
}

/// Compose an optional singleton assertion.
pub fn resolve_maybe<A>(
    key: &str,
    input: Vec<(Provenance, Option<A>)>,
    conflicts: &mut Vec<ConflictEntry>,
) -> Option<ResolvedRequirement<A::Merged, A>>
where
    A: Resolve,
{
    let items = input
        .into_iter()
        .filter_map(|(prov, value)| value.map(|assertion| (prov, assertion)))
        .collect::<Vec<_>>();
    if items.is_empty() {
        None
    } else {
        A::resolve(key, items, conflicts)
    }
}

/// Compose file-item collection requirements.
pub fn resolve_items<Item>(
    key: &str,
    input: Vec<(Provenance, ItemRequirements<Item>)>,
    conflicts: &mut Vec<ConflictEntry>,
) -> ResolvedItemRequirements<Item>
where
    Item: FileItemRequirement,
    Item::Identity: ToString,
{
    let mut required: BTreeMap<Item::Identity, Vec<(Provenance, (Item, String))>> = BTreeMap::new();
    let mut banned: BTreeMap<Item::Identity, Vec<(Provenance, (Item, String))>> = BTreeMap::new();
    let mut closed_by = Vec::new();
    let mut closed_inputs: Vec<(Provenance, String, BTreeSet<Item::Identity>)> = Vec::new();

    for (prov, items) in input {
        let allowed = items
            .required
            .iter()
            .map(|(item, _)| item.merge_identity())
            .collect::<BTreeSet<_>>();
        for (item, msg) in items.required {
            required
                .entry(item.merge_identity())
                .or_default()
                .push((prov.clone(), (item, msg)));
        }
        for (item, msg) in items.banned {
            banned
                .entry(item.merge_identity())
                .or_default()
                .push((prov.clone(), (item, msg)));
        }
        if let Some(msg) = items.closed {
            closed_inputs.push((prov.clone(), msg.clone(), allowed));
            closed_by.push((prov, msg));
        }
    }

    let mut resolved_required = BTreeMap::new();
    for (identity, items) in required {
        let path = format!("{}.{}", key, identity.to_string());
        if let Some(resolved) = Item::compose_item(&path, items, conflicts) {
            let _ = resolved_required.insert(identity, resolved);
        }
    }

    let mut resolved_banned = BTreeMap::new();
    for (identity, items) in banned {
        let Some((_, (first, _))) = items.first() else {
            continue;
        };
        let _ = resolved_banned.insert(
            identity,
            ResolvedRequirement {
                merged: first.clone(),
                collected: items
                    .into_iter()
                    .map(|(prov, (_, msg))| (prov, msg))
                    .collect(),
            },
        );
    }

    for identity in resolved_required.keys() {
        if let Some(ban) = resolved_banned.get(identity) {
            let mut contributors = Vec::new();
            if let Some(req) = resolved_required.get(identity) {
                contributors.extend(req.collected.iter().map(|(prov, entry)| {
                    let _ = entry;
                    (prov.clone(), "required".to_owned())
                }));
            }
            contributors.extend(
                ban.collected
                    .iter()
                    .map(|(prov, _)| (prov.clone(), "banned".to_owned())),
            );
            conflicts.push(ConflictEntry {
                key: format!("{}.{}", key, identity.to_string()),
                reason: "item-required-and-banned".to_owned(),
                contributors,
            });
        }
    }

    for (closer, _, allowed) in &closed_inputs {
        for (identity, req) in &resolved_required {
            if allowed.contains(identity) {
                continue;
            }
            let mut contributors = vec![(closer.clone(), "closed".to_owned())];
            contributors.extend(
                req.collected
                    .iter()
                    .map(|(prov, _)| (prov.clone(), "required".to_owned())),
            );
            conflicts.push(ConflictEntry {
                key: format!("{}.{}", key, identity.to_string()),
                reason: "closed-collection-rejects-unlisted-required-item".to_owned(),
                contributors,
            });
        }
    }

    ResolvedItemRequirements {
        required: resolved_required,
        banned: resolved_banned,
        closed_by,
    }
}

/// Compose ban-only glob requirements.
pub fn resolve_forbidden_globs<Glob>(
    key: &str,
    input: Vec<(Provenance, ForbiddenGlobRequirements<Glob>)>,
    conflicts: &mut Vec<ConflictEntry>,
) -> ResolvedForbiddenGlobRequirements<Glob>
where
    Glob: ForbiddenGlobRequirement,
    Glob::Identity: ToString,
{
    let _ = conflicts;
    let mut by_glob: BTreeMap<Glob::Identity, Vec<(Provenance, (Glob, String))>> = BTreeMap::new();

    for (prov, globs) in input {
        for (glob, msg) in globs.globs {
            by_glob
                .entry(glob.merge_identity())
                .or_default()
                .push((prov.clone(), (glob, msg)));
        }
    }

    let mut resolved_globs = BTreeMap::new();
    for (identity, items) in by_glob {
        let Some((_, (first, _))) = items.first() else {
            continue;
        };
        let _path = format!("{}.{}", key, identity.to_string());
        let _ = resolved_globs.insert(
            identity,
            ResolvedRequirement {
                merged: first.clone(),
                collected: items
                    .into_iter()
                    .map(|(prov, (_, msg))| (prov, msg))
                    .collect(),
            },
        );
    }

    ResolvedForbiddenGlobRequirements {
        globs: resolved_globs,
    }
}

/// Compose list product requirements.
pub fn resolve_list(
    key: &str,
    items: Vec<(Provenance, ListRequirements)>,
    conflicts: &mut Vec<ConflictEntry>,
) -> ResolvedListRequirements {
    let mut contains: BTreeMap<String, Vec<(Provenance, String)>> = BTreeMap::new();
    let mut excludes: BTreeMap<String, Vec<(Provenance, String)>> = BTreeMap::new();
    let mut exact_items = Vec::new();

    for (prov, list) in items {
        for (name, msg) in list.contains {
            contains.entry(name).or_default().push((prov.clone(), msg));
        }
        for (name, msg) in list.excludes {
            excludes.entry(name).or_default().push((prov.clone(), msg));
        }
        if let Some(exact) = list.exact {
            exact_items.push((prov, exact));
        }
    }

    let mut resolved_contains = BTreeMap::new();
    for (name, collected) in contains {
        let _ = resolved_contains.insert(
            name,
            ResolvedRequirement {
                merged: (),
                collected,
            },
        );
    }

    let mut resolved_excludes = BTreeMap::new();
    for (name, collected) in excludes {
        let _ = resolved_excludes.insert(
            name,
            ResolvedRequirement {
                merged: (),
                collected,
            },
        );
    }

    for name in resolved_contains.keys() {
        if let Some(exclude) = resolved_excludes.get(name) {
            let mut contributors = Vec::new();
            if let Some(include) = resolved_contains.get(name) {
                contributors.extend(
                    include
                        .collected
                        .iter()
                        .map(|(prov, _)| (prov.clone(), "contains".to_owned())),
                );
            }
            contributors.extend(
                exclude
                    .collected
                    .iter()
                    .map(|(prov, _)| (prov.clone(), "excludes".to_owned())),
            );
            conflicts.push(ConflictEntry {
                key: format!("{key}.{name}"),
                reason: "list-contains-and-excludes".to_owned(),
                contributors,
            });
        }
    }

    let exact = resolve_exact_list(key, exact_items, conflicts);
    if let Some(exact) = &exact {
        let allowed = exact.merged.iter().cloned().collect::<BTreeSet<_>>();
        for (name, include) in &resolved_contains {
            if !allowed.contains(name) {
                let mut contributors = exact
                    .collected
                    .iter()
                    .map(|(prov, _)| (prov.clone(), "exact".to_owned()))
                    .collect::<Vec<_>>();
                contributors.extend(
                    include
                        .collected
                        .iter()
                        .map(|(prov, _)| (prov.clone(), "contains".to_owned())),
                );
                conflicts.push(ConflictEntry {
                    key: format!("{key}.{name}"),
                    reason: "list-exact-missing-contained-item".to_owned(),
                    contributors,
                });
            }
        }
        for (name, exclude) in &resolved_excludes {
            if allowed.contains(name) {
                let mut contributors = exact
                    .collected
                    .iter()
                    .map(|(prov, _)| (prov.clone(), "exact".to_owned()))
                    .collect::<Vec<_>>();
                contributors.extend(
                    exclude
                        .collected
                        .iter()
                        .map(|(prov, _)| (prov.clone(), "excludes".to_owned())),
                );
                conflicts.push(ConflictEntry {
                    key: format!("{key}.{name}"),
                    reason: "list-exact-contains-excluded-item".to_owned(),
                    contributors,
                });
            }
        }
    }

    ResolvedListRequirements {
        contains: resolved_contains,
        excludes: resolved_excludes,
        exact,
    }
}

/// Compose assertions that must all be the same semantic value.
pub fn resolve_scalar<T>(
    key: &str,
    items: Vec<(Provenance, T)>,
    render: impl Fn(&T) -> String,
    conflicts: &mut Vec<ConflictEntry>,
) -> Option<ResolvedRequirement<T, T>>
where
    T: PartialEq + Clone,
{
    resolve_all_equal(key, "scalar-disagree", items, render, conflicts)
}

/// Compose exact-list assertions.
pub fn resolve_exact_list(
    key: &str,
    items: Vec<(Provenance, (Vec<String>, String))>,
    conflicts: &mut Vec<ConflictEntry>,
) -> Option<ResolvedRequirement<Vec<String>, (Vec<String>, String)>> {
    let resolved = resolve_all_equal(
        key,
        "exact-mismatch",
        items,
        |(list, _)| format!("{list:?}"),
        conflicts,
    )?;
    Some(ResolvedRequirement {
        merged: resolved.merged.0,
        collected: resolved.collected,
    })
}

/// Compose semantic values and retain every assertion.
pub fn resolve_all_equal<T>(
    key: &str,
    reason: &str,
    items: Vec<(Provenance, T)>,
    render: impl Fn(&T) -> String,
    conflicts: &mut Vec<ConflictEntry>,
) -> Option<ResolvedRequirement<T, T>>
where
    T: PartialEq + Clone,
{
    let mut iter = items.iter();
    let (_, first) = iter.next()?;
    let disagree = iter.any(|(_, value)| value != first);
    if disagree {
        conflicts.push(ConflictEntry {
            key: key.to_owned(),
            reason: reason.to_owned(),
            contributors: items
                .iter()
                .map(|(prov, value)| (prov.clone(), render(value)))
                .collect(),
        });
        None
    } else {
        Some(ResolvedRequirement {
            merged: first.clone(),
            collected: items,
        })
    }
}

/// Compose two optional scalar fields inside a larger entry.
pub fn compose_optional_field<T>(
    key: &str,
    items: Vec<(Provenance, Option<T>)>,
    render: impl Fn(&T) -> String,
    conflicts: &mut Vec<ConflictEntry>,
) -> Option<T>
where
    T: PartialEq + Clone,
{
    let present = items
        .into_iter()
        .filter_map(|(prov, value)| value.map(|inner| (prov, inner)))
        .collect::<Vec<_>>();
    if present.is_empty() {
        None
    } else {
        resolve_scalar(key, present, render, conflicts).map(|resolved| resolved.merged)
    }
}

/// Ordered, deduplicated union of string lists.
#[must_use]
pub fn compose_string_list(items: Vec<Vec<String>>) -> Vec<String> {
    let mut out = Vec::new();
    for list in items {
        for item in list {
            if !out.iter().any(|seen| seen == &item) {
                out.push(item);
            }
        }
    }
    out
}

/// Union of string sets.
#[must_use]
pub fn compose_string_set(items: Vec<BTreeSet<String>>) -> BTreeSet<String> {
    items.into_iter().flatten().collect()
}

/// Highest version-like floor, retaining the winning message.
#[must_use]
pub fn strongest_version_floor(items: Vec<(String, String)>) -> (String, String) {
    items
        .into_iter()
        .max_by(|(a, _), (b, _)| parse_version_tuple(a).cmp(&parse_version_tuple(b)))
        .unwrap_or_default()
}

/// Semantic equality of two keyed `(value, message)` maps.
#[must_use]
pub fn keyed_entries_eq<S: PartialEq, M>(
    a: &BTreeMap<String, (S, M)>,
    b: &BTreeMap<String, (S, M)>,
) -> bool {
    a.len() == b.len()
        && a.iter()
            .all(|(key, (left, _))| b.get(key).is_some_and(|(right, _)| left == right))
}

impl<Value> FileItemRequirement for KeyedItem<Value>
where
    Value: PartialEq + Clone,
{
    type Identity = String;

    fn merge_identity(&self) -> Self::Identity {
        self.file_key.clone()
    }

    fn compose_item(
        key: &str,
        items: Vec<(Provenance, (Self, String))>,
        conflicts: &mut Vec<ConflictEntry>,
    ) -> Option<ResolvedRequirement<Self, (Self, String)>> {
        compose_item_by(key, items, |item| item.value.clone(), conflicts)
    }
}

impl Resolve for ConfigScalar {
    type Merged = Self;

    fn resolve(
        key: &str,
        items: Vec<(Provenance, Self)>,
        conflicts: &mut Vec<ConflictEntry>,
    ) -> Option<ResolvedRequirement<Self::Merged, Self>> {
        resolve_scalar(key, items, |item| format!("{item:?}"), conflicts)
    }
}

/// Generic item composer for semantic-value equality.
pub fn compose_item_by<Item, Semantic>(
    key: &str,
    items: Vec<(Provenance, (Item, String))>,
    project: impl Fn(&Item) -> Semantic,
    conflicts: &mut Vec<ConflictEntry>,
) -> Option<ResolvedRequirement<Item, (Item, String)>>
where
    Item: Clone,
    Semantic: PartialEq,
{
    let mut iter = items.iter();
    let (_, (first, _)) = iter.next()?;
    let first_semantic = project(first);
    let disagree = iter.any(|(_, (entry, _))| project(entry) != first_semantic);
    if disagree {
        conflicts.push(ConflictEntry {
            key: key.to_owned(),
            reason: "set-key-disagree".to_owned(),
            contributors: items
                .iter()
                .map(|(prov, _)| (prov.clone(), "required".to_owned()))
                .collect(),
        });
        None
    } else {
        Some(ResolvedRequirement {
            merged: first.clone(),
            collected: items,
        })
    }
}