feat: adjust default experiments, add --all flag

Ensure that the default experiment list only includes
the more stable experimnets (coreutils & sudo-rs), but
also include a `--all` command line flag to enable people
to go 'all in'

Author: jnsgruk

README.md

@@ -9,10 +9,11 @@ It currently supports the following experiments:
 - [uutils diffutils](https://github.com/uutils/diffutils)
 - [sudo-rs](https://github.com/trifectatechfoundation/sudo-rs)
 
+By default, the `coreutils` and `sudo-rs` experiments are enabled because they're the most complete, stable experiments. Others can be toggled using command line arguments shown below.
+
 ## Installation
 
-> [!WARNING]
-> `oxidizr` is an experimental tool to help developers and tinkerers play with relatively new alternatives to core system utilities. It may cause a loss of data, or prevent your system from booting, so use with caution!
+> [!WARNING] > `oxidizr` is an experimental tool to help developers and tinkerers play with relatively new alternatives to core system utilities. It may cause a loss of data, or prevent your system from booting, so use with caution!
 
 You can install `oxidizr` using `cargo`:
 
@@ -47,10 +48,13 @@ Options:
   -y, --yes
           Skip confirmation prompts
 
+  -a, --all
+          Enable/disable all known experiments
+
   -e, --experiments <EXPERIMENTS>...
           Select experiments to enable or disable
 
-          [default: coreutils findutils diffutils sudo-rs]
+          [default: coreutils sudo-rs]
 
   -h, --help
           Print help (see a summary with '-h')
@@ -62,6 +66,8 @@ Options:
 ### Example
 
 ```bash
+# Enable all experiments
+sudo oxidizr enable --ll
 # Enable just coreutils and findutils experiments
 sudo oxidizr enable --experiments coreutils findutils
 # Enable just coreutils experiment without prompting with debug logging enabled

src/main.rs

@@ -36,7 +36,7 @@ use clap::{Parser, Subcommand};
 use clap_verbosity_flag::{InfoLevel, Verbosity};
 use experiments::{all_experiments, Experiment};
 use inquire::Confirm;
-use tracing::info;
+use tracing::{info, warn};
 use tracing_subscriber::{fmt, prelude::*};
 use utils::{System, Worker};
 
@@ -61,7 +61,16 @@ struct Args {
     #[arg(
         short,
         long,
-        default_values_t = vec!["coreutils".to_string(), "findutils".to_string(), "diffutils".to_string(), "sudo-rs".to_string()],
+        default_value_t = false,
+        global = true,
+        help = "Enable/disable all known experiments"
+    )]
+    all: bool,
+
+    #[arg(
+        short,
+        long,
+        default_values_t = vec!["coreutils".to_string(), "sudo-rs".to_string()],
         global = true,
         num_args = 1..,
         help = "Select experiments to enable or disable"
@@ -105,12 +114,18 @@ fn main() -> Result<()> {
         "This program only supports Ubuntu"
     );
 
-    // Get the set of enabled experiments. If the user specified nothing, all experiments are
-    // enabled.
-    let selected_experiments: Vec<Experiment<'_>> = all_experiments(&system)
-        .into_iter()
-        .filter(|e| args.experiments.contains(&e.name()))
-        .collect();
+    let selected_experiments: Vec<Experiment<'_>> = match args.all {
+        true => {
+            if args.experiments.len() > 0 {
+                warn!("Ignoring --experiments flag as --all is set");
+            }
+            all_experiments(&system)
+        }
+        false => all_experiments(&system)
+            .into_iter()
+            .filter(|e| args.experiments.contains(&e.name()))
+            .collect(),
+    };
 
     // Handle subcommands
     match args.cmd {

tests/disable-all/task.yaml

@@ -0,0 +1,34 @@
+summary: Test disabling experiments
+execute: |
+  oxidizr enable --yes --all
+  oxidizr disable --yes --all
+
+  apt list rust-coreutils | NOMATCH installed
+  ls -la /usr/bin/date | NOMATCH "/usr/bin/date -> /usr/bin/coreutils"
+  ls -la /usr/bin | NOMATCH ".date.oxidizr.bak"
+  date --help | MATCH "GNU"
+
+  apt list rust-findutils | NOMATCH installed
+  ls -la /usr/bin/find | NOMATCH "/usr/bin/find -> /usr/lib/cargo/bin/findutils/find"
+  ls -la /usr/bin | NOMATCH ".find.oxidizr.bak"
+  find --help | MATCH "GNU"
+
+  if [[ "$(lsb_release -rs)" != "24.04" ]]; then
+    apt list rust-diffutils | NOMATCH installed
+    ls -la /usr/bin/diff | NOMATCH "/usr/bin/diff -> /usr/lib/cargo/bin/diffutils/diff"
+    ls -la /usr/bin | NOMATCH ".diff.oxidizr.bak"
+    diff --help | MATCH "GNU"
+  fi
+
+  apt list sudo-rs | NOMATCH installed
+
+  ls -la /usr/bin/sudo | NOMATCH "/usr/bin/sudo -> /usr/lib/cargo/bin/sudo"
+  ls -la /usr/bin | NOMATCH ".sudo.oxidizr.bak"
+  /usr/bin/sudo --version 2>&1 | NOMATCH "sudo-rs"
+
+  ls -la /usr/bin/su | NOMATCH "/usr/bin/su -> /usr/lib/cargo/bin/su"
+  ls -la /usr/bin | NOMATCH ".su.oxidizr.bak"
+  /usr/bin/su --version 2>&1 | NOMATCH "su-rs"
+
+  ls -la /usr/sbin/visudo | NOMATCH "/usr/sbin/visudo -> /usr/lib/cargo/bin/visudo"
+  ls -la /usr/sbin | NOMATCH ".visudo.oxidizr.bak"

tests/disable-default/task.yaml

@@ -8,18 +8,6 @@ execute: |
   ls -la /usr/bin | NOMATCH ".date.oxidizr.bak"
   date --help | MATCH "GNU"
 
-  apt list rust-findutils | NOMATCH installed
-  ls -la /usr/bin/find | NOMATCH "/usr/bin/find -> /usr/lib/cargo/bin/findutils/find"
-  ls -la /usr/bin | NOMATCH ".find.oxidizr.bak"
-  find --help | MATCH "GNU"
-
-  if [[ "$(lsb_release -rs)" != "24.04" ]]; then
-    apt list rust-diffutils | NOMATCH installed
-    ls -la /usr/bin/diff | NOMATCH "/usr/bin/diff -> /usr/lib/cargo/bin/diffutils/diff"
-    ls -la /usr/bin | NOMATCH ".diff.oxidizr.bak"
-    diff --help | MATCH "GNU"
-  fi
-
   apt list sudo-rs | NOMATCH installed
 
   ls -la /usr/bin/sudo | NOMATCH "/usr/bin/sudo -> /usr/lib/cargo/bin/sudo"

tests/enable-all/task.yaml

@@ -0,0 +1,50 @@
+summary: Test enabling default experiments
+execute: |
+  oxidizr enable --yes --all
+
+  apt list rust-coreutils | MATCH installed
+  while read p; do
+    util_path="$(which $p)"
+    util_dir="$(dirname "$util_path")"
+    ls -la "$util_path"| MATCH "$util_path -> /usr/bin/coreutils"
+    ls -la "$util_dir/.$p.oxidizr.bak" || echo "No backup file for $util_path"
+    $util_path --help | NOMATCH "https://www.gnu.org/software/coreutils"
+  done < ../rust-coreutils-bins.txt
+
+  apt list rust-findutils | MATCH installed
+  while read p; do
+    util_path="$(which $p)"
+    util_dir="$(dirname "$util_path")"
+    ls -la "$util_path"| MATCH "$util_path -> /usr/lib/cargo/bin/findutils/$p"
+    ls -la "$util_dir/.$p.oxidizr.bak" || echo "No backup file for $util_path"
+    $util_path --help | NOMATCH "https://www.gnu.org/software/coreutils"
+  done < ../rust-findutils-bins.txt
+
+  if [[ "$(lsb_release -rs)" != "24.04" ]]; then
+    apt list rust-diffutils | MATCH installed
+    while read p; do
+      util_path="$(which $p)"
+      util_dir="$(dirname "$util_path")"
+      ls -la "$util_path"| MATCH "$util_path -> /usr/lib/cargo/bin/diffutils/$p"
+      ls -la "$util_dir/.$p.oxidizr.bak" || echo "No backup file for $util_path"
+      $util_path --help | NOMATCH "https://www.gnu.org/software/coreutils"
+    done < ../rust-diffutils-bins.txt
+  fi
+
+  apt list sudo-rs | MATCH installed
+
+  ls -la /usr/bin/sudo | MATCH "/usr/bin/sudo -> /usr/lib/cargo/bin/sudo"
+  ls -la /usr/bin | MATCH ".sudo.oxidizr.bak"
+  /usr/bin/sudo --version 2>&1 | MATCH "sudo-rs"
+
+  ls -la /usr/bin/su | MATCH "/usr/bin/su -> /usr/lib/cargo/bin/su"
+  ls -la /usr/bin | MATCH ".su.oxidizr.bak"
+  /usr/bin/su --version 2>&1 | MATCH "su-rs"
+
+  ls -la /usr/sbin/visudo | MATCH "/usr/sbin/visudo -> /usr/lib/cargo/bin/visudo"
+  ls -la /usr/sbin | MATCH ".visudo.oxidizr.bak"
+
+restore: |
+  if [[ -z "${CI:-}" ]]; then
+    oxidizr disable --yes --all
+  fi

tests/enable-default/task.yaml

@@ -11,26 +11,6 @@ execute: |
     $util_path --help | NOMATCH "https://www.gnu.org/software/coreutils"
   done < ../rust-coreutils-bins.txt
 
-  apt list rust-findutils | MATCH installed
-  while read p; do
-    util_path="$(which $p)"
-    util_dir="$(dirname "$util_path")"
-    ls -la "$util_path"| MATCH "$util_path -> /usr/lib/cargo/bin/findutils/$p"
-    ls -la "$util_dir/.$p.oxidizr.bak" || echo "No backup file for $util_path"
-    $util_path --help | NOMATCH "https://www.gnu.org/software/coreutils"
-  done < ../rust-findutils-bins.txt
-
-  if [[ "$(lsb_release -rs)" != "24.04" ]]; then
-    apt list rust-diffutils | MATCH installed
-    while read p; do
-      util_path="$(which $p)"
-      util_dir="$(dirname "$util_path")"
-      ls -la "$util_path"| MATCH "$util_path -> /usr/lib/cargo/bin/diffutils/$p"
-      ls -la "$util_dir/.$p.oxidizr.bak" || echo "No backup file for $util_path"
-      $util_path --help | NOMATCH "https://www.gnu.org/software/coreutils"
-    done < ../rust-diffutils-bins.txt
-  fi
-
   apt list sudo-rs | MATCH installed
 
   ls -la /usr/bin/sudo | MATCH "/usr/bin/sudo -> /usr/lib/cargo/bin/sudo"
@@ -46,5 +26,5 @@ execute: |
 
 restore: |
   if [[ -z "${CI:-}" ]]; then
-    oxidizr disable  --yes
+    oxidizr disable --yes
   fi

tests/enable-partial/task.yaml

@@ -13,6 +13,7 @@ execute: |
 
   apt list rust-findutils | NOMATCH installed
   apt list rust-diffutils | NOMATCH installed
+  apt list sudo-rs | NOMATCH installed
 
 restore: |
   if [[ -z "${CI:-}" ]]; then