Ensure oximeter schemas do not change (#9341)

Closes: #8862

Author: karencfv

Cargo.lock

@@ -21,6 +21,10 @@ transactions, we actually require that there are no writes of any kind. In
 practice, this means `oximeter` **must not** be running when this is called.
 Similarly, there must be only a single instance of this program at a time.
 
+_NB: Schema changes for the `oximeter` database are currently disabled due to
+ongoing self-service update work. More information about this restriction can
+be found in [#8862](https://github.com/oxidecomputer/omicron/issues/8862)_
+
 To run this program:
 
 - Ensure the ClickHouse server is running, and grab its IP address;

oximeter/db/schema/README.md

@@ -5,6 +5,7 @@
 use anyhow::Context;
 use clickward::{BasePorts, Deployment, DeploymentConfig, KeeperId};
 use dropshot::test_util::log_prefix_for_test;
+use omicron_test_utils::dev::file_checksum;
 use omicron_test_utils::dev::poll;
 use omicron_test_utils::dev::test_setup_log;
 use oximeter_db::oxql::query::QueryAuthzScope;
@@ -13,6 +14,7 @@ use oximeter_test_utils::wait_for_keepers;
 use slog::{Logger, info};
 use std::collections::BTreeSet;
 use std::default::Default;
+use std::path::PathBuf;
 use std::time::Duration;
 
 pub struct TestInput {
@@ -38,6 +40,42 @@ impl TestInput {
     }
 }
 
+/// Ensure the oximeter database schemas for both single node and replicated
+/// cluster are not modified.
+///
+/// Schema changes for the `oximeter` database are currently disabled due to
+/// ongoing self-service update work. More information about this restriction
+/// can be found in https://github.com/oxidecomputer/omicron/issues/8862
+#[tokio::test]
+async fn test_schemas_are_not_modified() -> anyhow::Result<()> {
+    let cur_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
+    let single_node_schema_checksum =
+        file_checksum(cur_dir.as_path().join("schema/single-node/db-init.sql"))
+            .unwrap();
+    let replicated_schema_1_checksum = file_checksum(
+        cur_dir.as_path().join("schema/replicated/db-init-1.sql"),
+    )
+    .unwrap();
+    let replicated_schema_2_checksum = file_checksum(
+        cur_dir.as_path().join("schema/replicated/db-init-2.sql"),
+    )
+    .unwrap();
+
+    assert_eq!(
+        "1422131e72b3410b7f4520bf72a213f0c3288ce8cd738a0010b1bf44edea480a",
+        single_node_schema_checksum
+    );
+    assert_eq!(
+        "038ca7fc66006d6c06243a6fa122cf2f0bfee6edf55227e13166a9b854169abb",
+        replicated_schema_1_checksum
+    );
+    assert_eq!(
+        "d78c49e5662a2bd211eba63cc71a33bffacca7c6a80d9090532329650c6baae0",
+        replicated_schema_2_checksum
+    );
+    Ok(())
+}
+
 /// Ensure `db-init-1.sql` and `db-init-2.sql` contain disjoint sets of tables.
 #[tokio::test]
 async fn test_schemas_disjoint() -> anyhow::Result<()> {

oximeter/db/tests/integration_test.rs

@@ -36,6 +36,7 @@ tokio-postgres.workspace = true
 usdt.workspace = true
 rcgen.workspace = true
 reqwest.workspace = true
+sha2.workspace = true
 walkdir.workspace = true
 omicron-workspace-hack.workspace = true
 uuid.workspace = true

test-utils/Cargo.toml

@@ -22,8 +22,12 @@ use dropshot::ConfigLoggingIfExists;
 use dropshot::ConfigLoggingLevel;
 pub use dropshot::test_util::LogContext;
 use omicron_common::disk::DiskIdentity;
+use sha2::Digest;
+use sha2::Sha256;
 use slog::Logger;
 use std::io::BufReader;
+use std::io::Read;
+use std::path::PathBuf;
 
 /// The environment variable via which the path to the seed tarball is passed.
 pub static CRDB_SEED_TAR_ENV: &str = "CRDB_SEED_TAR";
@@ -160,3 +164,20 @@ pub fn mock_disk_identity() -> DiskIdentity {
         model: "MOCKMODEL".to_string(),
     }
 }
+
+/// Returns the sha2 checksum of a file at `path`.
+pub fn file_checksum(path: PathBuf) -> Result<String> {
+    let mut digest = Sha256::new();
+    let mut buf = vec![0; 1024];
+    let mut file = std::fs::File::open(path)?;
+
+    loop {
+        let n = file.read(&mut buf)?;
+        if n == 0 {
+            break;
+        }
+        digest.update(&buf[..n]);
+    }
+
+    Ok(format!("{:x}", digest.finalize()))
+}