feat: testing environment.

Author: l-monninger

Cargo.lock

@@ -216,6 +216,14 @@ movement-aptos-core = { path = "util/movement-aptos/core" }
 movement-aptos-core-util = { path = "util/movement-aptos/core-util" }
 mtma-types = { path = "util/types" }
 
+## Environments
+### util
+mtma-environment-types = { path = "environments/util/types" }
+### core
+mtma-testing-environment = { path = "environments/core/testing" }
+mtma-provisioner-environment = { path = "environments/core/provisioner" }
+mtma-box-environment = { path = "environments/box/provisioner" }
+
 [workspace.lints.clippy]
 debug_assert_with_mut_call = "deny"
 inefficient_to_string = "deny"

Cargo.toml

@@ -35,6 +35,8 @@ movement-signer-loader = { workspace = true }
 hex = { workspace = true }
 mtma-types = { workspace = true }
 movement-core = { workspace = true }
+mtma-environment-types = { workspace = true }
+kestrel = { workspace = true }
 
 [lints]
 workspace = true

environments/core/testing/Cargo.toml

@@ -1,7 +1,7 @@
 /// Contains the configuration structs and logic for the migration.
 pub mod config;
 /// Contains the logic for the migration.
-pub mod migrate;
+pub mod environment;
 
 pub use config::*;
-pub use migrate::*;
+pub use environment::*;

environments/core/testing/src/migrate.rs renamed to environments/core/testing/src/environment.rs

@@ -0,0 +1,28 @@
+use crate::TestingEnvironment;
+use clap::Parser;
+use serde::{Deserialize, Serialize};
+use std::fmt::Debug;
+
+/// Errors thrown when working with the [Config].
+#[derive(Debug, thiserror::Error)]
+pub enum EnvironmentConfigError {
+	#[error("failed to build from config: {0}")]
+	Build(#[source] Box<dyn std::error::Error + Send + Sync>),
+}
+
+/// The config for the [TestingEnvironment].
+///
+/// All fields should be easily statically encodable to a CLI argument.
+/// This is the frontend for the core API.
+#[derive(Parser, Debug, Serialize, Deserialize, Clone, Default)]
+#[clap(help_expected = true)]
+pub struct Config {}
+
+impl Config {
+	/// Builds the [TestingEnvironment] struct from the config.
+	///
+	/// Note: preserving faillibility here because we may add debug path configuration to the [TestingEnvironment] soon.
+	pub fn build(&self) -> Result<TestingEnvironment, EnvironmentConfigError> {
+		Ok(TestingEnvironment::new())
+	}
+}

environments/core/testing/src/environment/config.rs

@@ -0,0 +1,58 @@
+use anyhow::Context;
+use movement_core::Overlays;
+use mtma_environment_types::{EnvironmentError, Environmentish};
+use mtma_migrator_types::migrator::MovementMigrator;
+use std::fmt::Debug;
+
+/// Errors thrown when using the [TestingEnvironment].
+#[derive(Debug, thiserror::Error)]
+pub enum TestingEnvironmentError {
+	#[error("Testing Environment: failed with an internal error: {0}")]
+	Internal(#[source] Box<dyn std::error::Error + Send + Sync>),
+}
+
+impl From<TestingEnvironmentError> for EnvironmentError {
+	fn from(e: TestingEnvironmentError) -> Self {
+		EnvironmentError::Internal(e.into())
+	}
+}
+
+pub struct TestingEnvironment {}
+
+impl TestingEnvironment {
+	pub fn new() -> Self {
+		Self {}
+	}
+}
+
+impl Environmentish for TestingEnvironment {
+	async fn build_movement_migrator(&self) -> Result<MovementMigrator, EnvironmentError> {
+		// Form the migrator.
+		let mut movement_migrator = MovementMigrator::try_temp()
+			.map_err(|e| TestingEnvironmentError::Internal(e.into()))?;
+		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",
+		).map_err(|e| TestingEnvironmentError::Internal(e.into()))?;
+
+		kestrel::end!(movement_migrator_task)
+			.context("failed to end movement migrator task")
+			.map_err(|e| TestingEnvironmentError::Internal(e.into()))?;
+
+		Ok(movement_migrator)
+	}
+}

environments/core/testing/src/environment/environment.rs

@@ -1,2 +1,2 @@
-pub mod migrate;
-pub use migrate::*;
+pub mod environment;
+pub use environment::*;