Migration testing runtime API/Bot (#8038)

* A clean new attempt * Checkpoint to move remote. * A lot of dependency wiring to make it feature gated. * bad macro, bad macro. * Undo the DB mess. * Update frame/support/src/traits.rs Co-authored-by: Alexander Popiak <alexander.popiak@parity.io> * Apply suggestions from code review Co-authored-by: Alexander Popiak <alexander.popiak@parity.io> * unbreak the build * Update frame/try-runtime/src/lib.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update utils/frame/try-runtime/cli/Cargo.toml Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> * Update frame/try-runtime/Cargo.toml Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> * Address most review grumbles. * Fix build * Add some comments * Remove allowing one pallet at a time. * More grumbles. * relocate remote-ext * Fix build Co-authored-by: Alexander Popiak <alexander.popiak@parity.io> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
2026-04-26 07:37:57 +00:00 · 2021-02-19 14:52:09 +00:00
parent 82e52b8be8
commit 16a27c28a9
24 changed files with 991 additions and 40 deletions
@@ -0,0 +1,32 @@
+[package]
+name = "try-runtime-cli"
+version = "0.9.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+edition = "2018"
+license = "Apache-2.0"
+homepage = "https://substrate.dev"
+repository = "https://github.com/paritytech/substrate/"
+description = "Cli command runtime testing and dry-running"
+readme = "README.md"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+log = "0.4.8"
+parity-scale-codec = { version = "2.0.0" }
+
+sc-service = { version = "0.9.0", default-features = false, path = "../../../../client/service" }
+sc-cli = { version = "0.9.0", path = "../../../../client/cli" }
+sc-executor = { path = "../../../../client/executor" }
+sc-client-api = { version = "3.0.0", path = "../../../../client/api" }
+structopt = "0.3.8"
+sp-state-machine = { version = "0.9.0", path = "../../../../primitives/state-machine" }
+sp-api = { version = "3.0.0", path = "../../../../primitives/api" }
+sp-blockchain = { version = "3.0.0", path = "../../../../primitives/blockchain" }
+sp-runtime = { version = "3.0.0", path = "../../../../primitives/runtime" }
+sp-externalities = { version = "0.9.0", path = "../../../../primitives/externalities" }
+sp-core = { version = "3.0.0", path = "../../../../primitives/core" }
+frame-try-runtime = { version = "0.9.0", path = "../../../../frame/try-runtime" }
+
+remote-externalities = { path = "../../remote-externalities" }
@@ -0,0 +1,178 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2021 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! `Structopt`-ready struct for `try-runtime`.
+
+use parity_scale_codec::Decode;
+use std::{fmt::Debug, str::FromStr};
+use sc_service::Configuration;
+use sc_cli::{CliConfiguration, ExecutionStrategy, WasmExecutionMethod};
+use sc_executor::NativeExecutor;
+use sc_service::NativeExecutionDispatch;
+use sp_state_machine::StateMachine;
+use sp_runtime::traits::{Block as BlockT, NumberFor};
+use sp_core::storage::{StorageData, StorageKey, well_known_keys};
+
+/// Various commands to try out the new runtime, over configurable states.
+///
+/// For now this only assumes running the `on_runtime_upgrade` hooks.
+#[derive(Debug, structopt::StructOpt)]
+pub struct TryRuntimeCmd {
+	/// The shared parameters
+	#[allow(missing_docs)]
+	#[structopt(flatten)]
+	pub shared_params: sc_cli::SharedParams,
+
+	/// The state to use to run the migration. Should be a valid FILE or HTTP URI.
+	#[structopt(short, long, default_value = "http://localhost:9933")]
+	pub state: State,
+
+	/// The execution strategy that should be used for benchmarks
+	#[structopt(
+		long = "execution",
+		value_name = "STRATEGY",
+		possible_values = &ExecutionStrategy::variants(),
+		case_insensitive = true,
+		default_value = "Native",
+	)]
+	pub execution: ExecutionStrategy,
+
+	/// Method for executing Wasm runtime code.
+	#[structopt(
+		long = "wasm-execution",
+		value_name = "METHOD",
+		possible_values = &WasmExecutionMethod::enabled_variants(),
+		case_insensitive = true,
+		default_value = "Interpreted"
+	)]
+	pub wasm_method: WasmExecutionMethod,
+}
+
+/// The state to use for a migration dry-run.
+#[derive(Debug)]
+pub enum State {
+	/// A snapshot. Inner value is a file path.
+	Snap(String),
+
+	/// A live chain. Inner value is the HTTP uri.
+	Live(String),
+}
+
+impl FromStr for State {
+	type Err = &'static str;
+	fn from_str(s: &str) -> Result<Self, Self::Err> {
+		match s.get(..7) {
+			// could use Url crate as well, but lets keep it simple for now.
+			Some("http://") => Ok(State::Live(s.to_string())),
+			Some("file://") => s
+				.split("//")
+				.collect::<Vec<_>>()
+				.get(1)
+				.map(|s| State::Snap(s.to_string()))
+				.ok_or("invalid file URI"),
+			_ => Err("invalid format. Must be a valid HTTP or File URI"),
+		}
+	}
+}
+
+impl TryRuntimeCmd {
+	pub async fn run<B, ExecDispatch>(&self, config: Configuration) -> sc_cli::Result<()>
+	where
+		B: BlockT,
+		ExecDispatch: NativeExecutionDispatch + 'static,
+	{
+		let spec = config.chain_spec;
+		let genesis_storage = spec.build_storage()?;
+
+		let code = StorageData(
+			genesis_storage
+				.top
+				.get(well_known_keys::CODE)
+				.expect("code key must exist in genesis storage; qed")
+				.to_vec(),
+		);
+		let code_key = StorageKey(well_known_keys::CODE.to_vec());
+
+		let wasm_method = self.wasm_method;
+		let execution = self.execution;
+
+		let mut changes = Default::default();
+		// don't really care about these -- use the default values.
+		let max_runtime_instances = config.max_runtime_instances;
+		let heap_pages = config.default_heap_pages;
+		let executor = NativeExecutor::<ExecDispatch>::new(
+			wasm_method.into(),
+			heap_pages,
+			max_runtime_instances,
+		);
+
+		let ext = {
+			use remote_externalities::{Builder, Mode, CacheConfig, OfflineConfig, OnlineConfig};
+			let builder = match &self.state {
+				State::Snap(file_path) => Builder::new().mode(Mode::Offline(OfflineConfig {
+					cache: CacheConfig { name: file_path.into(), ..Default::default() },
+				})),
+				State::Live(http_uri) => Builder::new().mode(Mode::Online(OnlineConfig {
+					uri: http_uri.into(),
+					..Default::default()
+				})),
+			};
+
+			// inject the code into this ext.
+			builder.inject(&[(code_key, code)]).build().await
+		};
+
+		let encoded_result = StateMachine::<_, _, NumberFor<B>, _>::new(
+			&ext.backend,
+			None,
+			&mut changes,
+			&executor,
+			"TryRuntime_on_runtime_upgrade",
+			&[],
+			ext.extensions,
+			&sp_state_machine::backend::BackendRuntimeCode::new(&ext.backend)
+				.runtime_code()?,
+			sp_core::testing::TaskExecutor::new(),
+		)
+		.execute(execution.into())
+		.map_err(|e| format!("failed to execute 'TryRuntime_on_runtime_upgrade' due to {:?}", e))?;
+
+		let (weight, total_weight) = <(u64, u64) as Decode>::decode(&mut &*encoded_result)
+			.map_err(|e| format!("failed to decode output due to {:?}", e))?;
+		log::info!(
+			"try-runtime executed without errors. Consumed weight = {}, total weight = {} ({})",
+			weight,
+			total_weight,
+			weight as f64 / total_weight as f64
+		);
+
+		Ok(())
+	}
+}
+
+impl CliConfiguration for TryRuntimeCmd {
+	fn shared_params(&self) -> &sc_cli::SharedParams {
+		&self.shared_params
+	}
+
+	fn chain_id(&self, _is_dev: bool) -> sc_cli::Result<String> {
+		Ok(match self.shared_params.chain {
+			Some(ref chain) => chain.clone(),
+			None => "dev".into(),
+		})
+	}
+}