Fix try-runtime follow-chain, try-runtime upgrade tuple tests, cli test utils (#13794)

* new test for try-runtime tuple stuff

* fix

* remove development comment

* formatting

* remove todo comment

* follow-chain working test

* refactor common cli testing utils

* fix comment

* revert Cargo.lock changes

* update Cargo.lock

* improve doc comment

* fix error typo

* update Cargo.lock

* feature gate try-runtime test

* build_substrate cli test util

* feature gate follow_chain tests

* move fn start_node to test-utils

* improve test pkg name

* use tokio Child and Command

* remove redundant import

* fix ci

* fix ci

* don't leave hanging processes

* improved child process cleanup

* use existing KillChildOnDrop

* remove redundant comment

* Update test-utils/cli/src/lib.rs

Co-authored-by: Koute <koute@users.noreply.github.com>

---------

Co-authored-by: kianenigma <kian@parity.io>
Co-authored-by: Koute <koute@users.noreply.github.com>

substrate/utils/frame/try-runtime/cli/Cargo.toml

@@ -45,10 +45,10 @@ serde_json = "1.0.85"
 zstd = { version = "0.11.2", default-features = false }
 
 [dev-dependencies]
-tokio = "1.22.0"
+assert_cmd = "2.0.10"
+regex = "1.7.3"
+substrate-cli-test-utils = { path = "../../../../test-utils/cli" }
+tokio = "1.27.0"
 
 [features]
-try-runtime = [
-	"sp-debug-derive/force-debug",
-	"frame-try-runtime/try-runtime",
-]
+try-runtime = ["sp-debug-derive/force-debug", "frame-try-runtime/try-runtime"]

substrate/utils/frame/try-runtime/cli/src/commands/follow_chain.rs

@@ -108,10 +108,12 @@ where
 				.or_else(|e| {
 					if matches!(e, substrate_rpc_client::Error::ParseError(_)) {
 						log::error!(
+							target: LOG_TARGET,
 							"failed to parse the block format of remote against the local \
-						codebase. The block format has changed, and follow-chain cannot run in \
-						this case. Try running this command in a branch of your codebase that has \
-						the same block format as the remote chain. For now, we replace the block with an empty one"
+							codebase. The block format has changed, and follow-chain cannot run in \
+							this case. Try running this command in a branch of your codebase that
+							has the same block format as the remote chain. For now, we replace the \
+							block with an empty one."
 						);
 					}
 					Err(rpc_err_handler(e))
@@ -148,7 +150,9 @@ where
 			state_ext,
 			&executor,
 			"TryRuntime_execute_block",
-			(block, command.state_root_check, command.try_state.clone()).encode().as_ref(),
+			(block, command.state_root_check, true, command.try_state.clone())
+				.encode()
+				.as_ref(),
 			full_extensions(executor.clone()),
 			shared
 				.export_proof

substrate/utils/frame/try-runtime/cli/tests/follow_chain.rs

@@ -0,0 +1,65 @@
+// This file is part of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+#![cfg(unix)]
+
+#[cfg(feature = "try-runtime")]
+mod tests {
+	use assert_cmd::cargo::cargo_bin;
+	use regex::Regex;
+	use std::{
+		process::{self},
+		time::Duration,
+	};
+	use substrate_cli_test_utils as common;
+	use tokio::process::{Child, Command};
+
+	#[tokio::test]
+	async fn follow_chain_works() {
+		// Build substrate so binaries used in the test use the latest code.
+		common::build_substrate(&["--features=try-runtime"]);
+
+		common::run_with_timeout(Duration::from_secs(60), async move {
+			fn start_follow(ws_url: &str) -> Child {
+				Command::new(cargo_bin("substrate"))
+					.stdout(process::Stdio::piped())
+					.stderr(process::Stdio::piped())
+					.args(&["try-runtime", "--runtime=existing"])
+					.args(&["follow-chain", format!("--uri={}", ws_url).as_str()])
+					.kill_on_drop(true)
+					.spawn()
+					.unwrap()
+			}
+
+			// Start a node and wait for it to begin finalizing blocks
+			let mut node = common::KillChildOnDrop(common::start_node());
+			let ws_url = common::extract_info_from_output(node.stderr.take().unwrap()).0.ws_url;
+			common::wait_n_finalized_blocks(1, &ws_url).await;
+
+			// Kick off the follow-chain process and wait for it to process at least 3 blocks.
+			let mut follow = start_follow(&ws_url);
+			let re = Regex::new(r#".*executed block ([3-9]|[1-9]\d+).*"#).unwrap();
+			let matched =
+				common::wait_for_stream_pattern_match(follow.stderr.take().unwrap(), re).await;
+
+			// Assert that the follow-chain process has followed at least 3 blocks.
+			assert!(matches!(matched, Ok(_)));
+		})
+		.await;
+	}
+}