From ce69e142a9816977ddbd546892f6aff75f09cbe0 Mon Sep 17 00:00:00 2001
From: Sean Klein <sean@oxide.computer>
Date: Wed, 20 Nov 2024 09:51:52 -0800
Subject: [PATCH] [sled-storage] Automatically clean up test zpools, storage
 (#7111)

`StorageManagerTestHarness` is a utility which allows sled agent tests
to use real zpools and datasets atop temporary file-backed storage. This
provides a decent test fidelity for storage-based parts of the sled
agent.

This harness previously took a liberal attitude towards zpool creation,
but a conservative perspective on their deletion: rather than
automatically destroying zpools on test failure, it would print commands
for "how to delete these zpools yourself". This tendency was mostly
borne out of fear: deleting zpools is a dangerous operation which should
be done with caution.

When working with the `StorageManagerTestHarness`, especially while
iterating on tests with many expected failures, I've decided this is an
Enormous Pain In The Butt. This PR changes the aforementioned tendency,
and just attempts to delete all provisioned zpools we created in our
tests. If we fail to do so, we'll *then* log an error message and let
the user take responsibility for manual cleanup.
---
 sled-storage/src/manager_test_harness.rs | 51 +++++++++++++++++-------
 1 file changed, 37 insertions(+), 14 deletions(-)

diff --git a/sled-storage/src/manager_test_harness.rs b/sled-storage/src/manager_test_harness.rs
index 40c7c5fbed..068816ffa7 100644
--- a/sled-storage/src/manager_test_harness.rs
+++ b/sled-storage/src/manager_test_harness.rs
@@ -83,10 +83,9 @@ pub struct StorageManagerTestHarness {
 impl Drop for StorageManagerTestHarness {
     fn drop(&mut self) {
         if let Some(vdev_dir) = self.vdev_dir.take() {
-            eprintln!(
+            eprint!(
                 "WARNING: StorageManagerTestHarness called without 'cleanup()'.\n\
-                 We may have leaked zpools, and not correctly deleted {}",
-                vdev_dir.path()
+                 Attempting automated cleanup ... ",
             );
 
             let pools = [
@@ -100,25 +99,49 @@ impl Drop for StorageManagerTestHarness {
                 ),
             ];
 
-            eprintln!(
-                "The following commands may need to be run to clean up state:"
-            );
-            eprintln!("---");
+            let mut failed_commands = vec![];
+
             for (prefix, pool) in pools {
                 let Ok(entries) = pool.read_dir_utf8() else {
                     continue;
                 };
                 for entry in entries.flatten() {
-                    eprintln!(
-                        "  pfexec zpool destroy {prefix}{} ",
-                        entry.file_name()
-                    );
+                    let pool_name = format!("{prefix}{}", entry.file_name());
+                    if let Err(_) =
+                        std::process::Command::new(illumos_utils::PFEXEC)
+                            .args(["zpool", "destroy", &pool_name])
+                            .status()
+                    {
+                        failed_commands
+                            .push(format!("pfexec zpool destroy {pool_name}"));
+                    }
                 }
             }
-            eprintln!("  pfexec rm -rf {}", vdev_dir.path());
-            eprintln!("---");
 
-            panic!("Dropped without cleanup. See stderr for cleanup advice");
+            let vdev_path = vdev_dir.path();
+            if let Err(_) = std::process::Command::new(illumos_utils::PFEXEC)
+                .args(["rm", "-rf", vdev_path.as_str()])
+                .status()
+            {
+                failed_commands.push(format!("pfexec rm -rf {vdev_path}"));
+            }
+
+            if !failed_commands.is_empty() {
+                eprintln!("FAILED");
+                eprintln!(
+                    "The following commands may need to be run to clean up state:"
+                );
+                eprintln!("---");
+                for cmd in failed_commands {
+                    eprintln!("{cmd}");
+                }
+                eprintln!("---");
+                panic!(
+                    "Dropped without cleanup. See stderr for cleanup advice"
+                );
+            } else {
+                eprintln!("OK");
+            }
         }
     }
 }