cargo-msrv 0.18.1

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

use crate::reporter::event::Message;
use crate::{CargoMSRVError, Event};

/// Represents a serializable reason why the program should terminate with a failure (a non-zero
/// exit code).
#[derive(Clone, Debug, PartialEq, serde::Serialize)]
#[serde(rename_all = "snake_case")]
pub struct TerminateWithFailure {
    // Whether the reason should be highlighted or not.
    #[serde(skip)]
    highlight: bool,
    reason: SerializableReason,
}

impl TerminateWithFailure {
    pub fn new(error: CargoMSRVError) -> Self {
        let highlight = matches!(
            error,
            CargoMSRVError::UnableToFindAnyGoodVersion { .. } | CargoMSRVError::InvalidMsrvSet(_)
        );

        Self {
            highlight,
            reason: SerializableReason {
                description: format!("{}", &error),
            },
        }
    }

    pub fn should_highlight(&self) -> bool {
        self.highlight
    }

    pub fn as_message(&self) -> &str {
        &self.reason.description
    }
}

impl From<TerminateWithFailure> for Event {
    fn from(it: TerminateWithFailure) -> Self {
        Message::TerminateWithFailure(it).into()
    }
}

#[derive(Clone, Debug, PartialEq, serde::Serialize)]
#[serde(rename_all = "snake_case")]
struct SerializableReason {
    description: String,
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::reporter::event::Message;
    use crate::reporter::TestReporterWrapper;
    use storyteller::EventReporter;

    #[test]
    fn reported_non_is_not_error_event() {
        let reporter = TestReporterWrapper::default();

        let event = TerminateWithFailure::new(CargoMSRVError::Storyteller);

        reporter.get().report_event(event.clone()).unwrap();
        let events = reporter.wait_for_events();

        assert_eq!(
            &events,
            &[Event::unscoped(Message::TerminateWithFailure(event))]
        );

        if let Message::TerminateWithFailure(msg) = &events[0].message {
            assert!(!msg.should_highlight());
            assert_eq!(msg.as_message(), "Unable to print event output");
        }
    }

    #[test]
    fn reported_non_is_error_event() {
        let reporter = TestReporterWrapper::default();

        let event = TerminateWithFailure::new(CargoMSRVError::UnableToFindAnyGoodVersion {
            command: "cargo build --all".to_string(),
        });

        reporter.get().report_event(event.clone()).unwrap();
        let events = reporter.wait_for_events();

        assert_eq!(
            &events,
            &[Event::unscoped(Message::TerminateWithFailure(event))]
        );

        if let Message::TerminateWithFailure(msg) = &events[0].message {
            assert!(msg.should_highlight());
            assert!(msg
                .as_message()
                .starts_with("Unable to find a Minimum Supported Rust Version (MSRV)"));
        }
    }
}