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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
use std::ffi; use std::process; use crate::cargo::Cargo; use crate::cargo::CURRENT_TARGET; use crate::error::*; use crate::msg::*; use crate::run::CargoRun; #[cfg(feature = "test_unstable")] use crate::test::CargoTest; /// The `build` subcommand. /// /// # Example /// /// ```rust /// extern crate escargot; /// extern crate assert_fs; /// /// let temp = assert_fs::TempDir::new().unwrap(); /// escargot::CargoBuild::new() /// .bin("bin") /// .current_release() /// .current_target() /// .manifest_path("tests/fixtures/bin/Cargo.toml") /// .target_dir(temp.path()) /// .exec() /// .unwrap(); /// ``` pub struct CargoBuild { cmd: process::Command, bin: bool, example: bool, } impl CargoBuild { /// Shortcut to create a `build` subcommand. /// /// See also [`Cargo`]. /// /// # Example /// /// ```rust /// extern crate escargot; /// extern crate assert_fs; /// /// let temp = assert_fs::TempDir::new().unwrap(); /// escargot::CargoBuild::new() /// .bin("bin") /// .manifest_path("tests/fixtures/bin/Cargo.toml") /// .target_dir(temp.path()) /// .exec() /// .unwrap(); /// ``` /// pub fn new() -> Self { Cargo::new().build() } pub(crate) fn with_command(cmd: process::Command) -> Self { Self { cmd, bin: false, example: false, } } /// Build from `name` package in workspaces. /// /// # Example /// /// ```rust /// extern crate escargot; /// extern crate assert_fs; /// /// let temp = assert_fs::TempDir::new().unwrap(); /// escargot::CargoBuild::new() /// .package("bin") /// .bin("bin") /// .manifest_path("tests/fixtures/bin/Cargo.toml") /// .target_dir(temp.path()) /// .exec() /// .unwrap(); /// ``` pub fn package<S: AsRef<ffi::OsStr>>(self, name: S) -> Self { self.arg("--package").arg(name) } /// Build only `name` binary. /// /// # Example /// /// ```rust /// extern crate escargot; /// extern crate assert_fs; /// /// let temp = assert_fs::TempDir::new().unwrap(); /// escargot::CargoBuild::new() /// .bin("bin") /// .manifest_path("tests/fixtures/bin/Cargo.toml") /// .target_dir(temp.path()) /// .exec() /// .unwrap(); /// ``` pub fn bin<S: AsRef<ffi::OsStr>>(mut self, name: S) -> Self { self.bin = true; self.arg("--bin").arg(name) } /// Build only `name` example. /// /// # Example /// /// ```rust /// extern crate escargot; /// extern crate assert_fs; /// /// let temp = assert_fs::TempDir::new().unwrap(); /// escargot::CargoBuild::new() /// .example("example_fixture") /// .manifest_path("tests/fixtures/example/Cargo.toml") /// .target_dir(temp.path()) /// .exec() /// .unwrap(); /// ``` pub fn example<S: AsRef<ffi::OsStr>>(mut self, name: S) -> Self { self.example = true; self.arg("--example").arg(name) } /// Build all tests /// /// # Example /// /// ```rust /// extern crate escargot; /// extern crate assert_fs; /// /// let temp = assert_fs::TempDir::new().unwrap(); /// escargot::CargoBuild::new() /// .tests() /// .manifest_path("tests/fixtures/test/Cargo.toml") /// .target_dir(temp.path()) /// .exec() /// .unwrap(); /// ``` pub fn tests(self) -> Self { self.arg("--tests") } /// Build only `name` test. /// /// # Example /// /// ```rust /// extern crate escargot; /// extern crate assert_fs; /// /// let temp = assert_fs::TempDir::new().unwrap(); /// escargot::CargoBuild::new() /// .test("test") /// .manifest_path("tests/fixtures/test/Cargo.toml") /// .target_dir(temp.path()) /// .exec() /// .unwrap(); /// ``` pub fn test<S: AsRef<ffi::OsStr>>(self, name: S) -> Self { self.arg("--test").arg(name) } /// Path to Cargo.toml pub fn manifest_path<S: AsRef<ffi::OsStr>>(self, path: S) -> Self { self.arg("--manifest-path").arg(path) } /// Build artifacts in release mode, with optimizations. pub fn release(self) -> Self { self.arg("--release") } /// Build artifacts in release mode if the current process has, with optimizations. #[cfg(debug_assertions)] pub fn current_release(self) -> Self { self } /// Build artifacts in release mode if the current process has, with optimizations. #[cfg(not(debug_assertions))] pub fn current_release(self) -> Self { self.release() } /// Build for the target triplet. pub fn target<S: AsRef<ffi::OsStr>>(self, triplet: S) -> Self { self.arg("--target").arg(triplet) } /// Build for the current process' triplet. pub fn current_target(self) -> Self { self.target(CURRENT_TARGET) } /// Directory for all generated artifacts pub fn target_dir<S: AsRef<ffi::OsStr>>(self, dir: S) -> Self { self.arg("--target-dir").arg(dir) } /// Activate all available features pub fn all_features(self) -> Self { self.arg("--all-features") } /// Do not activate the `default` feature pub fn no_default_features(self) -> Self { self.arg("--no-default-features") } /// Space-separated list of features to activate pub fn features<S: AsRef<ffi::OsStr>>(self, features: S) -> Self { self.arg("--features").arg(features) } /// Manually pass an argument that is unsupported. /// /// Caution: Passing in `--` can throw off the API. pub fn arg<S: AsRef<ffi::OsStr>>(mut self, arg: S) -> Self { self.cmd.arg(arg); self } /// Build the configured target, returning compiler messages. pub fn exec(self) -> CargoResult<CommandMessages> { CommandMessages::with_command(self.cmd) } /// Provide a proxy for running the built target. /// /// # Example /// /// ```rust /// extern crate escargot; /// extern crate assert_fs; /// /// let temp = assert_fs::TempDir::new().unwrap(); /// let run = escargot::CargoBuild::new() /// .bin("bin") /// .current_release() /// .current_target() /// .manifest_path("tests/fixtures/bin/Cargo.toml") /// .target_dir(temp.path()) /// .run() /// .unwrap(); /// println!("artifact={}", run.path().display()); /// ``` pub fn run(self) -> CargoResult<CargoRun> { let msgs = CommandMessages::with_command(self.cmd)?; CargoRun::from_message(msgs, self.bin, self.example) } /// Provide a proxy for running the built target. /// /// Required feature: `test_unstable` since the format parsed is unstable. /// /// # Example /// /// ```rust /// extern crate escargot; /// extern crate assert_fs; /// /// let temp = assert_fs::TempDir::new().unwrap(); /// let run = escargot::CargoBuild::new() /// .test("test") /// .current_release() /// .current_target() /// .manifest_path("tests/fixtures/test/Cargo.toml") /// .target_dir(temp.path()) /// .run_tests().unwrap() /// .next().unwrap().unwrap(); /// println!("artifact={}", run.path().display()); /// ``` #[cfg(feature = "test_unstable")] pub fn run_tests(self) -> CargoResult<impl Iterator<Item = Result<CargoTest, CargoError>>> { let msgs = CommandMessages::with_command(self.cmd)?; Ok(CargoTest::with_messages(msgs)) } } impl Default for CargoBuild { fn default() -> Self { Self::new() } }