nebulus 0.1.28

Low-latency native OpenIPC FPV ground station built with egui
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

pub(crate) const DOCS_URL: &str = "https://openipc-rs.neels.dev";
pub(crate) const WEB_APP_URL: &str = "https://nebulus.openipc-rs.neels.dev";
pub(crate) const REPOSITORY_URL: &str = "https://github.com/neelsani/openipc-rs";
pub(crate) const RELEASES_URL: &str = "https://github.com/neelsani/openipc-rs/releases";

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct BuildInfo {
    pub(crate) version: &'static str,
    pub(crate) commit: Option<&'static str>,
    pub(crate) tag: Option<&'static str>,
}

impl BuildInfo {
    pub(crate) fn release_label(self) -> String {
        self.tag
            .map(str::to_owned)
            .unwrap_or_else(|| format!("v{}", self.version))
    }

    pub(crate) fn short_commit(self) -> Option<&'static str> {
        self.commit
            .map(|commit| commit.get(..commit.len().min(8)).unwrap_or(commit))
    }

    pub(crate) fn commit_url(self) -> String {
        self.commit.map_or_else(
            || REPOSITORY_URL.to_owned(),
            |commit| format!("{REPOSITORY_URL}/commit/{commit}"),
        )
    }

    pub(crate) fn description(self) -> String {
        let mut parts = vec![format!("Nebulus v{}", self.version)];
        if let Some(commit) = self.commit {
            parts.push(format!("commit {commit}"));
        }
        if let Some(tag) = self
            .tag
            .filter(|tag| tag.strip_prefix('v') != Some(self.version))
        {
            parts.push(format!("tag {tag}"));
        }
        parts.join(" | ")
    }
}

pub(crate) fn current() -> BuildInfo {
    BuildInfo {
        version: env!("CARGO_PKG_VERSION"),
        commit: non_empty(option_env!("NEBULUS_GIT_COMMIT")),
        tag: non_empty(option_env!("NEBULUS_GIT_TAG")),
    }
}

fn non_empty(value: Option<&'static str>) -> Option<&'static str> {
    value.filter(|value| !value.trim().is_empty())
}

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

    #[test]
    fn build_info_always_contains_the_package_version() {
        assert_eq!(super::current().version, env!("CARGO_PKG_VERSION"));
        assert!(!super::current().description().is_empty());
    }

    #[test]
    fn matching_release_tag_replaces_the_duplicate_version_label() {
        let build = BuildInfo {
            version: "1.2.3",
            commit: Some("0123456789abcdef"),
            tag: Some("v1.2.3"),
        };

        assert_eq!(build.release_label(), "v1.2.3");
        assert_eq!(
            build.description(),
            "Nebulus v1.2.3 | commit 0123456789abcdef"
        );
    }

    #[test]
    fn untagged_build_uses_the_package_version() {
        let build = BuildInfo {
            version: "1.2.3",
            commit: None,
            tag: None,
        };

        assert_eq!(build.release_label(), "v1.2.3");
    }
}