-
Notifications
You must be signed in to change notification settings - Fork 296
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'kpop/CON-1057/manifest-splitting-v2' into 'master'
feat(ic-recovery): [CON-1057] Add a "ComputeExpectedManifests" step to the subnet splitting tool It works by calling the `state-tool` several times. Closes CON-1057 Closes CON-1057 See merge request dfinity-lab/public/ic!13133
- Loading branch information
Showing
11 changed files
with
300 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| use crate::utils::canister_id_ranges_to_strings; | ||
|
|
||
| use ic_base_types::SubnetId; | ||
| use ic_recovery::{ | ||
| error::{RecoveryError, RecoveryResult}, | ||
| file_sync_helper::{download_binary, path_exists, write_bytes}, | ||
| util::block_on, | ||
| }; | ||
| use ic_registry_routing_table::CanisterIdRange; | ||
| use ic_types::ReplicaVersion; | ||
| use slog::{info, Logger}; | ||
|
|
||
| use std::{ | ||
| iter::once, | ||
| path::{Path, PathBuf}, | ||
| process::{Command, Stdio}, | ||
| }; | ||
|
|
||
| const BINARY_NAME: &str = "state-tool"; | ||
|
|
||
| /// Helper struct to simplify executing the `state-tool` binary. | ||
| #[derive(Clone)] | ||
| pub(crate) struct StateToolHelper { | ||
| bin_dir: PathBuf, | ||
| logger: Logger, | ||
| } | ||
|
|
||
| impl StateToolHelper { | ||
| /// Creates a new instance of the [StateToolHelper]. | ||
| /// | ||
| /// If necessary, it will download the `state-tool` binary. | ||
| pub(crate) fn new( | ||
| bin_dir: PathBuf, | ||
| replica_version: Option<ReplicaVersion>, | ||
| logger: Logger, | ||
| ) -> RecoveryResult<Self> { | ||
| let state_tool_helper = Self { bin_dir, logger }; | ||
|
|
||
| state_tool_helper | ||
| .download_if_necessary(replica_version) | ||
| .map(|_| state_tool_helper) | ||
| } | ||
|
|
||
| /// Computes manifest of a checkpoint. | ||
| /// | ||
| /// Calls `state-tool manifest --state $dir > $output_path`. | ||
| pub(crate) fn compute_manifest(&self, dir: &Path, output_path: &Path) -> RecoveryResult<()> { | ||
| self.execute("manifest", Some(output_path), |command| { | ||
| command.args(["--state", dir.display().to_string().as_str()]) | ||
| }) | ||
| } | ||
|
|
||
| /// Splits a manifest, to verify the manifests resulting from a subnet split. | ||
| /// | ||
| /// Calls `state-tool split_manifest --path $manifest_path --from-subnet $source_subnet | ||
| /// --to_subnet $destination_subnet --subnet-type application --migrated-ranges | ||
| /// $canister_id_range`c. | ||
| pub(crate) fn split_manifest( | ||
| &self, | ||
| manifest_path: &Path, | ||
| source_subnet: SubnetId, | ||
| destination_subnet: SubnetId, | ||
| canister_id_ranges: &[CanisterIdRange], | ||
| output_path: &Path, | ||
| ) -> RecoveryResult<()> { | ||
| self.execute("split_manifest", Some(output_path), |command| { | ||
| command | ||
| .args(["--path", manifest_path.display().to_string().as_str()]) | ||
| .args(["--from-subnet", source_subnet.to_string().as_str()]) | ||
| .args(["--to-subnet", destination_subnet.to_string().as_str()]) | ||
| .args(["--subnet-type", "application"]) | ||
| .args( | ||
| once("--migrated-ranges".to_string()) | ||
| .chain(canister_id_ranges_to_strings(canister_id_ranges).into_iter()), | ||
| ) | ||
| }) | ||
| } | ||
|
|
||
| /// Verifies whether the textual representation of a manifest matches its root hash. | ||
| /// | ||
| /// Calls `state-tool verify_manifest --file $manifest_path`. | ||
| pub(crate) fn verify_manifest(&self, manifest_path: &Path) -> RecoveryResult<()> { | ||
| self.execute("verify_manifest", /*output_path=*/ None, |command| { | ||
| command.args(["--file", manifest_path.display().to_string().as_str()]) | ||
| }) | ||
| } | ||
|
|
||
| fn execute( | ||
| &self, | ||
| main_argument: &str, | ||
| output_path: Option<&Path>, | ||
| command_builder: impl Fn(&mut Command) -> &mut Command, | ||
| ) -> RecoveryResult<()> { | ||
| let mut command = Command::new(self.binary_path()); | ||
| command.arg(main_argument).stderr(Stdio::inherit()); | ||
| command_builder(&mut command); | ||
|
|
||
| info!(self.logger, "Executing {:?}", command); | ||
|
|
||
| let output = command.output().map_err(|e| { | ||
| RecoveryError::StateToolError(format!("Failed executing the command, error: {}", e)) | ||
| })?; | ||
|
|
||
| if !output.status.success() { | ||
| return Err(RecoveryError::StateToolError(format!( | ||
| "The command returned non-zero value: {}", | ||
| output.status, | ||
| ))); | ||
| } | ||
|
|
||
| info!( | ||
| self.logger, | ||
| "Succeeded executing the command:\n{}", | ||
| String::from_utf8_lossy(&output.stdout) | ||
| ); | ||
|
|
||
| if let Some(output_path) = output_path { | ||
| write_bytes(output_path, output.stdout)?; | ||
| } | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| fn download_if_necessary(&self, replica_version: Option<ReplicaVersion>) -> RecoveryResult<()> { | ||
| if path_exists(&self.binary_path())? { | ||
| info!( | ||
| self.logger, | ||
| "{} already exists, skipping download", | ||
| &self.binary_path().display(), | ||
| ); | ||
|
|
||
| return Ok(()); | ||
| } | ||
|
|
||
| if let Some(version) = replica_version { | ||
| block_on(download_binary( | ||
| &self.logger, | ||
| version, | ||
| BINARY_NAME.to_string(), | ||
| &self.bin_dir, | ||
| )) | ||
| .map(|_| ()) | ||
| } else { | ||
| info!( | ||
| self.logger, | ||
| "No state-tool version provided, skipping download." | ||
| ); | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| fn binary_path(&self) -> PathBuf { | ||
| self.bin_dir.join(BINARY_NAME) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.