cargo-msrv 0.16.1

Find your minimum supported Rust version (MSRV)!
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
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

use crate::context::{EnvironmentContext, RustReleasesContext, SetContext};
use crate::manifest::bare_version::BareVersion;
use crate::reporter::Reporter;
use crate::{Set, SubCommand, TResult};
use rust_releases::ReleaseIndex;

/// Write the MSRV to the Cargo manifest
///
/// Repurposes the Set MSRV subcommand for this action.
pub fn write_msrv(
    reporter: &impl Reporter,
    msrv: BareVersion,
    release_index: Option<&ReleaseIndex>,
    environment: EnvironmentContext,
    rust_releases: RustReleasesContext,
) -> TResult<()> {
    let context = SetContext {
        msrv,
        environment,
        rust_releases,
    };

    Set::new(release_index).run(&context, reporter)?;

    Ok(())
}

#[cfg(test)]
mod tests {
    use crate::context::{EnvironmentContext, RustReleasesContext};
    use crate::error::CargoMSRVError;
    use crate::manifest::bare_version::BareVersion;
    use crate::reporter::FakeTestReporter;
    use crate::writer::write_msrv::write_msrv;
    use assert_fs::prelude::*;
    use camino::Utf8Path;
    use rust_releases::{semver, ReleaseIndex};
    use std::iter::FromIterator;

    #[test]
    fn set_release_in_index() {
        let tmp = assert_fs::TempDir::new().unwrap();
        tmp.child("Cargo.toml").touch().unwrap();

        let manifest = tmp.join("Cargo.toml");
        std::fs::write(&manifest, "[package]").unwrap();

        let root = Utf8Path::from_path(tmp.path()).unwrap();

        let fake_reporter = FakeTestReporter::default();
        let version = BareVersion::ThreeComponents(2, 0, 5);

        let env = EnvironmentContext {
            crate_path: root.to_path_buf(),
        };

        let index = ReleaseIndex::from_iter(vec![rust_releases::Release::new_stable(
            semver::Version::new(2, 0, 5),
        )]);

        write_msrv(
            &fake_reporter,
            version,
            Some(&index),
            env,
            RustReleasesContext::default(),
        )
        .unwrap();

        let content = std::fs::read_to_string(&manifest).unwrap();
        assert_eq!(content, "[package]\nrust-version = \"2.0.5\"\n");
    }

    #[test]
    fn fail_to_set_release_not_in_index() {
        let tmp = assert_fs::TempDir::new().unwrap();
        tmp.child("Cargo.toml").touch().unwrap();

        let manifest = tmp.join("Cargo.toml");
        std::fs::write(manifest, "[package]").unwrap();

        let root = Utf8Path::from_path(tmp.path()).unwrap();

        let fake_reporter = FakeTestReporter::default();
        let version = BareVersion::ThreeComponents(2, 0, 5);

        let env = EnvironmentContext {
            crate_path: root.to_path_buf(),
        };

        let index = ReleaseIndex::from_iter(vec![]);

        let err = write_msrv(
            &fake_reporter,
            version,
            Some(&index),
            env,
            RustReleasesContext::default(),
        )
        .unwrap_err();

        assert!(matches!(err, CargoMSRVError::InvalidMsrvSet(_)));
    }

    #[test]
    fn set_release_without_index_check() {
        let tmp = assert_fs::TempDir::new().unwrap();
        tmp.child("Cargo.toml").touch().unwrap();

        let manifest = tmp.join("Cargo.toml");
        std::fs::write(&manifest, "[package]").unwrap();

        let root = Utf8Path::from_path(tmp.path()).unwrap();

        let fake_reporter = FakeTestReporter::default();
        let version = BareVersion::ThreeComponents(2, 0, 5);

        let env = EnvironmentContext {
            crate_path: root.to_path_buf(),
        };

        write_msrv(
            &fake_reporter,
            version,
            None,
            env,
            RustReleasesContext::default(),
        )
        .unwrap();

        let content = std::fs::read_to_string(&manifest).unwrap();
        assert_eq!(content, "[package]\nrust-version = \"2.0.5\"\n");
    }
}