feat!: Allow specifying many options in config profile without array (#211)

Adds the possibility to specify many options in config profile files as
single strings which required arrays of strings - in the case of the
array only containing 1 entry.

Breaking change:
Also removes the splitting of one string from `password-command` and
`warmup-command`. Now the already-split command has to be given as array
(or single string if there are no arguments to the command).

Author: aawsome

crates/core/Cargo.toml

@@ -85,7 +85,6 @@ filetime = "0.2.23"
 ignore = "0.4.22"
 nix = { version = "0.28", default-features = false, features = ["user", "fs"] }
 path-dedot = "3.1.1"
-shell-words = "1.1.0"
 walkdir = "2.5.0"
 
 # cache

crates/core/src/backend/ignore.rs

@@ -6,7 +6,7 @@ use std::{
     path::{Path, PathBuf},
 };
 
-use serde_with::{serde_as, DisplayFromStr};
+use serde_with::{serde_as, DisplayFromStr, OneOrMany};
 
 use bytesize::ByteSize;
 #[cfg(not(windows))]
@@ -70,21 +70,25 @@ pub struct LocalSourceFilterOptions {
     /// Glob pattern to exclude/include (can be specified multiple times)
     #[cfg_attr(feature = "clap", clap(long))]
     #[cfg_attr(feature = "merge", merge(strategy = merge::vec::overwrite_empty))]
+    #[serde_as(as = "OneOrMany<_>")]
     pub glob: Vec<String>,
 
     /// Same as --glob pattern but ignores the casing of filenames
     #[cfg_attr(feature = "clap", clap(long, value_name = "GLOB"))]
     #[cfg_attr(feature = "merge", merge(strategy = merge::vec::overwrite_empty))]
+    #[serde_as(as = "OneOrMany<_>")]
     pub iglob: Vec<String>,
 
     /// Read glob patterns to exclude/include from this file (can be specified multiple times)
     #[cfg_attr(feature = "clap", clap(long, value_name = "FILE"))]
     #[cfg_attr(feature = "merge", merge(strategy = merge::vec::overwrite_empty))]
+    #[serde_as(as = "OneOrMany<_>")]
     pub glob_file: Vec<String>,
 
     /// Same as --glob-file ignores the casing of filenames in patterns
     #[cfg_attr(feature = "clap", clap(long, value_name = "FILE"))]
     #[cfg_attr(feature = "merge", merge(strategy = merge::vec::overwrite_empty))]
+    #[serde_as(as = "OneOrMany<_>")]
     pub iglob_file: Vec<String>,
 
     /// Ignore files based on .gitignore files
@@ -100,11 +104,13 @@ pub struct LocalSourceFilterOptions {
     /// Treat the provided filename like a .gitignore file (can be specified multiple times)
     #[cfg_attr(feature = "clap", clap(long, value_name = "FILE"))]
     #[cfg_attr(feature = "merge", merge(strategy = merge::vec::overwrite_empty))]
+    #[serde_as(as = "OneOrMany<_>")]
     pub custom_ignorefile: Vec<String>,
 
     /// Exclude contents of directories containing this filename (can be specified multiple times)
     #[cfg_attr(feature = "clap", clap(long, value_name = "FILE"))]
     #[cfg_attr(feature = "merge", merge(strategy = merge::vec::overwrite_empty))]
+    #[serde_as(as = "OneOrMany<_>")]
     pub exclude_if_present: Vec<String>,
 
     /// Exclude other file systems, don't cross filesystem boundaries and subvolumes

crates/core/src/commands/forget.rs

@@ -4,7 +4,7 @@ use chrono::{DateTime, Datelike, Duration, Local, Timelike};
 use derivative::Derivative;
 use derive_setters::Setters;
 use serde_derive::{Deserialize, Serialize};
-use serde_with::{serde_as, DisplayFromStr};
+use serde_with::{serde_as, DisplayFromStr, OneOrMany};
 
 use crate::{
     error::RusticResult,
@@ -107,13 +107,14 @@ pub(crate) fn get_forget_snapshots<P: ProgressBars, S: Open>(
 pub struct KeepOptions {
     /// Keep snapshots with this taglist (can be specified multiple times)
     #[cfg_attr(feature = "clap", clap(long, value_name = "TAG[,TAG,..]"))]
-    #[serde_as(as = "Vec<DisplayFromStr>")]
+    #[serde_as(as = "OneOrMany<DisplayFromStr>")]
     #[cfg_attr(feature = "merge", merge(strategy=merge::vec::overwrite_empty))]
     pub keep_tags: Vec<StringList>,
 
     /// Keep snapshots ids that start with ID (can be specified multiple times)
     #[cfg_attr(feature = "clap", clap(long = "keep-id", value_name = "ID"))]
     #[cfg_attr(feature = "merge", merge(strategy=merge::vec::overwrite_empty))]
+    #[serde_as(as = "OneOrMany<_>")]
     pub keep_ids: Vec<String>,
 
     /// Keep the last N snapshots (N == -1: keep all snapshots)

crates/core/src/error.rs

@@ -290,8 +290,6 @@ pub enum RepositoryErrorKind {
     /// error accessing config file
     AccessToConfigFileFailed,
     /// {0:?}
-    FromSplitError(#[from] shell_words::ParseError),
-    /// {0:?}
     FromThreadPoolbilderError(rayon::ThreadPoolBuildError),
     /// reading Password failed: `{0:?}`
     ReadingPasswordFromReaderFailed(std::io::Error),
@@ -437,8 +435,6 @@ pub enum SnapshotFileErrorKind {
     UnpackingSnapshotFileResultFailed,
     /// collecting IDs failed: {0:?}
     FindingIdsFailed(Vec<String>),
-    /// {0:?}
-    FromSplitError(#[from] shell_words::ParseError),
     /// removing dots from paths failed: `{0:?}`
     RemovingDotsFromPathFailed(std::io::Error),
     /// canonicalizing path failed: `{0:?}`

crates/core/src/repofile/snapshotfile.rs

@@ -15,8 +15,7 @@ use itertools::Itertools;
 use log::info;
 use path_dedot::ParseDot;
 use serde_derive::{Deserialize, Serialize};
-use serde_with::{serde_as, DisplayFromStr};
-use shell_words::split;
+use serde_with::{serde_as, DisplayFromStr, OneOrMany};
 
 use crate::{
     backend::{decrypt::DecryptReadBackend, FileType, FindInBackend},
@@ -52,7 +51,7 @@ pub struct SnapshotOptions {
 
     /// Tags to add to snapshot (can be specified multiple times)
     #[cfg_attr(feature = "clap", clap(long, value_name = "TAG[,TAG,..]"))]
-    #[serde_as(as = "Vec<DisplayFromStr>")]
+    #[serde_as(as = "OneOrMany<DisplayFromStr>")]
     #[cfg_attr(feature = "merge", merge(strategy = merge::vec::overwrite_empty))]
     pub tag: Vec<StringList>,
 
@@ -1106,45 +1105,24 @@ impl Display for PathList {
     }
 }
 
-impl FromIterator<PathBuf> for PathList {
-    fn from_iter<I: IntoIterator<Item = PathBuf>>(iter: I) -> Self {
-        Self(iter.into_iter().collect())
-    }
-}
-
-impl<'a> FromIterator<&'a String> for PathList {
-    fn from_iter<I: IntoIterator<Item = &'a String>>(iter: I) -> Self {
-        Self(iter.into_iter().map(PathBuf::from).collect())
-    }
-}
-
-impl FromIterator<String> for PathList {
-    fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> Self {
-        Self(iter.into_iter().map(PathBuf::from).collect())
-    }
-}
-
-impl<'a> FromIterator<&'a str> for PathList {
-    fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> Self {
-        Self(iter.into_iter().map(PathBuf::from).collect())
+impl<T: Into<PathBuf>> FromIterator<T> for PathList {
+    fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
+        Self(iter.into_iter().map(T::into).collect())
     }
 }
 
 impl PathList {
-    /// Create a `PathList` by parsing a Strings containing paths separated by whitspaces.
+    /// Create a `PathList` from a String containing a single path
+    /// Note: for multiple paths, use `PathList::from_iter`.
     ///
     /// # Arguments
     ///
-    /// * `sources` - The String to parse
+    /// * `source` - The String to parse
     ///
     /// # Errors
-    ///
-    /// * [`SnapshotFileErrorKind::FromSplitError`] - If the parsing failed
-    ///
-    /// [`SnapshotFileErrorKind::FromSplitError`]: crate::error::SnapshotFileErrorKind::FromSplitError
-    pub fn from_string(sources: &str) -> RusticResult<Self> {
-        let sources = split(sources).map_err(SnapshotFileErrorKind::FromSplitError)?;
-        Ok(Self::from_iter(sources))
+    /// no errors can occur here
+    pub fn from_string(source: &str) -> RusticResult<Self> {
+        Ok(Self(vec![source.into()]))
     }
 
     /// Number of paths in the `PathList`.

crates/core/src/repository.rs

@@ -12,8 +12,7 @@ use std::{
 use bytes::Bytes;
 use derive_setters::Setters;
 use log::{debug, error, info};
-use serde_with::{serde_as, DisplayFromStr};
-use shell_words::split;
+use serde_with::{serde_as, DisplayFromStr, OneOrMany};
 
 use crate::{
     backend::{
@@ -111,7 +110,9 @@ pub struct RepositoryOptions {
         env = "RUSTIC_PASSWORD_COMMAND",
         conflicts_with_all = &["password", "password_file"],
     ))]
-    pub password_command: Option<String>,
+    #[cfg_attr(feature = "merge", merge(strategy = merge::vec::overwrite_empty))]
+    #[serde_as(as = "OneOrMany<_>")]
+    pub password_command: Vec<String>,
 
     /// Don't use a cache.
     #[cfg_attr(feature = "clap", clap(long, global = true, env = "RUSTIC_NO_CACHE"))]
@@ -140,7 +141,9 @@ pub struct RepositoryOptions {
         feature = "clap",
         clap(long, global = true, conflicts_with = "warm_up")
     )]
-    pub warm_up_command: Option<String>,
+    #[cfg_attr(feature = "merge", merge(strategy = merge::vec::overwrite_empty))]
+    #[serde_as(as = "OneOrMany<_>")]
+    pub warm_up_command: Vec<String>,
 
     /// Duration (e.g. 10m) to wait after warm up
     #[cfg_attr(feature = "clap", clap(long, global = true, value_name = "DURATION"))]
@@ -177,11 +180,10 @@ impl RepositoryOptions {
                 );
                 Ok(Some(read_password_from_reader(&mut file)?))
             }
-            (_, _, Some(command)) => {
-                let commands = split(command).map_err(RepositoryErrorKind::FromSplitError)?;
-                debug!("commands: {commands:?}");
-                let command = Command::new(&commands[0])
-                    .args(&commands[1..])
+            (_, _, command) if !command.is_empty() => {
+                debug!("commands: {command:?}");
+                let command = Command::new(&command[0])
+                    .args(&command[1..])
                     .stdout(Stdio::piped())
                     .spawn()?;
                 let Ok(output) = command.wait_with_output() else {
@@ -205,7 +207,7 @@ impl RepositoryOptions {
                     }
                 }))
             }
-            (None, None, None) => Ok(None),
+            (None, None, _) => Ok(None),
         }
     }
 }
@@ -321,11 +323,11 @@ impl<P> Repository<P, ()> {
         let mut be = backends.repository();
         let be_hot = backends.repo_hot();
 
-        if let Some(command) = &opts.warm_up_command {
-            if !command.contains("%id") {
+        if !opts.warm_up_command.is_empty() {
+            if opts.warm_up_command.iter().all(|c| !c.contains("%id")) {
                 return Err(RepositoryErrorKind::NoIDSpecified.into());
             }
-            info!("using warm-up command {command}");
+            info!("using warm-up command {:?}", opts.warm_up_command);
         }
 
         if opts.warm_up {

crates/core/src/repository/warm_up.rs

@@ -3,7 +3,6 @@ use std::thread::sleep;
 
 use log::{debug, error, warn};
 use rayon::ThreadPoolBuilder;
-use shell_words::split;
 
 use crate::{
     backend::{FileType, ReadBackend},
@@ -63,8 +62,8 @@ pub(crate) fn warm_up<P: ProgressBars, S>(
     repo: &Repository<P, S>,
     packs: impl ExactSizeIterator<Item = Id>,
 ) -> RusticResult<()> {
-    if let Some(command) = &repo.opts.warm_up_command {
-        warm_up_command(packs, command, &repo.pb)?;
+    if !repo.opts.warm_up_command.is_empty() {
+        warm_up_command(packs, &repo.opts.warm_up_command, &repo.pb)?;
     } else if repo.be.needs_warm_up() {
         warm_up_repo(repo, packs)?;
     }
@@ -86,16 +85,18 @@ pub(crate) fn warm_up<P: ProgressBars, S>(
 /// [`RepositoryErrorKind::FromSplitError`]: crate::error::RepositoryErrorKind::FromSplitError
 fn warm_up_command<P: ProgressBars>(
     packs: impl ExactSizeIterator<Item = Id>,
-    command: &str,
+    command: &[String],
     pb: &P,
 ) -> RusticResult<()> {
     let p = pb.progress_counter("warming up packs...");
     p.set_length(packs.len() as u64);
     for pack in packs {
-        let actual_command = command.replace("%id", &pack.to_hex());
-        debug!("calling {actual_command}...");
-        let commands = split(&actual_command).map_err(RepositoryErrorKind::FromSplitError)?;
-        let status = Command::new(&commands[0]).args(&commands[1..]).status()?;
+        let command: Vec<_> = command
+            .iter()
+            .map(|c| c.replace("%id", &pack.to_hex()))
+            .collect();
+        debug!("calling {command:?}...");
+        let status = Command::new(&command[0]).args(&command[1..]).status()?;
         if !status.success() {
             warn!("warm-up command was not successful for pack {pack:?}. {status}");
         }