Malus: add disputed block percentage

node/malus/Cargo.toml

@@ -29,11 +29,12 @@ assert_matches = "1.5"
 async-trait = "0.1.57"
 sp-keystore = { git = "https://github.com/paritytech/substrate", branch = "master" }
 sp-core = { git = "https://github.com/paritytech/substrate", branch = "master" }
-clap = { version = "3.1", features = ["derive"] }
+clap = { version = "3.2.21", features = ["derive"] }
 futures = "0.3.21"
 futures-timer = "3.0.2"
 gum = { package = "tracing-gum", path = "../gum/" }
 erasure = { package = "polkadot-erasure-coding", path = "../../erasure-coding" }
+rand = "0.8.5"
 
 [features]
 default = []

node/malus/src/malus.rs

@@ -33,9 +33,9 @@ use variants::*;
 #[clap(rename_all = "kebab-case")]
 enum NemesisVariant {
 	/// Suggest a candidate with an invalid proof of validity.
-	SuggestGarbageCandidate(Cli),
+	SuggestGarbageCandidate(SuggestGarbageCandidateOptions),
 	/// Back a candidate with a specifically crafted proof of validity.
-	BackGarbageCandidate(Cli),
+	BackGarbageCandidate(BackGarbageCandidateOptions),
 	/// Delayed disputing of ancestors that are perfectly fine.
 	DisputeAncestor(DisputeAncestorOptions),
 
@@ -62,16 +62,31 @@ impl MalusCli {
 	fn launch(self) -> eyre::Result<()> {
 		let finality_delay = self.finality_delay;
 		match self.variant {
-			NemesisVariant::BackGarbageCandidate(cli) =>
-				polkadot_cli::run_node(cli, BackGarbageCandidate, finality_delay)?,
-			NemesisVariant::SuggestGarbageCandidate(cli) =>
-				polkadot_cli::run_node(cli, BackGarbageCandidateWrapper, finality_delay)?,
+			NemesisVariant::BackGarbageCandidate(opts) => {
+				let BackGarbageCandidateOptions { percentage, cli } = opts;
+
+				polkadot_cli::run_node(cli, BackGarbageCandidates { percentage }, finality_delay)?
+			},
+			NemesisVariant::SuggestGarbageCandidate(opts) => {
+				let SuggestGarbageCandidateOptions { percentage, cli } = opts;
+
+				polkadot_cli::run_node(
+					cli,
+					SuggestGarbageCandidates { percentage },
+					finality_delay,
+				)?
+			},
 			NemesisVariant::DisputeAncestor(opts) => {
-				let DisputeAncestorOptions { fake_validation, fake_validation_error, cli } = opts;
+				let DisputeAncestorOptions {
+					fake_validation,
+					fake_validation_error,
+					percentage,
+					cli,
+				} = opts;
 
 				polkadot_cli::run_node(
 					cli,
-					DisputeValidCandidates { fake_validation, fake_validation_error },
+					DisputeValidCandidates { fake_validation, fake_validation_error, percentage },
 					finality_delay,
 				)?
 			},
@@ -129,4 +144,77 @@ mod tests {
 			assert!(run.cli.run.base.bob);
 		});
 	}
+
+	#[test]
+	fn percentage_works_suggest_garbage() {
+		let cli = MalusCli::try_parse_from(IntoIterator::into_iter([
+			"malus",
+			"suggest-garbage-candidate",
+			"--percentage",
+			"100",
+			"--bob",
+		]))
+		.unwrap();
+		assert_matches::assert_matches!(cli, MalusCli {
+			variant: NemesisVariant::SuggestGarbageCandidate(run),
+			..
+		} => {
+			assert!(run.cli.run.base.bob);
+		});
+	}
+
+	#[test]
+	fn percentage_works_dispute_ancestor() {
+		let cli = MalusCli::try_parse_from(IntoIterator::into_iter([
+			"malus",
+			"dispute-ancestor",
+			"--percentage",
+			"100",
+			"--bob",
+		]))
+		.unwrap();
+		assert_matches::assert_matches!(cli, MalusCli {
+			variant: NemesisVariant::DisputeAncestor(run),
+			..
+		} => {
+			assert!(run.cli.run.base.bob);
+		});
+	}
+
+	#[test]
+	fn percentage_works_back_garbage() {
+		let cli = MalusCli::try_parse_from(IntoIterator::into_iter([
+			"malus",
+			"back-garbage-candidate",
+			"--percentage",
+			"100",
+			"--bob",
+		]))
+		.unwrap();
+		assert_matches::assert_matches!(cli, MalusCli {
+			variant: NemesisVariant::BackGarbageCandidate(run),
+			..
+		} => {
+			assert!(run.cli.run.base.bob);
+		});
+	}
+
+	#[test]
+	#[should_panic]
+	fn validate_range_for_percentage() {
+		let cli = MalusCli::try_parse_from(IntoIterator::into_iter([
+			"malus",
+			"suggest-garbage-candidate",
+			"--percentage",
+			"101",
+			"--bob",
+		]))
+		.unwrap();
+		assert_matches::assert_matches!(cli, MalusCli {
+			variant: NemesisVariant::DisputeAncestor(run),
+			..
+		} => {
+			assert!(run.cli.run.base.bob);
+		});
+	}
 }

node/malus/src/variants/back_garbage_candidate.rs

@@ -25,6 +25,7 @@ use polkadot_cli::{
 		OverseerConnector, OverseerGen, OverseerGenArgs, OverseerHandle, ParachainHost,
 		ProvideRuntimeApi,
 	},
+	Cli,
 };
 use polkadot_node_subsystem::SpawnGlue;
 use sp_core::traits::SpawnNamed;
@@ -36,11 +37,27 @@ use crate::{
 
 use std::sync::Arc;
 
+#[derive(Debug, clap::Parser)]
+#[clap(rename_all = "kebab-case")]
+#[allow(missing_docs)]
+pub struct BackGarbageCandidateOptions {
+	/// Determines the percentage of garbage candidates that should be backed.
+	/// Defaults to 100% of garbage candidates being backed.
+	#[clap(short, long, ignore_case = true, default_value_t = 100, value_parser = clap::value_parser!(u8).range(0..=100))]
+	pub percentage: u8,
+
+	#[clap(flatten)]
+	pub cli: Cli,
+}
+
 /// Generates an overseer that replaces the candidate validation subsystem with our malicious
 /// variant.
-pub(crate) struct BackGarbageCandidate;
+pub(crate) struct BackGarbageCandidates {
+	/// The probability of behaving maliciously.
+	pub percentage: u8,
+}
 
-impl OverseerGen for BackGarbageCandidate {
+impl OverseerGen for BackGarbageCandidates {
 	fn generate<'a, Spawner, RuntimeClient>(
 		&self,
 		connector: OverseerConnector,
@@ -55,6 +72,7 @@ impl OverseerGen for BackGarbageCandidate {
 		let validation_filter = ReplaceValidationResult::new(
 			FakeCandidateValidation::BackingAndApprovalValid,
 			FakeCandidateValidationError::InvalidOutputs,
+			f64::from(self.percentage),
 			SpawnGlue(spawner),
 		);