ossctl-core 0.2.0

Core library for ossctl: contract normalizer, repo-fact detection, audit scoring, release engine, and the versioned protocol DTOs.
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

//! Version-control helpers shared across domains — the neutral home for git
//! remote/URL parsing that both the readiness [audit](crate::audit) and the
//! release [coordinator](crate::release::coordinator) depend on.
//!
//! Kept out of any single domain module so the dependency runs one way (each
//! consumer → `vcs`) rather than one domain reaching into another's internals.

/// Every recognized way a GitHub remote URL prefixes the `owner/repo` tail. The
/// match is a **prefix**, not a substring, so a non-GitHub host that merely
/// contains `github.com` in its path (`https://mirror.example/github.com/o/r`)
/// is rejected rather than mis-parsed into a GitHub slug.
const GITHUB_PREFIXES: &[&str] = &[
    "git@github.com:",       // scp-like (the common SSH form)
    "ssh://git@github.com/", // explicit ssh:// SSH form
    "ssh://github.com/",     // ssh:// without a user
    "https://github.com/",   //
    "http://github.com/",    //
    "git://github.com/",     //
    "github.com:",           // bare scp-like
    "github.com/",           // bare
];

/// Parse `owner/repo` out of a GitHub remote URL — the SSH (`git@github.com:o/r`,
/// `ssh://git@github.com/o/r`), HTTPS, and `git://` forms. `None` for a
/// non-GitHub host or an unrecognizable URL. The parser anchors on a known host
/// prefix (never a bare `find`), so a lookalike host is never accepted; a wrong
/// parse would in any case only yield a failed `gh api` ⇒ `unknown`, never a
/// false `Absent`.
pub(crate) fn parse_github_slug(url: &str) -> Option<String> {
    let tail = GITHUB_PREFIXES.iter().find_map(|p| url.strip_prefix(p))?;
    // Trim a trailing slash BEFORE stripping `.git` so `.../repo.git/` and
    // `.../repo/` both reduce to `repo` (strip order matters).
    let tail = tail.trim_end_matches('/');
    let tail = tail.strip_suffix(".git").unwrap_or(tail);
    let tail = tail.trim_end_matches('/');
    let mut parts = tail.splitn(3, '/');
    let owner = parts.next().filter(|s| !s.is_empty())?;
    let repo = parts.next().filter(|s| !s.is_empty())?;
    // Reject a trailing path segment (`owner/repo/extra`) — not a bare slug.
    if parts.next().is_some() {
        return None;
    }
    Some(format!("{owner}/{repo}"))
}

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

    #[test]
    fn parses_github_slugs_across_url_forms() {
        assert_eq!(
            parse_github_slug("git@github.com:acme/tool.git"),
            Some("acme/tool".to_string())
        );
        assert_eq!(
            parse_github_slug("https://github.com/acme/tool.git"),
            Some("acme/tool".to_string())
        );
        assert_eq!(
            parse_github_slug("https://github.com/acme/tool"),
            Some("acme/tool".to_string())
        );
        assert_eq!(
            parse_github_slug("git://github.com/acme/tool.git"),
            Some("acme/tool".to_string())
        );
        assert_eq!(
            parse_github_slug("ssh://git@github.com/acme/tool.git"),
            Some("acme/tool".to_string())
        );
        // A trailing slash after `.git` still reduces to the bare slug.
        assert_eq!(
            parse_github_slug("https://github.com/acme/tool.git/"),
            Some("acme/tool".to_string())
        );
        assert_eq!(
            parse_github_slug("https://github.com/acme/tool/"),
            Some("acme/tool".to_string())
        );

        // Non-GitHub host, lookalike hosts, and over-long paths are rejected.
        assert_eq!(parse_github_slug("git@gitlab.com:acme/tool.git"), None);
        assert_eq!(
            parse_github_slug("https://mirror.example.com/github.com/acme/tool.git"),
            None
        );
        assert_eq!(
            parse_github_slug("https://github.com.evil.example/acme/tool"),
            None
        );
        assert_eq!(
            parse_github_slug("https://github.com/acme/tool/tree/main"),
            None
        );
        assert_eq!(parse_github_slug("https://github.com/acme"), None);
    }
}