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
// Copyright (c) 2018, [Ribose Inc](https://www.ribose.com). // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions // are met: // 1. Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // 2. Redistributions in binary form must reproduce the above copyright // notice, this list of conditions and the following disclaimer in the // documentation and/or other materials provided with the distribution. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. //! Use `nereon` for application configuration and option parsing. //! //! Configuration written in //! [NOC](https://github.com/riboseinc/nereon-syntax) syntax can be //! parsed into a [`Value`](enum.Value.html) using the //! [`parse_noc`](fn.parse_noc.html) function. //! //! ``` //! extern crate nereon; //! use nereon::{parse_noc, Value}; //! use std::collections::HashMap; //! //! let noc = r#" //! user admin { //! uid 1000 //! name "John Doe" //! }"#; //! //! let expected = Value::Table(HashMap::new()) //! .insert(vec!["user", "admin", "uid"], Value::from("1000")) //! .insert(vec!["user", "admin", "name"], Value::from("John Doe")); //! //! assert_eq!(parse_noc::<Value>(noc), Ok(expected)); //! ``` //! //! A Nereon [`Value`](enum.Value.html) can be converted back into a NOC string: //! //! ``` //! extern crate nereon; //! use nereon::{parse_noc, Value}; //! //! let noc = r#" //! user admin { //! uid 1000 + 10 //! name "John Doe" //! }"#; //! //! let expected = r#""user" {"admin" {"name" "John Doe","uid" "1010"}}"# //! .to_owned(); //! //! assert_eq!(parse_noc::<Value>(noc).map(|v| v.as_noc_string()), Ok(expected)); //! ``` //! //! By using the [`nereon-derive`](../nereon_derive/index.html) crate, a //! Nereon [`Value`](enum.Value.html) can be converted into another type //! using the [`FromValue`](trait.FromValue.html) trait. //! //! ``` //! #[macro_use] //! extern crate nereon_derive; //! extern crate nereon; //! use nereon::{parse_noc, FromValue, Value}; //! //! # fn main() { //! #[derive(FromValue, PartialEq, Debug)] //! struct User { //! uid: u32, //! name: String, //! } //! //! let noc = r#" //! uid 1000 + 10 //! name "John Doe" //! "#; //! //! let expected = User { uid: 1010, name: "John Doe".to_owned() }; //! let user = parse_noc::<User>(noc); //! assert_eq!(user, Ok(expected)); //! # } //! ``` //! //! Nereon can also be used to parse command lines. Command line //! options are described with a NOS configuration in NOC syntax. //! Arguments from the command line are inserted into the resulting //! [`Value`](enum.Value.html). NOS accepts environment variables as //! option defaults and can optionally load further defaults from a //! configuration file. //! //! ``` //! # extern crate nereon; //! use nereon::{configure, parse_noc, Value, FromValue}; //! use std::collections::HashMap; //! //! let nos = r#" //! name "Nereon test" //! authors ["John Doe <john@doe.me>"] //! license Free //! version "0.0.1" //! option config { //! env nereon_config //! usage "Config file" //! key [] //! } //! option user { //! short u //! key [user, admin, uid] //! usage "User's UID" //! hint USER //! } //! option permissions { //! env nereon_permissions //! key [user, admin, permissions] //! usage "Permissions for user" //! }"#; //! //! // create an example NOC config file and environment variables //! ::std::fs::write("/tmp/nereon_test", "user admin permissions read").unwrap(); //! ::std::env::set_var("nereon_config", "/tmp/nereon_test"); //! ::std::env::set_var("nereon_permissions", "read,write"); //! //! let expected = parse_noc::<Value>(r#" //! user admin uid 100 //! user admin permissions "read,write""# //! ).unwrap(); //! //! assert_eq!(configure::<Value, _, _>(&nos, &["program", "-u", "100"]), Ok(expected)); //! //! # ::std::fs::remove_file("/tmp/nereon_test").unwrap(); //! ``` extern crate clap; #[macro_use] extern crate pest_derive; extern crate pest; #[macro_use] extern crate lazy_static; #[macro_use] extern crate nereon_derive; use std::collections::HashMap; use std::env; use std::ffi::OsString; use std::fs::File; use std::io::Read; mod nos; use nos::{Nos, UserOption}; mod noc; pub use noc::{parse_noc, FromValue, Value}; /// Parse command-line options into a [`Value`](enum.Value.html). /// /// # Examples /// /// ``` /// # extern crate nereon; /// use std::collections::HashMap; /// use nereon::{Value, parse_noc, configure, FromValue}; /// let nos = r#" /// name "Nereon test" /// authors ["John Doe <john@doe.me>"] /// version "0.0.1" /// license Free /// option username { /// short u /// long user /// env NEREON_USER /// default admin /// hint USER /// usage "User name" /// key [username] /// }"#; /// let expected = Value::Table(HashMap::new()) /// .insert(vec!["username"], Value::from("root")); /// assert_eq!(configure::<Value, _, _>(nos, &["program", "-u", "root"]), Ok(expected)); /// ``` pub fn configure<T, U: IntoIterator<Item = I>, I: Into<OsString> + Clone>( nos: &str, args: U, ) -> Result<T, String> where T: FromValue, { let nos = parse_noc::<Nos>(nos)?; let options = nos.option.as_ref().unwrap(); // get command line options let mut clap_app = clap::App::new(nos.name.to_owned()) .version(nos.version.as_str()) .about(nos.license.as_str()); for a in nos.authors.iter() { clap_app = clap_app.author(a.as_str()); } for (n, o) in options.iter() { let mut arg = clap::Arg::with_name(n.as_str()).required(true); if let Some(ref s) = o.short { arg = arg.short(s); } if let Some(ref l) = o.long { arg = arg.long(l); } if let Some(ref d) = o.default { arg = arg.default_value(d); } if o.default_arg.is_none() { arg = arg.takes_value(true); } if let Some(ref e) = o.env { arg = arg.env(e); } if let Some(ref h) = o.hint { arg = arg.value_name(h); } clap_app = clap_app.arg(arg); } let matches = clap_app .get_matches_from_safe(args) .map_err(|e| format!("{}", e))?; fn key_to_strs(option: &UserOption) -> Vec<&str> { option.key.iter().map(|k| k.as_str()).collect() } // read the config file if there is one let mut config = Value::Table(HashMap::new()); if let Some(n) = matches.value_of_os("config") { let mut buffer = String::new(); config = File::open(&n) .and_then(|ref mut f| f.read_to_string(&mut buffer)) .map_err(|e| format!("{:?}", e)) .and_then(|_| parse_noc::<Value>(&buffer)) .and_then(|v| { Ok({ let keys = key_to_strs(&options.get("config").unwrap()); config.insert(keys, v) }) })? }; // build the config tree config = options.iter().fold(config, |mut config, (name, option)| { if name != "config" { let value = if matches.occurrences_of(name) == 0 { option .env .as_ref() .and_then(env::var_os) .map(Value::from) .or_else(|| { config .lookup(key_to_strs(&option)) .map_or_else(|| option.default.clone().map(Value::from), |_| None) }) } else { matches .value_of_os(name) .map(Value::from) .or_else(|| option.default_arg.clone().map(Value::from)) }; if let Some(v) = value { let keys = key_to_strs(option); config = config.insert(keys, v); } } config }); T::from_value(config) } #[cfg(test)] mod tests { #[test] fn test_configure() { use super::{configure, Value}; use std::collections::HashMap; let nos = r#" name "Nereon test" authors ["John Doe <john@doe.me>"] version "0.0.1" license Free option username { short u long user env NEREON_USER default admin hint USER usage "User name" key [username] }"#; let expected = Value::Table(HashMap::new()).insert(vec!["username"], Value::from("root")); assert_eq!( configure::<Value, _, _>(nos, &["program", "-u", "root"]), Ok(expected) ); } #[test] fn test_configure1() { use super::{configure, parse_noc, Value}; use std::collections::HashMap; let noc = r#"user admin {uid 1000}"#; let expected = Value::Table(HashMap::new()).insert(vec!["user", "admin", "uid"], Value::from("1000")); assert_eq!(parse_noc::<Value>(noc), Ok(expected)); let nos = r#" name "Nereon test" authors ["John Doe <john@doe.me>"] license Free version "0.0.1" option config { env nereon_config usage "Config file" key [] } option user { short u key [user, admin, uid] usage "User's UID" hint USER } option permissions { env nereon_permissions key [user, admin, permissions] usage "Permissions for user" }"#; // create an example NOC config file ::std::fs::write("/tmp/nereon_test", "user admin permissions read").unwrap(); ::std::env::set_var("nereon_config", "/tmp/nereon_test"); ::std::env::set_var("nereon_permissions", "read,write"); let expected = parse_noc::<Value>( r#" user admin uid 100 user admin permissions "read,write""#, ).unwrap(); assert_eq!( configure::<Value, _, _>(nos, &["program", "-u", "100"]), Ok(expected) ); ::std::fs::remove_file("/tmp/nereon_test").unwrap(); } }