Merge pull request #39 from tox-rs/pretty_fixes

Pretty fixes

Author: kpp

Cargo.lock

@@ -29,7 +29,6 @@ tokio-codec = "0.1"
 config = "0.9.1"
 serde = "1.0"
 serde_derive = "1.0"
-serde_ignored = "0.0.4"
 serde_yaml = "0.8.8"
 tox = { git = "https://github.com/tox-rs/tox/" }
 

Cargo.toml

@@ -4,7 +4,7 @@ A server application to run tox bootstrap node.
 
 ## Building and running
 
-You'll need [Rust] >= 1.26.0 and [libsodium].
+You'll need [Rust] >= 1.31.0.
 
 Build with:
 
@@ -78,7 +78,7 @@ In order to run with config, run with `--config <file>`.
 Example config.yml is below.
 ```yaml
 log-type: Stderr
-keys-file: keys
+keys-file: ./keys
 udp-address: 0.0.0.0:33445
 tcp-addresses:
   - 0.0.0.0:33445
@@ -88,12 +88,13 @@ bootstrap-nodes:
     addr: 198.98.51.198:33445
   - pk: DA4E4ED4B697F2E9B000EEFE3A34B554ACD3F45F5C96EAEA2516DD7FF9AF7B43
     addr: 185.25.116.107:33445
-no-lan: True
+threads: auto # or any u16 > 0
+lan-discovery: True
 ```
 Or you can use it with CLI like this
 ```sh
 tox-node --keys-file keys \
-    --bootstrap-node 1D5A5F2F5D6233058BF0259B09622FB40B482E4FA0931EB8FD3AB8E7BF7DAF6F 198.98.51.198:33445 \ 
+    --bootstrap-node 1D5A5F2F5D6233058BF0259B09622FB40B482E4FA0931EB8FD3AB8E7BF7DAF6F 198.98.51.198:33445 \
     --udp-address '0.0.0.0:33445' --tcp-address '0.0.0.0:33445' \
     --motd "{{start_date}} {{uptime}} Tcp: incoming {{tcp_packets_in}}, outgoing {{tcp_packets_out}}, Udp: incoming {{udp_packets_in}}, outgoing {{udp_packets_out}}"
 ```

README.md

@@ -17,7 +17,6 @@ extern crate config;
 #[macro_use]
 extern crate serde_derive;
 extern crate serde;
-extern crate serde_ignored;
 extern crate serde_yaml;
 extern crate tox;
 
@@ -305,8 +304,8 @@ fn main() {
         LogType::None => { },
     }
 
-    for arg_unused in config.unused.clone() {
-        warn!("Unused configuration key: {:?}", arg_unused);
+    for (key, _) in &config.unused {
+        warn!("Unused configuration key: {:?}", key);
     }
 
     let (dht_pk, dht_sk) = if let Some(ref sk) = config.sk {

src/main.rs

@@ -2,10 +2,11 @@ use std::net::{SocketAddr, ToSocketAddrs};
 use std::num::ParseIntError;
 use std::str::FromStr;
 use std::path::Path;
-use std::collections::BTreeSet as Set;
+use std::collections::HashMap;
 
 use config::{Config, File as CfgFile};
 use serde::de::{self, Deserialize, Deserializer};
+use serde_yaml::Value;
 use clap::{App, AppSettings, Arg, SubCommand, ArgMatches};
 use hex::FromHex;
 use itertools::Itertools;
@@ -89,15 +90,15 @@ fn de_log_type<'de, D>(deserializer: D) -> Result<LogType, D::Error> where D: De
         #[cfg(unix)]
         "Syslog" => Ok(LogType::Syslog),
         "None" => Ok(LogType::None),
-        e => Err(de::Error::custom(format!("Invalid LogType {}", e))),
+        other => Err(de::Error::custom(format!("log-type: invalid value '{}'", other))),
     }
 }
 
-fn de_thread<'de, D>(deserializer: D) -> Result<Threads, D::Error> where D: Deserializer<'de> {
+fn de_threads<'de, D>(deserializer: D) -> Result<Threads, D::Error> where D: Deserializer<'de> {
     let s = String::deserialize(deserializer)?;
 
     Threads::from_str(&s)
-        .map_err(|e| de::Error::custom(format!("Can't parse Threads {:?}", e)))
+        .map_err(|e| de::Error::custom(format!("threads: {:?}", e)))
 }
 
 impl BootstrapNode {
@@ -135,17 +136,15 @@ pub struct NodeConfig {
     #[serde(skip_deserializing)]
     pub sk_passed_as_arg: bool,
     /// Path to the file where DHT keys are stored.
-    /// When run with config, this field is required.
+    /// Required with config.
     #[serde(rename = "keys-file")]
-    pub keys_file_config: String,
-    #[serde(skip_deserializing)]
     pub keys_file: Option<String>,
     /// List of bootstrap nodes.
     #[serde(rename = "bootstrap-nodes")]
     #[serde(default)]
     pub bootstrap_nodes: Vec<BootstrapNode>,
     /// Number of threads for execution.
-    #[serde(deserialize_with = "de_thread")]
+    #[serde(deserialize_with = "de_threads")]
     pub threads: Threads,
     /// Specifies where to write logs.
     #[serde(deserialize_with = "de_log_type")]
@@ -154,11 +153,11 @@ pub struct NodeConfig {
     /// Message of the day
     pub motd: String,
     /// Whether LAN discovery is enabled
-    #[serde(rename = "no-lan")]
+    #[serde(rename = "lan-discovery")]
     pub lan_discovery_enabled: bool,
     /// Unused fields while parsing config file
-    #[serde(skip_deserializing)]
-    pub unused: Set<String>,
+    #[serde(flatten)]
+    pub unused: HashMap<String, Value>,
 }
 
 /// Parse command line arguments.
@@ -248,9 +247,9 @@ pub fn cli_parse() -> NodeConfig {
                 }
             })
             .default_value("This is tox-rs"))
-        .arg(Arg::with_name("no-lan")
-            .long("no-lan")
-            .help("Disable LAN discovery"))
+        .arg(Arg::with_name("lan-discovery")
+            .long("lan-discovery")
+            .help("Enable LAN discovery (disabled by default)"))
         .get_matches();
 
     match matches.subcommand() {
@@ -265,7 +264,7 @@ fn parse_config(config_path: String) -> NodeConfig {
 
     settings.set_default("log-type", "Stderr").expect("Can't set default value for `log-type`");
     settings.set_default("motd", "This is tox-rs").expect("Can't set default value for `motd`");
-    settings.set_default("no-lan", "False").expect("Can't set default value for `no-lan`");
+    settings.set_default("lan-discovery", "False").expect("Can't set default value for `lan-discovery`");
     settings.set_default("threads", "1").expect("Can't set default value for `threads`");
 
     let config_file = if !Path::new(&config_path).exists() {
@@ -274,18 +273,13 @@ fn parse_config(config_path: String) -> NodeConfig {
         CfgFile::with_name(&config_path)
     };
 
-    settings.merge(config_file).expect("Merging config file with default value fails");
+    settings.merge(config_file).expect("Merging config file with default values failed");
 
-    // Collect unrecognized fields to warn about them
-    let mut unused = Set::new();
-    let mut config: NodeConfig = serde_ignored::deserialize(settings, |path| {
-        unused.insert(path.to_string());
-    }).expect("Can't deserialize config");
+    let config: NodeConfig = settings.try_into().expect("Can't deserialize config");
 
-    config.unused = unused;
-    config.sk_passed_as_arg = false;
-    config.lan_discovery_enabled = !config.lan_discovery_enabled;
-    config.keys_file = Some(config.keys_file_config.clone());
+    if config.keys_file.is_none() {
+        panic!("Can't deserialize config: 'keys-file' is not set");
+    }
 
     config
 }
@@ -342,22 +336,19 @@ fn run_args(matches: &ArgMatches) -> NodeConfig {
 
     let motd = value_t!(matches.value_of("motd"), String).unwrap_or_else(|e| e.exit());
 
-    let lan_discovery_enabled = !matches.is_present("no-lan");
-
-    let keys_file_config = String::new();
+    let lan_discovery_enabled = matches.is_present("lan-discovery");
 
     NodeConfig {
         udp_addr,
         tcp_addrs,
         sk,
         sk_passed_as_arg,
         keys_file,
-        keys_file_config,
         bootstrap_nodes,
         threads,
         log_type,
         motd,
         lan_discovery_enabled,
-        unused: Set::new(),
+        unused: HashMap::new(),
     }
 }