From 34d016fd3fd48eb9507183d17e07bd921f96addf Mon Sep 17 00:00:00 2001 From: Chewing_Bever Date: Fri, 11 Aug 2023 21:26:17 +0200 Subject: [PATCH] feat: allow passing global configuration as TOML file --- Cargo.lock | 164 +++++++++++++++++++++++++++++++++++ Cargo.toml | 1 + alex-example.toml | 16 ++++ src/backup/manager/config.rs | 4 +- src/cli/backup.rs | 13 ++- src/cli/config.rs | 49 +++++++++++ src/cli/mod.rs | 115 ++++++++++++------------ src/cli/run.rs | 16 ++-- src/error.rs | 32 +++++++ src/main.rs | 11 ++- 10 files changed, 347 insertions(+), 74 deletions(-) create mode 100644 alex-example.toml create mode 100644 src/cli/config.rs create mode 100644 src/error.rs diff --git a/Cargo.lock b/Cargo.lock index 16ec2ca..1854dec 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -14,6 +14,7 @@ version = "0.3.1" dependencies = [ "chrono", "clap", + "figment", "flate2", "serde", "serde_json", @@ -85,6 +86,12 @@ dependencies = [ "windows-sys", ] +[[package]] +name = "atomic" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c59bdb34bc650a32731b31bd8f0829cc15d24a708ee31559e0bb34f2bc320cba" + [[package]] name = "autocfg" version = "1.1.0" @@ -194,6 +201,12 @@ dependencies = [ "cfg-if", ] +[[package]] +name = "equivalent" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5443807d6dff69373d433ab9ef5378ad8df50ca6298caf15de6e52e24aaf54d5" + [[package]] name = "errno" version = "0.3.1" @@ -215,6 +228,20 @@ dependencies = [ "libc", ] +[[package]] +name = "figment" +version = "0.10.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4547e226f4c9ab860571e070a9034192b3175580ecea38da34fcdb53a018c9a5" +dependencies = [ + "atomic", + "pear", + "serde", + "toml", + "uncased", + "version_check", +] + [[package]] name = "filetime" version = "0.2.21" @@ -237,6 +264,12 @@ dependencies = [ "miniz_oxide", ] +[[package]] +name = "hashbrown" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2c6201b9ff9fd90a5a3bac2e56a830d0caa509576f0e503818ee82c181b3437a" + [[package]] name = "heck" version = "0.4.1" @@ -272,6 +305,22 @@ dependencies = [ "cc", ] +[[package]] +name = "indexmap" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d5477fe2230a79769d8dc68e0eabf5437907c0457a5614a9e8dddb67f65eb65d" +dependencies = [ + "equivalent", + "hashbrown", +] + +[[package]] +name = "inlinable_string" +version = "0.1.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c8fae54786f62fb2918dcfae3d568594e50eb9b5c25bf04371af6fe7516452fb" + [[package]] name = "io-lifetimes" version = "1.0.11" @@ -328,6 +377,12 @@ version = "0.4.18" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "518ef76f2f87365916b142844c16d8fefd85039bc5699050210a7778ee1cd1de" +[[package]] +name = "memchr" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d" + [[package]] name = "miniz_oxide" version = "0.7.1" @@ -352,6 +407,29 @@ version = "1.17.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9670a07f94779e00908f3e686eab508878ebb390ba6e604d3a284c00e8d0487b" +[[package]] +name = "pear" +version = "0.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "61a386cd715229d399604b50d1361683fe687066f42d56f54be995bc6868f71c" +dependencies = [ + "inlinable_string", + "pear_codegen", + "yansi", +] + +[[package]] +name = "pear_codegen" +version = "0.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da9f0f13dac8069c139e8300a6510e3f4143ecf5259c60b116a9b271b4ca0d54" +dependencies = [ + "proc-macro2", + "proc-macro2-diagnostics", + "quote", + "syn", +] + [[package]] name = "proc-macro2" version = "1.0.59" @@ -361,6 +439,19 @@ dependencies = [ "unicode-ident", ] +[[package]] +name = "proc-macro2-diagnostics" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af066a9c399a26e020ada66a034357a868728e72cd426f3adcd35f80d88d88c8" +dependencies = [ + "proc-macro2", + "quote", + "syn", + "version_check", + "yansi", +] + [[package]] name = "quote" version = "1.0.28" @@ -430,6 +521,15 @@ dependencies = [ "serde", ] +[[package]] +name = "serde_spanned" +version = "0.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96426c9936fd7a0124915f9185ea1d20aa9445cc9821142f0a73bc9207a2e186" +dependencies = [ + "serde", +] + [[package]] name = "signal-hook" version = "0.3.15" @@ -488,6 +588,49 @@ dependencies = [ "winapi", ] +[[package]] +name = "toml" +version = "0.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c17e963a819c331dcacd7ab957d80bc2b9a9c1e71c804826d2f283dd65306542" +dependencies = [ + "serde", + "serde_spanned", + "toml_datetime", + "toml_edit", +] + +[[package]] +name = "toml_datetime" +version = "0.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7cda73e2f1397b1262d6dfdcef8aafae14d1de7748d66822d3bfeeb6d03e5e4b" +dependencies = [ + "serde", +] + +[[package]] +name = "toml_edit" +version = "0.19.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8123f27e969974a3dfba720fdb560be359f57b44302d280ba72e76a74480e8a" +dependencies = [ + "indexmap", + "serde", + "serde_spanned", + "toml_datetime", + "winnow", +] + +[[package]] +name = "uncased" +version = "0.9.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b9bc53168a4be7402ab86c3aad243a84dd7381d09be0eddc81280c1da95ca68" +dependencies = [ + "version_check", +] + [[package]] name = "unicode-ident" version = "1.0.9" @@ -500,6 +643,12 @@ version = "0.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a" +[[package]] +name = "version_check" +version = "0.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" + [[package]] name = "wasi" version = "0.10.0+wasi-snapshot-preview1" @@ -657,6 +806,15 @@ version = "0.48.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1a515f5799fe4961cb532f983ce2b23082366b898e52ffbce459c86f67c8378a" +[[package]] +name = "winnow" +version = "0.5.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "19f495880723d0999eb3500a9064d8dbcf836460b24c17df80ea7b5794053aac" +dependencies = [ + "memchr", +] + [[package]] name = "xattr" version = "0.2.3" @@ -665,3 +823,9 @@ checksum = "6d1526bbe5aaeb5eb06885f4d987bcdfa5e23187055de9b83fe00156a821fabc" dependencies = [ "libc", ] + +[[package]] +name = "yansi" +version = "1.0.0-rc" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9ee746ad3851dd3bc40e4a028ab3b00b99278d929e48957bcb2d111874a7e43e" diff --git a/Cargo.toml b/Cargo.toml index 01d0593..777407a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -17,6 +17,7 @@ clap = { version = "4.3.1", features = ["derive", "env"] } signal-hook = "0.3.15" serde = { version = "1.0.164", features = ["derive", "rc"] } serde_json = "1.0.96" +figment = { version = "0.10.10", features = ["env", "toml"] } [profile.release] lto = "fat" diff --git a/alex-example.toml b/alex-example.toml new file mode 100644 index 0000000..d4b4122 --- /dev/null +++ b/alex-example.toml @@ -0,0 +1,16 @@ +config = "data/config" +world = "data/worlds" +backup = "data/backups" +server = "Paper" + +[[layers]] +name = "2min" +frequency = 2 +chains = 4 +chain_len = 4 + +[[layers]] +name = "3min" +frequency = 3 +chains = 2 +chain_len = 2 diff --git a/src/backup/manager/config.rs b/src/backup/manager/config.rs index 8adbd5a..75af34e 100644 --- a/src/backup/manager/config.rs +++ b/src/backup/manager/config.rs @@ -2,7 +2,9 @@ use std::error::Error; use std::fmt; use std::str::FromStr; -#[derive(Clone, Debug)] +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Debug, Serialize, Deserialize)] pub struct ManagerConfig { pub name: String, pub frequency: u32, diff --git a/src/cli/backup.rs b/src/cli/backup.rs index 6810e42..85c0cee 100644 --- a/src/cli/backup.rs +++ b/src/cli/backup.rs @@ -1,5 +1,4 @@ use crate::backup::Backup; -use crate::cli::Cli; use crate::other; use chrono::{TimeZone, Utc}; use clap::{Args, Subcommand}; @@ -103,7 +102,7 @@ pub struct BackupExtractArgs { } impl BackupArgs { - pub fn run(&self, cli: &Cli) -> io::Result<()> { + pub fn run(&self, cli: &super::Config) -> io::Result<()> { match &self.command { BackupCommands::Create(args) => args.run(cli), BackupCommands::List(args) => args.run(cli), @@ -115,7 +114,7 @@ impl BackupArgs { } impl BackupCreateArgs { - pub fn run(&self, cli: &Cli) -> io::Result<()> { + pub fn run(&self, cli: &super::Config) -> io::Result<()> { let mut meta = cli.meta()?; if let Some(res) = meta.create_backup(&self.layer) { @@ -127,7 +126,7 @@ impl BackupCreateArgs { } impl BackupListArgs { - pub fn run(&self, cli: &Cli) -> io::Result<()> { + pub fn run(&self, cli: &super::Config) -> io::Result<()> { let meta = cli.meta()?; // A bit scuffed? Sure @@ -184,7 +183,7 @@ fn parse_backup_path( } impl BackupRestoreArgs { - pub fn run(&self, cli: &Cli) -> io::Result<()> { + pub fn run(&self, cli: &super::Config) -> io::Result<()> { let backup_dir = cli.backup.canonicalize()?; // Create directories if needed @@ -237,7 +236,7 @@ impl BackupRestoreArgs { } impl BackupExportArgs { - pub fn run(&self, cli: &Cli) -> io::Result<()> { + pub fn run(&self, cli: &super::Config) -> io::Result<()> { let backup_dir = cli.backup.canonicalize()?; if self.make { @@ -261,7 +260,7 @@ impl BackupExportArgs { } impl BackupExtractArgs { - pub fn run(&self, _cli: &Cli) -> io::Result<()> { + pub fn run(&self, _cli: &super::Config) -> io::Result<()> { // Create directories if needed if self.make { std::fs::create_dir_all(&self.output_config)?; diff --git a/src/cli/config.rs b/src/cli/config.rs new file mode 100644 index 0000000..da80269 --- /dev/null +++ b/src/cli/config.rs @@ -0,0 +1,49 @@ +use std::{io, path::PathBuf}; + +use serde::{Deserialize, Serialize}; + +use crate::{ + backup::{ManagerConfig, MetaManager}, + server::{Metadata, ServerType}, +}; + +#[derive(Serialize, Deserialize, Debug)] +pub struct Config { + pub config: PathBuf, + pub world: PathBuf, + pub backup: PathBuf, + pub layers: Vec, + pub server: ServerType, + pub server_version: String, +} + +impl Default for Config { + fn default() -> Self { + Self { + config: PathBuf::from("."), + world: PathBuf::from("../worlds"), + backup: PathBuf::from("../backups"), + layers: Vec::new(), + server: ServerType::Unknown, + server_version: String::from(""), + } + } +} + +impl Config { + /// Convenience method to initialize backup manager from the cli arguments + pub fn meta(&self) -> io::Result> { + let metadata = Metadata { + server_type: self.server, + server_version: self.server_version.clone(), + }; + let dirs = vec![ + (PathBuf::from("config"), self.config.canonicalize()?), + (PathBuf::from("worlds"), self.world.canonicalize()?), + ]; + let mut meta = MetaManager::new(self.backup.canonicalize()?, dirs, metadata); + meta.add_all(&self.layers)?; + + Ok(meta) + } +} diff --git a/src/cli/mod.rs b/src/cli/mod.rs index 0594e8e..6ba3f94 100644 --- a/src/cli/mod.rs +++ b/src/cli/mod.rs @@ -1,4 +1,5 @@ mod backup; +mod config; mod run; pub use crate::backup::MetaManager; @@ -8,7 +9,13 @@ pub use run::RunArgs; use crate::backup::ManagerConfig; use crate::server::ServerType; -use clap::{Parser, Subcommand}; +use clap::{Args, Parser, Subcommand}; +pub use config::Config; +use figment::{ + providers::{Env, Format, Serialized, Toml}, + Figment, +}; +use serde::{Deserialize, Serialize}; use std::io; use std::path::PathBuf; @@ -20,73 +27,71 @@ pub enum Commands { Backup(BackupArgs), } -#[derive(Parser)] -#[command(author, version, about, long_about = None)] -pub struct Cli { - #[command(subcommand)] - pub command: Commands, +#[derive(Args, Serialize, Deserialize, Clone)] +pub struct CliArgs { /// Directory where configs are stored, and where the server will run - #[arg( - long, - value_name = "CONFIG_DIR", - default_value = ".", - env = "ALEX_CONFIG_DIR", - global = true - )] - pub config: PathBuf, + #[arg(long, value_name = "CONFIG_DIR", global = true)] + #[serde(skip_serializing_if = "::std::option::Option::is_none")] + pub config: Option, + /// Directory where world files will be saved - #[arg( - long, - value_name = "WORLD_DIR", - default_value = "../worlds", - env = "ALEX_WORLD_DIR", - global = true - )] - pub world: PathBuf, + #[arg(long, value_name = "WORLD_DIR", global = true)] + #[serde(skip_serializing_if = "::std::option::Option::is_none")] + pub world: Option, + /// Directory where backups will be stored - #[arg( - long, - value_name = "BACKUP_DIR", - default_value = "../backups", - env = "ALEX_BACKUP_DIR", - global = true - )] - pub backup: PathBuf, + #[arg(long, value_name = "BACKUP_DIR", global = true)] + #[serde(skip_serializing_if = "::std::option::Option::is_none")] + pub backup: Option, /// What backup layers to employ, provided as a list of tuples name,frequency,chains,chain_len /// delimited by semicolons (;). - #[arg(long, env = "ALEX_LAYERS", global = true, value_delimiter = ';')] - pub layers: Vec, + #[arg(long, global = true, value_delimiter = ';')] + #[serde(skip_serializing_if = "::std::option::Option::is_none")] + pub layers: Option>, /// Type of server - #[arg(long, default_value = "unknown", env = "ALEX_SERVER", global = true)] - pub server: ServerType, + #[arg(long, global = true)] + #[serde(skip_serializing_if = "::std::option::Option::is_none")] + pub server: Option, + /// Version string for the server, e.g. 1.19.4-545 - #[arg(long, default_value = "", env = "ALEX_SERVER_VERSION", global = true)] - pub server_version: String, + #[arg(long, global = true)] + #[serde(skip_serializing_if = "::std::option::Option::is_none")] + pub server_version: Option, +} + +#[derive(Parser, Serialize)] +#[command(author, version, about, long_about = None)] +pub struct Cli { + #[command(subcommand)] + #[serde(skip)] + pub command: Commands, + + /// Path to a TOML configuration file + #[arg(long = "config-file", global = true)] + pub config_file: Option, + + #[command(flatten)] + pub args: CliArgs, } impl Cli { - pub fn run(&self) -> io::Result<()> { + pub fn run(&self) -> crate::Result<()> { + let toml_file = self + .config_file + .clone() + .unwrap_or(PathBuf::from(Env::var_or("ALEX_CONFIG_FILE", ""))); + let config: Config = Figment::new() + .merge(Serialized::defaults(Config::default())) + .merge(Toml::file(toml_file)) + .merge(Env::prefixed("ALEX_")) + .merge(Serialized::defaults(&self.args)) + .extract()?; + match &self.command { - Commands::Run(args) => args.run(self), - Commands::Backup(args) => args.run(self), + Commands::Run(args) => args.run(&config), + Commands::Backup(args) => Ok(args.run(&config)?), } } - - /// Convenience method to initialize backup manager from the cli arguments - pub fn meta(&self) -> io::Result> { - let metadata = Metadata { - server_type: self.server, - server_version: self.server_version.clone(), - }; - let dirs = vec![ - (PathBuf::from("config"), self.config.canonicalize()?), - (PathBuf::from("worlds"), self.world.canonicalize()?), - ]; - let mut meta = MetaManager::new(self.backup.canonicalize()?, dirs, metadata); - meta.add_all(&self.layers)?; - - Ok(meta) - } } diff --git a/src/cli/run.rs b/src/cli/run.rs index 986fe8a..4e577b8 100644 --- a/src/cli/run.rs +++ b/src/cli/run.rs @@ -57,16 +57,16 @@ fn backups_thread(counter: Arc>) { } impl RunArgs { - pub fn run(&self, cli: &Cli) -> io::Result<()> { + pub fn run(&self, config: &super::Config) -> crate::Result<()> { let (_, mut signals) = signals::install_signal_handlers()?; - let mut cmd = server::ServerCommand::new(cli.server, &cli.server_version) + let mut cmd = server::ServerCommand::new(config.server, &config.server_version) .java(&self.java) .jar(self.jar.clone()) - .config(cli.config.clone()) - .world(cli.world.clone()) - .backup(cli.backup.clone()) - .managers(cli.layers.clone()) + .config(config.config.clone()) + .world(config.world.clone()) + .backup(config.backup.clone()) + .managers(config.layers.clone()) .xms(self.xms) .xmx(self.xmx); cmd.canonicalize()?; @@ -79,7 +79,7 @@ impl RunArgs { let counter = Arc::new(Mutex::new(cmd.spawn()?)); - if !cli.layers.is_empty() { + if !config.layers.is_empty() { let clone = Arc::clone(&counter); std::thread::spawn(move || backups_thread(clone)); } @@ -89,6 +89,6 @@ impl RunArgs { std::thread::spawn(move || stdin::handle_stdin(clone)); // Signal handler loop exits the process when necessary - signals::handle_signals(&mut signals, counter) + Ok(signals::handle_signals(&mut signals, counter)?) } } diff --git a/src/error.rs b/src/error.rs new file mode 100644 index 0000000..0ea7532 --- /dev/null +++ b/src/error.rs @@ -0,0 +1,32 @@ +use std::{fmt, io}; + +pub type Result = std::result::Result; + +#[derive(Debug)] +pub enum Error { + IO(io::Error), + Figment(figment::Error), +} + +impl fmt::Display for Error { + fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + Error::IO(err) => write!(fmt, "{}", err), + Error::Figment(err) => write!(fmt, "{}", err), + } + } +} + +impl std::error::Error for Error {} + +impl From for Error { + fn from(err: io::Error) -> Self { + Error::IO(err) + } +} + +impl From for Error { + fn from(err: figment::Error) -> Self { + Error::Figment(err) + } +} diff --git a/src/main.rs b/src/main.rs index f357d1b..245a796 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,13 +1,17 @@ mod backup; mod cli; +mod error; mod server; mod signals; mod stdin; -use crate::cli::Cli; -use clap::Parser; use std::io; +use clap::Parser; + +use crate::cli::Cli; +pub use error::{Error, Result}; + pub fn other(msg: &str) -> io::Error { io::Error::new(io::ErrorKind::Other, msg) } @@ -32,7 +36,8 @@ pub fn other(msg: &str) -> io::Error { // // manager.remove_old_backups() // } -fn main() -> io::Result<()> { +fn main() -> crate::Result<()> { let cli = Cli::parse(); + cli.run() }