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 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
// Copyright 2018 oooutlk@outlook.com. See the COPYRIGHT // file at the top-level directory of this distribution. // // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your // option. This file may not be copied, modified, or distributed // except according to those terms. //! # Problem To Solve //! //! Sometimes a crate needs to gather information from its downstream users. //! //! Frequently used mechanisms: //! //! - Cargo Features. //! //! The are friendly to cargo tools but not applicable for passing free contents //! because they are predefined options. //! //! - Environment Variables. //! //! They can pass free contents, but are not friendly to cargo tools. //! //! # Project Goal //! //! To provide a mechanism that is both friendly to cargo tools and able to pass //! free contents. //! //! # Library Overview //! //! This library helps to send metadata through the hierarchy of crates, from //! downstream crates to one of their common ancestor. //! //! The main API is `inwelling()`, which is expected to be called in `build.rs` of //! the common ancestor crate. //! //! ```text //! . +--------------> [topmost crate] //! . | 3 | ^ //! . | 4| |8 //! . | | | //! . | [dependencies] //! . |2 | | //! . | | | //! . | (metadata) |5 7| (API) //! . | | | //! . | 1 v 6 | //! . inwelling() <---- build.rs ----> bindings.rs //! .[inwelling crate] [common ancestor] //! ``` //! //! The information in section `[package.metadata.inwelling.{common ancestor}.*]` //! in downstream crates' Cargo.toml files will be collected by `inwelling()`. //! //! # Examples //! //! See this [demo](https://github.com/oooutlk/inwelling/tree/main/examples/) //! for more. //! //! The `echo` crate has build-dependency of inwelling crate: //! //! ```toml //! [build-dependencies] //! inwelling = { path = "../.." } //! ``` //! //! And provides `echo()` which simply returns what it recieves as strings. //! //! In `build.rs`: //! //! ```rust,no_run //! use std::{env, fs, path::PathBuf}; //! //! fn main() { //! let metadata_from_downstream = inwelling::inwelling() //! .sections //! .into_iter() //! .fold( String::new(), |acc, section| //! format!( "{}{:?} <{}>: {}\n" //! , acc //! , section.manifest //! , section.pkg //! , section.metadata.to_string() )); //! //! let out_path = PathBuf::from( env::var( "OUT_DIR" ) //! .expect( "$OUT_DIR should exist." ) //! ).join( "metadata_from_downstream" ); //! //! fs::write( //! out_path, //! metadata_from_downstream //! ).expect( "metadata_from_downstream generated." ); //! } //! ``` //! //! In `lib.rs`: //! //! ```rust,no_run //! pub fn echo() -> String { //! include_str!( concat!( env!( "OUT_DIR" ), "/metadata_from_downstream" )) //! .to_owned() //! } //! ``` //! //! The gamma crate depends on alpha crate and conditionally depends on beta crate. //! The beta crate depends on alpha crate. The alpha, beta and gamma ccrates all //! depend on echo crate. //! //! ```text //! . +---------------> [gamma crate] gamma=true //! . | . ^ ^ //! . | gamma=true . | | //! . | . | | //! . | [beta crate] | beta=true //! . | | | | //! . | beta=true | | | //! . | | | | //! . | [alpha crate] alpha=true //! . | | | | //! . | alpha=true | | | //! . | v | | //! . inwelling() <---- build.rs ----> `echo()`----+ //! .[inwelling crate] [echo crate] //! ``` //! //! In alpha crate's test code: //! //! ```rust,no_run //! pub fn test() { //! let metadata = echo::echo(); //! assert!( metadata.find("<alpha>: {\"alpha\":true}\n").is_some() ); //! } //! ``` //! //! # Optional Metadata //! //! Cargo features can control whether to send metadata or not. in section //! `[package.metadata.inwelling-{common ancestor}]`, a value of `feature = blah` //! means that the metadata will be collected by inwelling if and only if blah //! feature is enabled. See beta crate in examples for more. //! //! # Other information collected from downstream crates //! //! The following information are also collected: //! //! - Package names. //! //! - Cargo.toml files' paths. //! //! - Optional .rs file paths. Call `inwelling()` with the argument //! `inwelling::Opt::dump_rs_paths == true` to collect. //! //! # Caveat //! //! ## Reverse Dependency //! //! Collecting metadata from downstream and utilizing it in build process makes a //! crate depending on its downstream crates. Unfortunately this kind of //! reverse-dependency is not known to cargo. As a result, the changing of feature //! set will not cause recompilation of the crate collecting metadata, which it //! should. //! //! To address this issue, simply do `cargo clean`, or more precisely, //! `cargo clean --package {crate-collecting-metadata}` before running //! `cargo build`. Substitute `{crate-collecting-metadata}` with actual crate name, //! e.g. `cargo clean --package echo` in the examples above. //! //! ## Lacking Of `PWD` Environment Variable On Windows //! //! Without official support from cargo, this library requires environment variable //! such as `PWD` to locate topmost crate's Cargo.toml. Unfortunately `PWD` is //! missing on Windows platform. This library will panic if it is feeling no luck to //! locate Cargo.toml. However, `PWD` is not mandatory, unless `inwelling()` told //! you so. use cargo_metadata::{ CargoOpt, MetadataCommand, }; use pals::Pid; use std::{ collections::HashMap, env, path::{Path, PathBuf}, process, }; /// Information collected from downstream crates. #[derive( Debug )] pub struct Inwelling { pub sections : Vec<Section>, } impl Default for Inwelling { fn default() -> Self { Inwelling{ sections: Vec::new() } } } /// Information collected from one downstream crate. Including: /// /// - Package name. /// /// - Cargo.toml file' path. /// /// - metadata from `[package.metadata.inwelling.*]` section in Cargo.toml file. /// /// - Optional .rs file paths. #[derive( Debug )] pub struct Section { /// name of the package which collects metadata from its downstream crates. pub pkg : String, /// path of Cargo.toml. pub manifest : PathBuf, /// metadata represented in JSON. pub metadata : serde_json::value::Value, /// .rs files under src/, examples/ and tests/ directories if dump_rs_file is /// true, otherwise `None`. pub rs_paths : Option<Vec<PathBuf>>, } fn scan_rs_paths( current_dir: impl AsRef<Path>, rs_paths: &mut Vec<PathBuf> ) { if let Ok( entries ) = current_dir.as_ref().read_dir() { for entry in entries { if let Ok( entry ) = entry { let path = entry.path(); if path.is_dir() { scan_rs_paths( path, rs_paths ); } else if let Some( extention ) = path.extension() { if extention == "rs" { rs_paths.push( path ); } } } } } } /// Options passed to inwelling(). pub struct Opts { /// build.rs using inwelling() will re-run if downstream crates' Cargo.toml files have been changed. pub watch_manifest : bool, /// build.rs using inwelling() will re-run if downstream crates' .rs files have been changed. pub watch_rs_files : bool, /// if this flag is true, inwelling()'s returning value will contain .rs file paths. pub dump_rs_paths : bool, } impl Default for Opts { fn default() -> Opts { Opts { watch_manifest : true, watch_rs_files : false, dump_rs_paths : false, } } } /// Collects information from downstream crates. Including: /// /// - Package names. /// /// - Cargo.toml files' paths. /// /// - metadata from `[package.metadata.inwelling.*]` sections in Cargo.toml files. /// /// - Optional .rs file paths. pub fn inwelling( Opts{ watch_manifest, watch_rs_files, dump_rs_paths }: Opts ) -> Inwelling { let mut command = MetadataCommand::new(); let mut manifest_path = None; let mut target_dir_defined_in_cmdline = false; let pals = pals::pals(); if let Ok( pals ) = pals { if let Some( parent ) = pals.parent_of( Pid( process::id() )) { if let Some( parent ) = pals.parent_of( parent.ppid ) { let mut argv = parent.argv(); while let Some( arg ) = argv.next() { match arg { "--all-features" => { command.features( CargoOpt::AllFeatures ); }, "--features" => if let Some( features ) = argv.next() { command.features( CargoOpt::SomeFeatures( features .split_ascii_whitespace() .map( ToOwned::to_owned ) .collect() )); }, "--no-default-features" => { command.features( CargoOpt::NoDefaultFeatures ); }, "--manifest-path" if cfg!( unix ) => if let Some( path ) = argv.next() { manifest_path = Some( PathBuf::from( path )); } "--target-dir" => target_dir_defined_in_cmdline = true, _ => (), } } } } } let manifest_path = manifest_path.unwrap_or_else( || if let Ok( cwd ) = env::var("PWD") { return PathBuf::from( cwd ).join( "Cargo.toml" ); } else { if !target_dir_defined_in_cmdline { if let Ok( out_dir ) = env::var("OUT_DIR") { let out_dir = Path::new( &out_dir ); let ancestors = out_dir.ancestors(); if let Some( manifest_dir ) = ancestors.skip(5).next() { return manifest_dir.join( "Cargo.toml" ); } } } panic!("Failed to locate manifest path. Consider providing PWD environment variable.") } ); if !manifest_path.exists() { panic!( "{:?} should be manifest file", manifest_path ); } let metadata = command .manifest_path( &manifest_path ) .exec() .expect("cargo metadata command should be executed successfully."); let build_name = env::var("CARGO_PKG_NAME").expect("CARGO_PKG_NAME"); let enabled_features = metadata .resolve .expect("package dependencies resolved.") .nodes.iter().fold( HashMap::new(), |mut map, node| { map.insert( node.id.clone(), node.features.clone() ); map }); metadata.packages.into_iter().fold( Inwelling::default(), |mut inwelling, mut pkg| { let pkg_id = pkg.id.clone(); let mut rs_paths = Vec::new(); let enabled = pkg.metadata.get( &format!( "inwelling-{}", &build_name )) .and_then( |section| section.get( "feature" )) .map( |feature| { let feature = feature.as_str().expect("feature name should be str."); enabled_features[ &pkg_id ] .iter() .find( |&enabled_feature| enabled_feature == &feature ) .is_some() }) .unwrap_or( true ); if enabled { if watch_manifest { println!( "cargo:rerun-if-changed={}", pkg.manifest_path.to_str().unwrap() ); } if dump_rs_paths || watch_rs_files { let manifest_path = pkg.manifest_path.parent().unwrap(); scan_rs_paths( &manifest_path.join( "src" ), &mut rs_paths ); scan_rs_paths( &manifest_path.join( "examples" ), &mut rs_paths ); scan_rs_paths( &manifest_path.join( "tests" ), &mut rs_paths ); if watch_rs_files { rs_paths.iter().for_each( |rs_file| println!( "cargo:rerun-if-changed={}", rs_file.to_str().unwrap() )); } } if let Some( section ) = pkg.metadata.get_mut("inwelling") { if let Some( metadata ) = section.get_mut( &build_name ) { inwelling.sections.push( Section{ pkg : pkg.name, manifest : pkg.manifest_path, metadata : metadata.take(), rs_paths : if dump_rs_paths { Some( rs_paths )} else { None }, }); } } } inwelling }) }