pezkuwi-subxt/substrate/frame/staking/fuzzer/src/submit_solution.rs

// This file is part of Substrate.

// Copyright (C) 2020 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.

//! Fuzzing for staking pallet.
//!
//! HFUZZ_RUN_ARGS="-n 8" cargo hfuzz run submit_solution

use honggfuzz::fuzz;

use mock::Test;
use pallet_staking::testing_utils::*;
use frame_support::{assert_ok, storage::StorageValue, traits::UnfilteredDispatchable};
use frame_system::RawOrigin;
use sp_runtime::DispatchError;
use sp_core::offchain::{testing::TestOffchainExt, OffchainExt};
use pallet_staking::{EraElectionStatus, ElectionStatus, Module as Staking, Call as StakingCall};

mod mock;

#[repr(u32)]
#[allow(dead_code)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Mode {
	/// Initial submission. This will be rather cheap.
	InitialSubmission,
	/// A better submission that will replace the previous ones. This is the most expensive.
	StrongerSubmission,
	/// A weak submission that will be rejected. This will be rather cheap.
	WeakerSubmission,
}

pub fn new_test_ext(iterations: u32) -> sp_io::TestExternalities {
	let mut ext: sp_io::TestExternalities = frame_system::GenesisConfig::default()
		.build_storage::<mock::Test>()
		.map(Into::into)
		.expect("Failed to create test externalities.");

	let (offchain, offchain_state) = TestOffchainExt::new();

	let mut seed = [0u8; 32];
	seed[0..4].copy_from_slice(&iterations.to_le_bytes());
	offchain_state.write().seed = seed;

	ext.register_extension(OffchainExt::new(offchain));

	ext
}

fn main() {
	let to_range = |x: u32, a: u32, b: u32| {
		let collapsed = x % b;
		if collapsed >= a {
			collapsed
		} else {
			collapsed + a
		}
	};
	loop {
		fuzz!(|data: (u32, u32, u32, u32, u32)| {
			let (mut num_validators, mut num_nominators, mut edge_per_voter, mut to_elect, mode_u32) = data;
			// always run with 5 iterations.
			let mut ext = new_test_ext(5);
			let mode: Mode = unsafe { std::mem::transmute(mode_u32) };
			num_validators = to_range(num_validators, 50, 1000);
			num_nominators = to_range(num_nominators, 50, 2000);
			edge_per_voter = to_range(edge_per_voter, 1, 16);
			to_elect = to_range(to_elect, 20, num_validators);

			let do_reduce = true;

			println!("+++ instance with params {} / {} / {} / {} / {:?}({})",
				num_nominators,
				num_validators,
				edge_per_voter,
				to_elect,
				mode,
				mode_u32,
			);

			ext.execute_with(|| {
				// initial setup
				init_active_era();

				assert_ok!(create_validators_with_nominators_for_era::<Test>(
					num_validators,
					num_nominators,
					edge_per_voter as usize,
					true,
					None,
				));

				<EraElectionStatus<Test>>::put(ElectionStatus::Open(1));
				assert!(<Staking<Test>>::create_stakers_snapshot().0);

				let origin = RawOrigin::Signed(create_funded_user::<Test>("fuzzer", 0, 100));

				// stuff to submit
				let (winners, compact, score, size) = match mode {
					Mode::InitialSubmission => {
						/* No need to setup anything */
						get_seq_phragmen_solution::<Test>(do_reduce)
					},
					Mode::StrongerSubmission => {
						let (winners, compact, score, size) = get_weak_solution::<Test>(false);
						println!("Weak on chain score = {:?}", score);
						assert_ok!(
							<Staking<Test>>::submit_election_solution(
								origin.clone().into(),
								winners,
								compact,
								score,
								current_era::<Test>(),
								size,
							)
						);
						get_seq_phragmen_solution::<Test>(do_reduce)
					},
					Mode::WeakerSubmission => {
						let (winners, compact, score, size) = get_seq_phragmen_solution::<Test>(do_reduce);
						println!("Strong on chain score = {:?}", score);
						assert_ok!(
							<Staking<Test>>::submit_election_solution(
								origin.clone().into(),
								winners,
								compact,
								score,
								current_era::<Test>(),
								size,
							)
						);
						get_weak_solution::<Test>(false)
					}
				};

				// must have chosen correct number of winners.
				assert_eq!(winners.len() as u32, <Staking<Test>>::validator_count());

				// final call and origin
				let call = StakingCall::<Test>::submit_election_solution(
					winners,
					compact,
					score,
					current_era::<Test>(),
					size,
				);

				// actually submit
				match mode {
					Mode::WeakerSubmission => {
						assert_eq!(
							call.dispatch_bypass_filter(origin.clone().into()).unwrap_err().error,
							DispatchError::Module {
								index: 0,
								error: 16,
								message: Some("PhragmenWeakSubmission"),
							},
						);
					},
					// NOTE: so exhaustive pattern doesn't work here.. maybe some rust issue?
					// or due to `#[repr(u32)]`?
					Mode::InitialSubmission | Mode::StrongerSubmission => {
						assert_ok!(call.dispatch_bypass_filter(origin.into()));
					}
				};
			})
		});
	}
}