pezkuwi-sdk/bizinikiwi/pezframe/membership/src/benchmarking.rs

// This file is part of Bizinikiwi.

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

//! Membership pezpallet benchmarking.

use super::{Pezpallet as Membership, *};
use pezframe_benchmarking::v1::{account, benchmarks_instance_pallet, whitelist, BenchmarkError};
use pezframe_support::{assert_ok, traits::EnsureOrigin};
use pezframe_system::RawOrigin;

const SEED: u32 = 0;

fn set_members<T: Config<I>, I: 'static>(members: Vec<T::AccountId>, prime: Option<usize>) {
	let reset_origin = T::ResetOrigin::try_successful_origin()
		.expect("ResetOrigin has no successful origin required for the benchmark");
	let prime_origin = T::PrimeOrigin::try_successful_origin()
		.expect("PrimeOrigin has no successful origin required for the benchmark");

	assert_ok!(Membership::<T, I>::reset_members(reset_origin, members.clone()));
	if let Some(prime) = prime.map(|i| members[i].clone()) {
		let prime_lookup = T::Lookup::unlookup(prime);
		assert_ok!(Membership::<T, I>::set_prime(prime_origin, prime_lookup));
	} else {
		assert_ok!(Membership::<T, I>::clear_prime(prime_origin));
	}
}

benchmarks_instance_pallet! {
	add_member {
		let m in 1 .. (T::MaxMembers::get() - 1);

		let members = (0..m).map(|i| account("member", i, SEED)).collect::<Vec<T::AccountId>>();
		set_members::<T, I>(members, None);
		let new_member = account::<T::AccountId>("add", m, SEED);
		let new_member_lookup = T::Lookup::unlookup(new_member.clone());
	}: {
		assert_ok!(Membership::<T, I>::add_member(
			T::AddOrigin::try_successful_origin().map_err(|_| BenchmarkError::Weightless)?,
			new_member_lookup,
		));
	} verify {
		assert!(Members::<T, I>::get().contains(&new_member));
		#[cfg(test)] crate::mock::clean();
	}

	// the case of no prime or the prime being removed is surely cheaper than the case of
	// reporting a new prime via `MembershipChanged`.
	remove_member {
		let m in 2 .. T::MaxMembers::get();

		let members = (0..m).map(|i| account("member", i, SEED)).collect::<Vec<T::AccountId>>();
		set_members::<T, I>(members.clone(), Some(members.len() - 1));

		let to_remove = members.first().cloned().unwrap();
		let to_remove_lookup = T::Lookup::unlookup(to_remove.clone());
	}: {
		assert_ok!(Membership::<T, I>::remove_member(
			T::RemoveOrigin::try_successful_origin().map_err(|_| BenchmarkError::Weightless)?,
			to_remove_lookup,
		));
	} verify {
		assert!(!Members::<T, I>::get().contains(&to_remove));
		// prime is rejigged
		assert!(Prime::<T, I>::get().is_some() && T::MembershipChanged::get_prime().is_some());
		#[cfg(test)] crate::mock::clean();
	}

	// we remove a non-prime to make sure it needs to be set again.
	swap_member {
		let m in 2 .. T::MaxMembers::get();

		let members = (0..m).map(|i| account("member", i, SEED)).collect::<Vec<T::AccountId>>();
		set_members::<T, I>(members.clone(), Some(members.len() - 1));
		let add = account::<T::AccountId>("member", m, SEED);
		let add_lookup = T::Lookup::unlookup(add.clone());
		let remove = members.first().cloned().unwrap();
		let remove_lookup = T::Lookup::unlookup(remove.clone());
	}: {
		assert_ok!(Membership::<T, I>::swap_member(
			T::SwapOrigin::try_successful_origin().map_err(|_| BenchmarkError::Weightless)?,
			remove_lookup,
			add_lookup,
		));
	} verify {
		assert!(!Members::<T, I>::get().contains(&remove));
		assert!(Members::<T, I>::get().contains(&add));
		// prime is rejigged
		assert!(Prime::<T, I>::get().is_some());
		#[cfg(test)] crate::mock::clean();
	}

	// er keep the prime common between incoming and outgoing to make sure it is rejigged.
	reset_members {
		let m in 1 .. T::MaxMembers::get();

		let members = (1..m+1).map(|i| account("member", i, SEED)).collect::<Vec<T::AccountId>>();
		set_members::<T, I>(members.clone(), Some(members.len() - 1));
		let mut new_members = (m..2*m).map(|i| account("member", i, SEED)).collect::<Vec<T::AccountId>>();
	}: {
		assert_ok!(Membership::<T, I>::reset_members(
			T::ResetOrigin::try_successful_origin().map_err(|_| BenchmarkError::Weightless)?,
			new_members.clone(),
		));
	} verify {
		new_members.sort();
		assert_eq!(Members::<T, I>::get(), new_members);
		// prime is rejigged
		assert!(Prime::<T, I>::get().is_some());
		#[cfg(test)] crate::mock::clean();
	}

	change_key {
		let m in 1 .. T::MaxMembers::get();

		// worse case would be to change the prime
		let members = (0..m).map(|i| account("member", i, SEED)).collect::<Vec<T::AccountId>>();
		let prime = members.last().cloned().unwrap();
		set_members::<T, I>(members.clone(), Some(members.len() - 1));

		let add = account::<T::AccountId>("member", m, SEED);
		let add_lookup = T::Lookup::unlookup(add.clone());
		whitelist!(prime);
	}: {
		assert_ok!(Membership::<T, I>::change_key(RawOrigin::Signed(prime.clone()).into(), add_lookup));
	} verify {
		assert!(!Members::<T, I>::get().contains(&prime));
		assert!(Members::<T, I>::get().contains(&add));
		// prime is rejigged
		assert_eq!(Prime::<T, I>::get().unwrap(), add);
		#[cfg(test)] crate::mock::clean();
	}

	set_prime {
		let m in 1 .. T::MaxMembers::get();
		let members = (0..m).map(|i| account("member", i, SEED)).collect::<Vec<T::AccountId>>();
		let prime = members.last().cloned().unwrap();
		let prime_lookup = T::Lookup::unlookup(prime.clone());
		set_members::<T, I>(members, None);
	}: {
		assert_ok!(Membership::<T, I>::set_prime(
			T::PrimeOrigin::try_successful_origin().map_err(|_| BenchmarkError::Weightless)?,
			prime_lookup,
		));
	} verify {
		assert!(Prime::<T, I>::get().is_some());
		#[cfg(test)] crate::mock::clean();
	}

	clear_prime {
		let members = (0..T::MaxMembers::get()).map(|i| account("member", i, SEED)).collect::<Vec<T::AccountId>>();
		let prime = members.last().cloned().unwrap();
		set_members::<T, I>(members, None);
	}: {
		assert_ok!(Membership::<T, I>::clear_prime(
			T::PrimeOrigin::try_successful_origin().map_err(|_| BenchmarkError::Weightless)?,
		));
	} verify {
		assert!(Prime::<T, I>::get().is_none());
		assert!(<T::MembershipChanged>::get_prime().is_none());
		#[cfg(test)] crate::mock::clean();
	}

	impl_benchmark_test_suite!(Membership, crate::mock::new_bench_ext(), crate::mock::Test);
}