pop_chains/

errors.rs

// SPDX-License-Identifier: GPL-3.0

use thiserror::Error;
use zombienet_sdk::OrchestratorError;

/// Represents the various errors that can occur in the crate.
#[derive(Error, Debug)]
pub enum Error {
	/// The operation has been aborted due to an existing target directory.
	#[error("User aborted due to existing target directory.")]
	Aborted,
	/// An error occurred.
	#[error("Anyhow error: {0}")]
	AnyhowError(#[from] anyhow::Error),
	/// An error occurred while generating the chain specification.
	#[error("Failed to build the chain spec: {0}")]
	BuildSpecError(String),
	/// An error occurred while running benchmarking.
	#[error("Failed to run benchmarking: {0}")]
	BenchmarkingError(String),
	/// An error occurred while decoding the call data.
	#[error("Failed to decode call data: {0}")]
	CallDataDecodingError(String),
	/// An error occurred while encoding the call data.
	#[error("Failed to encode call data: {0}")]
	CallDataEncodingError(String),
	/// An error occurred.
	#[error("{0}")]
	CommonError(#[from] pop_common::Error),
	/// An error occurred while attempting to establish a connection to the endpoint.
	#[error("Failed to establish a connection to: {0}")]
	ConnectionFailure(String),
	/// A configuration error occurred.
	#[error("Configuration error: {0}")]
	Config(String),
	/// The current directory could not be accessed.
	#[error("Failed to access the current directory")]
	CurrentDirAccess,
	/// The endowment value could not be parsed.
	#[error("Failed to parse the endowment value")]
	EndowmentError,
	/// The specified event was not found.
	#[error("Event {0} not found.")]
	EventNotFound(String),
	/// An error occurred during the submission of an extrinsic.
	#[error("Extrinsic submission error: {0}")]
	ExtrinsicSubmissionError(String),
	/// The callable item is not supported.
	#[error("The callable item is not supported")]
	CallableNotSupported,
	/// Function not found.
	#[error("Function not found: {0}")]
	FunctionNotFound(String),
	/// An error occurred while working with the genesis builder.
	#[error("Genesis builder error: {0}")]
	GenesisBuilderError(String),
	/// Failed to retrieve the image tag.
	#[error("Failed to retrieve image tag.")]
	ImageTagRetrievalFailed,
	/// An IO error occurred.
	#[error("IO error: {0}")]
	IO(#[from] std::io::Error),
	/// A JSON error occurred.
	#[error("JSON error: {0}")]
	JsonError(#[from] serde_json::Error),
	/// An error occurred while parsing metadata of a parameter.
	#[error("Error parsing metadata for parameter: {0}")]
	MetadataParsingError(String),
	/// A binary is missing.
	#[error("Missing binary: {0}")]
	MissingBinary(String),
	/// A chain spec is missing.
	#[error("Missing chain spec file at: {0}")]
	MissingChainSpec(String),
	/// A required command does not exist.
	#[error("Command {command} doesn't exist in binary {binary}")]
	MissingCommand {
		/// The required command.
		command: String,
		/// The binary used.
		binary: String,
	},
	/// A network configuration error occurred.
	#[error("Configuration error: {0:?}")]
	NetworkConfigurationError(Vec<anyhow::Error>),
	/// An orchestrator error occurred.
	#[error("Orchestrator error: {0}")]
	OrchestratorError(#[from] OrchestratorError),
	/// The attempt to create a pallet directory failed.
	#[error("Failed to create pallet directory")]
	PalletDirCreation,
	/// The specified pallet could not be found.
	#[error("Failed to find the pallet: {0}")]
	PalletNotFound(String),
	/// An error occurred while processing the arguments provided by the user.
	#[error("Failed to process the arguments provided by the user.")]
	ParamProcessingError,
	/// An error occurred while parsing the arguments provided by the user.
	#[error("Failed to parse the arguments provided by the user: {0}")]
	ParamParsingError(String),
	/// The path is invalid.
	#[error("Invalid path")]
	PathError,
	/// Failed to execute `rustfmt`.
	#[error("Failed to execute rustfmt")]
	RustfmtError(std::io::Error),
	/// The specified runtime could not be found.
	#[error("Failed to find the runtime {0}")]
	RuntimeNotFound(String),
	/// An error occurred sourcing a binary.
	#[error("Template error: {0}")]
	SourcingError(#[from] pop_common::sourcing::Error),
	/// An error occurred whilst interacting with a chain using `subxt`.
	#[error("Subxt error: {0}")]
	SubXtError(#[from] Box<subxt::Error>),
	/// A TOML error occurred.
	#[error("Toml error: {0}")]
	TomlError(#[from] toml_edit::de::Error),
	/// An error occurred while testing with try-runtime.
	#[error("Failed to test with try-runtime: {0}")]
	TryRuntimeError(String),
	/// The command is not supported.
	#[error("Unsupported command: {0}")]
	UnsupportedCommand(String),
	/// The workspace could not be located.
	#[error("Failed to locate the workspace")]
	WorkspaceLocate,
}

// Handles command execution errors by extracting and returning the stderr message using the
// provided error constructor.
pub(crate) fn handle_command_error<F>(
	output: &std::process::Output,
	custom_error: F,
) -> Result<(), Error>
where
	F: FnOnce(String) -> Error,
{
	if !output.status.success() {
		let stderr_msg = String::from_utf8_lossy(&output.stderr);
		return Err(custom_error(stderr_msg.to_string()));
	}
	Ok(())
}

#[cfg(test)]
mod tests {
	use super::*;
	use anyhow::Result;
	use std::{
		os::unix::process::ExitStatusExt,
		process::{ExitStatus, Output},
	};

	#[test]
	fn handle_command_error_failure() -> Result<()> {
		let output = Output {
			status: ExitStatus::from_raw(1),
			stdout: Vec::new(),
			stderr: Vec::from("Error message".as_bytes()),
		};
		assert!(matches!(
			handle_command_error(&output, Error::BuildSpecError),
			Err(Error::BuildSpecError(message))
			if message == "Error message"
		));
		Ok(())
	}
}