shiplog-redact 0.6.0

Deterministic profile-based redaction engine for shiplog events and workstreams.
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

//! Profile-string projection dispatch for shiplog redaction.

use crate::policy::{redact_events_with_aliases, redact_workstreams_with_aliases};
use crate::profile::RedactionProfile;
use crate::repo::AliasResolver;
use shiplog_schema::event::EventEnvelope;
use shiplog_schema::workstream::WorkstreamsFile;

/// Parse a raw profile string into a canonical profile.
#[must_use]
pub(crate) fn parse_profile(profile: &str) -> RedactionProfile {
    RedactionProfile::from_profile_str(profile)
}

/// Project events using profile-string dispatch and an alias resolver.
#[must_use]
pub(crate) fn project_events_with_aliases<A: AliasResolver + ?Sized>(
    events: &[EventEnvelope],
    profile: &str,
    aliases: &A,
) -> Vec<EventEnvelope> {
    redact_events_with_aliases(events, parse_profile(profile), aliases)
}

/// Project workstreams using profile-string dispatch and an alias resolver.
#[must_use]
pub(crate) fn project_workstreams_with_aliases<A: AliasResolver + ?Sized>(
    workstreams: &WorkstreamsFile,
    profile: &str,
    aliases: &A,
) -> WorkstreamsFile {
    redact_workstreams_with_aliases(workstreams, parse_profile(profile), aliases)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parse_profile_keeps_known_values() {
        assert_eq!(parse_profile("internal"), RedactionProfile::Internal);
        assert_eq!(parse_profile("manager"), RedactionProfile::Manager);
        assert_eq!(parse_profile("public"), RedactionProfile::Public);
    }

    #[test]
    fn parse_profile_defaults_unknown_to_public() {
        assert_eq!(parse_profile("unexpected"), RedactionProfile::Public);
        assert_eq!(parse_profile(""), RedactionProfile::Public);
    }
}