Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.
Merged
Prev Previous commit
Next Next commit
add basic verification to benchmarks
  • Loading branch information
shawntabrizi committed Sep 15, 2020
commit 442ead29f0d5ffa843ecc30e56f33225e5c9c9fb
125 changes: 100 additions & 25 deletions frame/identity/src/benchmarking.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,22 @@

use super::*;

use frame_system::RawOrigin;
use frame_system::{EventRecord, RawOrigin};
use frame_benchmarking::{benchmarks, account, whitelisted_caller};
use sp_runtime::traits::Bounded;

use crate::Module as Identity;

const SEED: u32 = 0;

fn assert_last_event<T: Trait>(generic_event: <T as Trait>::Event) {
let events = frame_system::Module::<T>::events();
let system_event: <T as frame_system::Trait>::Event = generic_event.into();
// compare to the last event record
let EventRecord { event, .. } = &events[events.len() - 1];
assert_eq!(event, &system_event);
}

// Adds `r` registrars to the Identity Pallet. These registrars will have set fees and fields.
fn add_registrars<T: Trait>(r: u32) -> Result<(), &'static str> {
for i in 0..r {
Expand Down Expand Up @@ -120,7 +128,11 @@ benchmarks! {

add_registrar {
let r in 1 .. T::MaxRegistrars::get() - 1 => add_registrars::<T>(r)?;
ensure!(Registrars::<T>::get().len() as u32 == r, "Registrars not set up correctly.");
}: _(RawOrigin::Root, account("registrar", r + 1, SEED))
verify {
ensure!(Registrars::<T>::get().len() as u32 == r + 1, "Registrars not added.");
}

set_identity {
let r in ...;
Expand Down Expand Up @@ -150,10 +162,10 @@ benchmarks! {
}
caller
};
}: _(
RawOrigin::Signed(caller),
create_identity_info::<T>(x)
)
}: _(RawOrigin::Signed(caller.clone()), create_identity_info::<T>(x))
verify {
assert_last_event::<T>(Event::<T>::IdentitySet(caller).into());
}

// We need to split `set_subs` into two benchmarks to accurately isolate the potential
// writes caused by new or old sub accounts. The actual weight should simply be
Expand All @@ -163,7 +175,11 @@ benchmarks! {
// Create a new subs vec with s sub accounts
let s in 1 .. T::MaxSubAccounts::get() => ();
let subs = create_sub_accounts::<T>(&caller, s)?;
}: set_subs(RawOrigin::Signed(caller), subs)
ensure!(SubsOf::<T>::get(&caller).1.len() == 0, "Caller already has subs");
}: set_subs(RawOrigin::Signed(caller.clone()), subs)
verify {
ensure!(SubsOf::<T>::get(&caller).1.len() as u32 == s, "Subs not added");
}

set_subs_old {
let caller: T::AccountId = whitelisted_caller();
Expand All @@ -173,8 +189,14 @@ benchmarks! {
};
// Remove all subs.
let subs = create_sub_accounts::<T>(&caller, 0)?;

}: set_subs(RawOrigin::Signed(caller), subs)
ensure!(
SubsOf::<T>::get(&caller).1.len() as u32 == p,
"Caller does have subs",
);
}: set_subs(RawOrigin::Signed(caller.clone()), subs)
verify {
ensure!(SubsOf::<T>::get(&caller).1.len() == 0, "Subs not removed");
}

clear_identity {
let caller: T::AccountId = whitelisted_caller();
Expand All @@ -196,15 +218,22 @@ benchmarks! {
Judgement::Reasonable
)?;
}
}: _(RawOrigin::Signed(caller))
ensure!(IdentityOf::<T>::contains_key(&caller), "Identity does not exist.");
}: _(RawOrigin::Signed(caller.clone()))
verify {
ensure!(!IdentityOf::<T>::contains_key(&caller), "Identity not cleared.");
}

request_judgement {
let caller: T::AccountId = whitelisted_caller();
let _ = T::Currency::make_free_balance_be(&caller, BalanceOf::<T>::max_value());

let r in ...;
let x in ...;
}: _(RawOrigin::Signed(caller), r - 1, 10.into())
}: _(RawOrigin::Signed(caller.clone()), r - 1, 10.into())
verify {
assert_last_event::<T>(Event::<T>::JudgementRequested(caller, r-1).into());
}

cancel_request {
let caller: T::AccountId = whitelisted_caller();
Expand All @@ -215,15 +244,24 @@ benchmarks! {
let x in ...;

Identity::<T>::request_judgement(caller_origin, r - 1, 10.into())?;
}: _(RawOrigin::Signed(caller), r - 1)
}: _(RawOrigin::Signed(caller.clone()), r - 1)
verify {
assert_last_event::<T>(Event::<T>::JudgementUnrequested(caller, r-1).into());
}

set_fee {
let caller: T::AccountId = whitelisted_caller();

let r in 1 .. T::MaxRegistrars::get() - 1 => add_registrars::<T>(r)?;

Identity::<T>::add_registrar(RawOrigin::Root.into(), caller.clone())?;
}: _(RawOrigin::Signed(caller), r, 10.into())
let registrars = Registrars::<T>::get();
ensure!(registrars[r as usize].as_ref().unwrap().fee == 0.into(), "Fee already set.");
}: _(RawOrigin::Signed(caller), r, 100.into())
verify {
let registrars = Registrars::<T>::get();
ensure!(registrars[r as usize].as_ref().unwrap().fee == 100.into(), "Fee not changed.");
}

set_account_id {
let caller: T::AccountId = whitelisted_caller();
Expand All @@ -232,7 +270,13 @@ benchmarks! {
let r in 1 .. T::MaxRegistrars::get() - 1 => add_registrars::<T>(r)?;

Identity::<T>::add_registrar(RawOrigin::Root.into(), caller.clone())?;
let registrars = Registrars::<T>::get();
ensure!(registrars[r as usize].as_ref().unwrap().account == caller.clone(), "id not set.");
}: _(RawOrigin::Signed(caller), r, account("new", 0, SEED))
verify {
let registrars = Registrars::<T>::get();
ensure!(registrars[r as usize].as_ref().unwrap().account == account("new", 0, SEED), "id not changed.");
}

set_fields {
let caller: T::AccountId = whitelisted_caller();
Expand All @@ -245,7 +289,13 @@ benchmarks! {
IdentityField::Display | IdentityField::Legal | IdentityField::Web | IdentityField::Riot
| IdentityField::Email | IdentityField::PgpFingerprint | IdentityField::Image | IdentityField::Twitter
);
let registrars = Registrars::<T>::get();
ensure!(registrars[r as usize].as_ref().unwrap().fields == Default::default(), "fields already set.");
}: _(RawOrigin::Signed(caller), r, fields)
verify {
let registrars = Registrars::<T>::get();
ensure!(registrars[r as usize].as_ref().unwrap().fields != Default::default(), "fields not set.");
}

provide_judgement {
// The user
Expand All @@ -267,28 +317,38 @@ benchmarks! {
Identity::<T>::add_registrar(RawOrigin::Root.into(), caller.clone())?;
Identity::<T>::request_judgement(user_origin.clone(), r, 10.into())?;
}: _(RawOrigin::Signed(caller), r, user_lookup, Judgement::Reasonable)
verify {
assert_last_event::<T>(Event::<T>::JudgementGiven(user, r).into())
}

kill_identity {
let caller: T::AccountId = whitelisted_caller();
let caller_origin: <T as frame_system::Trait>::Origin = RawOrigin::Signed(caller.clone()).into();
let caller_lookup: <T::Lookup as StaticLookup>::Source = T::Lookup::unlookup(caller.clone());
let _ = T::Currency::make_free_balance_be(&caller, BalanceOf::<T>::max_value());

let r in ...;
let s in ...;
let x in ...;

let target: T::AccountId = account("target", 0, SEED);
let target_origin: <T as frame_system::Trait>::Origin = RawOrigin::Signed(target.clone()).into();
let target_lookup: <T::Lookup as StaticLookup>::Source = T::Lookup::unlookup(target.clone());
let _ = T::Currency::make_free_balance_be(&target, BalanceOf::<T>::max_value());

let info = create_identity_info::<T>(T::MaxAdditionalFields::get());
Identity::<T>::set_identity(target_origin.clone(), info)?;

// User requests judgement from all the registrars, and they approve
for i in 0..r {
Identity::<T>::request_judgement(caller_origin.clone(), i, 10.into())?;
Identity::<T>::request_judgement(target_origin.clone(), i, 10.into())?;
Identity::<T>::provide_judgement(
RawOrigin::Signed(account("registrar", i, SEED)).into(),
i,
caller_lookup.clone(),
target_lookup.clone(),
Judgement::Reasonable
)?;
}
}: _(RawOrigin::Root, caller_lookup)
ensure!(IdentityOf::<T>::contains_key(&target), "Identity not set");
}: _(RawOrigin::Root, target_lookup)
verify {
ensure!(!IdentityOf::<T>::contains_key(&target), "Identity not removed");
}

add_sub {
let s in 1 .. T::MaxSubAccounts::get() - 1;
Expand All @@ -297,23 +357,34 @@ benchmarks! {
let _ = add_sub_accounts::<T>(&caller, p)?;
let sub = account("new_sub", 0, SEED);
let data = Data::Raw(vec![0; 32]);
}: _(RawOrigin::Signed(caller), T::Lookup::unlookup(sub), data)
ensure!(SubsOf::<T>::get(&caller).1.len() as u32 == s, "Subs not set.");
}: _(RawOrigin::Signed(caller.clone()), T::Lookup::unlookup(sub), data)
verify {
ensure!(SubsOf::<T>::get(&caller).1.len() as u32 == s + 1, "Subs not added.");
}

rename_sub {
let s in 1 .. T::MaxSubAccounts::get();

let caller: T::AccountId = whitelisted_caller();
let (sub, _) = add_sub_accounts::<T>(&caller, p)?.remove(0);
let data = Data::Raw(vec![1; 32]);

}: _(RawOrigin::Signed(caller), T::Lookup::unlookup(sub), data)
ensure!(SuperOf::<T>::get(&sub).unwrap().1 != data, "data already set");
}: _(RawOrigin::Signed(caller), T::Lookup::unlookup(sub.clone()), data.clone())
verify {
ensure!(SuperOf::<T>::get(&sub).unwrap().1 == data, "data not set");
}

remove_sub {
let s in 1 .. T::MaxSubAccounts::get();

let caller: T::AccountId = whitelisted_caller();
let (sub, _) = add_sub_accounts::<T>(&caller, s)?.remove(0);
}: _(RawOrigin::Signed(caller), T::Lookup::unlookup(sub))
ensure!(SuperOf::<T>::contains_key(&sub), "Sub doesn't exists");
}: _(RawOrigin::Signed(caller), T::Lookup::unlookup(sub.clone()))
verify {
ensure!(!SuperOf::<T>::contains_key(&sub), "Sub not removed");
}

quit_sub {
let s in 1 .. T::MaxSubAccounts::get() - 1;
Expand All @@ -323,7 +394,11 @@ benchmarks! {
let _ = add_sub_accounts::<T>(&sup, p)?;
let sup_origin = RawOrigin::Signed(sup).into();
Identity::<T>::add_sub(sup_origin, T::Lookup::unlookup(caller.clone()), Data::Raw(vec![0; 32]))?;
}: _(RawOrigin::Signed(caller))
ensure!(SuperOf::<T>::contains_key(&caller), "Sub doesn't exists");
}: _(RawOrigin::Signed(caller.clone()))
verify {
ensure!(!SuperOf::<T>::contains_key(&caller), "Sub not removed");
}

}

Expand Down