More changes -- will update summary

Created using spr 1.3.4

Cargo.toml

@@ -6,9 +6,9 @@ members = [
     "caboose-util",
     "certificates",
     "common",
-    "crdb-seed",
     "ddm-admin-client",
     "deploy",
+    "dev-tools/crdb-seed",
     "dev-tools/omdb",
     "dev-tools/omicron-dev",
     "dev-tools/xtask",
@@ -76,6 +76,7 @@ default-members = [
     "ddm-admin-client",
     "dpd-client",
     "deploy",
+    "dev-tools/crdb-seed",
     "dev-tools/omdb",
     "dev-tools/omicron-dev",
     "dev-tools/xtask",

crdb-seed/Cargo.toml → dev-tools/crdb-seed/Cargo.toml

@@ -3,15 +3,12 @@ name = "crdb-seed"
 version = "0.1.0"
 edition = "2021"
 license = "MPL-2.0"
+readme = "README.md"
 
 [dependencies]
 anyhow.workspace = true
-camino.workspace = true
-camino-tempfile.workspace = true
 dropshot.workspace = true
-hex.workspace = true
 omicron-test-utils.workspace = true
-ring.workspace = true
 slog.workspace = true
 tokio.workspace = true
 omicron-workspace-hack.workspace = true

dev-tools/crdb-seed/README.md

@@ -0,0 +1,11 @@
+# crdb-seed
+
+This is a small utility that creates a seed tarball for our CockroachDB instance
+in the temporary directory. It is used as a setup script for nextest (see
+`.config/nextest.rs`).
+
+This utility hashes inputs and attempts to reuse a tarball if it already exists
+(see `digest_unique_to_schema` in `omicron/test-utils/src/dev/seed.rs`).
+
+To invalidate the tarball and cause it to be recreated from scratch, set
+`CRDB_SEED_INVALIDATE=1` in the environment.

dev-tools/crdb-seed/src/main.rs

@@ -0,0 +1,38 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+use anyhow::{Context, Result};
+use dropshot::{test_util::LogContext, ConfigLogging, ConfigLoggingLevel};
+use omicron_test_utils::dev::seed::{
+    ensure_seed_tarball_exists, should_invalidate_seed,
+};
+use std::io::Write;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    // TODO: dropshot is v heavyweight for this, we should be able to pull in a
+    // smaller binary
+    let logctx = LogContext::new(
+        "crdb_seeding",
+        &ConfigLogging::StderrTerminal { level: ConfigLoggingLevel::Info },
+    );
+    let (seed_tar, status) =
+        ensure_seed_tarball_exists(&logctx.log, should_invalidate_seed())
+            .await?;
+    status.log(&logctx.log, &seed_tar);
+
+    if let Ok(env_path) = std::env::var("NEXTEST_ENV") {
+        let mut file = std::fs::File::create(&env_path)
+            .context("failed to open NEXTEST_ENV file")?;
+        writeln!(file, "CRDB_SEED_TAR={seed_tar}")
+            .context("failed to write to NEXTEST_ENV file")?;
+    } else {
+        slog::warn!(
+            logctx.log,
+            "NEXTEST_ENV not set (is this script running under nextest?)"
+        );
+    }
+
+    Ok(())
+}

dev-tools/omicron-dev/src/bin/omicron-dev.rs

@@ -341,8 +341,6 @@ async fn cmd_run_all(args: &RunAllArgs) -> Result<(), anyhow::Error> {
         config.deployment.dropshot_external.dropshot.bind_address.set_port(p);
     }
 
-    // Start up a ControlPlaneTestContext, which tautologically sets up
-    // everything needed for a simulated control plane.
     println!("omicron-dev: setting up all services ... ");
     let cptestctx = nexus_test_utils::test_setup_with_config::<
         omicron_nexus::Server,

nexus/test-utils/src/db.rs

@@ -24,7 +24,7 @@ fn seed_tar() -> Utf8PathBuf {
 }
 
 /// Wrapper around [`dev::test_setup_database`] which uses a seed tarball
-/// provided at build-time.
+/// provided from the environment.
 pub async fn test_setup_database(log: &Logger) -> dev::db::CockroachInstance {
     let input_tar = seed_tar();
     dev::test_setup_database(
@@ -34,6 +34,19 @@ pub async fn test_setup_database(log: &Logger) -> dev::db::CockroachInstance {
     .await
 }
 
+/// Wrapper around [`dev::test_setup_database`] which uses a seed tarball
+/// provided as an argument.
+pub async fn test_setup_database_from_seed(
+    log: &Logger,
+    input_tar: Utf8PathBuf,
+) -> dev::db::CockroachInstance {
+    dev::test_setup_database(
+        log,
+        dev::StorageSource::CopyFromSeed { input_tar },
+    )
+    .await
+}
+
 /// Creates a new database with no data populated.
 ///
 /// Primarily used for schema change and migration testing.

nexus/test-utils/src/lib.rs

@@ -5,7 +5,9 @@
 //! Integration testing facilities for Nexus
 
 use anyhow::Context;
+use anyhow::Result;
 use camino::Utf8Path;
+use camino::Utf8PathBuf;
 use dns_service_client::types::DnsConfigParams;
 use dropshot::test_util::ClientTestContext;
 use dropshot::test_util::LogContext;
@@ -283,15 +285,37 @@ impl<'a, N: NexusServer> ControlPlaneTestContextBuilder<'a, N> {
         }
     }
 
-    pub async fn start_crdb(&mut self, populate: bool) {
+    pub async fn ensure_seed_tarball_exists(&self) -> Result<Utf8PathBuf> {
+        let log = &self.logctx.log;
+        debug!(log, "Ensuring seed tarball exists");
+
+        // Start up a ControlPlaneTestContext, which tautologically sets up
+        // everything needed for a simulated control plane.
+        let why_invalidate =
+            omicron_test_utils::dev::seed::should_invalidate_seed();
+        let (seed_tar, status) =
+            omicron_test_utils::dev::seed::ensure_seed_tarball_exists(
+                log,
+                why_invalidate,
+            )
+            .await
+            .context("ensuring seed tarball exists")?;
+        status.log(log, &seed_tar);
+        Ok(seed_tar)
+    }
+
+    pub async fn start_crdb(&mut self, populate: StartCrdbPopulate) {
         let log = &self.logctx.log;
         debug!(log, "Starting CRDB");
 
         // Start up CockroachDB.
-        let database = if populate {
-            db::test_setup_database(log).await
-        } else {
-            db::test_setup_database_empty(log).await
+        let database = match populate {
+            StartCrdbPopulate::FromSeed { input_tar } => {
+                db::test_setup_database_from_seed(log, input_tar).await
+            }
+            StartCrdbPopulate::Empty => {
+                db::test_setup_database_empty(log).await
+            }
         };
 
         eprintln!("DB URL: {}", database.pg_config());
@@ -759,6 +783,15 @@ impl<'a, N: NexusServer> ControlPlaneTestContextBuilder<'a, N> {
     }
 }
 
+#[derive(Clone, Debug)]
+pub enum StartCrdbPopulate {
+    /// Populate Cockroach from the seed at this tarball.
+    FromSeed { input_tar: Utf8PathBuf },
+
+    /// Do not populate Cockroach.
+    Empty,
+}
+
 pub async fn test_setup_with_config<N: NexusServer>(
     test_name: &str,
     config: &mut omicron_common::nexus_config::Config,
@@ -768,8 +801,8 @@ pub async fn test_setup_with_config<N: NexusServer>(
     let mut builder =
         ControlPlaneTestContextBuilder::<N>::new(test_name, config);
 
-    let populate = true;
-    builder.start_crdb(populate).await;
+    let input_tar = builder.ensure_seed_tarball_exists().await.unwrap();
+    builder.start_crdb(StartCrdbPopulate::FromSeed { input_tar }).await;
     builder.start_clickhouse().await;
     builder.start_dendrite(SwitchLocation::Switch0).await;
     builder.start_dendrite(SwitchLocation::Switch1).await;

test-utils/Cargo.toml

@@ -12,10 +12,12 @@ camino-tempfile.workspace = true
 dropshot.workspace = true
 futures.workspace = true
 headers.workspace = true
+hex.workspace = true
 http.workspace = true
 libc.workspace = true
 omicron-common.workspace = true
 pem.workspace = true
+ring.workspace = true
 rustls.workspace = true
 slog.workspace = true
 subprocess.workspace = true

test-utils/src/dev/db.rs

@@ -509,7 +509,7 @@ pub enum CockroachStartError {
 /// You are **required** to invoke [`CockroachInstance::wait_for_shutdown()`] or
 /// [`CockroachInstance::cleanup()`] before this object is dropped.
 #[derive(Debug)]
-pub struct CockroachInstance {
+pub struct  CockroachInstance {
     /// child process id
     pid: u32,
     /// PostgreSQL config to use to connect to CockroachDB as a SQL client