socketry-cargo-bake 0.18.0

Cargo launcher for project-local Bake tasks
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

// Released under the MIT License.
// Copyright, 2026, by Samuel Williams.

use crate::Result;
use std::ffi::OsString;
use std::path::PathBuf;
use std::process::Command;

#[derive(Default)]
pub(crate) struct Options {
    pub(crate) manifest: Option<PathBuf>,
    pub(crate) offline: bool,
    pub(crate) locked: bool,
    pub(crate) release: bool,
    pub(crate) regenerate: bool,
    pub(crate) help: bool,
    pub(crate) version: bool,
    pub(crate) arguments: Vec<OsString>,
}

impl Options {
    pub(crate) fn parse(arguments: impl IntoIterator<Item = OsString>) -> Result<Self> {
        Self::parse_arguments(arguments.into_iter().collect())
    }

    fn parse_arguments(arguments: Vec<OsString>) -> Result<Self> {
        let mut arguments = arguments.into_iter().peekable();
        // Cargo external subcommands receive their command name as argument one.
        if arguments.peek().is_some_and(|argument| argument == "bake") {
            arguments.next();
        }
        let mut options = Self::default();
        while let Some(argument) = arguments.next() {
            match argument.to_str() {
                Some("--manifest-path") => {
                    options.manifest = Some(
                        arguments
                            .next()
                            .ok_or("--manifest-path requires a path")?
                            .into(),
                    );
                }
                Some("--offline") => options.offline = true,
                Some("--locked") => options.locked = true,
                Some("--release") => options.release = true,
                Some("--regenerate") => options.regenerate = true,
                Some("--help" | "-h") => options.help = true,
                Some("--version" | "-V") => options.version = true,
                Some("--") => {
                    options.arguments.extend(arguments);
                    break;
                }
                _ => {
                    options.arguments.push(argument);
                    options.arguments.extend(arguments);
                    break;
                }
            }
        }
        Ok(options)
    }

    pub(crate) fn configure(&self, command: &mut Command) {
        if self.offline {
            command.arg("--offline");
        }
        if self.locked {
            command.arg("--locked");
        }
    }
}

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

    #[test]
    fn forwards_tokens_after_a_separator_unchanged() {
        let options = Options::parse(
            ["bake", "--locked", "--", "--not-a-launcher-option", "value"].map(OsString::from),
        )
        .unwrap();

        assert!(options.locked);
        assert_eq!(options.arguments, ["--not-a-launcher-option", "value"]);
    }

    #[test]
    fn parses_launcher_options_and_rejects_missing_values() {
        let options = Options::parse(
            [
                "--manifest-path",
                "project/Cargo.toml",
                "--offline",
                "--locked",
                "--release",
                "--regenerate",
                "--version",
            ]
            .map(OsString::from),
        )
        .unwrap();

        assert_eq!(options.manifest, Some(PathBuf::from("project/Cargo.toml")));
        assert!(options.offline);
        assert!(options.locked);
        assert!(options.release);
        assert!(options.regenerate);
        assert!(options.version);
        assert!(Options::parse([OsString::from("--manifest-path")]).is_err());

        assert!(Options::parse([OsString::from("-h")]).unwrap().help);
        assert!(Options::parse([OsString::from("-V")]).unwrap().version);
    }

    #[cfg(unix)]
    #[test]
    fn forwards_non_utf8_task_arguments() {
        use std::os::unix::ffi::OsStringExt;

        let argument = OsString::from_vec(vec![0xff]);
        let options = Options::parse([argument.clone()]).unwrap();

        assert_eq!(options.arguments, [argument]);
    }

    #[test]
    fn forwards_offline_and_locked_options_to_cargo() {
        let options = Options {
            offline: true,
            locked: true,
            ..Options::default()
        };
        let mut command = Command::new("cargo");

        options.configure(&mut command);

        assert_eq!(
            command.get_args().collect::<Vec<_>>(),
            ["--offline", "--locked"]
        );
    }
}