Migration testing runtime API/Bot

.gitignore

@@ -23,3 +23,4 @@ rls*.log
 **/hfuzz_workspace/
 .cargo/
 .cargo-remote.toml
+*.bin

Cargo.toml

@@ -186,6 +186,9 @@ members = [
 	"utils/fork-tree",
 	"utils/frame/benchmarking-cli",
 	"utils/frame/frame-utilities-cli",
+	"utils/frame/dry-run-runtime-upgrade/remote-externalities",
+	"utils/frame/dry-run-runtime-upgrade/cli",
+	"utils/frame/dry-run-runtime-upgrade/api",
 	"utils/frame/rpc/support",
 	"utils/frame/rpc/system",
 	"utils/prometheus",

bin/node/cli/Cargo.toml

@@ -99,6 +99,7 @@ node-executor = { version = "2.0.0", path = "../executor" }
 sc-cli = { version = "0.8.0", optional = true, path = "../../../client/cli" }
 frame-benchmarking-cli = { version = "2.0.0", optional = true, path = "../../../utils/frame/benchmarking-cli" }
 node-inspect = { version = "0.8.0", optional = true, path = "../inspect" }
+dry-run-runtime-upgrade-cli = { version = "2.0.0", optional = true, path = "../../../utils/frame/dry-run-runtime-upgrade/cli" }
 
 # WASM-specific dependencies
 wasm-bindgen = { version = "0.2.57", optional = true }
@@ -131,6 +132,7 @@ node-inspect = { version = "0.8.0", optional = true, path = "../inspect" }
 frame-benchmarking-cli = { version = "2.0.0", optional = true, path = "../../../utils/frame/benchmarking-cli" }
 substrate-build-script-utils = { version = "2.0.0", optional = true, path = "../../../utils/build-script-utils" }
 substrate-frame-cli = { version = "2.0.0", optional = true, path = "../../../utils/frame/frame-utilities-cli" }
+dry-run-runtime-upgrade-cli = { version = "2.0.0", optional = true, path = "../../../utils/frame/dry-run-runtime-upgrade/cli" }
 
 [build-dependencies.sc-cli]
 version = "0.8.0"
@@ -155,6 +157,7 @@ cli = [
 	"sc-finality-grandpa-warp-sync",
 	"structopt",
 	"substrate-build-script-utils",
+	"dry-run-runtime-upgrade-cli",
 ]
 runtime-benchmarks = [
 	"node-runtime/runtime-benchmarks",

bin/node/cli/src/cli.rs

@@ -47,6 +47,9 @@ pub enum Subcommand {
 	#[structopt(name = "benchmark", about = "Benchmark runtime pallets.")]
 	Benchmark(frame_benchmarking_cli::BenchmarkCmd),
 
+	/// DryRun all of the runtime upgrade hooks in the current runtime upon a configurable state.
+	DryRunRuntimeUpgrade(dry_run_runtime_upgrade_cli::DryRunCmd),
+
 	/// Verify a signature for a message, provided on STDIN, with a given (public or secret) key.
 	Verify(VerifyCmd),
 

bin/node/cli/src/command.rs

@@ -149,5 +149,12 @@ pub fn run() -> Result<()> {
 				Ok((cmd.run(client, backend), task_manager))
 			})
 		},
+		Some(Subcommand::DryRun(cmd)) => {
+			let runner = cli.create_runner(cmd)?;
+			runner.async_run(|config| {
+				let PartialComponents { task_manager, .. } = new_partial(&config)?;
+				Ok((cmd.run::<Block, Executor>(config), task_manager))
+			})
+		}
 	}
 }

bin/node/runtime/Cargo.toml

@@ -83,6 +83,10 @@ pallet-transaction-payment = { version = "2.0.0", default-features = false, path
 pallet-transaction-payment-rpc-runtime-api = { version = "2.0.0", default-features = false, path = "../../../frame/transaction-payment/rpc/runtime-api/" }
 pallet-vesting = { version = "2.0.0", default-features = false, path = "../../../frame/vesting" }
 
+dry-run-runtime-upgrade-api = { default-features = false, path = "../../../utils/frame/dry-run-runtime-upgrade/api" }
+# TODO: probably best to put this in some primitive pallet, among with types that need to be passed
+# back and forth.
+
 [build-dependencies]
 substrate-wasm-builder = { version = "3.0.0", path = "../../../utils/wasm-builder" }
 
@@ -151,6 +155,7 @@ std = [
 	"pallet-society/std",
 	"pallet-recovery/std",
 	"pallet-vesting/std",
+	"dry-run-runtime-upgrade-api/std",
 ]
 runtime-benchmarks = [
 	"frame-benchmarking",

bin/node/runtime/src/lib.rs

@@ -1078,7 +1078,14 @@ pub type SignedPayload = generic::SignedPayload<Call, SignedExtra>;
 /// Extrinsic type that has already been checked.
 pub type CheckedExtrinsic = generic::CheckedExtrinsic<AccountId, Call, SignedExtra>;
 /// Executive: handles dispatch to the various modules.
-pub type Executive = frame_executive::Executive<Runtime, Block, frame_system::ChainContext<Runtime>, Runtime, AllModules>;
+pub type Executive = frame_executive::Executive<
+	Runtime,
+	Block,
+	frame_system::ChainContext<Runtime>,
+	Runtime,
+	AllModules,
+	(),
+>;
 
 /// MMR helper types.
 mod mmr {
@@ -1323,15 +1330,39 @@ impl_runtime_apis! {
 		}
 	}
 
+	// TODO: make everything feature gated.
+	impl dry_run_runtime_upgrade_api::DryRunRuntimeUpgrade<Block> for Runtime {
+		fn dry_run_runtime_upgrade() -> Weight {
+			frame_support::debug::RuntimeLogger::init();
+			frame_support::debug::info!("!!! DRYRUN MIGRATION UP AHEAD !!!");
+			let weight = Executive::dry_run_runtime_upgrade();
+			frame_support::debug::info!("!!! DRYRUN MIGRATION DONE !!!");
+			weight
+
+			// \migration_bot pallet:staking state:polkadot
+			// pseudo code:
+			// match config.pallet {
+			// 	"System" => {
+			// 		<Pallet as OnRuntimeUpgrade>::pre_migration();
+			// 		<Pallet as OnRuntimeUpgrade>::on_runtime_upgrade();
+			// 		<Pallet as OnRuntimeUpgrade>::post_migration();
+			// 	},
+			// 	"All" => {
+			// 		Executive::dry_run_runtime_upgrade()
+			// 	}
+			// }
+		}
+	}
+
 	#[cfg(feature = "runtime-benchmarks")]
 	impl frame_benchmarking::Benchmark<Block> for Runtime {
 		fn dispatch_benchmark(
 			config: frame_benchmarking::BenchmarkConfig
 		) -> Result<Vec<frame_benchmarking::BenchmarkBatch>, sp_runtime::RuntimeString> {
 			use frame_benchmarking::{Benchmarking, BenchmarkBatch, add_benchmark, TrackedStorageKey};
-			// Trying to add benchmarks directly to the Session Pallet caused cyclic dependency issues.
-			// To get around that, we separated the Session benchmarks into its own crate, which is why
-			// we need these two lines below.
+			// Trying to add benchmarks directly to the Session Pallet caused cyclic dependency
+			// issues. To get around that, we separated the Session benchmarks into its own crate,
+			// which is why we need these two lines below.
 			use pallet_session_benchmarking::Module as SessionBench;
 			use pallet_offences_benchmarking::Module as OffencesBench;
 			use frame_system_benchmarking::Module as SystemBench;