nscope 1.0.0

Communication with nScope devices
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

/***************************************************************************************************
 *
 *  nLabs, LLC
 *  https://nscope.org
 *  Copyright(c) 2020. All Rights Reserved
 *
 *  This file is part of the nScope API
 *
 **************************************************************************************************/

use git_version::git_version;
use regex::Regex;

/// Returns the current version of the nScope API
pub fn version() -> String {
    let git_description = git_version!(
        args = ["--always", "--tags", "--dirty"],
        suffix = "",
        cargo_suffix = ""
    );

    // Use a `+` to separate the tag info from build info in the git description
    let re = Regex::new(r"(?P<ver>\S+)-(?P<build>\d+-g[0-9a-f]{7})").unwrap();
    re.replace_all(git_description, "${ver}+${build}")
        .to_string()
}

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

    #[test]
    fn cargo_version_matches_git_version() {
        let cargo_version = env!("CARGO_PKG_VERSION").to_owned();
        let git_version = version();

        let cargo_semver = Version::parse(&cargo_version);
        let git_semver = Version::parse(&git_version);

        assert!(
            cargo_semver.is_ok(),
            "invalid semver cargo version: {}",
            cargo_version
        );
        assert!(
            git_semver.is_ok(),
            "invalid semver in git version: {}",
            git_version
        );
        let cargo_semver = cargo_semver.unwrap();
        let git_semver = git_semver.unwrap();

        assert!(
            cargo_semver.major == git_semver.major
                && cargo_semver.minor == git_semver.minor
                && cargo_semver.patch == git_semver.patch
                && cargo_semver.pre == git_semver.pre,
            "cargo version {} does not match git version {}",
            cargo_version,
            git_version
        );
    }

    #[test]
    fn version_is_valid_semver() {
        let v = version();
        assert!(Version::parse(&v).is_ok(), "invalid version: {}", v);
    }
}