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
52
53
54
55
56

//! Repository redaction helpers for public projections.

use shiplog_schema::event::{RepoRef, RepoVisibility};

/// Alias resolver used by public repository redaction.
pub(crate) trait AliasResolver {
    fn alias(&self, kind: &str, value: &str) -> String;
}

impl<F> AliasResolver for F
where
    F: Fn(&str, &str) -> String,
{
    fn alias(&self, kind: &str, value: &str) -> String {
        (self)(kind, value)
    }
}

/// Redact a repository reference for `public` profile projection.
#[must_use]
pub(crate) fn redact_repo_public<A: AliasResolver + ?Sized>(
    repo: &RepoRef,
    aliases: &A,
) -> RepoRef {
    RepoRef {
        full_name: aliases.alias("repo", &repo.full_name),
        html_url: None,
        visibility: RepoVisibility::Unknown,
    }
}

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

    #[test]
    fn closure_alias_resolver_is_supported() {
        let resolver = |kind: &str, value: &str| format!("{kind}:{value}");
        assert_eq!(resolver.alias("repo", "acme/core"), "repo:acme/core");
    }

    #[test]
    fn redact_repo_public_applies_public_contract() {
        let repo = RepoRef {
            full_name: "acme/private-repo".to_string(),
            html_url: Some("https://github.com/acme/private-repo".to_string()),
            visibility: RepoVisibility::Private,
        };
        let resolver = |kind: &str, value: &str| format!("{kind}-alias:{value}");

        let out = redact_repo_public(&repo, &resolver);
        assert_eq!(out.full_name, "repo-alias:acme/private-repo");
        assert!(out.html_url.is_none());
        assert_eq!(out.visibility, RepoVisibility::Unknown);
    }
}