goup 1.7.0

A simple version manager for Go written in Rust! 🚀
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222

use super::{Version, VersionPart};
use crate::{
    cmd::{self, exec},
    warning,
};
use anyhow::Result;
use reqwest::{blocking::Client, header};
use serde::Deserialize;
use std::str::FromStr;

const GOLANG_REPO: &str = "https://github.com/golang/go.git";
const GOLANG_TAGS_ENDPOINT: &str =
    "https://api.github.com/repos/golang/go/git/matching-refs/tags/go";

/// Queries all tags from the upstream
/// [Go repository on GitHub](https://github.com/golang/go),
/// filters for all tags prefixed with `go`, parses the
/// [`Version`]s and returns the sorted list of versions
/// (oldest to latest).
///
/// The tags are first tried to be fetched via the GitHub API.
/// If this fails, a warning message is printed and
/// `git ls-remote --tags` is used as fallback.
pub fn get_upstream_versions() -> Result<Vec<Version>> {
    let mut tags = get_upstream_versions_api().or_else(|err| {
        warning!(
            "Listing remote versions via GitHub API failed, falling back to using git ls-remote.\n\
            Error was: {err}"
        );
        get_upstream_versions_git()
    })?;

    tags.sort();

    Ok(tags)
}

/// Fetches a list of versions from the Go remote repository on
/// GitHub using `git ls-remote --tags`.
fn get_upstream_versions_git() -> Result<Vec<Version>> {
    let res = exec(&["git", "ls-remote", "--tags", GOLANG_REPO]);

    let res = match res {
        Ok(res) => res,
        Err(cmd::errors::Error::NotFound) => {
            anyhow::bail!(
                "Seems you don't have git installed on your system. Listing versions failed."
            )
        }
        Err(err) => return Err(err.into()),
    };

    res.split('\n')
        .filter_map(|line| line.split_once("refs/tags/"))
        .map(|(_, tag)| tag)
        .filter_map(|tag| tag.strip_prefix("go"))
        .map(FromStr::from_str)
        .collect()
}

#[derive(Deserialize)]
struct Ref {
    r#ref: String,
}

/// Fetches a list of versions from the Go remote repository on
/// GitHub using the GitHub REST API.
fn get_upstream_versions_api() -> Result<Vec<Version>> {
    let refs: Vec<Ref> = Client::builder()
        .build()?
        .get(GOLANG_TAGS_ENDPOINT)
        .header(header::USER_AGENT, "goup")
        .send()?
        .error_for_status()?
        .json()?;

    refs.iter()
        .filter_map(|r| r.r#ref.strip_prefix("refs/tags/go"))
        .map(FromStr::from_str)
        .collect()
}

/// Fetches upstream versions *(see [`get_versions`])* and returns
/// the latest stable [`Version`].
///
/// If `include_unstable` is passed as `true`, the latest version
/// is returned including unstable versions.
///
/// # Errors
/// If no version has been found, an error of type [`anyhow::Error`]
/// is returned with a message containing more details.
pub fn get_latest_upstream_version(include_unstable: bool) -> Result<Version> {
    get_upstream_versions()?
        .iter()
        .rev()
        .find(|v| include_unstable || v.is_stable())
        .cloned()
        .ok_or_else(|| anyhow::anyhow!("no stable version found"))
}

/// Fetches upstream versions *(see [`get_versions`])* and returns
/// the latest version that covers the given Version `s`. See
/// [`Version`] implementation for more details.
///
/// If `s` includes a `pre` part *(`"1.20rc1"`, for example)*, the
/// specified pre-release version is returned. Otherwise, only
/// matching stable versions are returned.
///
/// # Errors
/// If no version has been found, an error of type [`anyhow::Error`]
/// is returned with a message containing more details.
pub fn find_upstream_version(s: &Version) -> Result<Version> {
    get_upstream_versions()?
        .iter()
        .rev()
        .filter(|v| v.is_stable() || !s.is_stable())
        .find(|v| s.covers(v))
        .cloned()
        .ok_or_else(|| anyhow::anyhow!("no matching stable version found"))
}

pub fn get_new_minor<'a>(versions: &'a [Version], current: &Version) -> Option<&'a Version> {
    versions.iter().rev().find(|v| {
        current.is_stable() == v.is_stable()
            && v.minor > current.minor
            && current.strip_after(VersionPart::Major).covers(v)
    })
}

pub fn get_new_patch<'a>(versions: &'a [Version], current: &Version) -> Option<&'a Version> {
    versions
        .iter()
        .rev()
        .find(|v| v.patch > current.patch && current.strip_after(VersionPart::Minor).covers(v))
}

pub fn get_new_pre<'a>(versions: &'a [Version], current: &Version) -> Option<&'a Version> {
    if current.is_stable() {
        return None;
    }

    versions
        .iter()
        .rev()
        .find(|v| v.pre > current.pre && current.strip_after(VersionPart::Patch).covers(v))
}

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

    fn get_versions() -> Vec<Version> {
        vec![
            "1.19.0".parse().unwrap(),
            "1.19.1".parse().unwrap(),
            "1.19.2".parse().unwrap(),
            "1.19.3".parse().unwrap(),
            "1.20.0".parse().unwrap(),
            "1.20.1".parse().unwrap(),
            "1.20.2".parse().unwrap(),
            "1.20.3".parse().unwrap(),
            "1.20.4".parse().unwrap(),
            "1.21.0".parse().unwrap(),
            "1.21.1".parse().unwrap(),
            "1.21.2".parse().unwrap(),
            "1.21.3".parse().unwrap(),
            "1.22rc1".parse().unwrap(),
            "1.22rc2".parse().unwrap(),
            "1.22rc3".parse().unwrap(),
        ]
    }

    #[test]
    fn test_get_new_minor() {
        let versions = get_versions();

        let current = "1.20.3".parse().unwrap();
        let new = get_new_minor(&versions, &current);
        let exp = Some("1.21.3".parse().unwrap());
        assert_eq!(exp.as_ref(), new);

        let current = "1.21.1".parse().unwrap();
        let new = get_new_minor(&versions, &current);
        let exp = None;
        assert_eq!(exp.as_ref(), new);
    }

    #[test]
    fn test_get_new_patch() {
        let versions = get_versions();

        let current = "1.20.3".parse().unwrap();
        let new = get_new_patch(&versions, &current);
        let exp = Some("1.20.4".parse().unwrap());
        assert_eq!(exp.as_ref(), new);

        let current = "1.19.3".parse().unwrap();
        let new = get_new_patch(&versions, &current);
        let exp = None;
        assert_eq!(exp.as_ref(), new);
    }

    #[test]
    fn test_get_new_pre() {
        let versions = get_versions();

        let current = "1.22rc1".parse().unwrap();
        let new = get_new_pre(&versions, &current);
        let exp = Some("1.22rc3".parse().unwrap());
        assert_eq!(exp.as_ref(), new);

        let current = "1.21.3".parse().unwrap();
        let new = get_new_pre(&versions, &current);
        let exp = None;
        assert_eq!(exp.as_ref(), new);

        let current = "1.22rc3".parse().unwrap();
        let new = get_new_pre(&versions, &current);
        let exp = None;
        assert_eq!(exp.as_ref(), new);
    }
}