Merge pull request #105 from movementlabsxyz/l-monninger/accounts-citerion-redux

chore: second stage of balances criterion merge

Author: l-monninger

Cargo.lock

@@ -189,9 +189,11 @@ mtma-node-test-global-storage-includes-criterion = { path = "checks/node/citeria
 mtma-node-test-global-storage-not-empty-criterion = { path = "checks/node/citeria/global-storage-not-empty" }
 
 
-### e2e
+### migrator
 mtma-migrator-test-types = { path = "checks/migrator/util/types" }
 mtma-migrator-test-accounts-equal-criterion = { path = "checks/migrator/citeria/accounts-equal" }
+mtma-migrator-test-balances-equal-criterion = { path = "checks/migrator/citeria/balances-equal" }
+
 ## util
 bcs-ext = { path = "util/bcs-ext" }
 movement-syncing = { path = "util/movement/syncing" }

Cargo.toml

@@ -0,0 +1,34 @@
+[package]
+name = "mtma-migrator-balances-equal"
+version = { workspace = true }
+edition = { workspace = true }
+license = { workspace = true }
+authors = { workspace = true }
+homepage = { workspace = true }
+publish = { workspace = true }
+rust-version = { workspace = true }
+
+[dependencies]
+mtma-types = { workspace = true }
+mtma-migrator-types = { workspace = true }
+mtma-migrator-test-types = { workspace = true }
+anyhow = { workspace = true }
+mtma-node-replay-core = { workspace = true }
+mtma-node-test-global-storage-injective-criterion = { workspace = true }
+mtma-node-test-global-storage-includes-criterion = { workspace = true }
+mtma-node-test-global-storage-not-empty-criterion = { workspace = true }
+mtma-migrator-test-balances-equal-criterion = { workspace = true }
+mtma-node-preludes = { workspace = true }
+mtma-node-null-core = { workspace = true }
+tokio = { workspace = true }
+chrono = { workspace = true }
+rand = { workspace = true }
+kestrel = { workspace = true }
+mtma-node-test-types = { workspace = true }
+
+[dev-dependencies]
+tracing-test = { workspace = true }
+tracing = { workspace = true }
+
+[lints]
+workspace = true

checks/migrator/checks/balances-equal/Cargo.toml

@@ -0,0 +1,2 @@
+# Migration Executor Checks Sketchpad
+A sketchpad for playing around with checks on the testpad. 

checks/migrator/checks/balances-equal/README.md

@@ -0,0 +1,73 @@
+#[cfg(test)]
+pub mod test {
+
+	use anyhow::Context;
+	use mtma_migrator_test_balances_equal_criterion::BalancesEqual;
+	use mtma_migrator_test_types::check::checked_migration;
+	use mtma_migrator_types::migrator::{movement_migrator::Overlays, MovementMigrator};
+	use mtma_node_null_core::config::Config as MtmaNullConfig;
+	use mtma_node_test_types::prelude::Prelude;
+	use tracing::info;
+
+	#[tokio::test(flavor = "multi_thread")]
+	#[tracing_test::traced_test]
+	async fn test_balances_equal() -> Result<(), anyhow::Error> {
+		// use a scope to ensure everything is dropped
+		{
+			// Form the migrator.
+			let mut movement_migrator = MovementMigrator::try_temp()?;
+			movement_migrator.set_overlays(Overlays::default());
+
+			// Start the migrator so that it's running in the background.
+			// In the future, some migrators may be for already running nodes.
+			let movement_migrator_for_task = movement_migrator.clone();
+			let movement_migrator_task = kestrel::task(async move {
+				movement_migrator_for_task.run().await?;
+				Ok::<_, anyhow::Error>(())
+			});
+
+			// wait for the rest client to be ready
+			// once we have this, there should also be a config, so we can then kill off the migrator and proceed
+			movement_migrator
+			.wait_for_rest_client_ready(tokio::time::Duration::from_secs(600)) // we wait for up to ten minutes because the nix flake in .vendors/movementcan be a bit slow the first time
+			.await
+			.context(
+				"failed to wait for movement migrator rest client while running accounts equal manual prelude",
+			)?;
+
+			kestrel::end!(movement_migrator_task)?;
+
+			// Form the prelude.
+			// todo: this needs to be updated to use the prelude generator
+			let prelude = Prelude::new_empty();
+
+			// Form the migration.
+			let migration_config = MtmaNullConfig::default();
+			let migration = migration_config.build()?;
+
+			// Run the checked migration.
+			let balances_equal = BalancesEqual::new();
+			info!("Running migration");
+			match checked_migration(
+				&mut movement_migrator,
+				&prelude,
+				&migration,
+				vec![balances_equal],
+			)
+			.await
+			{
+				Ok(()) => {}
+				Err(e) => {
+					info!("Migration failed: {:?}", e);
+					return Err(anyhow::anyhow!("Migration failed: {:?}", e));
+				}
+			}
+			info!("Migration succeeded");
+		}
+
+		// exit the test is fine when you only have one test per crate because when cargo test is run across a workspace, it actually multi-processes the tests by crate
+		std::process::exit(0);
+
+		Ok(())
+	}
+}

checks/migrator/checks/balances-equal/src/balances_equal.rs

@@ -0,0 +1 @@
+pub mod balances_equal;

checks/migrator/checks/balances-equal/src/lib.rs

@@ -0,0 +1,20 @@
+[package]
+name = "mtma-migrator-test-balances-equal-criterion"
+version = { workspace = true }
+edition = { workspace = true }
+license = { workspace = true }
+authors = { workspace = true }
+homepage = { workspace = true }
+publish = { workspace = true }
+rust-version = { workspace = true }
+
+[dependencies]
+mtma-migrator-test-types = { workspace = true }
+bcs = { workspace = true }
+bcs-ext = { workspace = true }
+tokio = { workspace = true }
+anyhow = { workspace = true }
+tracing = { workspace = true }
+
+[lints]
+workspace = true

checks/migrator/citeria/balances-equal/Cargo.toml

@@ -0,0 +1,2 @@
+# Balances Equal
+Checks that the balances in native coin for an account are equal. 

checks/migrator/citeria/balances-equal/README.md

@@ -0,0 +1,91 @@
+use anyhow::Context;
+use bcs_ext::{comparison::BcsEq, conversion::BcsInto};
+use mtma_migrator_test_types::criterion::{
+	Criterion, CriterionError, Criterionish, MovementAptosMigrator, MovementMigrator,
+};
+use tracing::info;
+
+pub struct BalancesEqual;
+
+impl BalancesEqual {
+	pub fn new() -> Self {
+		Self {}
+	}
+
+	pub fn criterion() -> Criterion<Self> {
+		Criterion::new(Self {})
+	}
+}
+
+impl Criterionish for BalancesEqual {
+	async fn satisfies(
+		&self,
+		movement_migrator: &MovementMigrator,
+		movement_aptos_migrator: &MovementAptosMigrator,
+	) -> Result<(), CriterionError> {
+		let movement_rest_client = movement_migrator
+			.wait_for_rest_client_ready(tokio::time::Duration::from_secs(30))
+			.await
+			.context(
+				"failed to wait for movement migrator rest client while checking accounts equal",
+			)
+			.map_err(|e| CriterionError::Internal(e.into()))?;
+		let movement_aptos_rest_client = movement_aptos_migrator
+			.wait_for_rest_client_ready(tokio::time::Duration::from_secs(30))
+			.await
+			.context("failed to wait for movement aptos migrator rest client while checking accounts equal")
+			.map_err(|e| CriterionError::Internal(e.into()))?;
+
+		let movement_node =
+			movement_migrator.node().await.map_err(|e| CriterionError::Internal(e.into()))?;
+
+		info!("Iterating over movement node accounts");
+		for account_address_res in movement_node
+			.iter_account_addresses(0)
+			.map_err(|e| CriterionError::Internal(e.into()))?
+		{
+			let account_address = match account_address_res
+				.context("account address is none")
+				.map_err(|e| CriterionError::Internal(e.into()))
+			{
+				Ok(account_address) => account_address,
+				Err(e) => {
+					info!("Transaction has no sender: {:?}", e);
+					continue;
+				}
+			};
+
+			info!("Getting movement account balance");
+			let movement_account_balance = movement_rest_client
+				.get_account_balance(account_address)
+				.await
+				.map_err(|e| {
+					CriterionError::Internal(format!("failed to get account: {:?}", e).into())
+				})?
+				.into_inner();
+
+			info!("Getting movement aptos address");
+			let movement_aptos_account_address =
+				account_address.bcs_into().map_err(|e| CriterionError::Internal(e.into()))?;
+
+			info!("Getting movement aptos account balance");
+			let movement_aptos_account_balance = movement_aptos_rest_client
+				.view_apt_account_balance(movement_aptos_account_address)
+				.await
+				.map_err(|e| {
+					CriterionError::Internal(format!("Failed to get account: {:?}", e).into())
+				})?
+				.into_inner();
+
+			info!("Comparing balances");
+			if u64::from(movement_account_balance.coin.value) != movement_aptos_account_balance {
+				return Err(CriterionError::Unsatisfied(
+					format!("movement and movement aptos account balances have different values: {:?} != {:?}", movement_account_balance, movement_aptos_account_balance).into(),
+				));
+			}
+			
+		}
+
+		Ok(())
+	}
+}